getMissionLayerEntities: Difference between revisions

Latest revision as of 11:45, 14 February 2024

1.56

SEServer

Hover & click on the images for description

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

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,

2.14 groups] (or empty array if the layer does not exist)

Examples

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;
Example 4:: getMissionLayerEntities 42 params [["_objects", []], ["_markers", []], ["_groups", []]];

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

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 3: / Line 3: @@
 |game1= arma3
 |version1= 1.56
+|serverExec= server
 |gr1= Eden Editor
@@ Line 8: / Line 10: @@
 |gr2= Mission Information
-|descr= Returns all entities within the specific [[Eden Editor: Layer|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.
+|descr= Returns all entities within the specific [[Eden Editor: Layer|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.
 {{Feature|informative|Default layers are not returned.}}
@@ Line 17: / Line 21: @@
 * [[Number]] - layer ID in the editor
-|r1= [[Array]] in format {{hl|[<nowiki/>[objects], [markers]]}} or empty array if the layer does not exist
+|r1= [[Array]] in format [objects, markers, {{GVI|arma3|2.14|size= 0.75}} groups] (or empty array if the layer does not exist)
-|x1= <code>[[private ]]_base = getMissionLayerEntities "Base";</code>
+|x1= <sqf>private _base = getMissionLayerEntities "Base";</sqf>
 |x2= delete all objects within that layer after the player is over 800m away from _someObject:
-<code>[[waitUntil]] { [[sleep]] 1; ([[player]] [[distance]] _someObject) > 800 };
+<sqf>
-[[private]] _simpleObjects = ([[getMissionLayerEntities]] "Simple Objects") [[select]] 0;
+waitUntil { sleep 1; (player distance _someObject) > 800 };
+private _simpleObjects = (getMissionLayerEntities "Simple Objects") select 0;
 {
-	[[deleteVehicle]] [[Magic Variables#x|_x]];
+	deleteVehicle _x;
-} [[forEach]] _simpleObjects;</code>
+} forEach _simpleObjects;
+</sqf>
-|x3= <code>private _layer1337Entities = [[getMissionLayerEntities]] 1337;</code>
+|x3= <sqf>private _layer1337Entities = getMissionLayerEntities 1337;</sqf>
+|x4= <sqf>getMissionLayerEntities 42 params [["_objects", []], ["_markers", []], ["_groups", []]];</sqf>
 |seealso= [[get3DENLayerEntities]]
-|serverExec= server
 }}