nearestLocation: Difference between revisions
Killzone Kid (talk | contribs) No edit summary  | 
				BrettMayson (talk | contribs)  mNo edit summary  | 
				||
| Line 28: | Line 28: | ||
|p2= locationType: [[String]] of a location class name. If "" is supplied, any nearest location is returned. Since Arma 3 2.14 locationType could be an [[Array]] of location types. See [[Location#Location Types|Location Types]]  | |p2= locationType: [[String]] of a location class name. If "" is supplied, any nearest location is returned. Since Arma 3 2.14 locationType could be an [[Array]] of location types. See [[Location#Location Types|Location Types]]  | ||
|p3= maxDistance   | |p3= maxDistance: [[Number]] - (Optional) max search radius. Default - unlimited range.  | ||
|p3since= arma3 2.14    | |p3since= arma3 2.14    | ||
Revision as of 20:49, 28 September 2023
Description
- Description:
 - Return the closest location of specified class to a given position. Checked range is unlimited (i.e. covers the whole map).
 - Groups:
 - Locations
 
Syntax
- Syntax:
 - nearestLocation [position, locationType, maxDistance]
 - Parameters:
 - position: Object or Array in format PositionAGL or Position2D
 - locationType: String of a location class name. If "" is supplied, any nearest location is returned. Since Arma 3 2.14 locationType could be an Array of location types. See Location Types
 - since 
 2.14 - maxDistance: Number - (Optional) max search radius. Default - unlimited range.
 - Return Value:
 - Location
 
Examples
- Example 1:
 - Example 2:
 
Additional Information
- See also:
 - findNearestEnemy nearestBuilding nearestObject nearestObjects nearObjects nearEntities nearTargets nearSupplies nearestLocationWithDubbing nearObjectsReady nearRoads Location Types locationPosition nearestLocations createLocation nearestMines
 
Notes
- 
Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note 
Categories: 
- Scripting Commands
 - Introduced with Armed Assault version 1.08
 - ArmA: Armed Assault: New Scripting Commands
 - ArmA: Armed Assault: Scripting Commands
 - Arma 2: Scripting Commands
 - Arma 2: Operation Arrowhead: Scripting Commands
 - Take On Helicopters: Scripting Commands
 - Arma 3: Scripting Commands
 - Command Group: Locations