entities: Difference between revisions

Revision as of 00:13, 7 February 2021

Game1 needed - Version1 needed

Hover & click on the images for description

Description:: This article is a Stub. You can help BI Community Wiki by expanding it.
Description needed
Groups:: Object Detection

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

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: 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 8: / Line 8: @@
 | 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.
-{{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.}}
+{{Feature | 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.}}
 | [[entities]] type