Difference between revisions of "nearEntities"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...)
Line 1: Line 1:
{{Command|Comments=
+
{{Command
  
| arma2 |Game name=
+
| arma2
  
|1.00|Game version=
+
|1.00
  
 
|arg= global |Arguments in MP=
 
|arg= global |Arguments in MP=
  
|gr1= Object Detection |GROUP1=
+
|gr1= Object Detection
  
 
| [[Image:sphere_radius.jpg|right|200px]]
 
| [[Image:sphere_radius.jpg|right|200px]]
 
Finds entities inside a sphere with the given radius. If the alternative syntax is used, only entities of given types or subtypes are listed. Entities returned are not sorted by distance. This command doesn't return dead entities or entities inside vehicles. If you need to return those, use [[entities]] command.<br><br>
 
Finds entities inside a sphere with the given radius. If the alternative syntax is used, only entities of given types or subtypes are listed. Entities returned are not sorted by distance. This command doesn't return dead entities or entities inside vehicles. If you need to return those, use [[entities]] command.<br><br>
{{Informative|This command is much [[Code_Optimisation#nearEntities_and_nearestObjects | faster]] than [[nearestObjects]] for on-foot soldier and vehicle detection.}} |Description=
+
{{Informative|This command is much [[Code_Optimisation#nearEntities_and_nearestObjects | faster]] than [[nearestObjects]] for on-foot soldier and vehicle detection.}}
  
| position [[nearEntities]] radius |Syntax=
+
| position [[nearEntities]] radius
  
|p1= position: [[Object]] or [[Array]] in format [[PositionAGL]] or [[Position2D]] - center of the sphere |PARAMETER1=
+
|p1= position: [[Object]] or [[Array]] in format [[PositionAGL]] or [[Position2D]] - center of the sphere
  
|p2= radius: [[Number]] - radius of the sphere |PARAMETER2=
+
|p2= radius: [[Number]] - radius of the sphere
  
| [[Array]] of [[Object|Objects]] - not sorted |RETURNVALUE=
+
| [[Array]] of [[Object|Objects]] - not sorted
  
 
|s2= position [[nearEntities]] [type, radius] |Syntax 2=
 
|s2= position [[nearEntities]] [type, radius] |Syntax 2=
Line 31: Line 31:
 
|p24= radius: [[Number]] - radius of the sphere |PARAMETER24=
 
|p24= radius: [[Number]] - radius of the sphere |PARAMETER24=
  
|r2= [[Array]] of [[Object|Objects]] - not sorted |RETURNVALUE 2=
+
|r2= [[Array]] of [[Object|Objects]] - not sorted
 
|x1= <code>_list = [[player]] [[nearEntities]] 20;
 
|x1= <code>_list = [[player]] [[nearEntities]] 20;
 
_list = [[ASLToAGL]] [[getPosASL]] [[player]] [[nearEntities]] 50;
 
_list = [[ASLToAGL]] [[getPosASL]] [[player]] [[nearEntities]] 50;
Line 38: Line 38:
 
_list = [[player]] [[nearEntities]] [<nowiki/>["Car", "Motorcycle", "Tank"], 50];
 
_list = [[player]] [[nearEntities]] [<nowiki/>["Car", "Motorcycle", "Tank"], 50];
 
_list = [[ASLToAGL]] [[getPosASL]] [[player]] [[nearEntities]] [<nowiki/>["Man", "Air", "Car", "Motorcycle", "Tank"], 200];
 
_list = [[ASLToAGL]] [[getPosASL]] [[player]] [[nearEntities]] [<nowiki/>["Man", "Air", "Car", "Motorcycle", "Tank"], 200];
</code>|EXAMPLE1=
+
</code>
  
  
|[[entities]], [[findNearestEnemy]], [[nearestBuilding]], [[nearestObject]], [[nearestObjects]], [[nearObjects]], [[nearestLocation]], [[nearTargets]], [[nearSupplies]], [[nearestLocationWithDubbing]], [[nearObjectsReady]], [[nearRoads]] |SEEALSO=
+
|[[entities]], [[findNearestEnemy]], [[nearestBuilding]], [[nearestObject]], [[nearestObjects]], [[nearObjects]], [[nearestLocation]], [[nearTargets]], [[nearSupplies]], [[nearestLocationWithDubbing]], [[nearObjectsReady]], [[nearRoads]]
  
 
|  |MPBEHAVIOUR=
 
|  |MPBEHAVIOUR=

Revision as of 02:11, 18 January 2021

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. Entities returned are not sorted by distance. This command doesn't return dead entities or entities inside vehicles. If you need to return those, use entities command.

Template:Informative
Groups:
Object Detection

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 - not sorted

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 - not sorted

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:
entitiesfindNearestEnemynearestBuildingnearestObjectnearestObjectsnearObjectsnearestLocationnearTargetsnearSuppliesnearestLocationWithDubbingnearObjectsReadynearRoads

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