nearestLocation: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "<code>([^ ]*)\[\[([a-zA-Z][a-zA-Z0-9_]+)\]\]([^ ]*)<\/code>" to "<code>$1$2$3</code>") |
Lou Montana (talk | contribs) m (Text replacement - "\{\{Feature *\| *Informative *\| ([^↵]+) *\}\}" to "{{Feature|informative|$1}}") |
||
| (22 intermediate revisions by 3 users not shown) | |||
| Line 20: | Line 20: | ||
|descr= Return the closest location of specified class to a given position. Checked range is unlimited (i.e. covers the whole map). | |descr= Return the closest location of specified class to a given position. Checked range is unlimited (i.e. covers the whole map). | ||
|s1= [[nearestLocation]] [position, | {{Feature|informative|Although locations can be placed in 3D with [[setPosition]], [[nearestLocations]] search is conducted in 2D.}} | ||
|s1= [[nearestLocation]] [position, locationType, maxDistance] | |||
|p1= position: [[Object]] or [[Array]] in format [[Position#PositionAGL|PositionAGL]] or [[Position#Introduction|Position2D]] | |p1= position: [[Object]] or [[Array]] in format [[Position#PositionAGL|PositionAGL]] or [[Position#Introduction|Position2D]] | ||
|p2= | |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: [[Number]] - (Optional) max search radius. Default - unlimited range. | |||
|p3since= arma3 2.14 | |||
|r1= [[Location]] | |r1= [[Location]] | ||
|x1= < | |x1= <sqf>_nearestCity = nearestLocation [getPos player, "nameCity"];</sqf> | ||
|x2= < | |x2= <sqf>_anyNearestLocation = nearestLocation [player, ""];</sqf> | ||
|seealso= | |seealso= [[findNearestEnemy]] [[nearestBuilding]] [[nearestObject]] [[nearestObjects]] [[nearObjects]] [[nearEntities]] [[nearTargets]] [[nearSupplies]] [[nearestLocationWithDubbing]] [[nearObjectsReady]] [[nearRoads]] [[Location#Location Types|Location Types]] [[locationPosition]] [[nearestLocations]] [[createLocation]] [[nearestMines]] | ||
}} | }} | ||
Latest revision as of 18:11, 15 March 2024
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