Difference between revisions of "nearEntities"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (removed brackets from examples)
(Add in-vehicle information)
Line 1: Line 1:
{{Command|= Comments
+
{{Command|Comments=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| arma2 |= Game name
+
| arma2 |Game name=
  
|1.00|= Game version
+
|1.00|Game version=
  
|arg= global |= Arguments in MP
+
|arg= global |Arguments in MP=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| [[Image:sphere_radius.jpg|right|150px]] Find entities in the sphere with given radius. If typeName(s) is (are) given, only entities of given type (or its subtype) are listed.
+
| [[Image:sphere_radius.jpg|right|150px]]
 +
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 returns only alive 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. |Description=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| position '''nearEntities''' radius |= Syntax
+
| position [[nearEntities]] radius |Syntax=
  
|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 |PARAMETER1=
  
|p2= radius: [[Number]] - radius of the sphere |= PARAMETER2
+
|p2= radius: [[Number]] - radius of the sphere |PARAMETER2=
  
| [[Array]] of [[Object|Objects]]|= RETURNVALUE
+
| [[Array]] of [[Object|Objects]]|RETURNVALUE=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
|s2= position '''nearEntities''' [typeName, radius] |=  
+
|s2= position [[nearEntities]] [typeName, radius] |Syntax 2=
  
|p21= position: [[Object]] or [[Array]] in format [[PositionAGL]] or [[Position2D]] - center of the sphere |= PARAMETER1
+
|p21= position: [[Object]] or [[Array]] in format [[PositionAGL]] or [[Position2D]] - center of the sphere |PARAMETER21=
  
|p22= [typeName, radius]: [[Array]] |= PARAMETER2
+
|p22= [type, radius]: [[Array]] |PARAMETER22=
  
|p23= typeName: [[String]] or [[Array]] of [[String|Strings]] - typeName(s) to search for |= PARAMETER3
+
|p23= type: [[String]] or [[Array]] of [[String|Strings]] - typeName(s) to search for |PARAMETER23=
  
|p24= radius: [[Number]] - radius of the sphere |= PARAMETER4
+
|p24= radius: [[Number]] - radius of the sphere |PARAMETER24=
  
|r2= [[Array]] of [[Object|Objects]] |= RETURNVALUE
+
|r2= [[Array]] of [[Object|Objects]] |RETURNVALUE 2=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
 
|x1= <code>_list = [[player]] [[nearEntities]] 20;
 
|x1= <code>_list = [[player]] [[nearEntities]] 20;
Line 41: Line 43:
 
_list = [[player]] [[nearEntities]] <nowiki>[</nowiki>["Car", "Motorcycle", "Tank"], 50];
 
_list = [[player]] [[nearEntities]] <nowiki>[</nowiki>["Car", "Motorcycle", "Tank"], 50];
 
_list = [[ASLToAGL]] [[getPosASL]] [[player]] [[nearEntities]] <nowiki>[</nowiki>["Man", "Air", "Car", "Motorcycle", "Tank"], 200];
 
_list = [[ASLToAGL]] [[getPosASL]] [[player]] [[nearEntities]] <nowiki>[</nowiki>["Man", "Air", "Car", "Motorcycle", "Tank"], 200];
</code>|= EXAMPLE1
+
</code>|EXAMPLE1=
  
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| [[findNearestEnemy]], [[nearestBuilding]], [[nearestObject]], [[nearestObjects]], [[nearObjects]], [[nearestLocation]], [[nearTargets]], [[nearSupplies]], [[nearestLocationWithDubbing]], [[nearObjectsReady]], [[nearRoads]] |= SEEALSO
+
| [[findNearestEnemy]], [[nearestBuilding]], [[nearestObject]], [[nearestObjects]], [[nearObjects]], [[nearestLocation]], [[nearTargets]], [[nearSupplies]], [[nearestLocationWithDubbing]], [[nearObjectsReady]], [[nearRoads]] |SEEALSO=
  
|  |= MPBEHAVIOUR
+
|  |MPBEHAVIOUR=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
 
}}
 
}}
Line 56: Line 58:
  
 
<dd class="notedate">Posted on 27 Mar, 2014
 
<dd class="notedate">Posted on 27 Mar, 2014
<dt class="note">'''[[User:Floriangeyer|Floriangeyer]]'''<dd class="note">
+
<dt class="note">[[User:Floriangeyer|Floriangeyer]]
According to [[Code Optimisation]], this function is the fastest and should be used instead of [[nearestObjects]] when suitable.
+
<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 -->
Line 64: Line 65:
  
 
<h3 style='display:none'>Bottom Section</h3>
 
<h3 style='display:none'>Bottom Section</h3>
 +
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
 
[[Category:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
 
[[Category:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
 

Revision as of 00:36, 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.
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
[type, radius]: Array
type: 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 = 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

Posted on 27 Mar, 2014
Floriangeyer
According to Code Optimisation, this function is the fastest and should be used instead of nearestObjects when suitable.

Bottom Section