Difference between revisions of "nearEntities"

From Bohemia Interactive Community
Jump to navigation Jump to search
(syntax)
Line 7: Line 7:
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| Find entities in the circle with given radius. If typeName(s) is (are) given, only entities of given type (or its subtype) are listed. This command returns only alive entities. If you need to return dead entities as well use [[entities]] command |= Description
+
| Find entities in the circle with given radius. If typeName(s) is (are) given, only entities of given type (or its subtype) are listed.
 +
 
 +
This command returns only alive entities. If you need to return dead entities as well use [[entities]] command. |= Description
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| position '''nearEntities''' radius or [typeName,radius] or <nowiki>[[typeName1,typeName2,...],radius]</nowiki> |= Syntax
+
| position '''nearEntities''' radius |= Syntax
 +
 
 +
|p1= position: [[Object]] or [[Array]] (format [[Position]]) - center of the circle |= PARAMETER1
 +
 
 +
|p2= radius: [[Number]] - radius of the circle |= PARAMETER2
  
|p1= position: [[Object]] or [[Array]] |= PARAMETER1
+
| [[Array]] of [[Object|Objects]]|= RETURNVALUE
 +
____________________________________________________________________________________________
  
|p2= [typeName,radius] or <nowiki>[[typeName1,typeName2,...],radius]</nowiki>: Array -  |= PARAMETER2
+
|s2= position '''nearEntities''' [typeName, radius] |=  
  
|p3= |= PARAMETER3
+
|p21= position: [[Object]] or [[Array]] (format [[Position]]) - center of the circle |= PARAMETER1
  
| [[Array]] |= RETURNVALUE
+
|p22= [typeName, radius]: [[Array]] |= PARAMETER2
  
 +
|p23= typeName: [[String]] or [[Array]] of [[String|Strings]] - typeName(s) to search for |= PARAMETER3
 +
 +
|p24= radius: [[Number]] - radius of the circle |= PARAMETER4
 +
 +
|r2= [[Array]] of [[Object|Objects]] |= RETURNVALUE
 +
____________________________________________________________________________________________
 
|x1= <pre>
 
|x1= <pre>
 +
_list = player nearEntities 20;
 
_list = (position player) nearEntities 50;
 
_list = (position player) nearEntities 50;
_list = (position player) nearEntities ["Land",1000];
+
_list = (position player) nearEntities ["Land", 1000];
_list = (position player) nearEntities ["LaserTarget",3000];
+
_list = (position player) nearEntities ["LaserTarget", 3000];
_list = (position player) nearEntities [["All"],50];
+
_list = (position player) nearEntities [["All"], 50];
_list = (position player) nearEntities [["Man","Air","Car","Motorcycle","Tank"],200];
+
_list = (position player) nearEntities [["Man", "Air", "Car", "Motorcycle", "Tank"], 200];
 
</pre>|= EXAMPLE1
 
</pre>|= EXAMPLE1
  
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| [[entities]] , [[nearestObject]], [[nearestObjects]], [[nearObjects]] |= SEEALSO  
+
| [[entities]], [[nearestObject]], [[nearestObjects]], [[nearObjects]] |= SEEALSO  
  
 
|  |= MPBEHAVIOUR  
 
|  |= MPBEHAVIOUR  

Revision as of 16:15, 1 August 2013

Hover & click on the images for description

Description

Description:
Find entities in the circle with given radius. If typeName(s) is (are) given, only entities of given type (or its subtype) are listed. This command returns only alive 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 (format Position) - center of the circle
radius: Number - radius of the circle
Return Value:
Array of Objects

Alternative Syntax

Syntax:
position nearEntities [typeName, radius]
Parameters:
position: Object or Array (format Position) - center of the circle
[typeName, radius]: Array
typeName: String or Array of Strings - typeName(s) to search for
radius: Number - radius of the circle
Return Value:
Array of Objects

Examples

Example 1:
_list = player nearEntities 20;
_list = (position player) nearEntities 50;
_list = (position player) nearEntities ["Land", 1000];
_list = (position player) nearEntities ["LaserTarget", 3000];
_list = (position player) nearEntities [["All"], 50];
_list = (position player) nearEntities [["Man", "Air", "Car", "Motorcycle", "Tank"], 200];

Additional Information

See also:
entitiesnearestObjectnearestObjectsnearObjects

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