unreal.ToolsetRegistry

class unreal.ToolsetRegistry(outer: Object | None = None, name: Name | str = 'None')

Bases: BlueprintFunctionLibrary

Blueprint-accessible wrapper to allow queries against the AI Toolset Registry.

C++ Source:

  • Plugin: ToolsetRegistry

  • Module: ToolsetRegistry

  • File: UToolsetRegistry.h

classmethod execute_tool(toolset_name, tool_name, json_input) → ToolCallAsyncResultString

Execute a registered tool given a toolset and tool name as if it was being executed by an AI assistant. If successful, the result’s value is a JSON string containing the tool’s return value. If a failure occurs, the result will contain an error.

Parameters:

  • toolset_name (str)

  • tool_name (str)

  • json_input (str)

Return type:

ToolCallAsyncResultString

classmethod get_all_toolset_json_schemas() → str

Get JSON schemas for all registered toolsets.

Return type:

str

classmethod get_toolset_json_schema(toolset_class) → str

Get toolset JSON schema for a toolset class. Meant for use while testing.

Parameters:

toolset_class (type(Class))

Return type:

str

classmethod is_available() → bool

Whether the toolset registry is available. For example, this will return false if the editor is not available.

Return type:

bool

classmethod is_toolset_class_registered(toolset_class) → bool

Return whether a toolset class is already registered.

Parameters:

toolset_class (type(Class))

Return type:

bool

classmethod is_toolset_registered(toolset_name) → bool

Return whether a toolset is already registered by name.

Parameters:

toolset_name (str)

Return type:

bool

classmethod register_toolset_class(toolset_class) → None

Register a Blueprint function library class as a toolset.

Parameters:

toolset_class (type(Class))

classmethod unregister_toolset_class(toolset_class) → None

Unregister a Blueprint function library class as a toolset.

Parameters:

toolset_class (type(Class))