Difference between revisions of "nearEntities"

From Bohemia Interactive Community
Jump to navigation Jump to search
(Add in-vehicle information)
m (typeName fix)
Line 25: Line 25:
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
|s2= position [[nearEntities]] [typeName, radius] |Syntax 2=
+
|s2= position [[nearEntities]] [type, radius] |Syntax 2=
  
 
|p21= position: [[Object]] or [[Array]] in format [[PositionAGL]] or [[Position2D]] - center of the sphere |PARAMETER21=
 
|p21= position: [[Object]] or [[Array]] in format [[PositionAGL]] or [[Position2D]] - center of the sphere |PARAMETER21=

Revision as of 00:37, 25 January 2019

Hover & click on the images for description

Description

Description:
sphere radius.jpg

Find entities in the sphere with given radius. If the alternativee syntax is used, only entities of given types or subtypes are listed.

This command doesn't return dead or in-vehicle entities. If you need to return dead entities as well use entities command.
Groups:
Uncategorised

Syntax

Syntax:
position nearEntities radius
Parameters:
position: Object or Array in format PositionAGL or Position2D - center of the sphere
radius: Number - radius of the sphere
Return Value:
Array of Objects

Alternative Syntax

Syntax:
position nearEntities [type, radius]
Parameters:
position: Object or Array in format PositionAGL or Position2D - center of the sphere
[type, radius]: Array
type: String or Array of Strings - typeName(s) to search for
radius: Number - radius of the sphere
Return Value:
Array of Objects

Examples

Example 1:
_list = player nearEntities 20; _list = ASLToAGL getPosASL player nearEntities 50; _list = player nearEntities ["Man", 1000]; _list = ASLToAGL getPosASL player nearEntities ["LaserTarget", 3000]; _list = player nearEntities [["Car", "Motorcycle", "Tank"], 50]; _list = ASLToAGL getPosASL player nearEntities [["Man", "Air", "Car", "Motorcycle", "Tank"], 200];

Additional Information

See also:
findNearestEnemynearestBuildingnearestObjectnearestObjectsnearObjectsnearestLocationnearTargetsnearSuppliesnearestLocationWithDubbingnearObjectsReadynearRoads

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

Notes

Posted on 27 Mar, 2014
Floriangeyer
According to Code Optimisation, this function is the fastest and should be used instead of nearestObjects when suitable.

Bottom Section