entities: Difference between revisions

Revision as of 11:17, 19 March 2020

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. When empty string "" is passed for the type, all entity types are returned.

Alternative syntax introduced in Arma 3 v1.65.138685 allows to filter entities by type and alive status as well as to return entities currently in vehicles.

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:: Uncategorised

Syntax:: entities [typesInclude, typesExclude, includeCrews, excludeDead] since Arma 3 v1.65.138685
Parameters:: [typesInclude, typesExclude, includeCrews, excludeDead]: Array
: 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): Boolean - include crews currently in vehicles. Default: false
: excludeDead (Optional): Boolean - exclude dead entities. Default: false
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 28: / Line 28: @@
 |x1= <code>_allcars = [[entities]] "Car";</code>|EXAMPLE1=
-|x2= Return all alive entities on the map:<code>_allalive = [[entities]] <nowiki>[</nowiki>[], [], [[true]], [[true]]];</code>|EXAMPLE2=
+|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>[</nowiki>[], ["Logic"], [[true]]];</code>|EXAMPLE3=
+|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>[</nowiki>["SoldierWB"], [], [[false]], [[true]]];</code>|EXAMPLE4=
+|x4= Return all alive [[west]] soldiers on foot:<code>_footsoldiers = [[entities]] [<nowiki/>["SoldierWB"], [], [[false]], [[true]]];</code>|EXAMPLE4=
 ____________________________________________________________________________________________