getMissionLayerEntities: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Arma[ _]3(\|.*)]]" to "{{GameCategory|arma3|Scripting Commands}}")
m (Text replacement - "\{\{GameCategory\|(arma[0123])\|New[ _]Scripting[ _]Commands[ _]List\}\}" to "{{GameCategory|$1|New Scripting Commands}}")
Line 53: Line 53:


<h3 style='display:none'>Bottom Section</h3>
<h3 style='display:none'>Bottom Section</h3>
{{GameCategory|arma3|New_Scripting_Commands_List}}
{{GameCategory|arma3|New Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Revision as of 22:03, 12 January 2021

Hover & click on the images for description

Description

Description:
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.
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:Array, markers:Array]

Alternative Syntax

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

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:
See also needed

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

Notes


Bottom Section


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.

Version: 1.65
Build: 139010