nearEntities: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}") |
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
||
| Line 1: | Line 1: | ||
{{Command|Comments= | {{Command|Comments= | ||
| arma2 |Game name= | | arma2 |Game name= | ||
| Line 9: | Line 8: | ||
|gr1= Object Detection |GROUP1= | |gr1= Object Detection |GROUP1= | ||
| [[Image:sphere_radius.jpg|right|200px]] | | [[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> | 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> | ||
{{Informative|This command is much [[Code_Optimisation#nearEntities_and_nearestObjects | faster]] than [[nearestObjects]] for on-foot soldier and vehicle detection.}} |Description= | {{Informative|This command is much [[Code_Optimisation#nearEntities_and_nearestObjects | faster]] than [[nearestObjects]] for on-foot soldier and vehicle detection.}} |Description= | ||
| position [[nearEntities]] radius |Syntax= | | position [[nearEntities]] radius |Syntax= | ||
| Line 23: | Line 20: | ||
| [[Array]] of [[Object|Objects]] - not sorted |RETURNVALUE= | | [[Array]] of [[Object|Objects]] - not sorted |RETURNVALUE= | ||
|s2= position [[nearEntities]] [type, radius] |Syntax 2= | |s2= position [[nearEntities]] [type, radius] |Syntax 2= | ||
| Line 36: | Line 32: | ||
|r2= [[Array]] of [[Object|Objects]] - not sorted |RETURNVALUE 2= | |r2= [[Array]] of [[Object|Objects]] - not sorted |RETURNVALUE 2= | ||
|x1= <code>_list = [[player]] [[nearEntities]] 20; | |x1= <code>_list = [[player]] [[nearEntities]] 20; | ||
_list = [[ASLToAGL]] [[getPosASL]] [[player]] [[nearEntities]] 50; | _list = [[ASLToAGL]] [[getPosASL]] [[player]] [[nearEntities]] 50; | ||
| Line 45: | Line 40: | ||
</code>|EXAMPLE1= | </code>|EXAMPLE1= | ||
|[[entities]], [[findNearestEnemy]], [[nearestBuilding]], [[nearestObject]], [[nearestObjects]], [[nearObjects]], [[nearestLocation]], [[nearTargets]], [[nearSupplies]], [[nearestLocationWithDubbing]], [[nearObjectsReady]], [[nearRoads]] |SEEALSO= | |[[entities]], [[findNearestEnemy]], [[nearestBuilding]], [[nearestObject]], [[nearestObjects]], [[nearObjects]], [[nearestLocation]], [[nearTargets]], [[nearSupplies]], [[nearestLocationWithDubbing]], [[nearObjectsReady]], [[nearRoads]] |SEEALSO= | ||
Revision as of 01:49, 17 January 2021
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
- 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
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