entities: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(units in vehicles are ignored)
(alt syntax)
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Returns a list of all dead or alive entities with given type. Units in vehicles are ignored.|= 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.
<br><br>Alternative syntax introduced in Arma 3 v.1.65.138685 allows to filter entities by type and alive status as well as to return entities currently in vehicles.<br><br>'''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
____________________________________________________________________________________________
____________________________________________________________________________________________


Line 16: Line 17:
| [[Array]] |= RETURNVALUE  
| [[Array]] |= RETURNVALUE  


| s2=  '''entities''' [typesInclude, typesExclude, includeCrews, excludeDead]&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;''since Arma 3 v.1.65.138685'' |= Syntax
|p21= [typesInclude, typesExclude, includeCrews, excludeDead]: [[Array]] |= PARAMETER21
|p22= typesInclude: [[Array]] - in format [type1, type2, ...typeN], where type is a [[String]]. Empty array [] means include every entity. Method used for filtering - [[isKindOf]]|= PARAMETER22
|p23=  typesExclude: [[Array]] - in format [type1, type2, ...typeN], where type is a [[String]]. Empty array [] means exclude no entity. Method used for filtering - [[isKindOf]]|= PARAMETER23
|p24= includeCrews (Optional): [[Boolean]] - include crews currently in vehicles. Default: [[false]] |= PARAMETER24
|p25= excludeDead (Optional): [[Boolean]] - exclude dead entities. Default: [[false]] |= PARAMETER25
| r2= [[Array]] |= RETURNVALUE


|x1= <code>_allcars = [[entities]] "Car";</code>|= EXAMPLE1  
|x1= <code>_allcars = [[entities]] "Car";</code>|= EXAMPLE1  
|x2= Return all alive entities on the map:<code>_allalive = [[entities]] <nowiki>[</nowiki>[], [], [[true]], [[true]]];</code>|= EXAMPLE2
|x3= Return dead and alive entities but logic:<code>_notlogic = [[entities]] <nowiki>[</nowiki>[], ["Logic"], [[true]]];</code>|= EXAMPLE3
|x4= Return all alive [[west]] soldiers on foot:<code>_footsoldiers = [[entities]] <nowiki>[</nowiki>["SoldierWB"], [], [[false]], [[true]]];</code>|= EXAMPLE4


____________________________________________________________________________________________
____________________________________________________________________________________________

Revision as of 21:31, 6 October 2016

Hover & click on the images for description

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.

Alternative syntax introduced in Arma 3 v.1.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

Syntax:
entities type
Parameters:
type: String
Return Value:
Array

Alternative Syntax

Syntax:
entities [typesInclude, typesExclude, includeCrews, excludeDead]      since Arma 3 v.1.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

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

See also:
nearEntitiesallUnitsvehiclesagentsallMissionObjects

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

Notes

Posted on Mar 27, 2014 - 20:26
ffur2007slx2_5
In ArmA3 ver 1.14 type (string) can be any children class under configfile >> "CfgVehicles". e.g.entities "All"; //or entities "CAManBase"; etc.

Bottom Section

Posted on July 12, 2016 - 22:37 (UTC)
MisterGoodson
In A3 1.62 entities "CAManBase" does not include entities inside vehicles (crew).