rig kit

112 tools. Generated from the plugin source; do not edit by hand.

Tools

Legend. risk 0 = read-only, 1 = harmless editor op, 2 = modifies asset, 3 = deletes/replaces asset, 4 = project/config/build op, 5 = potentially destructive (calls above MaxAutoRisk need "_confirm": true). mutates = runs in a transaction (edit.undo reverts). requires PIE / requires world = refused without a PIE session / an open level. requires plugin = unavailable while the plugin is disabled. dryRun = honours the dryRun argument. smoke = covered by edit.self_test.

rig.add_aim_template (risk 2, mutates, requires plugin ControlRig, smoke)

Aim template: a target control plus an Aim (AimItem) node that points a bone axis at it.

Argument	Type	Description
bone	string	required. Bone to aim.
controlName	string	Name of the created target control; empty = bone + '_aim'.
aimAxis	{x,y,z}	Bone-local axis that points at the target. Default FUeaVec3(1.0, 0.0, 0.0).
targetOffset	{x,y,z}	Initial target offset from the bone in rig space. Default FUeaVec3(100.0, 0.0, 0.0).
executeAfter	string	Optional node whose execute output starts the chain.
position	UeaRigVec2	Position of the first node.

Returns: graph, controls, nodes, links, entryPin, exitPin.

rig.add_animation_channel (risk 2, mutates, UE 5.1+, requires plugin ControlRig, smoke)

Adds an animation channel (an extra animatable value hosted by a control) on UE5.1+.

Argument	Type	Description
rig	string	required. Control Rig Blueprint object or package path.
name	string	required. Bare channel name.
parentControl	string	required. Host control name.
controlType	string	Channel type: bool, float, integer, vector2D, position, scale, rotator, scaleFloat (5.4+). Default TEXT("float").

Returns: control.

rig.add_array_pin (risk 2, mutates, requires plugin ControlRig, smoke)

Adds (index -1) or inserts an element pin into an array pin.

Argument	Type	Description
index	integer	Insert index; -1 appends. Default -1.
defaultValue	string	Default of the new element as exported text.

Returns: graph, pin, createdPin.

rig.add_available_space (risk 2, mutates, UE 5.5+, requires plugin ControlRig, smoke)

Adds a space to a control's space-switching list (UE5.5+).

Argument	Type	Description
space	string	required. Space element name.
spaceType	string	Space element type: bone, control or null. Default TEXT("bone").

Returns: control.

rig.add_bone (risk 2, mutates, requires plugin ControlRig, smoke)

Adds a user bone with an optional parent (bone by default; see parentType) and returns it with its transforms.

Argument	Type	Description
parent	string	Optional parent element name.
parentType	string	Parent type: bone (default), control, null (UE5). On UE4.27 bones take bone parents and controls take control or space parents. Default TEXT("bone").
controlType	string	add_control only: control type (bool, float, integer, vector2D, position, scale, rotator, transform, transformNoScale, eulerTransform, scaleFloat on UE5.4+). Default TEXT("transform").

Returns: element, transforms, children.

rig.add_bone_chain (risk 2, mutates, requires plugin ControlRig, smoke)

Adds a chain of bones, each offset from its predecessor, below an optional parent bone.

Argument	Type	Description
rig	string	required. Control Rig Blueprint object or package path.
names	array of string	required. Bare bone names, root of the chain first.
parent	string	Optional parent bone of the first chain bone.
offset	{x,y,z}	Local translation of each bone relative to its predecessor, in centimetres. Default FUeaVec3(0.0, 0.0, 20.0).

Returns: elements, count.

rig.add_branch_node (risk 2, mutates, requires plugin ControlRig, smoke)

Adds a Branch (if) node.

Argument	Type	Description
position	UeaRigVec2	Graph position.
nodeName	string	Requested node name.

Returns: graph, node.

rig.add_comment (risk 2, mutates, requires plugin ControlRig, smoke)

Adds a comment box.

Argument	Type	Description
text	string	required. Comment text.
position	UeaRigVec2	Graph position.
size	UeaRigVec2	Comment box size.
color	UeaRigColor	Comment colour.
nodeName	string	Requested node name.

Returns: graph, node.

rig.add_control (risk 2, mutates, requires plugin ControlRig, smoke)

Adds a control of any control type (default transform) with an optional parent and returns it. UE4.27 controls take control or space parents only.

Argument	Type	Description
parent	string	Optional parent element name.
parentType	string	Parent type: bone (default), control, null (UE5). On UE4.27 bones take bone parents and controls take control or space parents. Default TEXT("bone").
controlType	string	add_control only: control type (bool, float, integer, vector2D, position, scale, rotator, transform, transformNoScale, eulerTransform, scaleFloat on UE5.4+). Default TEXT("transform").

Returns: element, transforms, children.

rig.add_curve (risk 2, mutates, requires plugin ControlRig, smoke)

Adds a float curve element with an explicit initial value.

Argument	Type	Description
name	string	required. Bare curve name.
value	number	Initial curve value. Default 0.0.

Returns: element, transforms, children.

rig.add_fk_template (risk 2, mutates, requires plugin ControlRig, smoke)

FK template: one control per bone (at the bone pose) plus Get Transform -> Set Transform nodes chained by execution.

Argument	Type	Description
bones	array of string	required. Bones to drive, parents first. One control per bone is created at the bone's initial global transform.
controlSuffix	string	Suffix of the created control names. Default TEXT("_fk").
executeAfter	string	Optional node whose execute output starts the chain (e.g. the Forwards Solve event node).
position	UeaRigVec2	Position of the first node.

Returns: graph, controls, nodes, links, entryPin, exitPin.

rig.add_function (risk 2, mutates, UE 5.0+, requires plugin ControlRig, smoke)

Adds a function to the rig's local function library (UE5).

Argument	Type	Description
name	string	required. Function name.
mutable	boolean	add_function: the function has an execute pin (mutable). Default true.
position	UeaRigVec2	add_function: position in the function library.

Returns: functions, count.

rig.add_function_reference (risk 2, mutates, UE 5.0+, requires plugin ControlRig, smoke)

Adds a node that calls a local library function (UE5).

Argument	Type	Description
function	string	required. Local library function name.
position	UeaRigVec2	Graph position.
nodeName	string	Requested node name.

Returns: graph, node.

rig.add_member_variable (risk 2, mutates, requires plugin ControlRig, smoke)

Adds a blueprint member variable (bool, int, float, name, vector, rotator, transform) usable by variable nodes.

Argument	Type	Description
name	string	required. Bare variable name.
type	string	bool, int, float, name, vector, rotator or transform. Default TEXT("float").
public	boolean	Expose the variable on spawn / as a rig input. Default true.

Returns: variables, count.

rig.add_null (risk 2, mutates, UE 5.0+, requires plugin ControlRig, smoke)

Adds a null transform element with an optional parent. Available in UE 5.0 and later.

Argument	Type	Description
parent	string	Optional parent element name.
parentType	string	Parent type: bone (default), control, null (UE5). On UE4.27 bones take bone parents and controls take control or space parents. Default TEXT("bone").
controlType	string	add_control only: control type (bool, float, integer, vector2D, position, scale, rotator, transform, transformNoScale, eulerTransform, scaleFloat on UE5.4+). Default TEXT("transform").

Returns: element, transforms, children.

rig.add_parent (risk 2, mutates, UE 5.0+, requires plugin ControlRig, smoke)

Adds an extra weighted parent to an element (UE5 multi-parent space switching).

Argument	Type	Description
parent	string	required. Parent element name.
parentType	string	Parent element type: bone, control or null. Default TEXT("bone").
weight	UeaRigWeight	Weight of the relation (add_parent uses location as the single initial weight).
maintainGlobalTransform	boolean	Keep the child's global transform while changing relations. Default true.
initial	boolean	set_parent_weight: write the initial weight instead of the current one. Default true.

Returns: element, parents, count.

rig.add_socket (risk 2, mutates, UE 5.4+, requires plugin ControlRig, smoke)

Adds a socket (UE5.4+) below a parent element.

Argument	Type	Description
rig	string	required. Control Rig Blueprint object or package path.
name	string	required. Bare socket name.
parent	string	required. Parent element name.
parentType	string	Parent element type. Default TEXT("bone").
transform	UeaRigTransform	Socket transform relative to the parent.
description	string	Description shown by modular rigs.

Returns: element, transforms, children.

rig.add_two_bone_ik_template (risk 2, mutates, requires plugin ControlRig, smoke)

Two-bone IK template: an effector control plus a Basic IK (TwoBoneIKSimplePerItem) node driven by it.

Argument	Type	Description
itemA	string	required. Upper bone (e.g. upperarm).
itemB	string	required. Lower bone (e.g. lowerarm).
effector	string	required. Effector bone (e.g. hand).
controlName	string	Name of the created effector control; empty = effector + '_ik'.
poleVector	{x,y,z}	Pole vector in rig space. Default FUeaVec3(0.0, 100.0, 0.0).
executeAfter	string	Optional node whose execute output starts the chain.
position	UeaRigVec2	Position of the first node.

Returns: graph, controls, nodes, links, entryPin, exitPin.

rig.add_unit_node (risk 2, mutates, requires plugin ControlRig, smoke)

Adds a RigUnit node (struct path or unique name) and returns it with its pins.

Argument	Type	Description
unit	string	required. RigUnit struct path or unique name (see rig.search_rig_units).
method	string	Unit method. Default TEXT("Execute").
position	UeaRigVec2	Graph position.
nodeName	string	Requested node name (the engine makes it unique); empty lets the engine name it.

Returns: graph, node.

rig.add_variable_node (risk 2, mutates, requires plugin ControlRig, smoke)

Adds a Get or Set node for a member variable.

Argument	Type	Description
variable	string	required. Member variable name (see rig.add_member_variable).
isGetter	boolean	true = Get node, false = Set node. Default true.
position	UeaRigVec2	Graph position.
nodeName	string	Requested node name.

Returns: graph, node.

rig.audit_hierarchy (risk 0, requires plugin ControlRig, smoke)

Checks that every hierarchy element has a non-empty unique typed key.

Argument	Type	Description
rig	string	required. Control Rig Blueprint object or package path.

Returns: elements, count.

rig.audit_rigs (risk 0, requires plugin ControlRig, smoke)

Audits every Control Rig of a folder: compile status, preview mesh, hierarchy and graph counts, with problems listed per rig.

Argument	Type	Description
folder	string	Content folder searched recursively. Default TEXT("/Game").
nameContains	string	Optional case-insensitive asset-name fragment.
limit	integer	Maximum processed assets; 0 = unlimited. Default 100.

Returns: rigs, count, problemCount.

rig.break_pin_links (risk 2, mutates, requires plugin ControlRig, smoke)

Breaks every link of a pin.

Argument	Type	Description
asInput	boolean	Break the links that feed the pin (true) or leave it (false). Default true.

Returns: graph, links, count.

rig.clear_mapped_elements (risk 2, mutates, requires plugin ControlRig, requires world, smoke)

Removes every bone/curve mapping of a Control Rig component.

Argument	Type	Description
actor	string	required. Actor label or name (or class:).

Returns: component, changedActors.

rig.collapse_nodes (risk 2, mutates, UE 5.0+, requires plugin ControlRig, smoke)

Collapses nodes into a collapse node with its own graph (UE5).

Argument	Type	Description
nodes	array of string	Node names.
newName	string	collapse_nodes: requested name of the collapse node.

Returns: graph, node.

rig.compile_control_rig (risk 2, mutates, requires plugin ControlRig, smoke)

Compiles a Control Rig Blueprint so its generated class is usable by animation and Sequencer tools.

Argument	Type	Description
rig	string	required. Control Rig Blueprint object or package path.

Returns: rig.

rig.compile_rigs (risk 2, mutates, requires plugin ControlRig, smoke)

Compiles every Control Rig of a folder and reports per-rig status and message counts.

Argument	Type	Description
folder	string	Content folder searched recursively. Default TEXT("/Game").
nameContains	string	Optional case-insensitive asset-name fragment.
limit	integer	Maximum processed assets; 0 = unlimited. Default 100.

Returns: rigs, count, failedCount.

rig.connect_pins (risk 2, mutates, requires plugin ControlRig, smoke)

Links an output pin to an input pin.

Argument	Type	Description
source	string	required. Source (output) pin path.
target	string	required. Target (input) pin path.

Returns: graph, links, count.

rig.create_control_rig (risk 2, mutates, requires plugin ControlRig, smoke)

Creates an empty Control Rig Blueprint and returns its asset state.

Argument	Type	Description
folder	string	required. Destination content folder, beginning with /Game.
name	string	required. Bare asset name.

Returns: rig.

rig.disconnect_pins (risk 2, mutates, requires plugin ControlRig, smoke)

Removes the link between two pins.

Argument	Type	Description
source	string	required. Source (output) pin path.
target	string	required. Target (input) pin path.

Returns: graph, links, count.

rig.duplicate_element (risk 2, mutates, requires plugin ControlRig, smoke)

Duplicates one hierarchy element and returns the duplicated element key.

Argument	Type	Description
rig	string	required. Control Rig Blueprint object or package path.
name	string	required. Element name.
type	string	Element type: bone, control, curve, null (UE5), socket (UE5.4+) or space (UE4.27). Default TEXT("bone").

Returns: element, transforms, children.

rig.evaluate_rig_component (risk 1, mutates, requires plugin ControlRig, requires world, smoke)

Evaluates the rig instance of a Control Rig component once (forward solve) and returns its element counts.

Argument	Type	Description
deltaTime	number	Delta time passed to the rig update, in seconds. Default 0.0.

Returns: component, changedActors.

rig.expand_collapse_node (risk 2, mutates, UE 5.0+, requires plugin ControlRig, smoke)

Expands a collapse node back into its graph (UE5).

Argument	Type	Description
node	string	required. Node name.

Returns: graph, nodes, count.

rig.export_hierarchy (risk 0, requires plugin ControlRig, smoke)

Exports elements (all when 'elements' is empty) to the engine's hierarchy copy/paste text.

Argument	Type	Description
rig	string	required. Control Rig Blueprint object or package path.
elements	array of UeaRigElementRef	Elements; empty means every element (export) or clears the selection (select_elements).

Returns: text, count.

rig.export_nodes (risk 0, requires plugin ControlRig, smoke)

Exports nodes to the RigVM copy/paste text.

Argument	Type	Description
nodes	array of string	Node names.
newName	string	collapse_nodes: requested name of the collapse node.

Returns: text, count.

rig.find_elements (risk 0, requires plugin ControlRig, smoke)

Finds hierarchy elements by type and case-insensitive name fragment.

Argument	Type	Description
nameContains	string	Optional case-insensitive element-name fragment.
type	string	Optional exact element type such as bone, control, null, or curve.

Returns: elements, count.

rig.find_rigs_by_mesh (risk 0, requires plugin ControlRig, smoke)

Finds the Control Rigs whose preview mesh is (or shares the skeleton of) a skeletal mesh or skeleton.

Argument	Type	Description
mesh	string	required. Skeletal mesh or skeleton asset.
folder	string	Content folder searched recursively. Default TEXT("/Game").
matchSkeleton	boolean	Also match rigs whose preview mesh shares the skeleton of 'mesh'. Default true.

Returns: rigs, count.

rig.get_children (risk 0, requires plugin ControlRig, smoke)

Lists the children of an element, optionally recursively.

Argument	Type	Description
recursive	boolean	Include indirect relatives (grandparents / grandchildren). Default false.

Returns: elements, count.

rig.get_compile_errors (risk 2, mutates, requires plugin ControlRig, smoke)

Compiles the rig and returns its typed compiler messages.

Argument	Type	Description
rig	string	required. Control Rig Blueprint object or package path.

Returns: rig, errorCount, warningCount, messages.

rig.get_control_rig_info (risk 0, requires plugin ControlRig, smoke)

Gets Control Rig asset state, including its compiled class and hierarchy count.

Argument	Type	Description
rig	string	required. Control Rig Blueprint object or package path.

Returns: rig.

rig.get_control_settings (risk 0, requires plugin ControlRig, smoke)

Returns a control's full authored state: type, display name, shape, offset, limits, min/max, initial and current values, and available spaces.

Argument	Type	Description
rig	string	required. Control Rig Blueprint object or package path.
name	string	required. Control name.

Returns: control.

rig.get_control_value (risk 0, requires plugin ControlRig, smoke)

Reads one control value (kind: initial, current, minimum, maximum), typed by the control type.

Argument	Type	Description
kind	string	current or initial (setters); getters also accept minimum and maximum. Default TEXT("initial").
value	UeaRigControlValue	New value (setters).

Returns: element, kind, value.

rig.get_curve_value (risk 0, requires plugin ControlRig, smoke)

Reads the value of a curve element.

Argument	Type	Description
rig	string	required. Control Rig Blueprint object or package path.
name	string	required. Curve name.
value	number	New value (setter). Default 0.0.

Returns: name, value.

rig.get_element (risk 0, requires plugin ControlRig, smoke)

Gets one exact hierarchy element by type and name with its parent, children and initial/current local/global transforms.

Argument	Type	Description
rig	string	required. Control Rig Blueprint object or package path.
name	string	required. Element name.
type	string	Element type: bone, control, curve, null (UE5), socket (UE5.4+) or space (UE4.27). Default TEXT("bone").

Returns: element, transforms, children.

rig.get_element_metadata (risk 0, UE 5.1+, requires plugin ControlRig, smoke)

Lists the metadata names, types and values of an element (UE5.1+).

Argument	Type	Description
rig	string	required. Control Rig Blueprint object or package path.
name	string	required. Element name.
type	string	Element type: bone, control, curve, null (UE5), socket (UE5.4+) or space (UE4.27). Default TEXT("bone").

Returns: element, entries, count.

rig.get_global_transform (risk 0, requires plugin ControlRig, smoke)

Gets an element's global authored transform.

Argument	Type	Description
initial	boolean	Reads or writes the authored initial (setup pose) transform instead of the current transform. Default true.
transform	UeaRigTransform	New transform value for setter tools.
affectChildren	boolean	Propagates the transform change to children. UE4.27 always propagates; false is rejected there. Default true.

Returns: element, transform, transforms.

rig.get_local_transform (risk 0, requires plugin ControlRig, smoke)

Gets an element's local authored transform.

Argument	Type	Description
initial	boolean	Reads or writes the authored initial (setup pose) transform instead of the current transform. Default true.
transform	UeaRigTransform	New transform value for setter tools.
affectChildren	boolean	Propagates the transform change to children. UE4.27 always propagates; false is rejected there. Default true.

Returns: element, transform, transforms.

rig.get_node (risk 0, requires plugin ControlRig, smoke)

Returns one node with all its pins, defaults and links.

Argument	Type	Description
node	string	required. Node name.

Returns: graph, node.

rig.get_parents (risk 0, requires plugin ControlRig, smoke)

Lists the parents of an element with their weights (UE5 multi-parent; UE4.27 has one parent).

Argument	Type	Description
recursive	boolean	Include indirect relatives (grandparents / grandchildren). Default false.

Returns: element, parents, count.

rig.get_pin_default (risk 0, requires plugin ControlRig, smoke)

Reads one pin with its default value and links.

Argument	Type	Description
pin	string	required. Pin path (Node.Pin or Node.Pin.SubPin).

Returns: graph, pin, createdPin.

rig.get_pose (risk 0, requires plugin ControlRig, smoke)

Returns initial/current local/global transforms of every element (optionally one type).

Argument	Type	Description
type	string	Optional element type filter.

Returns: entries, count.

rig.get_rig_component_bone (risk 0, requires plugin ControlRig, requires world, smoke)

Reads a bone transform of the running rig in world, actor, component or rig space.

Argument	Type	Description
bone	string	required. Bone name.
space	string	worldSpace, actorSpace, componentSpace or rigSpace. Default TEXT("rigSpace").
initial	boolean	Read the initial (reference) transform instead of the current one (getter). Default false.
transform	UeaRigTransform	New transform (setter).
weight	number	Blend weight of the write (setter). Default 1.0.
propagateToChildren	boolean	Propagate the write to children (setter). Default true.

Returns: name, space, transform.

rig.get_rig_component_control (risk 0, requires plugin ControlRig, requires world, smoke)

Reads a control of the running rig (transform, float, bool, int, vector2D, position, rotator or scale).

Argument	Type	Description
control	string	required. Control name.
valueKind	string	Value kind: transform, float, bool, int, vector2D, position, rotator, scale. Default TEXT("transform").
space	string	Space for transform/position/rotator/scale: worldSpace, actorSpace, componentSpace, rigSpace, localSpace. Default TEXT("rigSpace").
number	number	Scalar value (float, bool 0/1, int). Default 0.0.
vector	{x,y,z}	Vector value (vector2D x/y, position, rotator pitch/yaw/roll, scale).
transform	UeaRigTransform	Transform value.

Returns: control, valueKind, number, vector, transform.

rig.get_rig_component_elements (risk 0, requires plugin ControlRig, requires world, smoke)

Lists the element names of the running rig by type.

Argument	Type	Description
type	string	bone, control, curve, null (UE5) or space (UE4.27). Default TEXT("bone").

Returns: names, count.

rig.get_selection (risk 0, requires plugin ControlRig, smoke)

Returns the elements selected in the Control Rig editor.

Argument	Type	Description
rig	string	required. Control Rig Blueprint object or package path.

Returns: elements, count.

rig.import_bones (risk 2, mutates, requires plugin ControlRig, smoke)

Imports the bone hierarchy of a skeletal mesh or skeleton into the rig.

Argument	Type	Description
rig	string	required. Control Rig Blueprint object or package path.
source	string	required. Skeletal mesh or skeleton asset.
replaceExisting	boolean	Replace bones that already exist (updating their transforms). Default false.
removeObsolete	boolean	Remove bones that do not exist in the source. Default false.

Returns: elements, count.

rig.import_hierarchy (risk 2, mutates, requires plugin ControlRig, smoke)

Imports hierarchy text (from rig.export_hierarchy) or copies elements from another rig.

Argument	Type	Description
rig	string	required. Target Control Rig Blueprint.
text	string	Hierarchy text from rig.export_hierarchy. Set either text or sourceRig.
sourceRig	string	Rig to copy elements from (exported and imported in one call).
sourceElements	array of UeaRigElementRef	Elements of sourceRig to copy; empty copies all of them.
replaceExisting	boolean	Replace elements with the same name instead of creating uniquely named copies. Default false.

Returns: elements, count.

rig.import_nodes (risk 2, mutates, requires plugin ControlRig, smoke)

Imports node text, or copies nodes from another rig graph, into a graph.

Argument	Type	Description
text	string	Node text from rig.export_nodes. Set either text or sourceRig.
sourceRig	string	Rig to copy nodes from.
sourceGraph	string	Graph of sourceRig (empty = main graph).
sourceNodes	array of string	Node names in the source graph.

Returns: graph, nodes, count.

rig.list_bones (risk 0, requires plugin ControlRig, smoke)

Lists only hierarchy bones.

Argument	Type	Description
rig	string	required. Control Rig Blueprint object or package path.

Returns: elements, count.

rig.list_control_rigs (risk 0, requires plugin ControlRig, smoke)

Lists Control Rig Blueprint assets under a content folder.

Argument	Type	Description
folder	string	Content folder to search. Default TEXT("/Game").
nameContains	string	Optional case-insensitive asset-name fragment.
limit	integer	Maximum returned assets; zero means no limit. Default 100.

Returns: rigs, count.

rig.list_control_shapes (risk 0, requires plugin ControlRig, smoke)

Lists the shape names available to controls from the rig's shape (gizmo) libraries.

Argument	Type	Description
rig	string	required. Control Rig Blueprint object or package path.

Returns: libraries, shapes, count.

rig.list_controls (risk 0, requires plugin ControlRig, smoke)

Lists only hierarchy controls.

Argument	Type	Description
rig	string	required. Control Rig Blueprint object or package path.

Returns: elements, count.

rig.list_curves (risk 0, requires plugin ControlRig, smoke)

Lists UE5 curve elements.

Argument	Type	Description
rig	string	required. Control Rig Blueprint object or package path.

Returns: elements, count.

rig.list_functions (risk 0, UE 5.0+, requires plugin ControlRig, smoke)

Lists the functions of the rig's local function library (UE5).

Argument	Type	Description
rig	string	required. Control Rig Blueprint object or package path.

Returns: functions, count.

rig.list_graphs (risk 0, requires plugin ControlRig, smoke)

Lists the RigVM graphs of a rig (main graph, collapse and function graphs, function library).

Argument	Type	Description
rig	string	required. Control Rig Blueprint object or package path.

Returns: graphs, count.

rig.list_hierarchy (risk 0, requires plugin ControlRig, smoke)

Lists the elements in a Control Rig hierarchy.

Argument	Type	Description
rig	string	required. Control Rig Blueprint object or package path.

Returns: elements, count.

rig.list_links (risk 0, requires plugin ControlRig, smoke)

Lists every link of a graph as source/target pin paths.

Argument	Type	Description
rig	string	required. Control Rig Blueprint object or package path.
graph	string	Graph path from rig.list_graphs (function or collapse graph, UE5); empty = the rig's main graph.

Returns: graph, links, count.

rig.list_nodes (risk 0, requires plugin ControlRig, smoke)

Lists the nodes of a graph, optionally filtered and with pins.

Argument	Type	Description
nameContains	string	Optional case-insensitive fragment of the node name, title or unit.
includePins	boolean	Include every pin of every node. Default false.

Returns: graph, nodes, count.

rig.list_nulls (risk 0, UE 5.0+, requires plugin ControlRig, smoke)

Lists UE5 null transform elements.

Argument	Type	Description
rig	string	required. Control Rig Blueprint object or package path.

Returns: elements, count.

rig.list_rig_components (risk 0, requires plugin ControlRig, requires world, smoke)

Lists the Control Rig components in the editor world.

Argument	Type	Description
rig	string	Optional Control Rig Blueprint: only components running its generated class.

Returns: components, count.

rig.map_skeletal_mesh (risk 2, mutates, requires plugin ControlRig, requires world, smoke)

Maps every bone of an actor's skeletal mesh component to the rig so evaluation drives the mesh.

Argument	Type	Description
meshActor	string	Actor that owns the skeletal mesh component; empty = the rig actor itself.

Returns: component, changedActors.

rig.mirror_elements (risk 2, mutates, requires plugin ControlRig, smoke)

Mirrors elements across an axis, renaming them with search/replace (e.g. _l to _r).

Argument	Type	Description
rig	string	required. Control Rig Blueprint object or package path.
elements	array of UeaRigElementRef	required. Elements to mirror.
mirrorAxis	string	Mirror plane normal axis: x, y or z. Default TEXT("x").
axisToFlip	string	Axis to flip: x, y or z. Default TEXT("z").
search	string	Name fragment to replace in the mirrored names (e.g. _l).
replace	string	Replacement fragment (e.g. _r).

Returns: elements, count.

rig.remove_array_pin (risk 2, mutates, requires plugin ControlRig, smoke)

Removes an element pin from an array pin.

Argument	Type	Description
pin	string	required. Pin path (Node.Pin or Node.Pin.SubPin).

Returns: graph, pin, createdPin.

rig.remove_available_space (risk 2, mutates, UE 5.5+, requires plugin ControlRig, smoke)

Removes a space from a control's space-switching list (UE5.5+).

Argument	Type	Description
space	string	required. Space element name.
spaceType	string	Space element type: bone, control or null. Default TEXT("bone").

Returns: control.

rig.remove_element (risk 3, mutates, destructive, requires plugin ControlRig, smoke)

Removes one hierarchy element. This can remove dependent hierarchy content.

Argument	Type	Description
rig	string	required. Control Rig Blueprint object or package path.
name	string	required. Element name.
type	string	Element type: bone, control, curve, null (UE5), socket (UE5.4+) or space (UE4.27). Default TEXT("bone").

Returns: elements, count.

rig.remove_element_metadata (risk 2, mutates, UE 5.1+, requires plugin ControlRig, smoke)

Removes one metadata entry from an element (UE5.1+).

Argument	Type	Description
metadataName	string	required. Metadata name.
metadataType	string	bool, float, int32, name, vector, rotator, transform or linearColor. Default TEXT("float").
number	number	Value for bool (0/1), float and int32. Default 0.0.
text	string	Value for name.
vector	{x,y,z}	Value for vector and rotator (pitch, yaw, roll).
transform	UeaRigTransform	Value for transform.
color	UeaRigColor	Value for linearColor.

Returns: element, entries, count.

rig.remove_function (risk 3, mutates, destructive, UE 5.0+, requires plugin ControlRig, smoke)

Removes a local library function (UE5); nodes that reference it are removed by the engine.

Argument	Type	Description
name	string	required. Function name.
mutable	boolean	add_function: the function has an execute pin (mutable). Default true.
position	UeaRigVec2	add_function: position in the function library.

Returns: functions, count.

rig.remove_node (risk 3, mutates, destructive, requires plugin ControlRig, smoke)

Removes a node and its links.

Argument	Type	Description
node	string	required. Node name.

Returns: graph, nodes, count.

rig.remove_parent (risk 2, mutates, UE 5.0+, requires plugin ControlRig, smoke)

Removes one parent relation of an element (UE5 multi-parent).

Argument	Type	Description
parent	string	required. Parent element name.
parentType	string	Parent element type: bone, control or null. Default TEXT("bone").
weight	UeaRigWeight	Weight of the relation (add_parent uses location as the single initial weight).
maintainGlobalTransform	boolean	Keep the child's global transform while changing relations. Default true.
initial	boolean	set_parent_weight: write the initial weight instead of the current one. Default true.

Returns: element, parents, count.

rig.remove_rig_actor (risk 3, mutates, destructive, requires plugin ControlRig, requires world, smoke)

Destroys an actor that carries a Control Rig component (exact label or name; refuses actors without one).

Argument	Type	Description
actor	string	required. Actor label or name (or class:).

Returns: component, changedActors.

rig.rename_element (risk 2, mutates, requires plugin ControlRig, smoke)

Renames a hierarchy element and returns its new key.

Argument	Type	Description
newName	string	required. New bare element name.

Returns: element, transforms, children.

rig.rename_node (risk 2, mutates, UE 5.0+, requires plugin ControlRig, smoke)

Renames a node (UE5).

Argument	Type	Description
newName	string	required. New node name.

Returns: graph, node.

rig.reorder_element (risk 2, mutates, UE 5.2+, requires plugin ControlRig, smoke)

Moves an element to another index among its siblings (UE5.2+).

Argument	Type	Description
index	integer	New index among the siblings. Default 0.

Returns: elements, count.

rig.reparent_element (risk 2, mutates, requires plugin ControlRig, smoke)

Replaces the parent of an element; an empty parent makes it a root element (UE5 removes all parents).

Argument	Type	Description
parent	string	New parent name, or empty to clear the parent.
parentType	string	New parent type: bone, control, or null (UE5). Default TEXT("bone").
maintainGlobalTransform	boolean	Preserves global location while changing the hierarchy parent. UE4.27 always preserves it; false is rejected there. Default true.

Returns: element, transforms, children.

rig.reset_pin_default (risk 2, mutates, requires plugin ControlRig, smoke)

Restores a pin's default to the unit default.

Argument	Type	Description
pin	string	required. Pin path (Node.Pin or Node.Pin.SubPin).

Returns: graph, pin, createdPin.

rig.reset_pose (risk 2, mutates, requires plugin ControlRig, smoke)

Resets every current transform to the initial (setup) pose.

Argument	Type	Description
rig	string	required. Control Rig Blueprint object or package path.

Returns: entries, count.

rig.search_rig_units (risk 0, requires plugin ControlRig, smoke)

Searches the loaded RigUnit structs usable by rig.add_unit_node.

Argument	Type	Description
nameContains	string	Optional case-insensitive fragment of the struct name, display name or category.
limit	integer	Maximum results; 0 = unlimited. Default 100.

Returns: units, count.

rig.select_elements (risk 1, mutates, requires plugin ControlRig, smoke)

Replaces the editor selection with the given elements (empty clears it).

Argument	Type	Description
rig	string	required. Control Rig Blueprint object or package path.
elements	array of UeaRigElementRef	Elements; empty means every element (export) or clears the selection (select_elements).

Returns: elements, count.

rig.select_nodes (risk 1, mutates, requires plugin ControlRig, smoke)

Replaces the node selection of the graph (empty clears it).

Argument	Type	Description
nodes	array of string	Node names.
newName	string	collapse_nodes: requested name of the collapse node.

Returns: graph, nodes, count.

rig.set_array_pin_size (risk 2, mutates, requires plugin ControlRig, smoke)

Sets the element count of an array pin.

Argument	Type	Description
size	integer	New element count. Default 0.
defaultValue	string	Default of added elements as exported text.

Returns: graph, pin, createdPin.

rig.set_comment_text (risk 2, mutates, requires plugin ControlRig, smoke)

Changes a comment's text (and UE5 font size / bubble options).

Argument	Type	Description
text	string	required. New comment text.
fontSize	integer	UE5 font size. Default 18.
bubbleVisible	boolean	UE5 show the comment bubble. Default false.
colorBubble	boolean	UE5 colour the comment bubble. Default false.

Returns: graph, node.

rig.set_control_animation_type (risk 2, mutates, UE 5.1+, requires plugin ControlRig, smoke)

Sets the UE5.1+ animation type of a control (animationControl, animationChannel, proxyControl, visualCue).

Argument	Type	Description
animationType	string	required. animationControl, animationChannel, proxyControl or visualCue.

Returns: control.

rig.set_control_display_name (risk 2, mutates, requires plugin ControlRig, smoke)

Sets the display name the editor and Sequencer show for a control.

Argument	Type	Description
displayName	string	New display name (empty clears it).

Returns: control.

rig.set_control_limits (risk 2, mutates, requires plugin ControlRig, smoke)

Enables translation/rotation/scale limits and writes the minimum and maximum values of a control.

Argument	Type	Description
limitTranslation	boolean	Limit translation (or the single channel of float/integer/vector2D controls). Default false.
limitRotation	boolean	Limit rotation channels. Default false.
limitScale	boolean	Limit scale channels. Default false.
drawLimits	boolean	Draw the limits in the viewport. Default true.
minimum	UeaRigControlValue	Minimum value, typed like the control.
maximum	UeaRigControlValue	Maximum value, typed like the control.

Returns: control.

rig.set_control_offset (risk 2, mutates, requires plugin ControlRig, smoke)

Sets a control's offset transform (the frame between its parent and the control).

Argument	Type	Description
transform	UeaRigTransform	New offset transform relative to the parent.
initial	boolean	Writes the initial offset (UE4.27 stores one offset; false is rejected there). Default true.

Returns: control.

rig.set_control_shape (risk 2, mutates, requires plugin ControlRig, smoke)

Changes a control's shape name, colour, visibility and/or shape transform.

Argument	Type	Description
shapeName	string	New shape name from the rig's shape library (see rig.list_control_shapes); empty leaves it unchanged.
applyColor	boolean	Apply 'color'. Default false.
color	UeaRigColor	New shape colour.
visibility	string	visible, hidden, or empty to leave visibility unchanged.
applyTransform	boolean	Apply 'transform'. Default false.
transform	UeaRigTransform	New initial shape transform relative to the control.

Returns: control.

rig.set_control_value (risk 2, mutates, requires plugin ControlRig, smoke)

Writes the initial or current value of a control; the field matching the control type is used.

Argument	Type	Description
kind	string	current or initial (setters); getters also accept minimum and maximum. Default TEXT("initial").
value	UeaRigControlValue	New value (setters).

Returns: element, kind, value.

rig.set_curve_value (risk 2, mutates, requires plugin ControlRig, smoke)

Writes the value of a curve element.

Argument	Type	Description
rig	string	required. Control Rig Blueprint object or package path.
name	string	required. Curve name.
value	number	New value (setter). Default 0.0.

Returns: name, value.

rig.set_element_metadata (risk 2, mutates, UE 5.1+, requires plugin ControlRig, smoke)

Writes one typed metadata value on an element (UE5.1+).

Argument	Type	Description
metadataName	string	required. Metadata name.
metadataType	string	bool, float, int32, name, vector, rotator, transform or linearColor. Default TEXT("float").
number	number	Value for bool (0/1), float and int32. Default 0.0.
text	string	Value for name.
vector	{x,y,z}	Value for vector and rotator (pitch, yaw, roll).
transform	UeaRigTransform	Value for transform.
color	UeaRigColor	Value for linearColor.

Returns: element, entries, count.

rig.set_global_transform (risk 2, mutates, requires plugin ControlRig, smoke)

Sets an element's global authored transform.

Argument	Type	Description
initial	boolean	Reads or writes the authored initial (setup pose) transform instead of the current transform. Default true.
transform	UeaRigTransform	New transform value for setter tools.
affectChildren	boolean	Propagates the transform change to children. UE4.27 always propagates; false is rejected there. Default true.

Returns: element, transform, transforms.

rig.set_local_transform (risk 2, mutates, requires plugin ControlRig, smoke)

Sets an element's local authored transform.

Argument	Type	Description
initial	boolean	Reads or writes the authored initial (setup pose) transform instead of the current transform. Default true.
transform	UeaRigTransform	New transform value for setter tools.
affectChildren	boolean	Propagates the transform change to children. UE4.27 always propagates; false is rejected there. Default true.

Returns: element, transform, transforms.

rig.set_node_color (risk 2, mutates, requires plugin ControlRig, smoke)

Recolours a node.

Argument	Type	Description
color	UeaRigColor	New node colour.

Returns: graph, node.

rig.set_node_position (risk 2, mutates, requires plugin ControlRig, smoke)

Moves a node.

Argument	Type	Description
value	UeaRigVec2	New position (set_node_position) or size (set_node_size).

Returns: graph, node.

rig.set_node_size (risk 2, mutates, requires plugin ControlRig, smoke)

Resizes a node (mostly comment boxes).

Argument	Type	Description
value	UeaRigVec2	New position (set_node_position) or size (set_node_size).

Returns: graph, node.

rig.set_parent_weight (risk 2, mutates, UE 5.0+, requires plugin ControlRig, smoke)

Sets the per-channel weight of an existing parent relation (UE5).

Argument	Type	Description
parent	string	required. Parent element name.
parentType	string	Parent element type: bone, control or null. Default TEXT("bone").
weight	UeaRigWeight	Weight of the relation (add_parent uses location as the single initial weight).
maintainGlobalTransform	boolean	Keep the child's global transform while changing relations. Default true.
initial	boolean	set_parent_weight: write the initial weight instead of the current one. Default true.

Returns: element, parents, count.

rig.set_pin_default (risk 2, mutates, requires plugin ControlRig, smoke)

Writes a pin default value as exported text.

Argument	Type	Description
value	string	New default as exported text (e.g. 0.5, (X=1,Y=0,Z=0), (Type=Bone,Name="hand_l")).
resizeArrays	boolean	Resize array pins to match an array value. Default true.

Returns: graph, pin, createdPin.

rig.set_pin_expansion (risk 1, mutates, requires plugin ControlRig, smoke)

Expands or collapses a struct or array pin in the editor.

Argument	Type	Description
expanded	boolean	Expanded state. Default true.

Returns: graph, pin, createdPin.

rig.set_preview_mesh (risk 2, mutates, requires plugin ControlRig, smoke)

Assigns a skeletal mesh as the editor preview mesh and returns updated state.

Argument	Type	Description
skeletalMesh	string	required. Skeletal mesh asset used as the rig preview mesh.

Returns: rig.

rig.set_rig_component_bone (risk 1, mutates, requires plugin ControlRig, requires world, smoke)

Writes a bone transform of the running rig.

Argument	Type	Description
bone	string	required. Bone name.
space	string	worldSpace, actorSpace, componentSpace or rigSpace. Default TEXT("rigSpace").
initial	boolean	Read the initial (reference) transform instead of the current one (getter). Default false.
transform	UeaRigTransform	New transform (setter).
weight	number	Blend weight of the write (setter). Default 1.0.
propagateToChildren	boolean	Propagate the write to children (setter). Default true.

Returns: name, space, transform.

rig.set_rig_component_control (risk 1, mutates, requires plugin ControlRig, requires world, smoke)

Drives a control of the running rig.

Argument	Type	Description
control	string	required. Control name.
valueKind	string	Value kind: transform, float, bool, int, vector2D, position, rotator, scale. Default TEXT("transform").
space	string	Space for transform/position/rotator/scale: worldSpace, actorSpace, componentSpace, rigSpace, localSpace. Default TEXT("rigSpace").
number	number	Scalar value (float, bool 0/1, int). Default 0.0.
vector	{x,y,z}	Vector value (vector2D x/y, position, rotator pitch/yaw/roll, scale).
transform	UeaRigTransform	Transform value.

Returns: control, valueKind, number, vector, transform.

rig.spawn_rig_actor (risk 2, mutates, requires plugin ControlRig, requires world, smoke)

Spawns an actor with a Control Rig component running a compiled rig, optionally with a mapped skeletal mesh.

Argument	Type	Description
rig	string	required. Compiled Control Rig Blueprint whose generated class the component runs.
label	string	Actor label. Default TEXT("ControlRigActor").
location	{x,y,z}	World location in centimetres.
skeletalMesh	string	Optional skeletal mesh shown by the actor and driven by the rig (all bones mapped).

Returns: component, changedActors.

rig.validate_hierarchy (risk 0, requires plugin ControlRig, smoke)

Checks the hierarchy for missing parents, degenerate transforms, duplicate display names and empty names.

Argument	Type	Description
rig	string	required. Control Rig Blueprint object or package path.

Returns: valid, issues, errorCount, warningCount, elementCount.