editor.mode

Editor mode management (placement, landscape, foliage, etc.)

← API Reference

editor.mode.getActive

Returns the current widget mode, coordinate system, active editor modes, and widget visibility.

No parameters.

Returns:

Name Type Description
widget_modestringOne of: translate, rotate, scale, translate_rotate_z, 2d, none
coord_systemstringOne of: world, local, parent, explicit, none
active_editor_modesarrayEach: {id, name}
show_widgetboolWhether transform widget is visible

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.mode.getActive" }

Example Response:

{
  "jsonrpc": "2.0", "id": 1,
  "result": {
    "widget_mode": "translate",
    "coord_system": "world",
    "active_editor_modes": [{ "id": "EM_Default", "name": "Default" }],
    "show_widget": true
  }
}

editor.mode.setWidgetMode

Sets the transform gizmo/widget mode.

Parameters:

Name Type Required Description
modestringYesOne of: translate (or move), rotate, scale, translate_rotate_z, 2d

Returns:

Name Type Description
successboolWhether mode was set
modestringActive widget mode

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.mode.setWidgetMode", "params": { "mode": "rotate" } }

editor.mode.setEditorMode

Activates an editor mode by its mode ID.

Parameters:

Name Type Required Description
mode_idstringYesEditor mode ID (e.g. "EM_Default", "EM_Landscape", "PLACEMENT")

Returns:

Name Type Description
successboolWhether mode was activated
mode_idstringMode ID
already_activeboolPresent if mode was already active
warningstringPresent if activation failed

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.mode.setEditorMode", "params": { "mode_id": "EM_Landscape" } }

editor.mode.getCoordSystem

Returns the current coordinate system setting.

No parameters.

Returns:

Name Type Description
coord_systemstringOne of: world, local, parent, explicit, none

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.mode.getCoordSystem" }

editor.mode.setCoordSystem

Sets the coordinate system for transform operations.

Parameters:

Name Type Required Description
coord_systemstringYesOne of: world, local, parent

Returns:

Name Type Description
successboolWhether setting was applied
coord_systemstringActive coordinate system

Example Request:

{ "jsonrpc": "2.0", "id": 1, "method": "editor.mode.setCoordSystem", "params": { "coord_system": "local" } }