entities: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " \| *(game[0-9]|version[0-9]|gr[0-9]|serverExec|mp|pr|descr|s[0-9]|p[0-9]{1,3}|r[0-9]|x1?[0-9]|seealso) *= +" to " |$1= ")
m (Text replacement - "\| *s([0-9]) *=([^ ]+) *\{\{Since\|(.+)\|([0-9]\.[0-9]5)[^ ]+\}\} " to "|s$1= $2 |s$1since= $3 $4THEINCREDIBLEHULK6 ")
Line 21: Line 21:
|r1= [[Array]]
|r1= [[Array]]


|s2= [[entities]] [typesInclude, typesExclude, includeCrews, excludeDead] {{Since|arma3|1.65.138685|y}}
|s2= [[entities]] [typesInclude, typesExclude, includeCrews, excludeDead]
 
|s2since= arma3 1.65THEINCREDIBLEHULK6


|p21= typesInclude: [[Array]] - in format [type1, type2, ...typeN], where type is a [[String]]. Empty array [] means include every entity. Method used for filtering - [[isKindOf]]
|p21= typesInclude: [[Array]] - in format [type1, type2, ...typeN], where type is a [[String]]. Empty array [] means include every entity. Method used for filtering - [[isKindOf]]

Revision as of 23:05, 10 August 2021

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

Syntax:
entities type
Parameters:
type: String - if an empty string "" is provided, all entities are returned
Return Value:
Array
<span class="gvi2 gvi-arma3Expression error: Unrecognized word "theincrediblehulk".

Expression error: Unrecognized word "theincrediblehulk".

Expression error: Unrecognized word "theincrediblehulk".">Arma 3 logo black.png1.65THEINCREDIBLEHULK6

Alternative Syntax

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

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