nearEntities: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) |
Lou Montana (talk | contribs) m (Some wiki formatting) |
||
| (19 intermediate revisions by 4 users not shown) | |||
| Line 17: | Line 17: | ||
|gr1= Object Detection | |gr1= Object Detection | ||
|descr= [[ | |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| | 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 | ||
| Line 26: | Line 26: | ||
|p2= radius: [[Number]] - radius of the sphere | |p2= radius: [[Number]] - radius of the sphere | ||
|r1= [[Array]] of [[Object | |r1= [[Array]] of [[Object]]s - not sorted | ||
|s2= position [[nearEntities]] [type, radius] | |s2= position [[nearEntities]] [type, radius] | ||
| Line 32: | Line 32: | ||
|p21= position: [[Object]] or [[Array]] in format [[Position#PositionAGL|PositionAGL]] or [[Position#Introduction|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: [[String]] or [[Array]] of [[String | |p22= type: [[String]] or [[Array]] of [[String]]s - type(s) to search for. See [[isKindOf]] | ||
|p23= radius: [[Number]] - radius of the sphere | |p23= radius: [[Number]] - radius of the sphere | ||
|r2= [[Array]] of [[Object | |r2= [[Array]] of [[Object]]s - not sorted | ||
|seealso= [[entities]] [[findNearestEnemy]] [[nearestBuilding]] | |s3= area [[nearEntities]] [types, matchExactType, aliveOnly, includeCrew] | ||
|s3since= arma3 2.18 | |||
|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]] | |||
}} | }} | ||
Latest revision as of 17:47, 4 March 2024
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.
- 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
Syntax 3
- Syntax:
- area nearEntities [types, matchExactType, aliveOnly, includeCrew]
- Parameters:
- area: String, Object or Array:
- 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