editor.utility

Editor Utility Widget spawning/closing and Message Log retrieval

← API Reference

editor.utility.runUtilityWidget

Spawn and register an Editor Utility Widget from a blueprint asset.

Parameters:

Name Type Required Description
asset_pathstringYesPath to EditorUtilityWidgetBlueprint (e.g. /Game/Tools/MyWidget.MyWidget)

Returns:

Name Type Description
successbooleanWhether the widget was spawned
tab_idstringThe tab ID assigned (use for close/check)
asset_pathstringEcho of the asset path
widget_classstringRuntime class name of the spawned widget

Example Request:

{
  "jsonrpc": "2.0",
  "method": "editor.utility.runUtilityWidget",
  "params": { "asset_path": "/Game/Tools/MyWidget.MyWidget" },
  "id": 1
}

Example Response:

{
  "jsonrpc": "2.0",
  "result": {
    "success": true,
    "tab_id": "MyWidget_0",
    "asset_path": "/Game/Tools/MyWidget.MyWidget",
    "widget_class": "MyWidget_C"
  },
  "id": 1
}

editor.utility.getUtilityWidgets

List all registered Editor Utility Widget tabs.

No parameters.

Returns:

Name Type Description
widgetsarrayList of registered utility widget entries
countnumberNumber of registered widgets

Each widget entry:

Name Type Description
tab_idstringThe tab ID
asset_pathstringBlueprint asset path
display_namestringDisplay name
is_openbooleanWhether the tab is currently open

Example Request:

{
  "jsonrpc": "2.0",
  "method": "editor.utility.getUtilityWidgets",
  "params": {},
  "id": 1
}

Example Response:

{
  "jsonrpc": "2.0",
  "result": {
    "widgets": [
      {
        "tab_id": "MyWidget_0",
        "asset_path": "/Game/Tools/MyWidget.MyWidget",
        "display_name": "MyWidget",
        "is_open": true
      }
    ],
    "count": 1
  },
  "id": 1
}

editor.utility.closeUtilityWidget

Close a running Editor Utility Widget tab by ID.

Parameters:

Name Type Required Description
tab_idstringYesThe tab ID to close (from runUtilityWidget or getUtilityWidgets)

Returns:

Name Type Description
successbooleanWhether the tab was closed
tab_idstringEcho of the tab ID
messagestringError message if tab not found

Example Request:

{
  "jsonrpc": "2.0",
  "method": "editor.utility.closeUtilityWidget",
  "params": { "tab_id": "MyWidget_0" },
  "id": 1
}

Example Response:

{
  "jsonrpc": "2.0",
  "result": { "success": true, "tab_id": "MyWidget_0" },
  "id": 1
}

editor.utility.getNotifications

Get recent messages from the editor's Message Log system.

Parameters:

Name Type Required Description
log_namestringNoMessage log name (default: BlueprintLog). Common: MapCheck, AssetCheck, LoadErrors, PIE, LightingResults, PackagingResults
max_countnumberNoMaximum messages to return (default: 50, max: 500)

Returns:

Name Type Description
log_namestringThe log name queried
messagesarrayList of message objects
countnumberNumber of messages returned
totalnumberTotal messages in the log

Each message:

Name Type Description
severitystringError, Warning, PerformanceWarning, or Info
messagestringThe message text
identifierstringOptional message identifier

Example Request:

{
  "jsonrpc": "2.0",
  "method": "editor.utility.getNotifications",
  "params": { "log_name": "MapCheck", "max_count": 10 },
  "id": 1
}

Example Response:

{
  "jsonrpc": "2.0",
  "result": {
    "log_name": "MapCheck",
    "messages": [
      { "severity": "Warning", "message": "Maps need lighting rebuilt" }
    ],
    "count": 1,
    "total": 1
  },
  "id": 1
}