nearEntities

From Bohemia Interactive Community
Revision as of 20:22, 27 March 2014 by Floriangeyer (talk | contribs) (Added suggestion for code optimization)
Jump to navigation Jump to search
Hover & click on the images for description

Description

Description:
Find entities in the circle with given radius. If typeName(s) is (are) given, only entities of given type (or its subtype) are listed. This command returns only alive 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 (format Position) - center of the circle
radius: Number - radius of the circle
Return Value:
Array of Objects

Alternative Syntax

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

Examples

Example 1:
_list = player nearEntities 20;
_list = (position player) nearEntities 50;
_list = (position player) nearEntities ["Land", 1000];
_list = (position player) nearEntities ["LaserTarget", 3000];
_list = (position player) nearEntities [["All"], 50];
_list = (position player) nearEntities [["Man", "Air", "Car", "Motorcycle", "Tank"], 200];

Additional Information

See also:
entitiesnearestObjectnearestObjectsnearObjects

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.

Bottom Section