editor.outliner

World Outliner queries and folder management

← API Reference

editor.outliner.getItems

Returns all actors in the world with their selection state and folder hierarchy.

No parameters.

Returns:

Name Type Description
itemsarrayEach: {item_id, display_name, type, actor_class, parent_id, is_selected}
countnumberNumber of items

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.outliner.getItems" }

Example Response:

{
  "jsonrpc": "2.0", "id": 1,
  "result": {
    "items": [
      { "item_id": "Cube_0", "display_name": "Cube", "type": "Actor", "actor_class": "StaticMeshActor", "parent_id": "", "is_selected": false }
    ],
    "count": 1
  }
}

editor.outliner.setSelection

Selects actors in the outliner by name or ID.

Parameters:

Name Type Required Description
itemsarrayYesArray of actor names/IDs to select

Returns:

Name Type Description
selected_countnumberNumber of actors selected

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.outliner.setSelection", "params": { "items": ["Cube", "PointLight"] } }

editor.outliner.getSelection

Returns currently selected items from the outliner.

No parameters.

Returns:

Name Type Description
itemsarrayEach: {item_id, display_name, type, actor_class, is_selected}
countnumberNumber of selected items

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.outliner.getSelection" }

editor.outliner.refresh

Triggers a full refresh of the scene outliner widget.

No parameters.

Returns:

Name Type Description
successboolWhether refresh was triggered

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.outliner.refresh" }

editor.outliner.getFolders

Returns outliner folders with actor counts. Supports pagination.

Parameters:

Name Type Required Description
limitnumberNoMax folders to return (1-5000, default 500)
offsetnumberNoFolders to skip (default 0)

Returns:

Name Type Description
foldersarrayEach: {path, actor_count}
countnumberNumber of folders in this page
totalnumberTotal folders available
limitnumberLimit used
offsetnumberOffset used
has_moreboolWhether more folders exist beyond this page

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.outliner.getFolders", "params": { "limit": 100 } }

editor.outliner.search

Searches actors by name pattern with optional class filter. Supports pagination.

Parameters:

Name Type Required Description
patternstringYesWildcard pattern (e.g. *Light*)
class_filterstringNoFilter by class name substring
limitnumberNoMax results to return (1-5000, default 500)
offsetnumberNoResults to skip (default 0)

Returns:

Name Type Description
actorsarrayEach: {label, class, path, folder_path}
countnumberNumber of matches in this page
totalnumberTotal matches available
limitnumberLimit used
offsetnumberOffset used
has_moreboolWhether more results exist beyond this page

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.outliner.search", "params": { "pattern": "*Light*", "limit": 50 } }

editor.outliner.getActorsInFolder

Returns actors in a specific folder. Supports pagination.

Parameters:

Name Type Required Description
folder_pathstringYesFolder path (e.g. "Lighting")
limitnumberNoMax actors to return (1-5000, default 500)
offsetnumberNoActors to skip (default 0)

Returns:

Name Type Description
actorsarrayEach: {label, class, path}
countnumberNumber of actors in this page
totalnumberTotal actors in folder
limitnumberLimit used
offsetnumberOffset used
has_moreboolWhether more actors exist beyond this page

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.outliner.getActorsInFolder", "params": { "folder_path": "Lighting", "limit": 100 } }

editor.outliner.createFolder

Creates a new folder in the world outliner.

Parameters:

Name Type Required Description
folder_pathstringYesFolder path (e.g. "Lighting/Interior")

Returns:

Name Type Description
successboolWhether folder was created
folder_pathstringThe folder path

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.outliner.createFolder", "params": { "folder_path": "Lighting/Interior" } }

editor.outliner.deleteFolder

Deletes a folder from the world outliner.

Parameters:

Name Type Required Description
folder_pathstringYesFolder path to delete

Returns:

Name Type Description
successboolWhether folder was deleted

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.outliner.deleteFolder", "params": { "folder_path": "Lighting/Interior" } }

editor.outliner.moveToFolder

Moves actors to a specified folder.

Parameters:

Name Type Required Description
actorsarrayYesArray of actor labels/names to move
folder_pathstringYesTarget folder path

Returns:

Name Type Description
successboolWhether any actors were moved
moved_countnumberNumber of actors moved
folder_pathstringTarget folder path

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.outliner.moveToFolder", "params": { "actors": ["PointLight", "SpotLight"], "folder_path": "Lighting" } }