getMissionLayerEntities: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|game([0-9])= *([^ ]+) * +\|version([0-9])= *([^ ]+) * " to "|game$1=$2 |version$3=$4 ")
m (Add sub-layers info)
Line 8: Line 8:
|gr2= Mission Information
|gr2= Mission Information


|descr= Returns all entities within specific [[Eden Editor: Layer]]. To be used when the scenario is running, not in the editor workspace. Useful for disabling / enabling whole parts of the scenario which you add to specific layer while editing.
|descr= Returns all entities within specific [[Eden Editor: Layer|Eden Editor layer]] and sub-layers. To be used when the scenario is running, not in the editor workspace. Useful for disabling / enabling whole parts of the scenario which you add to specific layer while editing.
{{Feature | Informative | Default layers are not returned.}}
{{Feature | Informative | Default layers are not returned.}}


Line 15: Line 15:
|p1= layerName: [[String]] - Layer name in the editor. If multiple layers with the same name are present in the scenario, the first found one is used
|p1= layerName: [[String]] - Layer name in the editor. If multiple layers with the same name are present in the scenario, the first found one is used


|r1= [[Array]] in format <tt><nowiki>[</nowiki>[objects], [markers]]</tt>
|r1= [[Array]] in format <tt>[<nowiki/>[objects], [markers]]</tt>


|x1= <code>_base = [[getMissionLayerEntities]] "Base";</code>
|x1= <code>_base = [[getMissionLayerEntities]] "Base";</code>
Line 43: Line 43:
<dt class="note">[[User:R3vo|R3vo]]</dt>
<dt class="note">[[User:R3vo|R3vo]]</dt>
<dd class="note">
<dd class="note">
After an [[object]] was deleted from a layer, [[getMissionLayerEntities]] will return <tt><NULL-object></tt> for the deleted [[object]].
After an [[object]] was deleted from a layer, [[getMissionLayerEntities]] will return <tt>&lt;NULL-object&gt;</tt> for the deleted [[object]].
</dd>
</dd>


</dl>
</dl>

Revision as of 21:07, 27 July 2021

Hover & click on the images for description

Description

Description:
Returns all entities within specific Eden Editor layer and sub-layers. To be used when the scenario is running, not in the editor workspace. Useful for disabling / enabling whole parts of the scenario which you add to specific layer while editing.
Default layers are not returned.
Groups:
Eden EditorMission Information

Syntax

Syntax:
getMissionLayerEntities layerName
Parameters:
layerName: String - Layer name in the editor. If multiple layers with the same name are present in the scenario, the first found one is used
Return Value:
Array in format [[objects], [markers]]

Alternative Syntax

Syntax:
getMissionLayerEntities layerID
Parameters:
layerID: Number - Layer ID in the editor
Return Value:
Array in format [[objects], [markers]]

Examples

Example 1:
_base = getMissionLayerEntities "Base";
Example 2:
waitUntil {(player distance _someObject) > 800}; { deleteVehicle _x; } forEach ((getMissionLayerEntities "Simple Objects") select 0); // Deletes all objects within that layer after the player is over 800m away from _someObject
Example 3:
_layer1337Entities = getMissionLayerEntities 1337;

Additional Information

See also:
get3DENLayerEntities

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
Posted on October 26, 2016 - 15:27 (UTC)
R3vo
After an object was deleted from a layer, getMissionLayerEntities will return <NULL-object> for the deleted object.