animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools¶
Tools for animating with Control Rig inside Sequencer. Use when adding Control Rig tracks to bindings, getting or setting control values (bool, float, int, position, rotator, scale, euler transform, transform), keying controls, baking animation to Control Rig, managing layered rigs and priority, masking controls per section, space switching (world, parent, control, bone), tweening and blending between keys, snapping controls to actors, mirroring poses, zeroing transforms, or managing animation layers (add, delete, duplicate, reorder, merge, collapse).
72 tool(s).
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.add_layer_from_selection¶
Add an animation layer from the currently selected objects in Sequencer.
Returns:
The index of the newly created animation layer.
Input schema
{
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "integer"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.bake_space¶
Bake Control Rig controls' space over a frame range.
Args:
sequence: The LevelSequence.
control_rig_asset_path: Path to identify which Control Rig.
control_names: Names of controls to bake.
start_frame: Start of the bake range.
end_frame: End of the bake range.
reduce_keys: If True, perform key reduction after baking.
tolerance: Key reduction tolerance.
Returns:
True if the bake succeeded.
Input schema
{
"properties": {
"control_names": {
"items": {
"type": "string"
},
"type": "array"
},
"control_rig_asset_path": {
"type": "string"
},
"end_frame": {
"type": "integer"
},
"reduce_keys": {
"default": false,
"type": "boolean"
},
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
},
"start_frame": {
"type": "integer"
},
"tolerance": {
"default": 0.001,
"type": "number"
}
},
"required": [
"sequence",
"control_rig_asset_path",
"control_names",
"start_frame",
"end_frame"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.bake_to_control_rig¶
Bake existing animation on a binding into a Control Rig track.
Args:
sequence: The LevelSequence.
binding: The skeletal mesh binding to bake from.
control_rig_asset_path: Path to the CR asset to bake into.
reduce_keys: If True, perform key reduction after baking.
tolerance: Key reduction tolerance. Smaller values keep more keys.
reset_controls: If True, reset all controls to initial value per frame.
Returns:
True if baking succeeded.
Input schema
{
"properties": {
"binding": {
"properties": {
"bindingId": {
"description": "Globally unique identifier in 8-4-4-4-12 hyphenated form, e.g. \"E05FCC13-4D37-9D7A-E238-83859F29AD74\".",
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$",
"type": "string"
},
"sequence": {
"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/MovieScene.MovieSceneSequence",
"type": "object"
}
},
"required": [
"bindingId",
"sequence"
],
"title": "MovieSceneBindingProxy",
"type": "object"
},
"control_rig_asset_path": {
"type": "string"
},
"reduce_keys": {
"default": false,
"type": "boolean"
},
"reset_controls": {
"default": true,
"type": "boolean"
},
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
},
"tolerance": {
"default": 0.001,
"type": "number"
}
},
"required": [
"sequence",
"binding",
"control_rig_asset_path"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.blend_values_on_selected¶
Perform a blend operation on selected keys or controls.
Args:
sequence: The LevelSequence (must be open in Sequencer).
operation: The blend operation. One of: 'tween',
'blend_to_neighbor', 'push_pull', 'blend_relative',
'blend_to_ease', 'smooth_rough'.
blend_value: Blend value, typically -1.0 to 1.0.
Returns:
True if the blend succeeded.
Input schema
{
"properties": {
"blend_value": {
"type": "number"
},
"operation": {
"type": "string"
},
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
}
},
"required": [
"sequence",
"operation",
"blend_value"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.clear_selection¶
Clear the current Control Rig control selection.
Input schema
{
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.collapse_anim_layers¶
Collapse all sections and layers on a Control Rig track into one section.
Args:
sequence: The LevelSequence.
control_rig_asset_path: Path to identify which Control Rig.
reduce_keys: If True, perform key reduction after collapsing.
tolerance: Key reduction tolerance.
Returns:
True if collapsing succeeded.
Input schema
{
"properties": {
"control_rig_asset_path": {
"type": "string"
},
"reduce_keys": {
"default": false,
"type": "boolean"
},
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
},
"tolerance": {
"default": 0.001,
"type": "number"
}
},
"required": [
"sequence",
"control_rig_asset_path"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.delete_anim_layer¶
Delete an animation layer at the specified index.
Args:
index: The index of the layer to delete.
Returns:
True if the layer was deleted successfully.
Input schema
{
"properties": {
"index": {
"type": "integer"
}
},
"required": [
"index"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.delete_space¶
Delete a space-switch key at a specific frame.
Performs compensation to the new space automatically.
Args:
sequence: The LevelSequence.
control_rig_asset_path: Path to identify which Control Rig.
control_name: Name of the control.
frame: Frame of the space key to delete.
Returns:
True if the deletion succeeded.
Input schema
{
"properties": {
"control_name": {
"type": "string"
},
"control_rig_asset_path": {
"type": "string"
},
"frame": {
"type": "integer"
},
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
}
},
"required": [
"sequence",
"control_rig_asset_path",
"control_name",
"frame"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.duplicate_anim_layer¶
Duplicate an animation layer at the specified index.
Args:
index: The index of the layer to duplicate.
Returns:
The index of the newly created duplicate layer, or -1 on failure.
Input schema
{
"properties": {
"index": {
"type": "integer"
}
},
"required": [
"index"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "integer"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.export_fbx_from_rig¶
Export an FBX file from a Control Rig section.
Args:
sequence: The LevelSequence.
control_rig_asset_path: Path to identify which Control Rig.
export_file_path: File system path for the output FBX file.
ascii: If True, export in ASCII format instead of binary.
Returns:
True if the export succeeded.
Input schema
{
"properties": {
"ascii": {
"default": false,
"type": "boolean"
},
"control_rig_asset_path": {
"type": "string"
},
"export_file_path": {
"type": "string"
},
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
}
},
"required": [
"sequence",
"control_rig_asset_path",
"export_file_path"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.find_or_create_track¶
Add a Control Rig track to a binding using a Control Rig asset.
This is the standard way to add a Control Rig to Sequencer.
Uses ControlRigSequencerLibrary.find_or_create_control_rig_track.
Args:
sequence: The LevelSequence.
binding: The binding to add the CR track to.
control_rig_asset_path: Path to the CR asset (e.g.
'/Game/Rigs/CR_Mannequin_Body').
is_layered: If True, create as a layered Control Rig.
Returns:
JSON string with 'track' refPath and 'control_rig' info.
Input schema
{
"properties": {
"binding": {
"properties": {
"bindingId": {
"description": "Globally unique identifier in 8-4-4-4-12 hyphenated form, e.g. \"E05FCC13-4D37-9D7A-E238-83859F29AD74\".",
"pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$",
"type": "string"
},
"sequence": {
"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/MovieScene.MovieSceneSequence",
"type": "object"
}
},
"required": [
"bindingId",
"sequence"
],
"title": "MovieSceneBindingProxy",
"type": "object"
},
"control_rig_asset_path": {
"type": "string"
},
"is_layered": {
"default": false,
"type": "boolean"
},
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
}
},
"required": [
"sequence",
"binding",
"control_rig_asset_path"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "string"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.frame_selection¶
Frame the viewport to the current Control Rig control selection.
Input schema
{
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.get_actor_transform_at_frame¶
Get an actor's world transform at a specific frame.
Finds the actor by name in the current editor world.
Args:
sequence: The LevelSequence.
actor_name: The name or label of the actor in the level.
frame: The frame number.
Returns:
JSON string with 'location' (x,y,z) and 'rotation' (pitch,yaw,roll).
Input schema
{
"properties": {
"actor_name": {
"type": "string"
},
"frame": {
"type": "integer"
},
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
}
},
"required": [
"sequence",
"actor_name",
"frame"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "string"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.get_anim_layers¶
Get all animation layers from the active Sequencer.
Returns:
JSON string with a list of layer objects, each containing
'index' and 'name'.
Input schema
{
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "string"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.get_anim_mode_gizmo_scale¶
Get the editor's transform gizmo size.
Reads UTransformGizmoEditorSettings::TransformGizmoSize. The CR-specific
gizmo scale was removed in UE 5.8 in favor of this editor-wide setting,
so this affects every transform gizmo (level, sequencer, CR, etc.).
Returns:
The transform gizmo size offset. Default 0.0; range -10..150.
Input schema
{
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "number"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.get_anim_mode_hide_manips¶
Get whether Animation Mode hides all manipulators.
Returns:
True if manipulators are hidden.
Input schema
{
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.get_anim_mode_hierarchy¶
Get whether the Animation Mode draws hierarchy lines/dots.
Returns:
True if hierarchy display is on.
Input schema
{
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.get_anim_mode_local_spaces¶
Get whether multi-select transforms act in each control's own space.
Returns:
True if each selected control transforms in its own local space.
Input schema
{
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.get_anim_mode_nulls¶
Get whether the Animation Mode draws nulls.
Returns:
True if null display is on.
Input schema
{
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.get_anim_mode_only_rig_sel¶
Get whether Animation Mode restricts viewport selection to rig controls.
Returns:
True if only rig controls are selectable.
Input schema
{
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.get_bool¶
Get a bool control value at a specific frame.
Args:
sequence: The LevelSequence.
control_rig_asset_path: Path to identify which Control Rig.
control_name: Name of the bool control.
frame: The frame number.
Returns:
The bool value at the given frame.
Input schema
{
"properties": {
"control_name": {
"type": "string"
},
"control_rig_asset_path": {
"type": "string"
},
"frame": {
"type": "integer"
},
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
}
},
"required": [
"sequence",
"control_rig_asset_path",
"control_name",
"frame"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.get_control_rigs¶
Get all Control Rigs currently in the sequence.
Returns proxy objects with track and rig references.
Args:
sequence: The LevelSequence to query.
Returns:
JSON string with list of CR info objects containing
'track', 'control_rig_name', and 'is_layered'.
Input schema
{
"properties": {
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
}
},
"required": [
"sequence"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "string"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.get_controls_info¶
Get all controls on a Control Rig with their names and types.
Returns a list of controls with name and type so the caller can
find controls of a specific type (e.g. find a Float control to
use with set_float).
Possible types: Bool, Float, Integer, Vector2D, Position,
Rotator, Scale, Transform, TransformNoScale, EulerTransform.
Args:
sequence: The LevelSequence.
control_rig_asset_path: Path to identify which Control Rig.
Returns:
JSON string with a list of objects, each with 'name' and 'type'.
Input schema
{
"properties": {
"control_rig_asset_path": {
"type": "string"
},
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
}
},
"required": [
"sequence",
"control_rig_asset_path"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "string"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.get_controls_mask¶
Check if a control is visible (unmasked) on a section.
Args:
section: The Control Rig parameter section.
control_name: The control name to check.
Returns:
True if the control is visible, False if masked.
Input schema
{
"properties": {
"control_name": {
"type": "string"
},
"section": {
"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/MovieScene.MovieSceneSection",
"type": "object"
}
},
"required": [
"section",
"control_name"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.get_euler_transform¶
Get an EulerTransform control value at a specific frame.
Args:
sequence: The LevelSequence.
control_rig_asset_path: Path to identify which Control Rig.
control_name: Name of the EulerTransform control.
frame: The frame number.
Returns:
JSON string with 'location' (x,y,z), 'rotation' (pitch,yaw,roll),
and 'scale' (x,y,z) dicts.
Input schema
{
"properties": {
"control_name": {
"type": "string"
},
"control_rig_asset_path": {
"type": "string"
},
"frame": {
"type": "integer"
},
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
}
},
"required": [
"sequence",
"control_rig_asset_path",
"control_name",
"frame"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "string"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.get_float¶
Get a float control value at a specific frame.
Args:
sequence: The LevelSequence.
control_rig_asset_path: Path to identify which Control Rig.
control_name: Name of the float control.
frame: The frame number.
Returns:
The float value at the given frame.
Input schema
{
"properties": {
"control_name": {
"type": "string"
},
"control_rig_asset_path": {
"type": "string"
},
"frame": {
"type": "integer"
},
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
}
},
"required": [
"sequence",
"control_rig_asset_path",
"control_name",
"frame"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "number"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.get_int¶
Get an integer control value at a specific frame.
Args:
sequence: The LevelSequence.
control_rig_asset_path: Path to identify which Control Rig.
control_name: Name of the integer control.
frame: The frame number.
Returns:
The integer value at the given frame.
Input schema
{
"properties": {
"control_name": {
"type": "string"
},
"control_rig_asset_path": {
"type": "string"
},
"frame": {
"type": "integer"
},
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
}
},
"required": [
"sequence",
"control_rig_asset_path",
"control_name",
"frame"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "integer"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.get_position¶
Get a position control value at a specific frame.
Args:
sequence: The LevelSequence.
control_rig_asset_path: Path to identify which Control Rig.
control_name: Name of the position control.
frame: The frame number.
Returns:
JSON string with 'x', 'y', 'z' fields.
Input schema
{
"properties": {
"control_name": {
"type": "string"
},
"control_rig_asset_path": {
"type": "string"
},
"frame": {
"type": "integer"
},
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
}
},
"required": [
"sequence",
"control_rig_asset_path",
"control_name",
"frame"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "string"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.get_priority_order¶
Get the evaluation priority order of a Control Rig track.
Args:
sequence: The LevelSequence.
control_rig_asset_path: Path to identify which Control Rig.
Returns:
The priority order integer.
Input schema
{
"properties": {
"control_rig_asset_path": {
"type": "string"
},
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
}
},
"required": [
"sequence",
"control_rig_asset_path"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "integer"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.get_rotator¶
Get a rotator control value at a specific frame.
Args:
sequence: The LevelSequence.
control_rig_asset_path: Path to identify which Control Rig.
control_name: Name of the rotator control.
frame: The frame number.
Returns:
JSON string with 'pitch', 'yaw', 'roll' fields.
Input schema
{
"properties": {
"control_name": {
"type": "string"
},
"control_rig_asset_path": {
"type": "string"
},
"frame": {
"type": "integer"
},
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
}
},
"required": [
"sequence",
"control_rig_asset_path",
"control_name",
"frame"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "string"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.get_scale¶
Get a scale control value at a specific frame.
Args:
sequence: The LevelSequence.
control_rig_asset_path: Path to identify which Control Rig.
control_name: Name of the scale control.
frame: The frame number.
Returns:
JSON string with 'x', 'y', 'z' fields.
Input schema
{
"properties": {
"control_name": {
"type": "string"
},
"control_rig_asset_path": {
"type": "string"
},
"frame": {
"type": "integer"
},
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
}
},
"required": [
"sequence",
"control_rig_asset_path",
"control_name",
"frame"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "string"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.get_selected_controls¶
Get the currently selected controls on a Control Rig.
Args:
sequence: The LevelSequence.
control_rig_asset_path: Path to identify which Control Rig.
Returns:
List of selected control names.
Input schema
{
"properties": {
"control_rig_asset_path": {
"type": "string"
},
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
}
},
"required": [
"sequence",
"control_rig_asset_path"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.get_transform¶
Get the transform value of a Control Rig control at a frame.
Automatically detects whether the control is a Transform or
EulerTransform type and uses the appropriate API.
Args:
sequence: The LevelSequence.
control_rig_asset_path: Path to identify which CR.
control_name: The control name (e.g. 'body_ctrl').
frame: The frame number.
Returns:
JSON string with 'location' and 'rotation' dicts.
Input schema
{
"properties": {
"control_name": {
"type": "string"
},
"control_rig_asset_path": {
"type": "string"
},
"frame": {
"type": "integer"
},
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
}
},
"required": [
"sequence",
"control_rig_asset_path",
"control_name",
"frame"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "string"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.get_vector2d¶
Get a Vector2D control value at a specific frame.
Args:
sequence: The LevelSequence.
control_rig_asset_path: Path to identify which Control Rig.
control_name: Name of the Vector2D control.
frame: The frame number.
Returns:
JSON string with 'x' and 'y' fields.
Input schema
{
"properties": {
"control_name": {
"type": "string"
},
"control_rig_asset_path": {
"type": "string"
},
"frame": {
"type": "integer"
},
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
}
},
"required": [
"sequence",
"control_rig_asset_path",
"control_name",
"frame"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "string"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.get_world_transform¶
Get a control's world-space transform at a specific frame.
Args:
sequence: The LevelSequence.
control_rig_asset_path: Path to identify which Control Rig.
control_name: Name of the control.
frame: The frame number.
Returns:
JSON string with 'location' (x,y,z) and 'rotation' (pitch,yaw,roll).
Input schema
{
"properties": {
"control_name": {
"type": "string"
},
"control_rig_asset_path": {
"type": "string"
},
"frame": {
"type": "integer"
},
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
}
},
"required": [
"sequence",
"control_rig_asset_path",
"control_name",
"frame"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "string"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.hide_all_controls¶
Hide all controls on a Control Rig section (mask everything).
Args:
section: The Control Rig parameter section.
Input schema
{
"properties": {
"section": {
"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/MovieScene.MovieSceneSection",
"type": "object"
}
},
"required": [
"section"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.import_fbx_to_rig¶
Import an FBX file onto a Control Rig track.
Args:
sequence: The LevelSequence.
control_rig_asset_path: Path to identify which Control Rig.
import_file_path: File system path to the FBX file to import.
selected_controls: Optional list of control names to import onto.
If provided, only these controls will be affected.
Returns:
True if the import succeeded.
Input schema
{
"properties": {
"control_rig_asset_path": {
"type": "string"
},
"import_file_path": {
"type": "string"
},
"selected_controls": {
"items": {
"type": "string"
},
"type": "array"
},
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
}
},
"required": [
"sequence",
"control_rig_asset_path",
"import_file_path",
"selected_controls"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.is_fk_control_rig¶
Check if a Control Rig is an FK Control Rig.
Args:
sequence: The LevelSequence.
control_rig_asset_path: Path to identify which Control Rig.
Returns:
True if the rig is an FK Control Rig.
Input schema
{
"properties": {
"control_rig_asset_path": {
"type": "string"
},
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
}
},
"required": [
"sequence",
"control_rig_asset_path"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.is_layered_control_rig¶
Check if a Control Rig in the sequence is in layered mode.
Args:
sequence: The LevelSequence.
control_rig_asset_path: Path to identify which Control Rig.
Returns:
True if the rig is in layered mode.
Input schema
{
"properties": {
"control_rig_asset_path": {
"type": "string"
},
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
}
},
"required": [
"sequence",
"control_rig_asset_path"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.key_controls¶
Key the specified controls on the section at the current Sequencer time.
Args:
section: The Control Rig parameter section.
control_names: List of control names to key.
Input schema
{
"properties": {
"control_names": {
"items": {
"type": "string"
},
"type": "array"
},
"section": {
"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/MovieScene.MovieSceneSection",
"type": "object"
}
},
"required": [
"section",
"control_names"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.key_controls_at_frames¶
Key the specified controls at specific frame numbers.
Args:
section: The Control Rig parameter section.
control_names: List of control names to key.
frames: List of frame numbers at which to set keys.
Input schema
{
"properties": {
"control_names": {
"items": {
"type": "string"
},
"type": "array"
},
"frames": {
"items": {
"type": "integer"
},
"type": "array"
},
"section": {
"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/MovieScene.MovieSceneSection",
"type": "object"
}
},
"required": [
"section",
"control_names",
"frames"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.load_anim_into_rig¶
Load an animation sequence into a Control Rig section.
Finds the skeletal mesh component from the binding associated with
the section's track.
Args:
cr_section: The Control Rig parameter section to load into.
anim_sequence_path: Content path to the AnimSequence asset.
start_frame: Frame at which to insert the animation.
reset_controls: If True, reset controls to initial value per frame.
key_reduce: If True, perform key reduction.
tolerance: Key reduction tolerance.
Returns:
True if the load succeeded.
Input schema
{
"properties": {
"anim_sequence_path": {
"type": "string"
},
"cr_section": {
"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/MovieScene.MovieSceneSection",
"type": "object"
},
"key_reduce": {
"default": false,
"type": "boolean"
},
"reset_controls": {
"default": true,
"type": "boolean"
},
"start_frame": {
"default": 0,
"type": "integer"
},
"tolerance": {
"default": 0.001,
"type": "number"
}
},
"required": [
"cr_section",
"anim_sequence_path"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.merge_anim_layers¶
Merge specified animation layers into one.
Merges onto the layer with the lowest index.
Args:
indices: List of layer indices to merge.
Returns:
True if the merge succeeded.
Input schema
{
"properties": {
"indices": {
"items": {
"type": "integer"
},
"type": "array"
}
},
"required": [
"indices"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.mirror_selected_controls¶
Apply a mirrored pose to the currently selected controls.
Input schema
{
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.move_space¶
Move a space-switch key from one frame to another.
Args:
sequence: The LevelSequence.
control_rig_asset_path: Path to identify which Control Rig.
control_name: Name of the control.
old_frame: The current frame of the space key.
new_frame: The new frame to move the space key to.
Returns:
True if the move succeeded.
Input schema
{
"properties": {
"control_name": {
"type": "string"
},
"control_rig_asset_path": {
"type": "string"
},
"new_frame": {
"type": "integer"
},
"old_frame": {
"type": "integer"
},
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
}
},
"required": [
"sequence",
"control_rig_asset_path",
"control_name",
"old_frame",
"new_frame"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.reorder_anim_layers¶
Move an animation layer from one index to another.
Cannot move the base layer (index 0).
Args:
old_index: Current index of the layer to move.
new_index: Target index to move the layer to.
Returns:
True if the reorder succeeded.
Input schema
{
"properties": {
"new_index": {
"type": "integer"
},
"old_index": {
"type": "integer"
}
},
"required": [
"old_index",
"new_index"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.select_control¶
Select or deselect a control on a Control Rig.
Args:
sequence: The LevelSequence.
control_rig_asset_path: Path to identify which Control Rig.
control_name: Name of the control.
selected: True to select, False to deselect.
Input schema
{
"properties": {
"control_name": {
"type": "string"
},
"control_rig_asset_path": {
"type": "string"
},
"selected": {
"default": true,
"type": "boolean"
},
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
}
},
"required": [
"sequence",
"control_rig_asset_path",
"control_name"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.select_mirrored_controls¶
Select the mirrored counterparts of the currently selected controls.
Replaces the current selection with mirrored controls.
Input schema
{
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.set_anim_mode_gizmo_scale¶
Set the editor's transform gizmo size.
Writes UTransformGizmoEditorSettings::TransformGizmoSize. The CR-specific
gizmo scale was removed in UE 5.8 in favor of this editor-wide setting.
Args:
scale: Gizmo size offset, clamped to [-10.0, 150.0]. 0.0 is default.
Returns:
True on success.
Input schema
{
"properties": {
"scale": {
"type": "number"
}
},
"required": [
"scale"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.set_anim_mode_hide_manips¶
Toggle whether Animation Mode hides all manipulators.
Args:
hide: True to hide all controls and gizmos.
Returns:
True on success.
Input schema
{
"properties": {
"hide": {
"type": "boolean"
}
},
"required": [
"hide"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.set_anim_mode_hierarchy¶
Toggle the Animation Mode hierarchy lines/dots display.
Args:
enabled: True to show, False to hide.
Returns:
True on success.
Input schema
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.set_anim_mode_local_spaces¶
Toggle multi-select transforms acting in each control's own space.
When True, transforming multiple selected controls respects each
control's own local space. When False, all use a shared reference.
Args:
enabled: True to enable per-control local space.
Returns:
True on success.
Input schema
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.set_anim_mode_nulls¶
Toggle the Animation Mode nulls display.
Args:
enabled: True to show, False to hide.
Returns:
True on success.
Input schema
{
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.set_anim_mode_only_rig_sel¶
Toggle Animation Mode restricting viewport selection to rig controls.
Args:
only_rig: True to only allow selecting rig controls in viewport.
Returns:
True on success.
Input schema
{
"properties": {
"only_rig": {
"type": "boolean"
}
},
"required": [
"only_rig"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.set_bool¶
Set a bool control value at a specific frame.
Args:
sequence: The LevelSequence.
control_rig_asset_path: Path to identify which Control Rig.
control_name: Name of the bool control.
frame: The frame number.
value: The bool value to set.
set_key: If True, set a keyframe at this frame.
Input schema
{
"properties": {
"control_name": {
"type": "string"
},
"control_rig_asset_path": {
"type": "string"
},
"frame": {
"type": "integer"
},
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
},
"set_key": {
"default": true,
"type": "boolean"
},
"value": {
"type": "boolean"
}
},
"required": [
"sequence",
"control_rig_asset_path",
"control_name",
"frame",
"value"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.set_controls_mask¶
Set the visibility mask for the specified controls on a section.
Args:
section: The Control Rig parameter section.
control_names: List of control names to affect.
visible: True to show, False to hide.
Input schema
{
"properties": {
"control_names": {
"items": {
"type": "string"
},
"type": "array"
},
"section": {
"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/MovieScene.MovieSceneSection",
"type": "object"
},
"visible": {
"type": "boolean"
}
},
"required": [
"section",
"control_names",
"visible"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.set_euler_transform¶
Set an EulerTransform control value at a specific frame.
Args:
sequence: The LevelSequence.
control_rig_asset_path: Path to identify which Control Rig.
control_name: Name of the EulerTransform control.
frame: The frame number.
location_x: X location.
location_y: Y location.
location_z: Z location.
rotation_pitch: Pitch in degrees.
rotation_yaw: Yaw in degrees.
rotation_roll: Roll in degrees.
scale_x: X scale.
scale_y: Y scale.
scale_z: Z scale.
set_key: If True, set a keyframe at this frame.
Input schema
{
"properties": {
"control_name": {
"type": "string"
},
"control_rig_asset_path": {
"type": "string"
},
"frame": {
"type": "integer"
},
"location_x": {
"default": 0,
"type": "number"
},
"location_y": {
"default": 0,
"type": "number"
},
"location_z": {
"default": 0,
"type": "number"
},
"rotation_pitch": {
"default": 0,
"type": "number"
},
"rotation_roll": {
"default": 0,
"type": "number"
},
"rotation_yaw": {
"default": 0,
"type": "number"
},
"scale_x": {
"default": 1,
"type": "number"
},
"scale_y": {
"default": 1,
"type": "number"
},
"scale_z": {
"default": 1,
"type": "number"
},
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
},
"set_key": {
"default": true,
"type": "boolean"
}
},
"required": [
"sequence",
"control_rig_asset_path",
"control_name",
"frame"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.set_float¶
Set a float control value at a specific frame.
Args:
sequence: The LevelSequence.
control_rig_asset_path: Path to identify which Control Rig.
control_name: Name of the float control.
frame: The frame number.
value: The float value to set.
set_key: If True, set a keyframe at this frame.
Input schema
{
"properties": {
"control_name": {
"type": "string"
},
"control_rig_asset_path": {
"type": "string"
},
"frame": {
"type": "integer"
},
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
},
"set_key": {
"default": true,
"type": "boolean"
},
"value": {
"type": "number"
}
},
"required": [
"sequence",
"control_rig_asset_path",
"control_name",
"frame",
"value"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.set_int¶
Set an integer control value at a specific frame.
Args:
sequence: The LevelSequence.
control_rig_asset_path: Path to identify which Control Rig.
control_name: Name of the integer control.
frame: The frame number.
value: The integer value to set.
set_key: If True, set a keyframe at this frame.
Input schema
{
"properties": {
"control_name": {
"type": "string"
},
"control_rig_asset_path": {
"type": "string"
},
"frame": {
"type": "integer"
},
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
},
"set_key": {
"default": true,
"type": "boolean"
},
"value": {
"type": "integer"
}
},
"required": [
"sequence",
"control_rig_asset_path",
"control_name",
"frame",
"value"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.set_layered_mode¶
Set a Control Rig track to layered or absolute mode.
Args:
sequence: The LevelSequence.
control_rig_asset_path: Path to identify which Control Rig.
is_layered: True for layered, False for absolute.
Returns:
True if the mode was set successfully.
Input schema
{
"properties": {
"control_rig_asset_path": {
"type": "string"
},
"is_layered": {
"type": "boolean"
},
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
}
},
"required": [
"sequence",
"control_rig_asset_path",
"is_layered"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.set_position¶
Set a position control value at a specific frame.
Args:
sequence: The LevelSequence.
control_rig_asset_path: Path to identify which Control Rig.
control_name: Name of the position control.
frame: The frame number.
x: X component.
y: Y component.
z: Z component.
set_key: If True, set a keyframe at this frame.
Input schema
{
"properties": {
"control_name": {
"type": "string"
},
"control_rig_asset_path": {
"type": "string"
},
"frame": {
"type": "integer"
},
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
},
"set_key": {
"default": true,
"type": "boolean"
},
"x": {
"default": 0,
"type": "number"
},
"y": {
"default": 0,
"type": "number"
},
"z": {
"default": 0,
"type": "number"
}
},
"required": [
"sequence",
"control_rig_asset_path",
"control_name",
"frame"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.set_priority_order¶
Set the evaluation priority order of a Control Rig track.
Args:
sequence: The LevelSequence.
control_rig_asset_path: Path to identify which Control Rig.
order: The priority order value to set.
Input schema
{
"properties": {
"control_rig_asset_path": {
"type": "string"
},
"order": {
"type": "integer"
},
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
}
},
"required": [
"sequence",
"control_rig_asset_path",
"order"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.set_rotator¶
Set a rotator control value at a specific frame.
Args:
sequence: The LevelSequence.
control_rig_asset_path: Path to identify which Control Rig.
control_name: Name of the rotator control.
frame: The frame number.
pitch: Pitch in degrees.
yaw: Yaw in degrees.
roll: Roll in degrees.
set_key: If True, set a keyframe at this frame.
Input schema
{
"properties": {
"control_name": {
"type": "string"
},
"control_rig_asset_path": {
"type": "string"
},
"frame": {
"type": "integer"
},
"pitch": {
"default": 0,
"type": "number"
},
"roll": {
"default": 0,
"type": "number"
},
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
},
"set_key": {
"default": true,
"type": "boolean"
},
"yaw": {
"default": 0,
"type": "number"
}
},
"required": [
"sequence",
"control_rig_asset_path",
"control_name",
"frame"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.set_scale¶
Set a scale control value at a specific frame.
Args:
sequence: The LevelSequence.
control_rig_asset_path: Path to identify which Control Rig.
control_name: Name of the scale control.
frame: The frame number.
x: X scale.
y: Y scale.
z: Z scale.
set_key: If True, set a keyframe at this frame.
Input schema
{
"properties": {
"control_name": {
"type": "string"
},
"control_rig_asset_path": {
"type": "string"
},
"frame": {
"type": "integer"
},
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
},
"set_key": {
"default": true,
"type": "boolean"
},
"x": {
"default": 1,
"type": "number"
},
"y": {
"default": 1,
"type": "number"
},
"z": {
"default": 1,
"type": "number"
}
},
"required": [
"sequence",
"control_rig_asset_path",
"control_name",
"frame"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.set_space¶
Set the space for a Control Rig control at a given frame.
Args:
sequence: The LevelSequence.
control_rig_asset_path: Path to identify which Control Rig.
control_name: Name of the control.
space_type: One of 'world', 'default_parent', 'control', or 'bone'.
For 'control' or 'bone', space_target must name the element.
frame: Frame at which to set the space switch key.
space_target: For 'control' or 'bone' types, the name of the
target element. Ignored for 'world' and 'default_parent'.
Returns:
True if the space key was set successfully.
Input schema
{
"properties": {
"control_name": {
"type": "string"
},
"control_rig_asset_path": {
"type": "string"
},
"frame": {
"type": "integer"
},
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
},
"space_target": {
"type": "string"
},
"space_type": {
"type": "string"
}
},
"required": [
"sequence",
"control_rig_asset_path",
"control_name",
"space_type",
"frame",
"space_target"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.set_transform¶
Set a transform value on a Control Rig control and optionally key it.
Uses ControlRigSequencerLibrary.set_local_control_rig_transform.
Args:
sequence: The LevelSequence.
control_rig_asset_path: Path to identify which CR (used to find the rig).
control_name: The control name (e.g. 'body_ctrl').
frame: The frame number.
location_x: X location.
location_y: Y location.
location_z: Z location.
rotation_pitch: Pitch rotation in degrees.
rotation_yaw: Yaw rotation in degrees.
rotation_roll: Roll rotation in degrees.
set_key: If True, set a keyframe at this frame.
Input schema
{
"properties": {
"control_name": {
"type": "string"
},
"control_rig_asset_path": {
"type": "string"
},
"frame": {
"type": "integer"
},
"location_x": {
"default": 0,
"type": "number"
},
"location_y": {
"default": 0,
"type": "number"
},
"location_z": {
"default": 0,
"type": "number"
},
"rotation_pitch": {
"default": 0,
"type": "number"
},
"rotation_roll": {
"default": 0,
"type": "number"
},
"rotation_yaw": {
"default": 0,
"type": "number"
},
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
},
"set_key": {
"default": true,
"type": "boolean"
}
},
"required": [
"sequence",
"control_rig_asset_path",
"control_name",
"frame"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.set_vector2d¶
Set a Vector2D control value at a specific frame.
Args:
sequence: The LevelSequence.
control_rig_asset_path: Path to identify which Control Rig.
control_name: Name of the Vector2D control.
frame: The frame number.
x: X component.
y: Y component.
set_key: If True, set a keyframe at this frame.
Input schema
{
"properties": {
"control_name": {
"type": "string"
},
"control_rig_asset_path": {
"type": "string"
},
"frame": {
"type": "integer"
},
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
},
"set_key": {
"default": true,
"type": "boolean"
},
"x": {
"default": 0,
"type": "number"
},
"y": {
"default": 0,
"type": "number"
}
},
"required": [
"sequence",
"control_rig_asset_path",
"control_name",
"frame"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.set_world_transform¶
Set a control's world-space transform at a specific frame.
Args:
sequence: The LevelSequence.
control_rig_asset_path: Path to identify which Control Rig.
control_name: Name of the control.
frame: The frame number.
location_x: World X location.
location_y: World Y location.
location_z: World Z location.
rotation_pitch: Pitch in degrees.
rotation_yaw: Yaw in degrees.
rotation_roll: Roll in degrees.
set_key: If True, set a keyframe at this frame.
Input schema
{
"properties": {
"control_name": {
"type": "string"
},
"control_rig_asset_path": {
"type": "string"
},
"frame": {
"type": "integer"
},
"location_x": {
"default": 0,
"type": "number"
},
"location_y": {
"default": 0,
"type": "number"
},
"location_z": {
"default": 0,
"type": "number"
},
"rotation_pitch": {
"default": 0,
"type": "number"
},
"rotation_roll": {
"default": 0,
"type": "number"
},
"rotation_yaw": {
"default": 0,
"type": "number"
},
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
},
"set_key": {
"default": true,
"type": "boolean"
}
},
"required": [
"sequence",
"control_rig_asset_path",
"control_name",
"frame"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.show_all_controls¶
Show all controls on a Control Rig section (unmask everything).
Args:
section: The Control Rig parameter section.
Input schema
{
"properties": {
"section": {
"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/MovieScene.MovieSceneSection",
"type": "object"
}
},
"required": [
"section"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.snap_control_rig¶
Snap Control Rig controls to a target actor over a frame range.
Args:
sequence: The LevelSequence.
control_rig_asset_path: Path to identify which Control Rig.
control_names: Names of controls to snap.
target_actor_name: Name or label of the target actor in the level.
start_frame: Start frame of the snap range.
end_frame: End frame of the snap range.
keep_offset: If True, maintain the initial offset.
snap_position: If True, snap position.
snap_rotation: If True, snap rotation.
snap_scale: If True, snap scale.
Returns:
True if the snap succeeded.
Input schema
{
"properties": {
"control_names": {
"items": {
"type": "string"
},
"type": "array"
},
"control_rig_asset_path": {
"type": "string"
},
"end_frame": {
"type": "integer"
},
"keep_offset": {
"default": false,
"type": "boolean"
},
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
},
"snap_position": {
"default": true,
"type": "boolean"
},
"snap_rotation": {
"default": true,
"type": "boolean"
},
"snap_scale": {
"default": false,
"type": "boolean"
},
"start_frame": {
"type": "integer"
},
"target_actor_name": {
"type": "string"
}
},
"required": [
"sequence",
"control_rig_asset_path",
"control_names",
"target_actor_name",
"start_frame",
"end_frame"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.tween_control_rig¶
Perform a tween operation on a Control Rig at the current Sequencer time.
The tween blends between the previous and next keyframe values.
Args:
sequence: The LevelSequence (must be open in Sequencer).
control_rig_asset_path: Path to identify which Control Rig.
tween_value: Blend value from -1.0 (previous key) to 1.0 (next key).
Returns:
True if tween succeeded.
Input schema
{
"properties": {
"control_rig_asset_path": {
"type": "string"
},
"sequence": {
"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/LevelSequence.LevelSequence",
"type": "object"
},
"tween_value": {
"type": "number"
}
},
"required": [
"sequence",
"control_rig_asset_path",
"tween_value"
],
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}
animation_toolset.toolsets.controlrig_sequencer.SequencerControlRigTools.zero_transforms¶
Reset Control Rig transforms to their default (usually zero) values.
Args:
selection_only: If True, only reset controls on rigs with
selected controls. If False, reset all.
include_channels: If True, include channels in addition to
parent controls.
Input schema
{
"properties": {
"include_channels": {
"default": true,
"type": "boolean"
},
"selection_only": {
"default": true,
"type": "boolean"
}
},
"type": "object"
}
Output schema
{
"properties": {
"returnValue": {
"type": "boolean"
}
},
"required": [
"returnValue"
],
"type": "object"
}