nearEntities: Difference between revisions
Jump to navigation
Jump to search
Killzone Kid (talk | contribs) (moving note in discuss because of faulty example) |
Killzone Kid (talk | contribs) (syntax description) |
||
Line 16: | Line 16: | ||
| position '''nearEntities''' radius |= Syntax | | position '''nearEntities''' radius |= Syntax | ||
|p1= position: [[Object]] or [[Array]] | |p1= position: [[Object]] or [[Array]] in format [[PositionAGL]] or [[Position2D]] - center of the sphere |= PARAMETER1 | ||
|p2= radius: [[Number]] - radius of the sphere |= PARAMETER2 | |p2= radius: [[Number]] - radius of the sphere |= PARAMETER2 |
Revision as of 17:17, 17 October 2015
Description
- Description:
- Find entities in the sphere 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 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 [typeName, radius]
- Parameters:
- position: Object or Array in format PositionAGL or Position2D - center of the sphere
- [typeName, radius]: Array
- typeName: 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 = (position player) nearEntities 50; _list = player nearEntities ["Man", 1000]; _list = (position player) nearEntities ["LaserTarget", 3000]; _list = player nearEntities [["Car", "Motorcycle", "Tank"], 50]; _list = (position 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.