Difference between revisions of "nearEntities"

From Bohemia Interactive Community
Jump to navigation Jump to search
(typos format)
m (Text replacement - "\| *((\[\[[a-zA-Z0-9_ |()]+\]\],? ?)+) * \}\}" to "|seealso= $1 }}")
 
(21 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|Comments=
+
{{RV|type=command
____________________________________________________________________________________________
 
  
| arma2 |Game name=
+
| arma2
  
|1.00|Game version=
+
|1.00
  
|arg= global |Arguments in MP=
+
|arg= global
____________________________________________________________________________________________
+
 
 +
|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. 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=
+
{{Feature|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]]|RETURNVALUE=
+
| [[Array]] of [[Object|Objects]] - not sorted
____________________________________________________________________________________________
 
  
|s2= position [[nearEntities]] [type, radius] |Syntax 2=
+
|s2= position [[nearEntities]] [type, radius]
  
|p21= position: [[Object]] or [[Array]] in format [[PositionAGL]] or [[Position2D]] - center of the sphere |PARAMETER21=
+
|p21= position: [[Object]] or [[Array]] in format [[PositionAGL]] or [[Position2D]] - center of the sphere
  
|p22= [type, radius]: [[Array]] |PARAMETER22=
+
|p22= [type, radius]: [[Array]]
  
|p23= type: [[String]] or [[Array]] of [[String|Strings]] - type(s) to search for |PARAMETER23=
+
|p23= type: [[String]] or [[Array]] of [[String|Strings]] - type(s) to search for
  
|p24= radius: [[Number]] - radius of the sphere |PARAMETER24=
+
|p24= radius: [[Number]] - radius of the sphere
  
|r2= [[Array]] of [[Object|Objects]] |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;
 
_list = [[player]] [[nearEntities]] ["Man", 1000];
 
_list = [[player]] [[nearEntities]] ["Man", 1000];
 
_list = [[ASLToAGL]] [[getPosASL]] [[player]] [[nearEntities]] ["LaserTarget", 3000];
 
_list = [[ASLToAGL]] [[getPosASL]] [[player]] [[nearEntities]] ["LaserTarget", 3000];
_list = [[player]] [[nearEntities]] <nowiki>[</nowiki>["Car", "Motorcycle", "Tank"], 50];
+
_list = [[player]] [[nearEntities]] [<nowiki/>["Car", "Motorcycle", "Tank"], 50];
_list = [[ASLToAGL]] [[getPosASL]] [[player]] [[nearEntities]] <nowiki>[</nowiki>["Man", "Air", "Car", "Motorcycle", "Tank"], 200];
+
_list = [[ASLToAGL]] [[getPosASL]] [[player]] [[nearEntities]] [<nowiki/>["Man", "Air", "Car", "Motorcycle", "Tank"], 200];
</code>|EXAMPLE1=
+
</code>
  
____________________________________________________________________________________________
+
|seealso= [[entities]], [[findNearestEnemy]], [[nearestBuilding]], [[nearestObject]], [[nearestObjects]], [[nearObjects]], [[nearestLocation]], [[nearTargets]], [[nearSupplies]], [[nearestLocationWithDubbing]], [[nearObjectsReady]], [[nearRoads]]
 
 
| [[findNearestEnemy]], [[nearestBuilding]], [[nearestObject]], [[nearestObjects]], [[nearObjects]], [[nearestLocation]], [[nearTargets]], [[nearSupplies]], [[nearestLocationWithDubbing]], [[nearObjectsReady]], [[nearRoads]] |SEEALSO=
 
 
 
|  |MPBEHAVIOUR=
 
 
}}
 
}}
  
<h3 style='display:none'>Notes</h3>
 
<dl class='command_description'>
 
<!-- Note Section BEGIN -->
 
  
<!-- Note Section END -->
+
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
</dl>
 
  
<h3 style='display:none'>Bottom Section</h3>
+
{{GameCategory|arma2|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
+
{{GameCategory|tkoh|Scripting Commands}}
[[Category:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
+
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 

Latest revision as of 00:54, 17 February 2021

Hover & click on the images for descriptions

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.

This command is much faster than nearestObjects for on-foot soldier and vehicle 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
Groups:
Object Detection

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