getMissionLayerEntities: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Some wiki formatting)
(Updated return value)
Line 21: Line 21:
* [[Number]] - layer ID in the editor
* [[Number]] - layer ID in the editor


|r1= [[Array]] in format [objects, markers] (or empty array if the layer does not exist)
|r1= [[Array]] in format [objects, markers, groups (since {{GVI|arma3|2.14}})] (or empty array if the layer does not exist)


|x1= <sqf>private _base = getMissionLayerEntities "Base";</sqf>
|x1= <sqf>private _base = getMissionLayerEntities "Base";</sqf>
Line 35: Line 35:


|x3= <sqf>private _layer1337Entities = getMissionLayerEntities 1337;</sqf>
|x3= <sqf>private _layer1337Entities = getMissionLayerEntities 1337;</sqf>
|x3= <sqf>getMissionLayerEntities 42 params [["_objects", []], ["_markers", []], ["_groups", []]];</sqf>


|seealso= [[get3DENLayerEntities]]
|seealso= [[get3DENLayerEntities]]

Revision as of 00:29, 9 January 2024

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 EditorMission 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, groups (since Arma 3 logo black.png2.14)] (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:
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.