nearEntities: Difference between revisions

From Bohemia Interactive Community
m (Text replacement - "<h3 style='display:none'>Notes</h3> <dl class='command_description'> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> <h3 style='display:none'>Bottom Section</h3>" to "")
No edit summary
 
(47 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Command
{{RV|type=command


| arma2
|game1= arma2
|version1= 1.00


|1.00
|game2= arma2oa
|version2= 1.50


|arg= global |Arguments in MP=
|game3= tkoh
|version3= 1.00
 
|game4= arma3
|version4= 0.50
 
|arg= global


|gr1= Object Detection
|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.<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.
{{Informative|This command is much [[Code_Optimisation#nearEntities_and_nearestObjects | faster]] than [[nearestObjects]] for on-foot soldier and vehicle detection.}}
Entities returned are not sorted by distance.
 
The main syntax does not return dead entities or entities inside vehicles. If you need to return those, use the {{Link|#Syntax 3|alternative syntax}} (with ''includeCrew'' set to [[true]]) or the [[entities]] command.
 
{{Feature|informative|This command is [[Code Optimisation#nearEntities and nearestObjects|much faster]] than [[nearestObjects]] for on-foot soldier and vehicle detection.}}


| 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]] - search centre


|p2= radius: [[Number]] - radius of the sphere
|p2= radius: [[Number]] - radius of the sphere


| [[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 [[Position#PositionAGL|PositionAGL]] or [[Position#Introduction|Position2D]] - search centre


|s2= position [[nearEntities]] [type, radius] |Syntax 2=
|p22= type: [[String]] or [[Array]] of [[String]]s - type(s) to search for. See [[isKindOf]]


|p21= position: [[Object]] or [[Array]] in format [[PositionAGL]] or [[Position2D]] - center of the sphere |PARAMETER21=
|p23= radius: [[Number]] - radius of the sphere


|p22= [type, radius]: [[Array]] |PARAMETER22=
|r2= [[Array]] of [[Object]]s - not sorted


|p23= type: [[String]] or [[Array]] of [[String|Strings]] - type(s) to search for |PARAMETER23=
|s3= area [[nearEntities]] [types, matchExactType, aliveOnly, includeCrew]
|s3since= arma3 2.18


|p24= radius: [[Number]] - radius of the sphere |PARAMETER24=
|p41= area: [[String]], [[Object]] or [[Array]]:
* [[String]] - marker name
* [[Object]] - trigger
* [[Array]] - format [center, a, b, angle, isRectangular, c] or since 2.22 [center, a, b, angle, isRectangular, c, usePosWorld] (see [[inArea]])


|r2= [[Array]] of [[Object|Objects]] - not sorted
|p42= types: [[Array]] of [[String]]s - type(s) to search for or [] empty array to return every type
|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>


|p43= matchExactType: [[Boolean]] - (Optional, default [[false]]) [[true]] for an exact type match, [[false]] for an [[isKindOf]] match


|[[entities]], [[findNearestEnemy]], [[nearestBuilding]], [[nearestObject]], [[nearestObjects]], [[nearObjects]], [[nearestLocation]], [[nearTargets]], [[nearSupplies]], [[nearestLocationWithDubbing]], [[nearObjectsReady]], [[nearRoads]]
|p44= aliveOnly: [[Boolean]] - (Optional, default [[true]]) [[true]] to ignore dead entities, [[false]] to include them


| |MPBEHAVIOUR=
|p45= includeCrew: [[Boolean]] - (Optional, default [[false]]) [[true]] to include crew of vehicles in search
}}


|r3= [[Array]] of [[Object]]s - not sorted


[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
|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>


{{GameCategory|arma2|Scripting Commands}}
|seealso= [[entities]] [[findNearestEnemy]] [[nearestBuilding]] [[nearestObject]] [[nearestObjects]] [[nearObjects]] [[nearestLocation]] [[nearTargets]] [[nearSupplies]] [[nearestLocationWithDubbing]] [[nearObjectsReady]] [[nearRoads]] [[nearestMines]]
{{GameCategory|tkoh|Scripting Commands}}
}}
{{GameCategory|arma3|Scripting Commands}}

Latest revision as of 22:36, 18 June 2025

Logo A2.png 1.00A2 OA Logo.png 1.50tkoh logo small.png 1.00Arma 3 logo black.png 0.50
GAGlobal
Hover & click on the images for description

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.

The main syntax does not return dead entities or entities inside vehicles. If you need to return those, use the alternative syntax (with includeCrew set to true) or the 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 - search centre
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 - search centre
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

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] or since 2.22 [center, a, b, angle, isRectangular, c, usePosWorld] (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
Retrieved from "https://community.bistudio.com/wiki?title=nearEntities&oldid=373699"