editor_toolset.toolsets.blueprint.BlueprintTools¶
Provides tools for working with Blueprints.
53 tool(s).
editor_toolset.toolsets.blueprint.BlueprintTools.add_component_bound_event¶
Creates a component bound event node in the event graph.
Args:
component: The component to bind the event to. Must be a component on a Blueprint actor.
event_name: The name of the delegate event to bind, e.g. 'OnComponentBeginOverlap'.
graph: The event graph to add the node to.
Returns:
The created or pre-existing component bound event node.
Input schema
{
"properties": {
"component": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.ActorComponent",
"type": "object"
},
"event_name": {
"type": "string"
},
"graph": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraph",
"type": "object"
}
},
"required": [
"component",
"event_name",
"graph"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraphNode",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.add_event¶
Adds an event node to the Blueprint's event graph.
If event_name matches an inherited overridable event, the new node is an
override of that event. Otherwise a new custom event with the given name is
created. Idempotent — if an event node with that name already exists,
that node is returned.
Args:
blueprint: The Blueprint asset to add the event to.
event_name: The name of an inherited event to override (e.g.
'ReceiveAnyDamage') or a name for a new custom event.
position: Position of the new node in the event graph.
Returns:
The event node.
Input schema
{
"properties": {
"blueprint": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.Blueprint",
"type": "object"
},
"event_name": {
"type": "string"
},
"position": {
"default": {
"x": 0,
"y": 0
},
"properties": {
"x": {
"type": "integer"
},
"y": {
"type": "integer"
}
},
"required": [
"x",
"y"
],
"title": "IntPoint",
"type": "object"
}
},
"required": [
"blueprint",
"event_name"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraphNode",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.add_event_dispatcher¶
Adds an event dispatcher to a Blueprint.
Args:
blueprint: The Blueprint to add the dispatcher to.
name: The name of the new event dispatcher.
Returns:
The event dispatcher graph.
Input schema
{
"properties": {
"blueprint": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.Blueprint",
"type": "object"
},
"name": {
"type": "string"
}
},
"required": [
"blueprint",
"name"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraph",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.add_function_graph¶
Adds a function graph to the Blueprint.
If graph_name matches an inherited overridable function, the new graph is a
function-graph override of that function. Idempotent — if a graph with that
name already exists, that graph is returned.
Args:
blueprint: The Blueprint asset to add the function to.
graph_name: The name of the new function graph.
Input schema
{
"properties": {
"blueprint": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.Blueprint",
"type": "object"
},
"graph_name": {
"type": "string"
}
},
"required": [
"blueprint",
"graph_name"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraph",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.add_function_param¶
Adds an input or output to a function or event dispatcher
Note: output params are not supported on event dispatchers.
Supported parameter types:
Primitives: 'bool', 'int', 'float', 'byte', 'string', 'name', 'text'
Structs: 'Vector', 'Rotator', 'Transform', 'Vector2D', 'LinearColor'
Args:
graph: The function or event dispatcher graph to add the parameter to.
param_name: The name of the new parameter.
param_type: The parameter type as a string (see above).
input_param: True to add an input param, false to add an output.
container_type: Container type for the parameter. MAP uses string as the key type.
Returns:
The PinID of the newly created parameter.
Input schema
{
"properties": {
"container_type": {
"default": null,
"enum": [
"ARRAY",
"SET",
"MAP"
],
"title": "ContainerType",
"type": "string"
},
"graph": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraph",
"type": "object"
},
"input_param": {
"type": "boolean"
},
"param_name": {
"type": "string"
},
"param_type": {
"type": "string"
}
},
"required": [
"graph",
"param_name",
"param_type",
"input_param"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"properties": {
"direction": {
"enum": [
"EGPD_Input",
"EGPD_Output"
],
"title": "EEdGraphPinDirection",
"type": "string"
},
"index_id": {
"type": "integer"
},
"node": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraphNode",
"type": "object"
}
},
"required": [
"direction",
"index_id",
"node"
],
"title": "PinID",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.add_node_pin¶
Adds a pin to a node that supports dynamic pin addition.
Works for Switch nodes (adds one case pin), Sequence nodes (adds one Then output),
commutative binary operators like Add/Multiply (adds one input), Make Array nodes, etc.
Args:
node: The node to add a pin to. Must support dynamic pin addition.
Returns:
The PinID of the newly added pin.
Input schema
{
"properties": {
"node": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraphNode",
"type": "object"
}
},
"required": [
"node"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"properties": {
"direction": {
"enum": [
"EGPD_Input",
"EGPD_Output"
],
"title": "EEdGraphPinDirection",
"type": "string"
},
"index_id": {
"type": "integer"
},
"node": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraphNode",
"type": "object"
}
},
"required": [
"direction",
"index_id",
"node"
],
"title": "PinID",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.add_object_function_param¶
Adds an object reference input or output to a function or event dispatcher.
Note: output params are not supported on event dispatchers.
Args:
graph: The function or event dispatcher graph to add the param to.
param_name: The name of the new param.
object_class: The class of object this param will reference.
input_param: True to add an input param, false to add an output.
container_type: Container type for the param. MAP uses string as the key type.
Returns:
The PinID of the newly created param.
Input schema
{
"properties": {
"container_type": {
"default": null,
"enum": [
"ARRAY",
"SET",
"MAP"
],
"title": "ContainerType",
"type": "string"
},
"graph": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraph",
"type": "object"
},
"input_param": {
"type": "boolean"
},
"object_class": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/CoreUObject.Class",
"type": "object"
},
"param_name": {
"type": "string"
}
},
"required": [
"graph",
"param_name",
"object_class",
"input_param"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"properties": {
"direction": {
"enum": [
"EGPD_Input",
"EGPD_Output"
],
"title": "EEdGraphPinDirection",
"type": "string"
},
"index_id": {
"type": "integer"
},
"node": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraphNode",
"type": "object"
}
},
"required": [
"direction",
"index_id",
"node"
],
"title": "PinID",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.add_object_variable¶
Adds a member or local variable that holds an object reference to a Blueprint.
Args:
blueprint: The Blueprint to add the variable to.
name: The variable name.
object_class: The class of object this variable will reference.
graph: If provided, adds a local variable to this function graph instead of a
member variable.
container_type: Container type for the variable. MAP uses string as the key type.
Input schema
{
"properties": {
"blueprint": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.Blueprint",
"type": "object"
},
"container_type": {
"default": null,
"enum": [
"ARRAY",
"SET",
"MAP"
],
"title": "ContainerType",
"type": "string"
},
"graph": {
"default": null,
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraph",
"type": "object"
},
"name": {
"type": "string"
},
"object_class": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/CoreUObject.Class",
"type": "object"
}
},
"required": [
"blueprint",
"name",
"object_class"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.add_struct_function_param¶
Adds a struct input or output to a function or event dispatcher.
Note: output params are not supported on event dispatchers.
Use this to add parameters of any UStruct type, including custom structs and engine
structs not in the basic list supported by add_function_param (e.g. HitResult, GameplayTag).
Args:
graph: The function or event dispatcher graph to add the parameter to.
param_name: The name of the new parameter.
struct_type: The struct type for this parameter.
input_param: True to add an input param, false to add an output.
container_type: Container type for the parameter. MAP uses string as the key type.
Returns:
The PinID of the newly created parameter.
Input schema
{
"properties": {
"container_type": {
"default": null,
"enum": [
"ARRAY",
"SET",
"MAP"
],
"title": "ContainerType",
"type": "string"
},
"graph": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraph",
"type": "object"
},
"input_param": {
"type": "boolean"
},
"param_name": {
"type": "string"
},
"struct_type": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/CoreUObject.ScriptStruct",
"type": "object"
}
},
"required": [
"graph",
"param_name",
"struct_type",
"input_param"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"properties": {
"direction": {
"enum": [
"EGPD_Input",
"EGPD_Output"
],
"title": "EEdGraphPinDirection",
"type": "string"
},
"index_id": {
"type": "integer"
},
"node": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraphNode",
"type": "object"
}
},
"required": [
"direction",
"index_id",
"node"
],
"title": "PinID",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.add_struct_variable¶
Adds a member or local variable of a struct type to a Blueprint.
Use this to add variables of any UStruct type, including custom structs and engine
structs not in the basic list supported by add_variable (e.g. HitResult, GameplayTag).
Args:
blueprint: The Blueprint to add the variable to.
name: The variable name.
struct_type: The struct type for this variable.
graph: If provided, adds a local variable to this function graph instead of a
member variable.
container_type: Container type for the variable. MAP uses string as the key type.
Input schema
{
"properties": {
"blueprint": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.Blueprint",
"type": "object"
},
"container_type": {
"default": null,
"enum": [
"ARRAY",
"SET",
"MAP"
],
"title": "ContainerType",
"type": "string"
},
"graph": {
"default": null,
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraph",
"type": "object"
},
"name": {
"type": "string"
},
"struct_type": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/CoreUObject.ScriptStruct",
"type": "object"
}
},
"required": [
"blueprint",
"name",
"struct_type"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.add_variable¶
Adds a member or local variable to a Blueprint.
Supported type names:
Primitives: 'bool', 'int', 'float', 'byte', 'string', 'name', 'text'
Structs: 'Vector', 'Rotator', 'Transform', 'Vector2D', 'LinearColor'
Args:
blueprint: The Blueprint to add the variable to.
name: The variable name.
type_name: The variable type as a string (see above).
graph: If provided, adds a local variable to this function graph instead of a
member variable.
container_type: Container type for the variable. MAP uses string as the key type.
Input schema
{
"properties": {
"blueprint": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.Blueprint",
"type": "object"
},
"container_type": {
"default": null,
"enum": [
"ARRAY",
"SET",
"MAP"
],
"title": "ContainerType",
"type": "string"
},
"graph": {
"default": null,
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraph",
"type": "object"
},
"name": {
"type": "string"
},
"type_name": {
"type": "string"
}
},
"required": [
"blueprint",
"name",
"type_name"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.arrange_nodes¶
Arranges a list of nodes in a readable left-to-right layout.
Organizes nodes into columns based on data/execution flow, with producer nodes to
the left of the nodes they feed into. Call this after building a graph
to avoid nodes overlapping. Connections to nodes outside the list are used as anchors
so the arranged nodes integrate cleanly with the rest of the graph.
Args:
nodes: The nodes to arrange.
Input schema
{
"properties": {
"nodes": {
"items": {
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraphNode",
"type": "object"
},
"type": "array"
}
},
"required": [
"nodes"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.break_pins¶
Breaks the connection between two pins.
Args:
output_pin: The PinID of the output pin to disconnect from.
input_pin: The PinID of the input pin to disconnect from.
Input schema
{
"properties": {
"input_pin": {
"properties": {
"direction": {
"enum": [
"EGPD_Input",
"EGPD_Output"
],
"title": "EEdGraphPinDirection",
"type": "string"
},
"index_id": {
"type": "integer"
},
"node": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraphNode",
"type": "object"
}
},
"required": [
"direction",
"index_id",
"node"
],
"title": "PinID",
"type": "object"
},
"output_pin": {
"properties": {
"direction": {
"enum": [
"EGPD_Input",
"EGPD_Output"
],
"title": "EEdGraphPinDirection",
"type": "string"
},
"index_id": {
"type": "integer"
},
"node": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraphNode",
"type": "object"
}
},
"required": [
"direction",
"index_id",
"node"
],
"title": "PinID",
"type": "object"
}
},
"required": [
"output_pin",
"input_pin"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.compile_blueprint¶
Compiles the given Blueprint.
Blueprints should be compiled after all graph modifications are complete.
Args:
blueprint: The Blueprint to compile.
warnings_as_errors: If True, raise on compile warnings as well as errors.
Defaults to False.
Input schema
{
"properties": {
"blueprint": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.Blueprint",
"type": "object"
},
"warnings_as_errors": {
"default": false,
"type": "boolean"
}
},
"required": [
"blueprint"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.connect_pins¶
Makes a connection between source (output) and dest (input) pins.
Args:
output_pin: The PinID of the output pin to connect from.
input_pin: The PinID of the input pin to connect to.
Input schema
{
"properties": {
"input_pin": {
"properties": {
"direction": {
"enum": [
"EGPD_Input",
"EGPD_Output"
],
"title": "EEdGraphPinDirection",
"type": "string"
},
"index_id": {
"type": "integer"
},
"node": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraphNode",
"type": "object"
}
},
"required": [
"direction",
"index_id",
"node"
],
"title": "PinID",
"type": "object"
},
"output_pin": {
"properties": {
"direction": {
"enum": [
"EGPD_Input",
"EGPD_Output"
],
"title": "EEdGraphPinDirection",
"type": "string"
},
"index_id": {
"type": "integer"
},
"node": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraphNode",
"type": "object"
}
},
"required": [
"direction",
"index_id",
"node"
],
"title": "PinID",
"type": "object"
}
},
"required": [
"output_pin",
"input_pin"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.create¶
Creates a new Blueprint asset in the project.
Args:
folder_path: The path to the folder that will contain the asset.
asset_name: The name of the asset in the folder.
asset_type: The specific kind of Blueprint to make.
Returns:
The Blueprint that was created.
Input schema
{
"properties": {
"asset_name": {
"type": "string"
},
"asset_type": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/CoreUObject.Class",
"type": "object"
},
"folder_path": {
"type": "string"
}
},
"required": [
"folder_path",
"asset_name",
"asset_type"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.Blueprint",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.create_node¶
Adds a new node to the graph.
Args:
graph: The graph to add a node to
type_id: The type of the node to add. Eg 'Development|PrintString',
'Utilities|Operators|Add', a macro like 'Utilities|FlowControl|ForLoop', a
dispatcher event handler like 'Default|EventDispatcherOnDamaged', an event
like 'AddEvent|EventBeginPlay', or a named custom event with
'AddEvent|Custom|MyEventName'.
pos: The x, y position of the created node
declaring_class: The class that should own the created node. Only set this when you need
to disambiguate nodes that share the same type_id to ensure the correct one is used.
Returns:
Returns the new node
Input schema
{
"properties": {
"declaring_class": {
"default": null,
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/CoreUObject.Class",
"type": "object"
},
"graph": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraph",
"type": "object"
},
"pos": {
"properties": {
"x": {
"type": "integer"
},
"y": {
"type": "integer"
}
},
"required": [
"x",
"y"
],
"title": "IntPoint",
"type": "object"
},
"type_id": {
"type": "string"
}
},
"required": [
"graph",
"type_id",
"pos"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraphNode",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.delete_node¶
Deletes the node from its graph.
Args:
node: The node to be deleted
Input schema
{
"properties": {
"node": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraphNode",
"type": "object"
}
},
"required": [
"node"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.find_node_categories¶
Retrieves a list of available node categories in a Blueprint graph, optionally filtered by compatible input and/or output pin types
Note: Categories are everything before the last | character in a node type id (eg 'Utilities|Operators' in the 'Utilities|Operators|Add' type id)
Args:
graph: the graph to make the search for
category_filter: Substring to match against the node categories (case-insensitive). Pass an empty string to return all categories.
context_pins: If set, only returns categories with nodes whose pin types match those specified in this list
Returns:
Returns node categories that match the input criteria
Input schema
{
"properties": {
"category_filter": {
"type": "string"
},
"context_pins": {
"items": {
"properties": {
"direction": {
"enum": [
"EGPD_Input",
"EGPD_Output"
],
"title": "EEdGraphPinDirection",
"type": "string"
},
"index_id": {
"type": "integer"
},
"node": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraphNode",
"type": "object"
}
},
"required": [
"direction",
"index_id",
"node"
],
"title": "PinID",
"type": "object"
},
"type": "array"
},
"graph": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraph",
"type": "object"
}
},
"required": [
"graph",
"category_filter",
"context_pins"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.find_node_types¶
Finds node types that can be created in a particular graph meeting the search criteria.
Note: there can be thousands of valid node types in a graph, so type_id_filter should be
reasonably specific even if that requires multiple searches.
To list all nodes within a category, use a trailing pipe: e.g. 'Utilities|FlowControl|'
returns every node under that category. Without the trailing pipe, 'Utilities|FlowControl'
also matches any node whose type_id contains that substring (such as a node with category
'Utilities' and title 'FlowControl').
Args:
graph: the graph to make the search for
type_id_filter: Substring to match against the node type_id (case-insensitive)
context_pins: If set, only returns nodes whose pin types match those specified in this list
Returns:
Returns nodes that match the input criteria
Input schema
{
"properties": {
"context_pins": {
"items": {
"properties": {
"direction": {
"enum": [
"EGPD_Input",
"EGPD_Output"
],
"title": "EEdGraphPinDirection",
"type": "string"
},
"index_id": {
"type": "integer"
},
"node": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraphNode",
"type": "object"
}
},
"required": [
"direction",
"index_id",
"node"
],
"title": "PinID",
"type": "object"
},
"type": "array"
},
"graph": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraph",
"type": "object"
},
"type_id_filter": {
"type": "string"
}
},
"required": [
"graph",
"type_id_filter",
"context_pins"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.find_nodes¶
Finds nodes in a graph by title, class, and/or execution role.
All filters are optional and ANDed together. Useful for locating specific
event chains in large graphs like EventGraph before reading them with
get_connected_subgraph.
Args:
graph: The graph to search.
title: Case-insensitive substring to match against the node's displayed
title. Pass an empty string to match any title.
node_class: If provided, only returns nodes that are instances of this
class or its subclasses.
entry_points_only: If True, only returns entry point nodes - nodes with
an exec output but no exec input (event nodes, function entry nodes,
macro input tunnels, etc.). Nothing can drive these nodes; they
start execution themselves.
Returns:
All nodes in the graph matching the given filters.
Input schema
{
"properties": {
"entry_points_only": {
"default": false,
"type": "boolean"
},
"graph": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraph",
"type": "object"
},
"node_class": {
"default": null,
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/CoreUObject.Class",
"type": "object"
},
"title": {
"type": "string"
}
},
"required": [
"graph",
"title"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"items": {
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraphNode",
"type": "object"
},
"type": "array"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.get_connected_subgraph¶
Returns detailed information for all nodes connected to the given node.
Use this alongside find_nodes to read a single event chain from a large graph
(like Event Graph) without reading the entire graph.
Args:
node: The starting node.
Returns:
Every node reachable from the given node via any connection, including
the starting node itself.
Input schema
{
"properties": {
"node": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraphNode",
"type": "object"
}
},
"required": [
"node"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"items": {
"properties": {
"input_pins": {
"items": {
"properties": {
"connected_pins": {
"items": {
"properties": {
"direction": {
"enum": [
"EGPD_Input",
"EGPD_Output"
],
"title": "EEdGraphPinDirection",
"type": "string"
},
"index_id": {
"type": "integer"
},
"node": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraphNode",
"type": "object"
}
},
"required": [
"direction",
"index_id",
"node"
],
"title": "PinID",
"type": "object"
},
"type": "array"
},
"name": {
"type": "string"
},
"pin_id": {
"properties": {
"direction": {
"enum": [
"EGPD_Input",
"EGPD_Output"
],
"title": "EEdGraphPinDirection",
"type": "string"
},
"index_id": {
"type": "integer"
},
"node": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraphNode",
"type": "object"
}
},
"required": [
"direction",
"index_id",
"node"
],
"title": "PinID",
"type": "object"
},
"type_id": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value",
"connected_pins",
"pin_id",
"type_id",
"name"
],
"title": "PinInfo",
"type": "object"
},
"type": "array"
},
"node": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraphNode",
"type": "object"
},
"output_pins": {
"items": {
"properties": {
"connected_pins": {
"items": {
"properties": {
"direction": {
"enum": [
"EGPD_Input",
"EGPD_Output"
],
"title": "EEdGraphPinDirection",
"type": "string"
},
"index_id": {
"type": "integer"
},
"node": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraphNode",
"type": "object"
}
},
"required": [
"direction",
"index_id",
"node"
],
"title": "PinID",
"type": "object"
},
"type": "array"
},
"name": {
"type": "string"
},
"pin_id": {
"properties": {
"direction": {
"enum": [
"EGPD_Input",
"EGPD_Output"
],
"title": "EEdGraphPinDirection",
"type": "string"
},
"index_id": {
"type": "integer"
},
"node": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraphNode",
"type": "object"
}
},
"required": [
"direction",
"index_id",
"node"
],
"title": "PinID",
"type": "object"
},
"type_id": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value",
"connected_pins",
"pin_id",
"type_id",
"name"
],
"title": "PinInfo",
"type": "object"
},
"type": "array"
},
"position": {
"properties": {
"x": {
"type": "integer"
},
"y": {
"type": "integer"
}
},
"required": [
"x",
"y"
],
"title": "IntPoint",
"type": "object"
},
"type_id": {
"description": "type_id is in the format Category|Title",
"type": "string"
}
},
"required": [
"output_pins",
"input_pins",
"position",
"node",
"type_id"
],
"title": "NodeInfo",
"type": "object"
},
"type": "array"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.get_create_event_function¶
Returns the function currently bound to a Create Event node.
Args:
node: The Create Event node.
Returns:
The bound function name, or empty string if none is set.
Input schema
{
"properties": {
"node": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/BlueprintGraph.K2Node_CreateDelegate",
"type": "object"
}
},
"required": [
"node"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "string"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.get_default_object¶
Returns the Class Default Object (CDO) for a Blueprint's.
ObjectTools list/set/get property will get the CDO automatically, so this
should primarily be used before calling tools that want to operate on the
object inside the blueprint (like ActorTools).
Note: The Blueprint must be compiled for the CDO to reflect the latest state.
Args:
blueprint: The Blueprint whose CDO to retrieve.
Returns:
The Class Default Object for the Blueprint's generated class.
Input schema
{
"properties": {
"blueprint": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.Blueprint",
"type": "object"
}
},
"required": [
"blueprint"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/CoreUObject.Object",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.get_graph¶
Retrieves a specific graph from a Blueprint asset by name.
Args:
blueprint: The Blueprint asset to search within.
graph_name: The name of the graph to retrieve (e.g., "EventGraph", "MyFunction")
Returns:
The graph object matching the specified name.
Input schema
{
"properties": {
"blueprint": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.Blueprint",
"type": "object"
},
"graph_name": {
"type": "string"
}
},
"required": [
"blueprint",
"graph_name"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraph",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.get_graph_dsl_docs¶
Returns the full syntax reference for write_graph_dsl.
Call this before using write_graph_dsl for the first time.
Input schema
{
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "string"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.get_node_infos¶
Retrieves detailed information for a list of Blueprint graph nodes.
Args:
nodes: The graph nodes to retrieve information from.
Returns:
Information about each node, including type, pins, connections, and position.
Input schema
{
"properties": {
"nodes": {
"items": {
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraphNode",
"type": "object"
},
"type": "array"
}
},
"required": [
"nodes"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"items": {
"properties": {
"input_pins": {
"items": {
"properties": {
"connected_pins": {
"items": {
"properties": {
"direction": {
"enum": [
"EGPD_Input",
"EGPD_Output"
],
"title": "EEdGraphPinDirection",
"type": "string"
},
"index_id": {
"type": "integer"
},
"node": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraphNode",
"type": "object"
}
},
"required": [
"direction",
"index_id",
"node"
],
"title": "PinID",
"type": "object"
},
"type": "array"
},
"name": {
"type": "string"
},
"pin_id": {
"properties": {
"direction": {
"enum": [
"EGPD_Input",
"EGPD_Output"
],
"title": "EEdGraphPinDirection",
"type": "string"
},
"index_id": {
"type": "integer"
},
"node": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraphNode",
"type": "object"
}
},
"required": [
"direction",
"index_id",
"node"
],
"title": "PinID",
"type": "object"
},
"type_id": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value",
"connected_pins",
"pin_id",
"type_id",
"name"
],
"title": "PinInfo",
"type": "object"
},
"type": "array"
},
"node": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraphNode",
"type": "object"
},
"output_pins": {
"items": {
"properties": {
"connected_pins": {
"items": {
"properties": {
"direction": {
"enum": [
"EGPD_Input",
"EGPD_Output"
],
"title": "EEdGraphPinDirection",
"type": "string"
},
"index_id": {
"type": "integer"
},
"node": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraphNode",
"type": "object"
}
},
"required": [
"direction",
"index_id",
"node"
],
"title": "PinID",
"type": "object"
},
"type": "array"
},
"name": {
"type": "string"
},
"pin_id": {
"properties": {
"direction": {
"enum": [
"EGPD_Input",
"EGPD_Output"
],
"title": "EEdGraphPinDirection",
"type": "string"
},
"index_id": {
"type": "integer"
},
"node": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraphNode",
"type": "object"
}
},
"required": [
"direction",
"index_id",
"node"
],
"title": "PinID",
"type": "object"
},
"type_id": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value",
"connected_pins",
"pin_id",
"type_id",
"name"
],
"title": "PinInfo",
"type": "object"
},
"type": "array"
},
"position": {
"properties": {
"x": {
"type": "integer"
},
"y": {
"type": "integer"
}
},
"required": [
"x",
"y"
],
"title": "IntPoint",
"type": "object"
},
"type_id": {
"description": "type_id is in the format Category|Title",
"type": "string"
}
},
"required": [
"output_pins",
"input_pins",
"position",
"node",
"type_id"
],
"title": "NodeInfo",
"type": "object"
},
"type": "array"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.get_node_type_pins¶
Returns the pin names and types for a node type.
Args:
graph: The graph context used to resolve the node type.
type_id: A node type_id as returned by find_node_types.
Returns:
NodeInfo with input_pins and output_pins listing each pin's name and type.
Input schema
{
"properties": {
"graph": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraph",
"type": "object"
},
"type_id": {
"type": "string"
}
},
"required": [
"graph",
"type_id"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"properties": {
"input_pins": {
"items": {
"properties": {
"connected_pins": {
"items": {
"properties": {
"direction": {
"enum": [
"EGPD_Input",
"EGPD_Output"
],
"title": "EEdGraphPinDirection",
"type": "string"
},
"index_id": {
"type": "integer"
},
"node": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraphNode",
"type": "object"
}
},
"required": [
"direction",
"index_id",
"node"
],
"title": "PinID",
"type": "object"
},
"type": "array"
},
"name": {
"type": "string"
},
"pin_id": {
"properties": {
"direction": {
"enum": [
"EGPD_Input",
"EGPD_Output"
],
"title": "EEdGraphPinDirection",
"type": "string"
},
"index_id": {
"type": "integer"
},
"node": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraphNode",
"type": "object"
}
},
"required": [
"direction",
"index_id",
"node"
],
"title": "PinID",
"type": "object"
},
"type_id": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value",
"connected_pins",
"pin_id",
"type_id",
"name"
],
"title": "PinInfo",
"type": "object"
},
"type": "array"
},
"node": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraphNode",
"type": "object"
},
"output_pins": {
"items": {
"properties": {
"connected_pins": {
"items": {
"properties": {
"direction": {
"enum": [
"EGPD_Input",
"EGPD_Output"
],
"title": "EEdGraphPinDirection",
"type": "string"
},
"index_id": {
"type": "integer"
},
"node": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraphNode",
"type": "object"
}
},
"required": [
"direction",
"index_id",
"node"
],
"title": "PinID",
"type": "object"
},
"type": "array"
},
"name": {
"type": "string"
},
"pin_id": {
"properties": {
"direction": {
"enum": [
"EGPD_Input",
"EGPD_Output"
],
"title": "EEdGraphPinDirection",
"type": "string"
},
"index_id": {
"type": "integer"
},
"node": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraphNode",
"type": "object"
}
},
"required": [
"direction",
"index_id",
"node"
],
"title": "PinID",
"type": "object"
},
"type_id": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"value",
"connected_pins",
"pin_id",
"type_id",
"name"
],
"title": "PinInfo",
"type": "object"
},
"type": "array"
},
"position": {
"properties": {
"x": {
"type": "integer"
},
"y": {
"type": "integer"
}
},
"required": [
"x",
"y"
],
"title": "IntPoint",
"type": "object"
},
"type_id": {
"description": "type_id is in the format Category|Title",
"type": "string"
}
},
"required": [
"output_pins",
"input_pins",
"position",
"node",
"type_id"
],
"title": "NodeInfo",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.get_parent¶
Returns the parent class of a Blueprint.
Args:
blueprint: The Blueprint whose parent class to retrieve.
Returns:
The parent class of the Blueprint's generated class.
Input schema
{
"properties": {
"blueprint": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.Blueprint",
"type": "object"
}
},
"required": [
"blueprint"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/CoreUObject.Class",
"type": "object"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.get_pin_value¶
Gets the value of a Blueprint graph pin.
Args:
pin: The PinID of the pin to read. Must be an input pin that supports default values.
Returns:
The value of the pin as a string.
Input schema
{
"properties": {
"pin": {
"properties": {
"direction": {
"enum": [
"EGPD_Input",
"EGPD_Output"
],
"title": "EEdGraphPinDirection",
"type": "string"
},
"index_id": {
"type": "integer"
},
"node": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraphNode",
"type": "object"
}
},
"required": [
"direction",
"index_id",
"node"
],
"title": "PinID",
"type": "object"
}
},
"required": [
"pin"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "string"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.get_variable_category¶
Gets the user-defined category of a Blueprint member variable.
Categories group variables in the My Blueprint panel. Variables with no
explicit category default to the Blueprint's name in the UI.
Args:
blueprint: The Blueprint containing the variable.
variable_name: The name of the member variable to query.
Returns:
The category as a string. Empty string if the variable has no custom
category override.
Input schema
{
"properties": {
"blueprint": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.Blueprint",
"type": "object"
},
"variable_name": {
"type": "string"
}
},
"required": [
"blueprint",
"variable_name"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "string"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.get_variable_replication¶
Gets the replication mode of a Blueprint member variable.
Args:
blueprint: The Blueprint containing the variable.
variable_name: The name of the member variable to query.
Returns:
The replication mode (NONE, REPLICATED, or REP_NOTIFY).
Input schema
{
"properties": {
"blueprint": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.Blueprint",
"type": "object"
},
"variable_name": {
"type": "string"
}
},
"required": [
"blueprint",
"variable_name"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"enum": [
"None",
"Replicated",
"RepNotify"
],
"title": "EBlueprintVariableReplication",
"type": "string"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.list_compatible_event_functions¶
Lists functions that can be bound to a Create Event node.
Args:
node: The Create Event node.
Returns:
A list of function names valid for binding.
Input schema
{
"properties": {
"node": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/BlueprintGraph.K2Node_CreateDelegate",
"type": "object"
}
},
"required": [
"node"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.list_component_events¶
Lists the bindable delegate events available on a component.
Args:
component: The component to query. Must be a component on a Blueprint actor.
Returns:
The names of all bindable events on the component, e.g. OnComponentBeginOverlap.
Input schema
{
"properties": {
"component": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.ActorComponent",
"type": "object"
}
},
"required": [
"component"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.list_event_dispatchers¶
Lists all event dispatchers defined on a Blueprint.
Args:
blueprint: The Blueprint to list event dispatchers for.
Returns:
A list of event dispatcher graphs, one per dispatcher.
Input schema
{
"properties": {
"blueprint": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.Blueprint",
"type": "object"
}
},
"required": [
"blueprint"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"items": {
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraph",
"type": "object"
},
"type": "array"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.list_events¶
Lists all events visible on the Blueprint — locally defined custom events plus inheritable events from the parent class chain and implemented interfaces.
Args:
blueprint: The Blueprint asset to query.
Input schema
{
"properties": {
"blueprint": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.Blueprint",
"type": "object"
}
},
"required": [
"blueprint"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"items": {
"properties": {
"bIsImplemented": {
"description": "True if this function/event already has a graph or node on the Blueprint; false if it is only available to implement or override.",
"type": "boolean"
},
"description": {
"description": "Short human-readable description, e.g. the tooltip shown in the editor. Empty if none.",
"type": "string"
},
"name": {
"description": "The function or event's identifier — the name a caller would use to refer to it.",
"type": "string"
}
},
"required": [
"name",
"description",
"bIsImplemented"
],
"title": "BlueprintFunctionInfo",
"type": "object"
},
"type": "array"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.list_functions¶
Lists all functions visible on the Blueprint — locally defined plus inheritable ones from the parent class chain and implemented interfaces.
Args:
blueprint: The Blueprint asset to query.
Input schema
{
"properties": {
"blueprint": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.Blueprint",
"type": "object"
}
},
"required": [
"blueprint"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"items": {
"properties": {
"bIsImplemented": {
"description": "True if this function/event already has a graph or node on the Blueprint; false if it is only available to implement or override.",
"type": "boolean"
},
"description": {
"description": "Short human-readable description, e.g. the tooltip shown in the editor. Empty if none.",
"type": "string"
},
"name": {
"description": "The function or event's identifier — the name a caller would use to refer to it.",
"type": "string"
}
},
"required": [
"name",
"description",
"bIsImplemented"
],
"title": "BlueprintFunctionInfo",
"type": "object"
},
"type": "array"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.list_graphs¶
Lists all graphs in the Blueprint.
Args:
blueprint: The Blueprint asset with the graphs to list.
Returns:
list of graphs in the Blueprint.
Input schema
{
"properties": {
"blueprint": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.Blueprint",
"type": "object"
}
},
"required": [
"blueprint"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"items": {
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraph",
"type": "object"
},
"type": "array"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.list_variables¶
Lists member or local variables defined on a Blueprint.
Args:
blueprint: The Blueprint to list variables for.
graph: If provided, lists local variables in this function graph instead of
member variables.
Returns:
A list of variable names.
Input schema
{
"properties": {
"blueprint": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.Blueprint",
"type": "object"
},
"graph": {
"default": null,
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraph",
"type": "object"
}
},
"required": [
"blueprint"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.read_graph_dsl¶
Reads a Blueprint graph and returns a DSL script.
The returned code uses the same syntax that write_graph_dsl accepts and can
be edited and passed back to write_graph_dsl to modify the graph.
Call get_graph_dsl_docs() for the full syntax reference.
Args:
graph: The graph to read.
Returns:
An S-expression DSL script representing the graph's logic.
Input schema
{
"properties": {
"graph": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraph",
"type": "object"
}
},
"required": [
"graph"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "string"
}
},
"required": [
"returnValue"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.remove_function_graph¶
Removes a function graph or event dispatcher from the Blueprint.
Note: This will close the Blueprint editor window if it is currently open.
Args:
blueprint: The Blueprint asset to remove the function graph from.
graph_name: The name of the function or dispatcher to remove.
Input schema
{
"properties": {
"blueprint": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.Blueprint",
"type": "object"
},
"graph_name": {
"type": "string"
}
},
"required": [
"blueprint",
"graph_name"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.remove_function_param¶
Removes an input or output from a function or event dispatcher.
Note: output params are not supported on event dispatchers.
Args:
graph: The function or event dispatcher graph to remove the param from.
param_name: The name of the param to remove.
input_param: True to remove an input param, False to remove an output.
Input schema
{
"properties": {
"graph": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraph",
"type": "object"
},
"input_param": {
"type": "boolean"
},
"param_name": {
"type": "string"
}
},
"required": [
"graph",
"param_name",
"input_param"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.remove_node_pin¶
Removes a specific pin from a node that supports dynamic pin removal.
Works for Switch nodes (removes one case pin), Sequence nodes (removes one Then output),
commutative binary operators like Add/Multiply (removes one input), Make Array nodes, etc.
Args:
node: The node to remove a pin from. Must support dynamic pin removal.
pin: The PinID of the pin to remove.
Input schema
{
"properties": {
"node": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraphNode",
"type": "object"
},
"pin": {
"properties": {
"direction": {
"enum": [
"EGPD_Input",
"EGPD_Output"
],
"title": "EEdGraphPinDirection",
"type": "string"
},
"index_id": {
"type": "integer"
},
"node": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraphNode",
"type": "object"
}
},
"required": [
"direction",
"index_id",
"node"
],
"title": "PinID",
"type": "object"
}
},
"required": [
"node",
"pin"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.remove_variable¶
Removes a member or local variable from a Blueprint.
Args:
blueprint: The Blueprint to remove the variable from.
name: The name of the variable to remove.
graph: If provided, removes a local variable from this function graph instead of a
member variable.
Input schema
{
"properties": {
"blueprint": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.Blueprint",
"type": "object"
},
"graph": {
"default": null,
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraph",
"type": "object"
},
"name": {
"type": "string"
}
},
"required": [
"blueprint",
"name"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.retarget_node_class¶
Replaces a node's baked-in class reference from old_class to new_class in place.
If the node's current class reference matches old_class it is replaced with
new_class and the node is reconstructed so its pins reflect the new type.
If the node already references new_class the call is a no-op.
When a Blueprint is duplicated, nodes in the copied graph retain class references
pointing to the original Blueprint. Calling this on each node with the original
and duplicate classes retargets them without manual delete-recreate-rewire cycles.
Handles cast, function call, event, and multicast delegate nodes. The Blueprint
must be compiled after all retargeting is complete.
Args:
node: The node to retarget.
old_class: The class currently baked into the node.
new_class: The replacement class.
Input schema
{
"properties": {
"new_class": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/CoreUObject.Class",
"type": "object"
},
"node": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraphNode",
"type": "object"
},
"old_class": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/CoreUObject.Class",
"type": "object"
}
},
"required": [
"node",
"old_class",
"new_class"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.set_create_event_function¶
Binds a function to a Create Event node.
Use list_compatible_event_functions to find valid function names.
Args:
node: The Create Event node.
function_name: The name of the function to bind.
Input schema
{
"properties": {
"function_name": {
"type": "string"
},
"node": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/BlueprintGraph.K2Node_CreateDelegate",
"type": "object"
}
},
"required": [
"node",
"function_name"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.set_node_position¶
Sets a new position for the node.
Args:
node: Node to be moved
pos: New x, y position of the node in the graph
Input schema
{
"properties": {
"node": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraphNode",
"type": "object"
},
"pos": {
"properties": {
"x": {
"type": "integer"
},
"y": {
"type": "integer"
}
},
"required": [
"x",
"y"
],
"title": "IntPoint",
"type": "object"
}
},
"required": [
"node",
"pos"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.set_parent¶
Reparents a Blueprint to a new parent class.
The Blueprint must be recompiled after reparenting.
Args:
blueprint: The Blueprint to reparent.
parent_class: The new parent class. Must be a UObject subclass.
Input schema
{
"properties": {
"blueprint": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.Blueprint",
"type": "object"
},
"parent_class": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/CoreUObject.Class",
"type": "object"
}
},
"required": [
"blueprint",
"parent_class"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.set_pin_value¶
Sets the value of a Blueprint graph pin.
Args:
pin: The PinID of the pin to modify. Must be an input pin that supports default values.
value: The value to assign as a string. Format depends on the pin's data type:
- Numeric pins (int/float): "42" or "3.14"
- Boolean pins: "true" or "false"
- String/Name/Text pins: "Hello World"
- Object reference pins: "/Game/Path/To/Asset.Asset"
Input schema
{
"properties": {
"pin": {
"properties": {
"direction": {
"enum": [
"EGPD_Input",
"EGPD_Output"
],
"title": "EEdGraphPinDirection",
"type": "string"
},
"index_id": {
"type": "integer"
},
"node": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraphNode",
"type": "object"
}
},
"required": [
"direction",
"index_id",
"node"
],
"title": "PinID",
"type": "object"
},
"value": {
"type": "string"
}
},
"required": [
"pin",
"value"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.set_variable_category¶
Sets the user-defined category on a Blueprint member variable.
Categories group variables in the My Blueprint panel. Pass an empty string
to reset to the default (the Blueprint's name).
Args:
blueprint: The Blueprint containing the variable.
variable_name: The name of the member variable to modify.
category: The new category text.
Input schema
{
"properties": {
"blueprint": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.Blueprint",
"type": "object"
},
"category": {
"type": "string"
},
"variable_name": {
"type": "string"
}
},
"required": [
"blueprint",
"variable_name",
"category"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.set_variable_instance_editable¶
Sets whether a member variable is editable per-instance on actors placed in the level.
Args:
blueprint: The Blueprint containing the variable.
variable_name: The name of the member variable to modify.
instance_editable: True to make the variable editable on instances, False to hide it.
Input schema
{
"properties": {
"blueprint": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.Blueprint",
"type": "object"
},
"instance_editable": {
"type": "boolean"
},
"variable_name": {
"type": "string"
}
},
"required": [
"blueprint",
"variable_name",
"instance_editable"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.set_variable_replication¶
Sets the replication mode on a Blueprint member variable.
RepNotify will automatically create an OnRep_ function on the Blueprint if one does not
already exist.
Args:
blueprint: The Blueprint containing the variable.
variable_name: The name of the member variable to modify.
replication: Replication mode (NONE, REPLICATED, or REP_NOTIFY).
Input schema
{
"properties": {
"blueprint": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.Blueprint",
"type": "object"
},
"replication": {
"enum": [
"None",
"Replicated",
"RepNotify"
],
"title": "EBlueprintVariableReplication",
"type": "string"
},
"variable_name": {
"type": "string"
}
},
"required": [
"blueprint",
"variable_name",
"replication"
],
"type": "object"
}
editor_toolset.toolsets.blueprint.BlueprintTools.write_graph_dsl¶
Populates a Blueprint graph with nodes from a DSL script and compiles the Blueprint.
Call get_graph_dsl_docs() for the full syntax reference and examples.
Args:
graph: The graph to populate with nodes.
code: The S-expression DSL script to convert into Blueprint nodes.
Input schema
{
"properties": {
"code": {
"type": "string"
},
"graph": {
"description": "Represents a reference to a UObject or UClass.",
"properties": {
"refPath": {
"description": "The reference stored as a soft path string.",
"type": "string"
}
},
"required": [
"refPath"
],
"title": "/Script/Engine.EdGraph",
"type": "object"
}
},
"required": [
"graph",
"code"
],
"type": "object"
}