nearestLocation: Difference between revisions
Jump to navigation
Jump to search
Killzone Kid (talk | contribs) No edit summary |
Killzone Kid (talk | contribs) No edit summary |
||
Line 19: | Line 19: | ||
|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). | ||
{{Feature | Informative | Although locations can be placed in 3D with [[setPosition]], [[nearestLocations]] search is conducted in 2D.}} | |||
|s1= [[nearestLocation]] [position, locationType, maxDistance] | |s1= [[nearestLocation]] [position, locationType, maxDistance] |
Revision as of 18:53, 30 July 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, or (since Arma3 2.14) Array of location types. See Location Types
- since 2.14
- maxDistance (Optional): Number - 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