Kit rig

112 ferramentas. Gerado a partir do código-fonte do plugin; não edite manualmente.

As descrições das ferramentas e dos argumentos são exibidas em inglês porque espelham o schema das ferramentas (o mesmo texto que o agente recebe em tools/list).

Ferramentas

Legenda. risco 0 = somente leitura, 1 = operação inofensiva do editor, 2 = altera asset, 3 = apaga/substitui asset, 4 = projeto/config/build, 5 = potencialmente destrutivo (chamadas acima de MaxAutoRisk exigem "_confirm": true). altera = roda numa transação (edit.undo reverte). requer PIE / requer mundo = recusado sem sessão PIE / sem nível aberto. requer plugin = indisponível quando o plugin está desativado. dryRun = aceita o argumento dryRun. smoke = coberto por edit.self_test.

rig.add_aim_template (risco 2, altera, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
bone	string	obrigatório. 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. Padrão FUeaVec3(1.0, 0.0, 0.0).
targetOffset	{x,y,z}	Initial target offset from the bone in rig space. Padrão FUeaVec3(100.0, 0.0, 0.0).
executeAfter	string	Optional node whose execute output starts the chain.
position	UeaRigVec2	Position of the first node.

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

rig.add_animation_channel (risco 2, altera, UE 5.1+, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
rig	string	obrigatório. Control Rig Blueprint object or package path.
name	string	obrigatório. Bare channel name.
parentControl	string	obrigatório. Host control name.
controlType	string	Channel type: bool, float, integer, vector2D, position, scale, rotator, scaleFloat (5.4+). Padrão TEXT("float").

Retorna: control.

rig.add_array_pin (risco 2, altera, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
index	integer	Insert index; -1 appends. Padrão -1.
defaultValue	string	Default of the new element as exported text.

Retorna: graph, pin, createdPin.

rig.add_available_space (risco 2, altera, UE 5.5+, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
space	string	obrigatório. Space element name.
spaceType	string	Space element type: bone, control or null. Padrão TEXT("bone").

Retorna: control.

rig.add_bone (risco 2, altera, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
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. Padrão TEXT("bone").
controlType	string	add_control only: control type (bool, float, integer, vector2D, position, scale, rotator, transform, transformNoScale, eulerTransform, scaleFloat on UE5.4+). Padrão TEXT("transform").

Retorna: element, transforms, children.

rig.add_bone_chain (risco 2, altera, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
rig	string	obrigatório. Control Rig Blueprint object or package path.
names	array of string	obrigatório. 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. Padrão FUeaVec3(0.0, 0.0, 20.0).

Retorna: elements, count.

rig.add_branch_node (risco 2, altera, requer plugin ControlRig, smoke)

Adds a Branch (if) node.

Argumento	Tipo	Descrição
position	UeaRigVec2	Graph position.
nodeName	string	Requested node name.

Retorna: graph, node.

rig.add_comment (risco 2, altera, requer plugin ControlRig, smoke)

Adds a comment box.

Argumento	Tipo	Descrição
text	string	obrigatório. Comment text.
position	UeaRigVec2	Graph position.
size	UeaRigVec2	Comment box size.
color	UeaRigColor	Comment colour.
nodeName	string	Requested node name.

Retorna: graph, node.

rig.add_control (risco 2, altera, requer 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.

Argumento	Tipo	Descrição
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. Padrão TEXT("bone").
controlType	string	add_control only: control type (bool, float, integer, vector2D, position, scale, rotator, transform, transformNoScale, eulerTransform, scaleFloat on UE5.4+). Padrão TEXT("transform").

Retorna: element, transforms, children.

rig.add_curve (risco 2, altera, requer plugin ControlRig, smoke)

Adds a float curve element with an explicit initial value.

Argumento	Tipo	Descrição
name	string	obrigatório. Bare curve name.
value	number	Initial curve value. Padrão 0.0.

Retorna: element, transforms, children.

rig.add_fk_template (risco 2, altera, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
bones	array of string	obrigatório. 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. Padrão 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.

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

rig.add_function (risco 2, altera, UE 5.0+, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
name	string	obrigatório. Function name.
mutable	boolean	add_function: the function has an execute pin (mutable). Padrão true.
position	UeaRigVec2	add_function: position in the function library.

Retorna: functions, count.

rig.add_function_reference (risco 2, altera, UE 5.0+, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
function	string	obrigatório. Local library function name.
position	UeaRigVec2	Graph position.
nodeName	string	Requested node name.

Retorna: graph, node.

rig.add_member_variable (risco 2, altera, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
name	string	obrigatório. Bare variable name.
type	string	bool, int, float, name, vector, rotator or transform. Padrão TEXT("float").
public	boolean	Expose the variable on spawn / as a rig input. Padrão true.

Retorna: variables, count.

rig.add_null (risco 2, altera, UE 5.0+, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
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. Padrão TEXT("bone").
controlType	string	add_control only: control type (bool, float, integer, vector2D, position, scale, rotator, transform, transformNoScale, eulerTransform, scaleFloat on UE5.4+). Padrão TEXT("transform").

Retorna: element, transforms, children.

rig.add_parent (risco 2, altera, UE 5.0+, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
parent	string	obrigatório. Parent element name.
parentType	string	Parent element type: bone, control or null. Padrão 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. Padrão true.
initial	boolean	set_parent_weight: write the initial weight instead of the current one. Padrão true.

Retorna: element, parents, count.

rig.add_socket (risco 2, altera, UE 5.4+, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
rig	string	obrigatório. Control Rig Blueprint object or package path.
name	string	obrigatório. Bare socket name.
parent	string	obrigatório. Parent element name.
parentType	string	Parent element type. Padrão TEXT("bone").
transform	UeaRigTransform	Socket transform relative to the parent.
description	string	Description shown by modular rigs.

Retorna: element, transforms, children.

rig.add_two_bone_ik_template (risco 2, altera, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
itemA	string	obrigatório. Upper bone (e.g. upperarm).
itemB	string	obrigatório. Lower bone (e.g. lowerarm).
effector	string	obrigatório. 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. Padrão FUeaVec3(0.0, 100.0, 0.0).
executeAfter	string	Optional node whose execute output starts the chain.
position	UeaRigVec2	Position of the first node.

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

rig.add_unit_node (risco 2, altera, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
unit	string	obrigatório. RigUnit struct path or unique name (see rig.search_rig_units).
method	string	Unit method. Padrão TEXT("Execute").
position	UeaRigVec2	Graph position.
nodeName	string	Requested node name (the engine makes it unique); empty lets the engine name it.

Retorna: graph, node.

rig.add_variable_node (risco 2, altera, requer plugin ControlRig, smoke)

Adds a Get or Set node for a member variable.

Argumento	Tipo	Descrição
variable	string	obrigatório. Member variable name (see rig.add_member_variable).
isGetter	boolean	true = Get node, false = Set node. Padrão true.
position	UeaRigVec2	Graph position.
nodeName	string	Requested node name.

Retorna: graph, node.

rig.audit_hierarchy (risco 0, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
rig	string	obrigatório. Control Rig Blueprint object or package path.

Retorna: elements, count.

rig.audit_rigs (risco 0, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
folder	string	Content folder searched recursively. Padrão TEXT("/Game").
nameContains	string	Optional case-insensitive asset-name fragment.
limit	integer	Maximum processed assets; 0 = unlimited. Padrão 100.

Retorna: rigs, count, problemCount.

rig.break_pin_links (risco 2, altera, requer plugin ControlRig, smoke)

Breaks every link of a pin.

Argumento	Tipo	Descrição
asInput	boolean	Break the links that feed the pin (true) or leave it (false). Padrão true.

Retorna: graph, links, count.

rig.clear_mapped_elements (risco 2, altera, requer plugin ControlRig, requer mundo, smoke)

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

Argumento	Tipo	Descrição
actor	string	obrigatório. Actor label or name (or class:).

Retorna: component, changedActors.

rig.collapse_nodes (risco 2, altera, UE 5.0+, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
nodes	array of string	Node names.
newName	string	collapse_nodes: requested name of the collapse node.

Retorna: graph, node.

rig.compile_control_rig (risco 2, altera, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
rig	string	obrigatório. Control Rig Blueprint object or package path.

Retorna: rig.

rig.compile_rigs (risco 2, altera, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
folder	string	Content folder searched recursively. Padrão TEXT("/Game").
nameContains	string	Optional case-insensitive asset-name fragment.
limit	integer	Maximum processed assets; 0 = unlimited. Padrão 100.

Retorna: rigs, count, failedCount.

rig.connect_pins (risco 2, altera, requer plugin ControlRig, smoke)

Links an output pin to an input pin.

Argumento	Tipo	Descrição
source	string	obrigatório. Source (output) pin path.
target	string	obrigatório. Target (input) pin path.

Retorna: graph, links, count.

rig.create_control_rig (risco 2, altera, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
folder	string	obrigatório. Destination content folder, beginning with /Game.
name	string	obrigatório. Bare asset name.

Retorna: rig.

rig.disconnect_pins (risco 2, altera, requer plugin ControlRig, smoke)

Removes the link between two pins.

Argumento	Tipo	Descrição
source	string	obrigatório. Source (output) pin path.
target	string	obrigatório. Target (input) pin path.

Retorna: graph, links, count.

rig.duplicate_element (risco 2, altera, requer plugin ControlRig, smoke)

Duplicates one hierarchy element and returns the duplicated element key.

Argumento	Tipo	Descrição
rig	string	obrigatório. Control Rig Blueprint object or package path.
name	string	obrigatório. Element name.
type	string	Element type: bone, control, curve, null (UE5), socket (UE5.4+) or space (UE4.27). Padrão TEXT("bone").

Retorna: element, transforms, children.

rig.evaluate_rig_component (risco 1, altera, requer plugin ControlRig, requer mundo, smoke)

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

Argumento	Tipo	Descrição
deltaTime	number	Delta time passed to the rig update, in seconds. Padrão 0.0.

Retorna: component, changedActors.

rig.expand_collapse_node (risco 2, altera, UE 5.0+, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
node	string	obrigatório. Node name.

Retorna: graph, nodes, count.

rig.export_hierarchy (risco 0, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
rig	string	obrigatório. Control Rig Blueprint object or package path.
elements	array of UeaRigElementRef	Elements; empty means every element (export) or clears the selection (select_elements).

Retorna: text, count.

rig.export_nodes (risco 0, requer plugin ControlRig, smoke)

Exports nodes to the RigVM copy/paste text.

Argumento	Tipo	Descrição
nodes	array of string	Node names.
newName	string	collapse_nodes: requested name of the collapse node.

Retorna: text, count.

rig.find_elements (risco 0, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
nameContains	string	Optional case-insensitive element-name fragment.
type	string	Optional exact element type such as bone, control, null, or curve.

Retorna: elements, count.

rig.find_rigs_by_mesh (risco 0, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
mesh	string	obrigatório. Skeletal mesh or skeleton asset.
folder	string	Content folder searched recursively. Padrão TEXT("/Game").
matchSkeleton	boolean	Also match rigs whose preview mesh shares the skeleton of 'mesh'. Padrão true.

Retorna: rigs, count.

rig.get_children (risco 0, requer plugin ControlRig, smoke)

Lists the children of an element, optionally recursively.

Argumento	Tipo	Descrição
recursive	boolean	Include indirect relatives (grandparents / grandchildren). Padrão false.

Retorna: elements, count.

rig.get_compile_errors (risco 2, altera, requer plugin ControlRig, smoke)

Compiles the rig and returns its typed compiler messages.

Argumento	Tipo	Descrição
rig	string	obrigatório. Control Rig Blueprint object or package path.

Retorna: rig, errorCount, warningCount, messages.

rig.get_control_rig_info (risco 0, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
rig	string	obrigatório. Control Rig Blueprint object or package path.

Retorna: rig.

rig.get_control_settings (risco 0, requer 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.

Argumento	Tipo	Descrição
rig	string	obrigatório. Control Rig Blueprint object or package path.
name	string	obrigatório. Control name.

Retorna: control.

rig.get_control_value (risco 0, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
kind	string	current or initial (setters); getters also accept minimum and maximum. Padrão TEXT("initial").
value	UeaRigControlValue	New value (setters).

Retorna: element, kind, value.

rig.get_curve_value (risco 0, requer plugin ControlRig, smoke)

Reads the value of a curve element.

Argumento	Tipo	Descrição
rig	string	obrigatório. Control Rig Blueprint object or package path.
name	string	obrigatório. Curve name.
value	number	New value (setter). Padrão 0.0.

Retorna: name, value.

rig.get_element (risco 0, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
rig	string	obrigatório. Control Rig Blueprint object or package path.
name	string	obrigatório. Element name.
type	string	Element type: bone, control, curve, null (UE5), socket (UE5.4+) or space (UE4.27). Padrão TEXT("bone").

Retorna: element, transforms, children.

rig.get_element_metadata (risco 0, UE 5.1+, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
rig	string	obrigatório. Control Rig Blueprint object or package path.
name	string	obrigatório. Element name.
type	string	Element type: bone, control, curve, null (UE5), socket (UE5.4+) or space (UE4.27). Padrão TEXT("bone").

Retorna: element, entries, count.

rig.get_global_transform (risco 0, requer plugin ControlRig, smoke)

Gets an element's global authored transform.

Argumento	Tipo	Descrição
initial	boolean	Reads or writes the authored initial (setup pose) transform instead of the current transform. Padrão 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. Padrão true.

Retorna: element, transform, transforms.

rig.get_local_transform (risco 0, requer plugin ControlRig, smoke)

Gets an element's local authored transform.

Argumento	Tipo	Descrição
initial	boolean	Reads or writes the authored initial (setup pose) transform instead of the current transform. Padrão 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. Padrão true.

Retorna: element, transform, transforms.

rig.get_node (risco 0, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
node	string	obrigatório. Node name.

Retorna: graph, node.

rig.get_parents (risco 0, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
recursive	boolean	Include indirect relatives (grandparents / grandchildren). Padrão false.

Retorna: element, parents, count.

rig.get_pin_default (risco 0, requer plugin ControlRig, smoke)

Reads one pin with its default value and links.

Argumento	Tipo	Descrição
pin	string	obrigatório. Pin path (Node.Pin or Node.Pin.SubPin).

Retorna: graph, pin, createdPin.

rig.get_pose (risco 0, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
type	string	Optional element type filter.

Retorna: entries, count.

rig.get_rig_component_bone (risco 0, requer plugin ControlRig, requer mundo, smoke)

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

Argumento	Tipo	Descrição
bone	string	obrigatório. Bone name.
space	string	worldSpace, actorSpace, componentSpace or rigSpace. Padrão TEXT("rigSpace").
initial	boolean	Read the initial (reference) transform instead of the current one (getter). Padrão false.
transform	UeaRigTransform	New transform (setter).
weight	number	Blend weight of the write (setter). Padrão 1.0.
propagateToChildren	boolean	Propagate the write to children (setter). Padrão true.

Retorna: name, space, transform.

rig.get_rig_component_control (risco 0, requer plugin ControlRig, requer mundo, smoke)

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

Argumento	Tipo	Descrição
control	string	obrigatório. Control name.
valueKind	string	Value kind: transform, float, bool, int, vector2D, position, rotator, scale. Padrão TEXT("transform").
space	string	Space for transform/position/rotator/scale: worldSpace, actorSpace, componentSpace, rigSpace, localSpace. Padrão TEXT("rigSpace").
number	number	Scalar value (float, bool 0/1, int). Padrão 0.0.
vector	{x,y,z}	Vector value (vector2D x/y, position, rotator pitch/yaw/roll, scale).
transform	UeaRigTransform	Transform value.

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

rig.get_rig_component_elements (risco 0, requer plugin ControlRig, requer mundo, smoke)

Lists the element names of the running rig by type.

Argumento	Tipo	Descrição
type	string	bone, control, curve, null (UE5) or space (UE4.27). Padrão TEXT("bone").

Retorna: names, count.

rig.get_selection (risco 0, requer plugin ControlRig, smoke)

Returns the elements selected in the Control Rig editor.

Argumento	Tipo	Descrição
rig	string	obrigatório. Control Rig Blueprint object or package path.

Retorna: elements, count.

rig.import_bones (risco 2, altera, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
rig	string	obrigatório. Control Rig Blueprint object or package path.
source	string	obrigatório. Skeletal mesh or skeleton asset.
replaceExisting	boolean	Replace bones that already exist (updating their transforms). Padrão false.
removeObsolete	boolean	Remove bones that do not exist in the source. Padrão false.

Retorna: elements, count.

rig.import_hierarchy (risco 2, altera, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
rig	string	obrigatório. 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. Padrão false.

Retorna: elements, count.

rig.import_nodes (risco 2, altera, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
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.

Retorna: graph, nodes, count.

rig.list_bones (risco 0, requer plugin ControlRig, smoke)

Lists only hierarchy bones.

Argumento	Tipo	Descrição
rig	string	obrigatório. Control Rig Blueprint object or package path.

Retorna: elements, count.

rig.list_control_rigs (risco 0, requer plugin ControlRig, smoke)

Lists Control Rig Blueprint assets under a content folder.

Argumento	Tipo	Descrição
folder	string	Content folder to search. Padrão TEXT("/Game").
nameContains	string	Optional case-insensitive asset-name fragment.
limit	integer	Maximum returned assets; zero means no limit. Padrão 100.

Retorna: rigs, count.

rig.list_control_shapes (risco 0, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
rig	string	obrigatório. Control Rig Blueprint object or package path.

Retorna: libraries, shapes, count.

rig.list_controls (risco 0, requer plugin ControlRig, smoke)

Lists only hierarchy controls.

Argumento	Tipo	Descrição
rig	string	obrigatório. Control Rig Blueprint object or package path.

Retorna: elements, count.

rig.list_curves (risco 0, requer plugin ControlRig, smoke)

Lists UE5 curve elements.

Argumento	Tipo	Descrição
rig	string	obrigatório. Control Rig Blueprint object or package path.

Retorna: elements, count.

rig.list_functions (risco 0, UE 5.0+, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
rig	string	obrigatório. Control Rig Blueprint object or package path.

Retorna: functions, count.

rig.list_graphs (risco 0, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
rig	string	obrigatório. Control Rig Blueprint object or package path.

Retorna: graphs, count.

rig.list_hierarchy (risco 0, requer plugin ControlRig, smoke)

Lists the elements in a Control Rig hierarchy.

Argumento	Tipo	Descrição
rig	string	obrigatório. Control Rig Blueprint object or package path.

Retorna: elements, count.

rig.list_links (risco 0, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
rig	string	obrigatório. 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.

Retorna: graph, links, count.

rig.list_nodes (risco 0, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
nameContains	string	Optional case-insensitive fragment of the node name, title or unit.
includePins	boolean	Include every pin of every node. Padrão false.

Retorna: graph, nodes, count.

rig.list_nulls (risco 0, UE 5.0+, requer plugin ControlRig, smoke)

Lists UE5 null transform elements.

Argumento	Tipo	Descrição
rig	string	obrigatório. Control Rig Blueprint object or package path.

Retorna: elements, count.

rig.list_rig_components (risco 0, requer plugin ControlRig, requer mundo, smoke)

Lists the Control Rig components in the editor world.

Argumento	Tipo	Descrição
rig	string	Optional Control Rig Blueprint: only components running its generated class.

Retorna: components, count.

rig.map_skeletal_mesh (risco 2, altera, requer plugin ControlRig, requer mundo, smoke)

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

Argumento	Tipo	Descrição
meshActor	string	Actor that owns the skeletal mesh component; empty = the rig actor itself.

Retorna: component, changedActors.

rig.mirror_elements (risco 2, altera, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
rig	string	obrigatório. Control Rig Blueprint object or package path.
elements	array of UeaRigElementRef	obrigatório. Elements to mirror.
mirrorAxis	string	Mirror plane normal axis: x, y or z. Padrão TEXT("x").
axisToFlip	string	Axis to flip: x, y or z. Padrão TEXT("z").
search	string	Name fragment to replace in the mirrored names (e.g. _l).
replace	string	Replacement fragment (e.g. _r).

Retorna: elements, count.

rig.remove_array_pin (risco 2, altera, requer plugin ControlRig, smoke)

Removes an element pin from an array pin.

Argumento	Tipo	Descrição
pin	string	obrigatório. Pin path (Node.Pin or Node.Pin.SubPin).

Retorna: graph, pin, createdPin.

rig.remove_available_space (risco 2, altera, UE 5.5+, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
space	string	obrigatório. Space element name.
spaceType	string	Space element type: bone, control or null. Padrão TEXT("bone").

Retorna: control.

rig.remove_element (risco 3, altera, destrutivo, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
rig	string	obrigatório. Control Rig Blueprint object or package path.
name	string	obrigatório. Element name.
type	string	Element type: bone, control, curve, null (UE5), socket (UE5.4+) or space (UE4.27). Padrão TEXT("bone").

Retorna: elements, count.

rig.remove_element_metadata (risco 2, altera, UE 5.1+, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
metadataName	string	obrigatório. Metadata name.
metadataType	string	bool, float, int32, name, vector, rotator, transform or linearColor. Padrão TEXT("float").
number	number	Value for bool (0/1), float and int32. Padrão 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.

Retorna: element, entries, count.

rig.remove_function (risco 3, altera, destrutivo, UE 5.0+, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
name	string	obrigatório. Function name.
mutable	boolean	add_function: the function has an execute pin (mutable). Padrão true.
position	UeaRigVec2	add_function: position in the function library.

Retorna: functions, count.

rig.remove_node (risco 3, altera, destrutivo, requer plugin ControlRig, smoke)

Removes a node and its links.

Argumento	Tipo	Descrição
node	string	obrigatório. Node name.

Retorna: graph, nodes, count.

rig.remove_parent (risco 2, altera, UE 5.0+, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
parent	string	obrigatório. Parent element name.
parentType	string	Parent element type: bone, control or null. Padrão 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. Padrão true.
initial	boolean	set_parent_weight: write the initial weight instead of the current one. Padrão true.

Retorna: element, parents, count.

rig.remove_rig_actor (risco 3, altera, destrutivo, requer plugin ControlRig, requer mundo, smoke)

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

Argumento	Tipo	Descrição
actor	string	obrigatório. Actor label or name (or class:).

Retorna: component, changedActors.

rig.rename_element (risco 2, altera, requer plugin ControlRig, smoke)

Renames a hierarchy element and returns its new key.

Argumento	Tipo	Descrição
newName	string	obrigatório. New bare element name.

Retorna: element, transforms, children.

rig.rename_node (risco 2, altera, UE 5.0+, requer plugin ControlRig, smoke)

Renames a node (UE5).

Argumento	Tipo	Descrição
newName	string	obrigatório. New node name.

Retorna: graph, node.

rig.reorder_element (risco 2, altera, UE 5.2+, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
index	integer	New index among the siblings. Padrão 0.

Retorna: elements, count.

rig.reparent_element (risco 2, altera, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
parent	string	New parent name, or empty to clear the parent.
parentType	string	New parent type: bone, control, or null (UE5). Padrão TEXT("bone").
maintainGlobalTransform	boolean	Preserves global location while changing the hierarchy parent. UE4.27 always preserves it; false is rejected there. Padrão true.

Retorna: element, transforms, children.

rig.reset_pin_default (risco 2, altera, requer plugin ControlRig, smoke)

Restores a pin's default to the unit default.

Argumento	Tipo	Descrição
pin	string	obrigatório. Pin path (Node.Pin or Node.Pin.SubPin).

Retorna: graph, pin, createdPin.

rig.reset_pose (risco 2, altera, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
rig	string	obrigatório. Control Rig Blueprint object or package path.

Retorna: entries, count.

rig.search_rig_units (risco 0, requer plugin ControlRig, smoke)

Searches the loaded RigUnit structs usable by rig.add_unit_node.

Argumento	Tipo	Descrição
nameContains	string	Optional case-insensitive fragment of the struct name, display name or category.
limit	integer	Maximum results; 0 = unlimited. Padrão 100.

Retorna: units, count.

rig.select_elements (risco 1, altera, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
rig	string	obrigatório. Control Rig Blueprint object or package path.
elements	array of UeaRigElementRef	Elements; empty means every element (export) or clears the selection (select_elements).

Retorna: elements, count.

rig.select_nodes (risco 1, altera, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
nodes	array of string	Node names.
newName	string	collapse_nodes: requested name of the collapse node.

Retorna: graph, nodes, count.

rig.set_array_pin_size (risco 2, altera, requer plugin ControlRig, smoke)

Sets the element count of an array pin.

Argumento	Tipo	Descrição
size	integer	New element count. Padrão 0.
defaultValue	string	Default of added elements as exported text.

Retorna: graph, pin, createdPin.

rig.set_comment_text (risco 2, altera, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
text	string	obrigatório. New comment text.
fontSize	integer	UE5 font size. Padrão 18.
bubbleVisible	boolean	UE5 show the comment bubble. Padrão false.
colorBubble	boolean	UE5 colour the comment bubble. Padrão false.

Retorna: graph, node.

rig.set_control_animation_type (risco 2, altera, UE 5.1+, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
animationType	string	obrigatório. animationControl, animationChannel, proxyControl or visualCue.

Retorna: control.

rig.set_control_display_name (risco 2, altera, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
displayName	string	New display name (empty clears it).

Retorna: control.

rig.set_control_limits (risco 2, altera, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
limitTranslation	boolean	Limit translation (or the single channel of float/integer/vector2D controls). Padrão false.
limitRotation	boolean	Limit rotation channels. Padrão false.
limitScale	boolean	Limit scale channels. Padrão false.
drawLimits	boolean	Draw the limits in the viewport. Padrão true.
minimum	UeaRigControlValue	Minimum value, typed like the control.
maximum	UeaRigControlValue	Maximum value, typed like the control.

Retorna: control.

rig.set_control_offset (risco 2, altera, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
transform	UeaRigTransform	New offset transform relative to the parent.
initial	boolean	Writes the initial offset (UE4.27 stores one offset; false is rejected there). Padrão true.

Retorna: control.

rig.set_control_shape (risco 2, altera, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
shapeName	string	New shape name from the rig's shape library (see rig.list_control_shapes); empty leaves it unchanged.
applyColor	boolean	Apply 'color'. Padrão false.
color	UeaRigColor	New shape colour.
visibility	string	visible, hidden, or empty to leave visibility unchanged.
applyTransform	boolean	Apply 'transform'. Padrão false.
transform	UeaRigTransform	New initial shape transform relative to the control.

Retorna: control.

rig.set_control_value (risco 2, altera, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
kind	string	current or initial (setters); getters also accept minimum and maximum. Padrão TEXT("initial").
value	UeaRigControlValue	New value (setters).

Retorna: element, kind, value.

rig.set_curve_value (risco 2, altera, requer plugin ControlRig, smoke)

Writes the value of a curve element.

Argumento	Tipo	Descrição
rig	string	obrigatório. Control Rig Blueprint object or package path.
name	string	obrigatório. Curve name.
value	number	New value (setter). Padrão 0.0.

Retorna: name, value.

rig.set_element_metadata (risco 2, altera, UE 5.1+, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
metadataName	string	obrigatório. Metadata name.
metadataType	string	bool, float, int32, name, vector, rotator, transform or linearColor. Padrão TEXT("float").
number	number	Value for bool (0/1), float and int32. Padrão 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.

Retorna: element, entries, count.

rig.set_global_transform (risco 2, altera, requer plugin ControlRig, smoke)

Sets an element's global authored transform.

Argumento	Tipo	Descrição
initial	boolean	Reads or writes the authored initial (setup pose) transform instead of the current transform. Padrão 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. Padrão true.

Retorna: element, transform, transforms.

rig.set_local_transform (risco 2, altera, requer plugin ControlRig, smoke)

Sets an element's local authored transform.

Argumento	Tipo	Descrição
initial	boolean	Reads or writes the authored initial (setup pose) transform instead of the current transform. Padrão 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. Padrão true.

Retorna: element, transform, transforms.

rig.set_node_color (risco 2, altera, requer plugin ControlRig, smoke)

Recolours a node.

Argumento	Tipo	Descrição
color	UeaRigColor	New node colour.

Retorna: graph, node.

rig.set_node_position (risco 2, altera, requer plugin ControlRig, smoke)

Moves a node.

Argumento	Tipo	Descrição
value	UeaRigVec2	New position (set_node_position) or size (set_node_size).

Retorna: graph, node.

rig.set_node_size (risco 2, altera, requer plugin ControlRig, smoke)

Resizes a node (mostly comment boxes).

Argumento	Tipo	Descrição
value	UeaRigVec2	New position (set_node_position) or size (set_node_size).

Retorna: graph, node.

rig.set_parent_weight (risco 2, altera, UE 5.0+, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
parent	string	obrigatório. Parent element name.
parentType	string	Parent element type: bone, control or null. Padrão 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. Padrão true.
initial	boolean	set_parent_weight: write the initial weight instead of the current one. Padrão true.

Retorna: element, parents, count.

rig.set_pin_default (risco 2, altera, requer plugin ControlRig, smoke)

Writes a pin default value as exported text.

Argumento	Tipo	Descrição
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. Padrão true.

Retorna: graph, pin, createdPin.

rig.set_pin_expansion (risco 1, altera, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
expanded	boolean	Expanded state. Padrão true.

Retorna: graph, pin, createdPin.

rig.set_preview_mesh (risco 2, altera, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
skeletalMesh	string	obrigatório. Skeletal mesh asset used as the rig preview mesh.

Retorna: rig.

rig.set_rig_component_bone (risco 1, altera, requer plugin ControlRig, requer mundo, smoke)

Writes a bone transform of the running rig.

Argumento	Tipo	Descrição
bone	string	obrigatório. Bone name.
space	string	worldSpace, actorSpace, componentSpace or rigSpace. Padrão TEXT("rigSpace").
initial	boolean	Read the initial (reference) transform instead of the current one (getter). Padrão false.
transform	UeaRigTransform	New transform (setter).
weight	number	Blend weight of the write (setter). Padrão 1.0.
propagateToChildren	boolean	Propagate the write to children (setter). Padrão true.

Retorna: name, space, transform.

rig.set_rig_component_control (risco 1, altera, requer plugin ControlRig, requer mundo, smoke)

Drives a control of the running rig.

Argumento	Tipo	Descrição
control	string	obrigatório. Control name.
valueKind	string	Value kind: transform, float, bool, int, vector2D, position, rotator, scale. Padrão TEXT("transform").
space	string	Space for transform/position/rotator/scale: worldSpace, actorSpace, componentSpace, rigSpace, localSpace. Padrão TEXT("rigSpace").
number	number	Scalar value (float, bool 0/1, int). Padrão 0.0.
vector	{x,y,z}	Vector value (vector2D x/y, position, rotator pitch/yaw/roll, scale).
transform	UeaRigTransform	Transform value.

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

rig.spawn_rig_actor (risco 2, altera, requer plugin ControlRig, requer mundo, smoke)

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

Argumento	Tipo	Descrição
rig	string	obrigatório. Compiled Control Rig Blueprint whose generated class the component runs.
label	string	Actor label. Padrão 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).

Retorna: component, changedActors.

rig.validate_hierarchy (risco 0, requer plugin ControlRig, smoke)

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

Argumento	Tipo	Descrição
rig	string	obrigatório. Control Rig Blueprint object or package path.

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