entities: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\| *arma2oa * +\| *1.([0-9]{2}) * *\|([^g]|g[^a])" to "| arma2oa |1.$1 |game2= tkoh |version2= 1.00 |game3= arma3 |version3= 0.50 |$2") |
Lou Montana (talk | contribs) m (Text replacement - " \| *(([^=\| ]+)('''|\[\[)([^=\| ]+)) * \|p1=" to " |s1= $1 |p1=") |
||
| Line 15: | Line 15: | ||
{{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.}} | {{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 | |s1= [[entities]] type | ||
|p1= type: [[String]] - if an empty string <tt>""</tt> is provided, all entities are returned | |p1= type: [[String]] - if an empty string <tt>""</tt> is provided, all entities are returned | ||
Revision as of 00:06, 13 June 2021
Description
- Description:
- Description needed
- Groups:
- Object Detection
Syntax
- Syntax:
- entities type
- Parameters:
- type: String - if an empty string "" is provided, all entities are returned
- Return Value:
- Array
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
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