entities: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\{\{( *)Informative( *)\|" to "{{$1Feature$2|$2Informative$2|")
m (Text replacement - "\| *((\[\[[a-zA-Z0-9_ |()]+\]\],? ?)+) * \}\}" to "|seealso= $1 }}")
Line 36: Line 36:
|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>


| [[nearEntities]], [[allUnits]], [[vehicles]], [[agents]], [[allMissionObjects]]
|seealso= [[nearEntities]], [[allUnits]], [[vehicles]], [[agents]], [[allMissionObjects]]
}}
}}



Revision as of 00:41, 17 February 2021

Hover & click on the images for description

Description

Description:
Description needed
Groups:
Object Detection

Syntax

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

Alternative Syntax

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

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