Difference between revisions of "nearEntities"

From Bohemia Interactive Community
Jump to navigation Jump to search
(formatting, example fixed)
m (Text replacement - "\| *((\[\[[a-zA-Z0-9_ |()]+\]\],? ?)+) * \}\}" to "|seealso= $1 }}")
(49 intermediate revisions by 12 users not shown)
Line 1: Line 1:
{{Command|= Comments
+
{{RV|type=command
____________________________________________________________________________________________
 
  
| arma2 |= Game name
+
| arma2
  
|1.00|= Game version
+
|1.00
____________________________________________________________________________________________
 
  
| Find entities in the circle with given radius. If typeName(s) is (are) given, only entities of given type (or its subtype) are listed. |= Description
+
|arg= global
____________________________________________________________________________________________
 
  
| position '''nearEntities''' radius or [typeName,radius] or <nowiki>[[typeName1,typeName2,...],radius]</nowiki> |= Syntax
+
|gr1= Object Detection
  
|p1= position: [[Object]] or [[Array]] - |= PARAMETER1
+
| [[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>
 +
{{Feature|Informative|This command is much [[Code_Optimisation#nearEntities_and_nearestObjects | faster]] than [[nearestObjects]] for on-foot soldier and vehicle detection.}}
  
|p2= [typeName,radius] or <nowiki>[[typeName1,typeName2,...],radius]</nowiki>: Array -  |= PARAMETER2
+
| position [[nearEntities]] radius
  
|p3= |= PARAMETER3
+
|p1= position: [[Object]] or [[Array]] in format [[PositionAGL]] or [[Position2D]] - center of the sphere
  
| [[Array]] |= RETURNVALUE
+
|p2= radius: [[Number]] - radius of the sphere
  
 +
| [[Array]] of [[Object|Objects]] - not sorted
  
|x1= <code>_list <nowiki>=</nowiki> position player nearEntities 50</code>|= EXAMPLE1
+
|s2= position [[nearEntities]] [type, radius]
  
____________________________________________________________________________________________
+
|p21= position: [[Object]] or [[Array]] in format [[PositionAGL]] or [[Position2D]] - center of the sphere
  
| |= SEEALSO
+
|p22= [type, radius]: [[Array]]
  
| |= MPBEHAVIOUR
+
|p23= type: [[String]] or [[Array]] of [[String|Strings]] - type(s) to search for
____________________________________________________________________________________________
+
 
 +
|p24= radius: [[Number]] - radius of the sphere
 +
 
 +
|r2= [[Array]] of [[Object|Objects]] - not sorted
 +
|x1= <code>_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]] [<nowiki/>["Car", "Motorcycle", "Tank"], 50];
 +
_list = [[ASLToAGL]] [[getPosASL]] [[player]] [[nearEntities]] [<nowiki/>["Man", "Air", "Car", "Motorcycle", "Tank"], 200];
 +
</code>
 +
 
 +
|seealso= [[entities]], [[findNearestEnemy]], [[nearestBuilding]], [[nearestObject]], [[nearestObjects]], [[nearObjects]], [[nearestLocation]], [[nearTargets]], [[nearSupplies]], [[nearestLocationWithDubbing]], [[nearObjectsReady]], [[nearRoads]]
 
}}
 
}}
  
<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:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
+
{{GameCategory|tkoh|Scripting Commands}}
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
+
{{GameCategory|arma3|Scripting Commands}}

Revision as of 00:54, 17 February 2021

Hover & click on the images for description

Description

Description:
Description needed
Groups:
Object Detection

Syntax

Syntax:
Syntax needed
Parameters:
position: Object or Array in format PositionAGL or Position2D - center of the sphere
radius: Number - radius of the sphere
Return Value:
Return value needed

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