nearEntities: Difference between revisions

Latest revision as of 17:47, 4 March 2024

1.00

Hover & click on the images for description

Description

Description:: 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.
Groups:: Object Detection

Syntax 1

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

Syntax 2

Syntax:: position nearEntities [type, radius]
Parameters:: position: Object or Array in format PositionAGL or Position2D - center of the sphere
: type: String or Array of Strings - type(s) to search for. See isKindOf
: radius: Number - radius of the sphere
Return Value:: Array of Objects - not sorted

2.18

Syntax 3

Syntax:

area nearEntities [types, matchExactType, aliveOnly, includeCrew]

Parameters:

area: String, Object or Array:

String - marker name
Object - trigger
Array - format [center, a, b, angle, isRectangular, c] (see inArea)

types: Array of Strings - type(s) to search for or [] empty array to return every type

matchExactType: Boolean - (Optional, default false) true for an exact type match, false for an isKindOf match

aliveOnly: Boolean - (Optional, default true) true to ignore dead entities, false to include them

includeCrew: Boolean - (Optional, default false) true to include crew of vehicles in search

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:: entities findNearestEnemy nearestBuilding nearestObject nearestObjects nearObjects nearestLocation nearTargets nearSupplies nearestLocationWithDubbing nearObjectsReady nearRoads nearestMines

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

@@ Line 1: / Line 1: @@
 {{RV|type=command
-| arma2
+|game1= arma2
-|1.00
+|version1= 1.00
 |game2= arma2oa
@@ Line 17: / Line 17: @@
 |gr1= Object Detection
-| [[Image:sphere_radius.jpg|right|200px]]
+|descr= [[File: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.{{Feature|Informative|This command is much [[Code_Optimisation#nearEntities_and_nearestObjects | faster]] than [[nearestObjects]] for on-foot soldier and vehicle detection.}}
+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.{{Feature|informative|This command is much [[Code_Optimisation#nearEntities_and_nearestObjects | faster]] than [[nearestObjects]] for on-foot soldier and vehicle detection.}}
-|s1=  position [[nearEntities]] radius
+|s1= position [[nearEntities]] radius
-|p1= position: [[Object]] or [[Array]] in format [[PositionAGL]] or [[Position2D]] - center of the sphere
+|p1= position: [[Object]] or [[Array]] in format [[Position#PositionAGL|PositionAGL]] or [[Position#Introduction|Position2D]] - center of the sphere
 |p2= radius: [[Number]] - radius of the sphere
-|r1= [[Array]] of [[Object|Objects]] - not sorted
+|r1= [[Array]] of [[Object]]s - not sorted
 |s2= position [[nearEntities]] [type, radius]
-|p21= position: [[Object]] or [[Array]] in format [[PositionAGL]] or [[Position2D]] - center of the sphere
+|p21= position: [[Object]] or [[Array]] in format [[Position#PositionAGL|PositionAGL]] or [[Position#Introduction|Position2D]] - center of the sphere
-|p22= [type, radius]: [[Array]]
+|p22= type: [[String]] or [[Array]] of [[String]]s - type(s) to search for. See [[isKindOf]]
-|p23= type: [[String]] or [[Array]] of [[String|Strings]] - type(s) to search for
+|p23= radius: [[Number]] - radius of the sphere
-|p24= radius: [[Number]] - radius of the sphere
+|r2= [[Array]] of [[Object]]s - not sorted
-|r2= [[Array]] of [[Object|Objects]] - not sorted
+|s3= area [[nearEntities]] [types, matchExactType, aliveOnly, includeCrew]
-|x1= <code>_list = [[player]] [[nearEntities]] 20;
+|s3since= arma3 2.18
-_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]]
+|p41= area: [[String]], [[Object]] or [[Array]]:
+* [[String]] - marker name
+* [[Object]] - trigger
+* [[Array]] - format [center, a, b, angle, isRectangular, c] (see [[inArea]])
+|p42= types: [[Array]] of [[String]]s - type(s) to search for or [] empty array to return every type
+|p43= matchExactType: [[Boolean]] - (Optional, default [[false]]) [[true]] for an exact type match, [[false]] for an [[isKindOf]] match
+|p44= aliveOnly: [[Boolean]] - (Optional, default [[true]]) [[true]] to ignore dead entities, [[false]] to include them
+|p45= includeCrew: [[Boolean]] - (Optional, default [[false]]) [[true]] to include crew of vehicles in search
+|r3= [[Array]] of [[Object]]s - not sorted
+|x1= <sqf>
+_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];
+</sqf>
+|seealso= [[entities]] [[findNearestEnemy]] [[nearestBuilding]] [[nearestObject]] [[nearestObjects]] [[nearObjects]] [[nearestLocation]] [[nearTargets]] [[nearSupplies]] [[nearestLocationWithDubbing]] [[nearObjectsReady]] [[nearRoads]] [[nearestMines]]
 }}
-{{GameCategory|tkoh|Scripting Commands}}
-{{GameCategory|arma3|Scripting Commands}}