USlateInspectorToolset

Playwright-style Slate UI automation toolset.

API > API/Plugins > API/Plugins/SlateInspectorToolset

Playwright-style Slate UI automation toolset.

Exposes snapshot, screenshot, and interaction tools for driving the Unreal Editor UI programmatically. Registered via UToolsetRegistry so the ModelContextProtocol plugin picks them up automatically.

A shallow root observer (depth 0) continuously tracks top-level windows. Before working with a specific window or panel, call Observe() on it to get deep widget coverage, then Unobserve() when done. Observers walk their subtree every ~100ms, assigning refs to newly appeared widgets and keeping the ref cache current.

Input simulation uses direct Slate event APIs (ProcessKeyCharEvent, ProcessMouseButtonDownEvent, etc.) rather than the AutomationDriver, because AutomationDriver's synchronous API deadlocks when called from the game thread (which is where MCP tool calls execute).

   
Name USlateInspectorToolset
Type class
Header File /Engine/Plugins/Experimental/Toolsets/SlateInspectorToolset/Source/SlateInspectorToolset/Public/SlateInspectorToolset.h
Include Path #include "SlateInspectorToolset.h"

Syntax

UCLASS (BlueprintType, MinimalAPI)  
class USlateInspectorToolset : public UToolsetDefinition

Inheritance Hierarchy

Functions

Static

Name Remarks Include Path Unreal Specifiers

static bool Click ( const FString& Ref,
const FString& Button,
bool DoubleClick,
const FSlateInspectorToolsetModifierKeys& Modifiers
)

 Click a Slate widget identified by its ref. SlateInspectorToolset.h
  • Meta=(AICallable)
  • Category="SlateInspectorToolset"

static bool Drag ( const FString& StartRef,
const FString& EndRef,
const FSlateInspectorToolsetModifierKeys& Modifiers
)

 Drag from one Slate widget to another (mouse down, move, release). SlateInspectorToolset.h
  • Meta=(AICallable)
  • Category="SlateInspectorToolset"

static bool FillForm ( const TArray< FSlateInspectorToolsetFormField >& Fields
)

 Fill multiple Slate form fields at once. SlateInspectorToolset.h
  • Meta=(AICallable)
  • Category="SlateInspectorToolset"

static FVector2D GetWidgetScreenCenter ( TSharedRef< SWidget > Widget
)

 Get the absolute screen-space center of a widget. SlateInspectorToolset.h  

static bool Hover ( const FString& Ref
)

 Hover over a Slate widget, triggering any hover state or tooltip. SlateInspectorToolset.h
  • Meta=(AICallable)
  • Category="SlateInspectorToolset"
List all active observers as a JSON array for debugging. SlateInspectorToolset.h
  • Meta=(AICallable)
  • Category="SlateInspectorToolset"

static FString Observe ( const FString& Ref,
int32 MaxDepth
)

 Register an observer on a widget subtree so its refs are continuously kept up to date (~100ms tick). SlateInspectorToolset.h
  • Meta=(AICallable)
  • Category="SlateInspectorToolset"

static FKey ParseMouseButtonKey ( const FString& Button
)

 Map a button name ("left", "right", "middle") to an FKey. SlateInspectorToolset.h  

static bool PressKey ( const FString& Key
)

 Press and release a keyboard key on the currently focused Slate widget. SlateInspectorToolset.h
  • Meta=(AICallable)
  • Category="SlateInspectorToolset"

static TSharedPtr< SWidget > ResolveRefOrWarn ( const FString& Ref
)

 Resolve a ref to a widget, logging a warning if it fails. SlateInspectorToolset.h  

static FToolsetImage Screenshot ( const FString& Ref
)

 Screenshot a Slate widget or the active editor window. SlateInspectorToolset.h
  • Meta=(AICallable)
  • Category="SlateInspectorToolset"

static bool SelectOption ( const FString& Ref,
const FString& Value
)

 Select an option in a Slate combobox by its text label. SlateInspectorToolset.h
  • Meta=(AICallable)
  • Category="SlateInspectorToolset"

static bool SimulateClick ( TSharedRef< SWidget > Widget,
FKey MouseButton,
bool bDoubleClick,
const FModifierKeysState& ModifierKeys
)

 Simulate a mouse click at a widget's screen-space center. SlateInspectorToolset.h  

static FString Snapshot ( const FString& Ref,
int32 MaxDepth,
bool bIncludeSourceLocations
)

 Capture a Slate UI accessibility snapshot. SlateInspectorToolset.h
  • Meta=(AICallable)
  • Category="SlateInspectorToolset"

static bool Type ( const FString& Ref,
const FString& Text,
bool Submit
)

 Type text into a Slate text input widget. SlateInspectorToolset.h
  • Meta=(AICallable)
  • Category="SlateInspectorToolset"

static bool Unobserve ( const FString& Identifier
)

 Remove an observer by its identifier. SlateInspectorToolset.h
  • Meta=(AICallable)
  • Category="SlateInspectorToolset"

static bool WaitFor ( const FString& Text,
const FString& TextGone
)

 Check if text is present or absent in the Slate widget tree. SlateInspectorToolset.h
  • Meta=(AICallable)
  • Category="SlateInspectorToolset"

static FString Windows ( const FString& Action,
int32 Index
)

 List, select, or close top-level Slate editor windows. SlateInspectorToolset.h
  • Meta=(AICallable)
  • Category="SlateInspectorToolset"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page