Editor control, logs, tests & Slate¶
Editor/PIE/viewport control, output log, automation tests, Slate UI inspection, config settings, and batch orchestration.
6 toolset(s), 56 tool(s). Full schemas in the raw catalog.
EditorToolset.EditorAppToolset · raw schemas¶
Tools for querying and modifying Unreal Editor state: console variables, asset imaging,
| Tool | Summary |
|---|---|
EditorToolset.EditorAppToolset.CaptureAssetImage |
Renders a thumbnail for the specified asset (e.g. static meshes, skeletal meshes, |
EditorToolset.EditorAppToolset.CaptureEditorImage |
Captures an image of the entire editor application as the user sees it. |
EditorToolset.EditorAppToolset.CaptureViewport |
Captures the level viewport with optional annotations. |
EditorToolset.EditorAppToolset.FocusOnActors |
Repositions the level editor camera to focus on the specified actors. |
EditorToolset.EditorAppToolset.GetCameraTransform |
Returns the position and rotation of the level viewport camera. |
EditorToolset.EditorAppToolset.GetContentBrowserPath |
Gets the current path of the active content browser. |
EditorToolset.EditorAppToolset.GetOpenAssets |
Gets the list of assets currently open in asset editors. |
EditorToolset.EditorAppToolset.GetSelectedActors |
Gets the currently selected actors in the level editor. |
EditorToolset.EditorAppToolset.GetSelectedAssets |
Gets the list of assets selected in the content browser. |
EditorToolset.EditorAppToolset.GetVisibleActors |
Returns all actors in the current level whose bounds intersect the viewport frustum. |
EditorToolset.EditorAppToolset.IsPIERunning |
Returns whether a Play In Editor session is currently running. |
EditorToolset.EditorAppToolset.OpenEditorForAsset |
Opens an asset editor for the specified asset. |
EditorToolset.EditorAppToolset.ScreenCoordsToWorld |
Finds the world position of the nearest solid object at a given set of normalized view space coords. |
EditorToolset.EditorAppToolset.SearchCVars |
Finds all console variables that contain a given name. |
EditorToolset.EditorAppToolset.SelectActors |
Selects the specified actors in the current scene. |
EditorToolset.EditorAppToolset.SelectAssets |
Selects the specified assets in the content browser. |
EditorToolset.EditorAppToolset.SetCameraTransform |
Sets the position and rotation of the level viewport camera. |
EditorToolset.EditorAppToolset.SetContentBrowserPath |
Navigates the active content browser to the specified folder path. |
EditorToolset.EditorAppToolset.StartPIE |
Starts a Play-In-Editor or Simulate-In-Editor session using the current level. |
EditorToolset.EditorAppToolset.StopPIE |
Stops the currently running play session (PIE or Simulate). |
EditorToolset.EditorAppToolset.WorldPosToScreenCoords |
Converts a world-space position into normalized screen space based on the editor viewport camera. |
EditorToolset.LogsToolset · raw schemas¶
Provides tools for reading the Unreal Engine output log and controlling
| Tool | Summary |
|---|---|
EditorToolset.LogsToolset.GetLogCategories |
Returns a sorted list of registered log categories. |
EditorToolset.LogsToolset.GetLogEntries |
Returns log entries from the current session's log file. |
EditorToolset.LogsToolset.GetVerbosity |
Returns the current verbosity level for a log category. |
EditorToolset.LogsToolset.SetVerbosity |
Sets the verbosity level for a log category. |
AutomationTestToolset.AutomationTestToolset · raw schemas¶
Automation test discovery and execution toolset.
| Tool | Summary |
|---|---|
AutomationTestToolset.AutomationTestToolset.DiscoverTests |
Initialize automation worker discovery and load the test list. |
AutomationTestToolset.AutomationTestToolset.GetTestResults |
Get detailed results for the current or most recent test run. |
AutomationTestToolset.AutomationTestToolset.GetTestStatus |
Get a lightweight status snapshot of the automation controller. |
AutomationTestToolset.AutomationTestToolset.ListTests |
List available automation tests. Requires DiscoverTests() to have completed. |
AutomationTestToolset.AutomationTestToolset.RunTests |
Run a set of automation tests by name. Requires DiscoverTests() to have completed. |
AutomationTestToolset.AutomationTestToolset.RunTestsByFilter |
Run automation tests selected by a filter expression. Requires DiscoverTests() |
AutomationTestToolset.AutomationTestToolset.StopTests |
Stop all currently running tests. Requires DiscoverTests() to have completed. |
SlateInspectorToolset.SlateInspectorToolset · raw schemas¶
Playwright-style Slate UI automation toolset.
| Tool | Summary |
|---|---|
SlateInspectorToolset.SlateInspectorToolset.Click |
Click a Slate widget identified by its ref. |
SlateInspectorToolset.SlateInspectorToolset.Drag |
Drag from one Slate widget to another (mouse down, move, release). |
SlateInspectorToolset.SlateInspectorToolset.FillForm |
Fill multiple Slate form fields at once. |
SlateInspectorToolset.SlateInspectorToolset.Hover |
Hover over a Slate widget, triggering any hover state or tooltip. |
SlateInspectorToolset.SlateInspectorToolset.ListObservers |
List all active observers as a JSON array for debugging. |
SlateInspectorToolset.SlateInspectorToolset.Observe |
Register an observer on a widget subtree so its refs are continuously |
SlateInspectorToolset.SlateInspectorToolset.PressKey |
Press and release a keyboard key on the currently focused Slate widget. |
SlateInspectorToolset.SlateInspectorToolset.Screenshot |
Screenshot a Slate widget or the active editor window. Prefer this over |
SlateInspectorToolset.SlateInspectorToolset.SelectOption |
Select an option in a Slate combobox by its text label. |
SlateInspectorToolset.SlateInspectorToolset.Snapshot |
Capture a Slate UI accessibility snapshot. Use this to read the current |
SlateInspectorToolset.SlateInspectorToolset.Type |
Type text into a Slate text input widget. Focuses the widget first, |
SlateInspectorToolset.SlateInspectorToolset.Unobserve |
Remove an observer by its identifier. |
SlateInspectorToolset.SlateInspectorToolset.WaitFor |
Check if text is present or absent in the Slate widget tree. |
SlateInspectorToolset.SlateInspectorToolset.Windows |
List, select, or close top-level Slate editor windows. |
ConfigSettingsToolset.ConfigSettingsToolset · raw schemas¶
Tools for listing, inspecting, and editing Config Settings sections
| Tool | Summary |
|---|---|
ConfigSettingsToolset.ConfigSettingsToolset.GetSectionPropertyValues |
Returns the current values of the specified properties as a JSON object. |
ConfigSettingsToolset.ConfigSettingsToolset.GetSectionSchema |
Returns a JSON Schema describing the user-visible properties of a settings section. |
ConfigSettingsToolset.ConfigSettingsToolset.ListCategories |
Lists the names of all categories within a settings container, sorted alphabetically. |
ConfigSettingsToolset.ConfigSettingsToolset.ListContainers |
Lists the names of all known settings containers, sorted alphabetically. |
ConfigSettingsToolset.ConfigSettingsToolset.ListSections |
Lists the names of all sections within a settings category, sorted alphabetically. |
ConfigSettingsToolset.ConfigSettingsToolset.ResetSectionToDefaults |
Resets the settings in a section to their default values. |
ConfigSettingsToolset.ConfigSettingsToolset.SaveSection |
Saves the settings in a section. |
ConfigSettingsToolset.ConfigSettingsToolset.SetSectionProperties |
Sets one or more properties on a settings section from a JSON object and saves. |
editor_toolset.toolsets.programmatic.ProgrammaticToolset · raw schemas¶
Batches calls to other registered tools through a small sandboxed Python
| Tool | Summary |
|---|---|
editor_toolset.toolsets.programmatic.ProgrammaticToolset.execute_tool_script |
Execute a Python script against the toolset APIs. |
editor_toolset.toolsets.programmatic.ProgrammaticToolset.get_execution_environment |
Get details about execution environment. |