entities: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
Lou Montana (talk | contribs) m (Add since template usage) |
||
| Line 9: | Line 9: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Returns a list of all alive and dead entities of the given type or deriving from the given type. Units in vehicles are ignored. | | Returns a list of all alive and dead entities of the given type or deriving from the given type. Units in vehicles are ignored. | ||
{{Informative | '''Optimisation tip''': Keep number of types in both ''includeTypes'' and ''excludeTypes'' arrays to a minimum by possibly using parent/base classes.<br>If you have to use several types, arrange them in order so that the more common types go at the beginning of the array.}} |DESCRIPTION= | |||
'''Optimisation tip''': Keep number of types in both ''includeTypes'' and ''excludeTypes'' arrays to a minimum by possibly using parent/base classes. If you have to use several types, arrange them in order so that the more common types go at the beginning of the array. |DESCRIPTION= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[entities]] type |SYNTAX= | | [[entities]] type |SYNTAX= | ||
|p1= type: [[String]] | |p1= type: [[String]] - if an empty string <tt>""</tt> is provided, all entities are returned |PARAMETER1= | ||
| [[Array]] |RETURNVALUE= | | [[Array]] |RETURNVALUE= | ||
____________________________________________________________________________________________ | |||
|s2= [[entities]] [typesInclude, typesExclude, includeCrews, excludeDead] {{since|arma3|1.65.138685|y}} |SYNTAX2= | |||
|p21= typesInclude: [[Array]] - in format [type1, type2, ...typeN], where type is a [[String]]. Empty array [] means include every entity. Method used for filtering - [[isKindOf]] |PARAMETER21= | |||
|p22= typesExclude: [[Array]] - in format [type1, type2, ...typeN], where type is a [[String]]. Empty array [] means exclude no entity. Method used for filtering - [[isKindOf]] |PARAMETER22= | |||
|p23= includeCrews (Optional, default [[false]]): [[Boolean]] - include crews currently in vehicles |PARAMETER23= | |||
|p24= excludeDead (Optional, default [[false]]): [[Boolean]] - exclude dead entities |PARAMETER24= | |||
|r2= [[Array]] |RETURNVALUE2= | |||
____________________________________________________________________________________________ | |||
| | |x1= <code>_allcars = [[entities]] "Car";</code> |EXAMPLE1= | ||
| | |x2= Return all alive entities on the map:<code>_allalive = [[entities]] [<nowiki/>[], [], [[true]], [[true]]];</code> |EXAMPLE2= | ||
| | |x3= Return dead and alive entities but logic:<code>_notlogic = [[entities]] [<nowiki/>[], ["Logic"], [[true]]];</code> |EXAMPLE3= | ||
|x4= Return all alive [[west]] soldiers on foot:<code>_footsoldiers = [[entities]] [<nowiki/>["SoldierWB"], [], [[false]], [[true]]];</code> |EXAMPLE4= | |||
|x4= Return all alive [[west]] soldiers on foot:<code>_footsoldiers = [[entities]] [<nowiki/>["SoldierWB"], [], [[false]], [[true]]];</code>|EXAMPLE4= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[nearEntities]], [[allUnits]], [[vehicles]], [[agents]], [[allMissionObjects]] |SEEALSO= | | [[nearEntities]], [[allUnits]], [[vehicles]], [[agents]], [[allMissionObjects]] |SEEALSO= | ||
}} | }} | ||
| Line 50: | Line 56: | ||
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]] | ||
Revision as of 23:57, 23 December 2020
Description
- Description:
- Returns a list of all alive and dead entities of the given type or deriving from the given type. Units in vehicles are ignored.
- Groups:
- Object Detection
Syntax
- Syntax:
- entities type
- Parameters:
- type: String - if an empty string "" is provided, all entities are returned
- Return Value:
- Array
Alternative Syntax
- Syntax:
- entities [typesInclude, typesExclude, includeCrews, excludeDead] Template:since
- Parameters:
- typesInclude: Array - in format [type1, type2, ...typeN], where type is a String. Empty array [] means include every entity. Method used for filtering - isKindOf
- typesExclude: Array - in format [type1, type2, ...typeN], where type is a String. Empty array [] means exclude no entity. Method used for filtering - isKindOf
- includeCrews (Optional, default false): Boolean - include crews currently in vehicles
- excludeDead (Optional, default false): Boolean - exclude dead entities
- Return Value:
- Array
Examples
- Example 1:
_allcars = entities "Car";- Example 2:
- Return all alive entities on the map:
_allalive = entities [[], [], true, true]; - Example 3:
- Return dead and alive entities but logic:
_notlogic = entities [[], ["Logic"], true]; - Example 4:
- Return all alive west soldiers on foot:
_footsoldiers = entities [["SoldierWB"], [], false, true];
Additional Information
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