editor.layers

Layer management (create, delete, assign actors)

`editor.layers.create`

Creates a new editor layer.

Parameters:

Name	Type	Required	Description
`name`	string	Yes	Layer name

Returns:

Name	Type	Description
`success`	bool	Whether layer was created
`name`	string	Layer name

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.layers.create", "params": { "name": "Lighting" } }

`editor.layers.delete`

Deletes an editor layer.

Parameters:

Name	Type	Required	Description
`name`	string	Yes	Layer name to delete

Returns:

Name	Type	Description
`success`	bool	Always true
`name`	string	Deleted layer name

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.layers.delete", "params": { "name": "Lighting" } }

`editor.layers.rename`

Renames an editor layer.

Parameters:

Name	Type	Required	Description
`name`	string	Yes	Current layer name
`new_name`	string	Yes	New layer name

Returns:

Name	Type	Description
`success`	bool	Whether rename succeeded
`old_name`	string	Previous name
`new_name`	string	New name

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.layers.rename", "params": { "name": "Lighting", "new_name": "Lights" } }

`editor.layers.getAll`

Returns all layer names in the current level.

No parameters.

Returns:

Name	Type	Description
`count`	number	Number of layers
`layers`	array	Array of layer name strings

Example Request:

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

`editor.layers.exists`

Checks if a layer exists.

Parameters:

Name	Type	Required	Description
`name`	string	Yes	Layer name

Returns:

Name	Type	Description
`exists`	bool	Whether the layer exists
`name`	string	Layer name

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.layers.exists", "params": { "name": "Lighting" } }

`editor.layers.addActorToLayer`

Adds an actor to a layer.

Parameters:

Name	Type	Required	Description
`path`	string	Yes	Actor object path
`layer`	string	Yes	Layer name

Returns:

Name	Type	Description
`success`	bool	Whether actor was added
`actor`	string	Actor label
`layer`	string	Layer name

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.layers.addActorToLayer", "params": { "path": "/Game/Maps/Level.Level:PersistentLevel.Cube", "layer": "Lighting" } }

`editor.layers.removeActorFromLayer`

Removes an actor from a layer.

Parameters:

Name	Type	Required	Description
`path`	string	Yes	Actor object path
`layer`	string	Yes	Layer name

Returns:

Name	Type	Description
`success`	bool	Whether actor was removed
`actor`	string	Actor label
`layer`	string	Layer name

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.layers.removeActorFromLayer", "params": { "path": "/Game/Maps/Level.Level:PersistentLevel.Cube", "layer": "Lighting" } }

`editor.layers.getActorsInLayer`

Returns all actors belonging to a layer.

Parameters:

Name	Type	Required	Description
`layer`	string	Yes	Layer name

Returns:

Name	Type	Description
`layer`	string	Layer name
`count`	number	Number of actors
`actors`	array	Each: {name, class, path}

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.layers.getActorsInLayer", "params": { "layer": "Lighting" } }

`editor.layers.addSelectedToLayer`

Adds all currently selected actors to a layer.

Parameters:

Name	Type	Required	Description
`layer`	string	Yes	Layer name

Returns:

Name	Type	Description
`success`	bool	Whether operation succeeded
`layer`	string	Layer name

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.layers.addSelectedToLayer", "params": { "layer": "Lighting" } }

`editor.layers.removeSelectedFromLayer`

Removes all currently selected actors from a layer.

Parameters:

Name	Type	Required	Description
`layer`	string	Yes	Layer name

Returns:

Name	Type	Description
`success`	bool	Whether operation succeeded
`layer`	string	Layer name

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.layers.removeSelectedFromLayer", "params": { "layer": "Lighting" } }

`editor.layers.setVisibility`

Sets a layer's visibility.

Parameters:

Name	Type	Required	Description
`layer`	string	Yes	Layer name
`visible`	bool	Yes	Visibility state

Returns:

Name	Type	Description
`success`	bool	Always true
`layer`	string	Layer name
`visible`	bool	New visibility state

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.layers.setVisibility", "params": { "layer": "Lighting", "visible": false } }

`editor.layers.toggleVisibility`

Toggles a layer's visibility.

Parameters:

Name	Type	Required	Description
`layer`	string	Yes	Layer name

Returns:

Name	Type	Description
`success`	bool	Always true
`layer`	string	Layer name

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.layers.toggleVisibility", "params": { "layer": "Lighting" } }

`editor.layers.makeAllVisible`

Makes all layers visible.

No parameters.

Returns:

Name	Type	Description
`success`	bool	Always true

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.layers.makeAllVisible" }