Difference between revisions of "nearEntities"

From Bohemia Interactive Community
Jump to navigation Jump to search
(Add note, typeName fix #2)
(typos format)
Line 9: Line 9:
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| [[Image:sphere_radius.jpg|right|150px]]
+
| [[Image:sphere_radius.jpg|right|200px]]
Find entities in the sphere with given radius.
+
Finds entities inside a sphere with the given radius. If the alternative syntax is used, only entities of given types or subtypes are listed. This command doesn't return dead entities or entities inside vehicles. If you need to return those, use [[entities]] command.<br><br>
If the alternativee syntax is used, only entities of given types or subtypes are listed.
+
{{Informative|This command is much [[Code_Optimisation#nearEntities_and_nearestObjects | faster]] than [[nearestObjects]] for on-foot soldier and vehicle detection.}} |Description=
 
 
This command doesn't return dead or in-vehicle entities. If you need to return dead entities as well use [[entities]] command.
 
{{Informative|This command is way faster than [[nearestObjects]] for on-foot soldier and vehicle detection.}} |Description=
 
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  

Revision as of 19:01, 25 January 2019

Hover & click on the images for description

Description

Description:
sphere radius.jpg

Finds entities inside a sphere with the given radius. If the alternative syntax is used, only entities of given types or subtypes are listed. This command doesn't return dead entities or entities inside vehicles. If you need to return those, use entities command.

Template:Informative
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 - type(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

Bottom Section