editor.datalayer

Data Layer management for World Partition

← API Reference

editor.datalayer.getAll

Returns all data layers with complete state and visibility information.

No parameters.

Returns:

Name Type Description
layersarrayEach: {layer_name, full_name, asset_name, runtime_state, effective_runtime_state, initial_runtime_state, is_initially_visible, is_visible, layer_type, is_runtime, parent_name}
countnumberNumber of data layers

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.datalayer.getAll" }

editor.datalayer.getState

Returns the current state and visibility of a specific data layer.

Parameters:

Name Type Required Description
layer_namestringYesData layer name

Returns:

Name Type Description
layer_namestringLayer name
runtime_statestring"unloaded", "loaded", or "activated"
effective_runtime_statestringEffective state (considering hierarchy)
initial_runtime_statestringInitial runtime state
is_visibleboolWhether layer is visible
is_runtimeboolWhether layer is a runtime layer
layer_typestring"runtime" or "editor"

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.datalayer.getState", "params": { "layer_name": "Gameplay" } }

editor.datalayer.setState

Sets the initial runtime state of a data layer.

Parameters:

Name Type Required Description
layer_namestringYesData layer name
statestringYes"unloaded", "loaded", or "activated"
recursiveboolNoApply to child layers (default false)

Returns:

Name Type Description
successboolWhether state was set
layer_namestringLayer name
new_statestringNew state

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.datalayer.setState", "params": { "layer_name": "Gameplay", "state": "activated" } }

editor.datalayer.getActors

Returns all actors assigned to a specific data layer.

Parameters:

Name Type Required Description
layer_namestringYesData layer name

Returns:

Name Type Description
actorsarrayEach: {actor_name, actor_class}
countnumberNumber of actors

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.datalayer.getActors", "params": { "layer_name": "Gameplay" } }