getMissionLayerEntities: Difference between revisions

Revision as of 13:05, 12 May 2022

Hover & click on the images for description

Description:: Returns all entities within the specific Eden Editor layer and its sub-layers. To be used when the scenario is running, not in the editor workspace. Useful to disable/enable whole parts of the scenario if layers are used during mission design.
ⓘ
Default layers are not returned.
Groups:: Eden Editor Mission Information

Syntax:

getMissionLayerEntities layerName

Parameters:

layerName: can be one of:

String - case-insensitive; layer name in the editor. If multiple layers with the same name are present in the scenario, the first found one is used
Number - layer ID in the editor

Return Value:

Array in format [[objects], [markers]] or empty array if the layer does not exist

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

: 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

R3vo - c: Posted on Oct 26, 2016 - 15:27 (UTC)
: After an object was deleted from a layer, getMissionLayerEntities will return <NULL-object> for the deleted object.

@@ Line 23: / Line 23: @@
 |x2= delete all objects within that layer after the player is over 800m away from _someObject:
 <code>waitUntil { sleep 1; (player distance _someObject) > 800 };
-private _simpleObjects = (getMissionLayerEntities "Simple Objects") [[select]] 0;
+private _simpleObjects = (getMissionLayerEntities "Simple Objects") select 0;
 {
 	[[deleteVehicle]] [[Magic Variables#x|_x]];