nearEntities: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) (Add note, typeName fix #2) |
Lou Montana (talk | contribs) m (Text replacement - "Category:Scripting Commands ArmA2" to "Category:Scripting Commands Arma 2") |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 9: | Line 9: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[Image:sphere_radius.jpg|right| | | [[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> | |||
If the | {{Informative|This command is much [[Code_Optimisation#nearEntities_and_nearestObjects | faster]] than [[nearestObjects]] for on-foot soldier and vehicle detection.}} |Description= | ||
This command doesn't return dead or | |||
{{Informative|This command is | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Line 23: | Line 20: | ||
|p2= radius: [[Number]] - radius of the sphere |PARAMETER2= | |p2= radius: [[Number]] - radius of the sphere |PARAMETER2= | ||
| [[Array]] of [[Object|Objects]]|RETURNVALUE= | | [[Array]] of [[Object|Objects]] - not sorted |RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Line 36: | Line 33: | ||
|p24= radius: [[Number]] - radius of the sphere |PARAMETER24= | |p24= radius: [[Number]] - radius of the sphere |PARAMETER24= | ||
|r2= [[Array]] of [[Object|Objects]] |RETURNVALUE 2= | |r2= [[Array]] of [[Object|Objects]] - not sorted |RETURNVALUE 2= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1= <code>_list = [[player]] [[nearEntities]] 20; | |x1= <code>_list = [[player]] [[nearEntities]] 20; | ||
| Line 48: | Line 45: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[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= | ||
| |MPBEHAVIOUR= | | |MPBEHAVIOUR= | ||
| Line 62: | Line 59: | ||
<h3 style='display:none'>Bottom Section</h3> | <h3 style='display:none'>Bottom Section</h3> | ||
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Scripting Commands | [[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]] | ||
Revision as of 16:09, 10 January 2020
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:
- Uncategorised
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