entities: Difference between revisions

Revision as of 22:52, 7 May 2022

Hover & click on the images for 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 with the primary syntax.
ⓘ
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.
Groups:: Object Detection

Syntax:: entities type
Parameters:: type: String - if an empty string "" is provided, all entities are returned
Return Value:: Array

Syntax:: entities [typesInclude, typesExclude, includeCrews, excludeDead]
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: Boolean - (Optional, default false) include crews currently in vehicles
: excludeDead: Boolean - (Optional, default false) exclude dead entities
Return Value:: Array

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];

: 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

@@ Line 37: / Line 37: @@
 |x1= <code>_allcars = [[entities]] "Car";</code>
-|x2= Return all alive entities on the map:<code>_allalive = [[entities]] [<nowiki/>[], [], [[true]], [[true]]];</code>
+|x2= Return all alive entities on the map:
+<code>_allalive = [[entities]] [<nowiki/>[], [], [[true]], [[true]]];</code>
-|x3= Return dead and alive entities but logic:<code>_notlogic = [[entities]] [<nowiki/>[], ["Logic"], [[true]]];</code>
+|x3= Return dead and alive entities but logic:
+<code>_notlogic = [[entities]] [<nowiki/>[], ["Logic"], [[true]]];</code>
-|x4= Return all alive [[west]] soldiers on foot:<code>_footsoldiers = [[entities]] [<nowiki/>["SoldierWB"], [], [[false]], [[true]]];</code>
+|x4= Return all alive [[west]] soldiers on foot:
+<code>_footsoldiers = [[entities]] [<nowiki/>["SoldierWB"], [], [[false]], [[true]]];</code>
 |seealso= [[nearEntities]] [[allUnits]] [[vehicles]] [[agents]] [[allMissionObjects]]
 }}