Difference between revisions of "nearEntities"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (typeName fix)
(Add note, typeName fix #2)
Line 13: Line 13:
 
If the alternativee syntax is used, only entities of given types or subtypes are listed.
 
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. |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=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
Line 31: Line 32:
 
|p22= [type, radius]: [[Array]] |PARAMETER22=
 
|p22= [type, radius]: [[Array]] |PARAMETER22=
  
|p23= type: [[String]] or [[Array]] of [[String|Strings]] - typeName(s) to search for |PARAMETER23=
+
|p23= type: [[String]] or [[Array]] of [[String|Strings]] - type(s) to search for |PARAMETER23=
  
 
|p24= radius: [[Number]] - radius of the sphere |PARAMETER24=
 
|p24= radius: [[Number]] - radius of the sphere |PARAMETER24=
Line 50: Line 51:
  
 
|  |MPBEHAVIOUR=
 
|  |MPBEHAVIOUR=
____________________________________________________________________________________________
 
 
}}
 
}}
  
Line 56: Line 56:
 
<dl class='command_description'>
 
<dl class='command_description'>
 
<!-- Note Section BEGIN -->
 
<!-- Note Section BEGIN -->
 
<dd class="notedate">Posted on 27 Mar, 2014
 
<dt class="note">[[User:Floriangeyer|Floriangeyer]]
 
<dd class="note">According to [[Code Optimisation]], this function is the fastest and should be used instead of [[nearestObjects]] when suitable.
 
  
 
<!-- Note Section END -->
 
<!-- Note Section END -->

Revision as of 00:43, 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.

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