`anim` kit

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

Guide

Everything animation: sequences (curves, notifies, sync markers, root motion, additive, compression), montages, composites, blend spaces, pose assets, anim blueprints (anim graph nodes, state machines, layers), IK Rigs and IK Retargeters, motion matching (Pose Search) and Chooser tables, playback on actors during Play-In-Editor, and folder-wide audits.

Works on UE 4.27 through 5.8. A large part of the kit is 5.x-only (the whole anim.ikrig_*, anim.rtg_*, anim.ps_* and anim.chooser_* families, plus everything that goes through the 5.x animation data controller); those tools are hidden from tools/list on older engines and refused with E_NOT_SUPPORTED if called anyway.

The kit is split over several classes that all expose the anim. namespace:

Class	Prefix	What
`UUeaKit_AnimSequence`	`anim.`	sequence info, root motion, additive, compression, curves, bone tracks, notifies, sync markers, metadata, import/export
`UUeaKit_AnimMontage`	`anim.montage_`	montages: slots, segments, sections, links, blending, notifies
`UUeaKit_AnimBlendSpace`	`anim.bs_`	1D/2D blend spaces and aim offsets: axes, samples, interpolation
`UUeaKit_AnimPose`	`anim.pose_`	pose assets
`UUeaKit_AnimBlueprint`	`anim.bp_`, `anim.sm_`	anim blueprints, anim graph nodes, state machines, layers
`UUeaKit_AnimIK`	`anim.ikrig_`, `anim.rtg_`	IK Rigs and IK Retargeters (UE 5, IKRig plugin)
`UUeaKit_AnimPoseSearch`	`anim.ps_`, `anim.chooser_`	motion matching schemas/databases and chooser tables (UE 5.4+, PoseSearch / Chooser plugins)
`UUeaKit_AnimRuntime`	`anim.`	playback on actors in PIE, montage control, curve and bone queries, pose snapshots
`UUeaKit_AnimBatch`	`anim.`	folder audits, bulk edits, reverse lookups

Not here: skeletons and skeletal meshes (skel / mesh kits), Control Rig, generic blueprint variables and functions (bp kit), placing characters in a level (actor kit).

Start here

anim.list {"folder":"/Game/Animations"} — the sequences of a folder.
anim.get {"anim":"/Game/Animations/A_Run"} — length, frame rate, skeleton, notifies, curves.
anim.audit {"folder":"/Game/Animations"} — the whole folder with root motion, additive, compression and the flagged assets.
anim.validate {"anim":"..."} — one sequence checked for a missing skeleton, out-of-range notifies, zero length and root motion without a root track.

Everything that changes an asset is transactional (edit.undo works) but nothing is written to disk until you call anim.save or asset.save_all.

Recipes (sequences)

Filled in by the sequence theme: footstep notifies with sound, curve authoring, root motion and additive setup, compression.

Recipes (montages, blend spaces, pose assets)

Filled in by the montage/blend space theme: a montage with sections and links from three clips, a 2D locomotion blend space.

Recipes (anim blueprints)

Filled in by the anim blueprint theme: a complete locomotion anim blueprint in one call, state machines, transition rules, linked layers.

Recipes (IK rigs and retargeting, UE 5)

An IK rig for a character

anim.ikrig_create           {"folder":"/Game/Rigs","name":"IK_Hero","mesh":"/Game/Chars/SK_Hero"}
anim.ikrig_auto_chains      {"ikRig":"/Game/Rigs/IK_Hero"}      // 5.6+: characterise the skeleton
anim.ikrig_list_chains      {"ikRig":"/Game/Rigs/IK_Hero"}

anim.ikrig_auto_chains matches the skeleton against the engine templates (UE5 mannequin, Mixamo, ...) and generates every retarget chain plus the pelvis. When it reports matched: false, build the chains by hand:

anim.ikrig_set_retarget_root {"ikRig":"/Game/Rigs/IK_Hero","bone":"pelvis"}
anim.ikrig_add_chain  {"ikRig":"/Game/Rigs/IK_Hero","name":"LeftArm",
                       "startBone":"upperarm_l","endBone":"hand_l"}
anim.ikrig_add_goal   {"ikRig":"/Game/Rigs/IK_Hero","name":"HandGoal_L","bone":"hand_l"}
anim.ikrig_set_chain_goal {"ikRig":"/Game/Rigs/IK_Hero","chain":"LeftArm","goal":"HandGoal_L"}

Bone arguments accept a bone name, a bone index ("3") or "root" (the first bone of the skeleton), so a rig can be wired without knowing the naming convention up front. Call anim.ikrig_list_bones to see the real names.

Solving with a solver stack (UE 5.6+)

anim.ikrig_list_solver_types {}
anim.ikrig_add_solver   {"ikRig":"/Game/Rigs/IK_Hero","type":"FullBodyIK"}   // -> index 0
anim.ikrig_set_solver_root_bone {"ikRig":"...","index":0,"bone":"pelvis"}
anim.ikrig_connect_goal {"ikRig":"...","goal":"HandGoal_L","solverIndex":0}
anim.ikrig_set_solver_setting {"ikRig":"...","index":0,
                               "property":"Settings.RootBehavior","value":"PinToInput"}

Solver settings are addressed by property path on the solver struct; the reply of anim.ikrig_set_solver_setting lists every property of that solver, which is the fastest way to discover the names. On UE 5.0-5.5 the solver stack used UObject solvers with a different controller API and the anim.ikrig_*_solver* tools are hidden.

Retargeting a pack of animations onto another skeleton

anim.rtg_create           {"folder":"/Game/Rigs","name":"RTG_HeroToVillain",
                           "sourceRig":"/Game/Rigs/IK_Hero","targetRig":"/Game/Rigs/IK_Villain"}
anim.rtg_set_preview_mesh {"retargeter":"/Game/Rigs/RTG_HeroToVillain","side":"source",
                           "mesh":"/Game/Chars/SK_Hero"}
anim.rtg_set_preview_mesh {"retargeter":"/Game/Rigs/RTG_HeroToVillain","side":"target",
                           "mesh":"/Game/Chars/SK_Villain"}
anim.rtg_auto_map_chains  {"retargeter":"/Game/Rigs/RTG_HeroToVillain","mode":"fuzzy"}
anim.rtg_validate         {"retargeter":"/Game/Rigs/RTG_HeroToVillain"}
anim.rtg_retarget_animations {"retargeter":"/Game/Rigs/RTG_HeroToVillain",
                              "anims":["/Game/Animations/A_Run","/Game/Animations/A_Idle"],
                              "folder":"/Game/Animations/Villain","prefix":"V_"}

anim.rtg_validate is the gate: it reports missing rigs, missing preview meshes and every target chain without a source chain. Fix those with anim.rtg_map_chain before running the batch. Retarget poses (the A-pose/T-pose correction) are edited with anim.rtg_add_pose, anim.rtg_set_pose_bone_rotation and anim.rtg_set_current_pose; the pose argument may be left empty to mean "the current pose of that side".

From UE 5.6 a retargeter is a stack of retarget ops instead of one global settings block: anim.rtg_list_ops dumps the stack with every op property, and anim.rtg_set_op_setting writes one with "<opName>.<property>" keys. On 5.0-5.5 use anim.rtg_set_global_settings, anim.rtg_set_root_settings and anim.rtg_set_chain_settings instead (those three are hidden on 5.6+).

Recipes (motion matching and choosers, UE 5.4+)

A motion matching database

anim.ps_create_schema  {"folder":"/Game/MM","name":"PSS_Locomotion",
                        "skeleton":"/Game/Chars/SK_Hero_Skeleton","sampleRate":30}
anim.ps_add_channel    {"schema":"/Game/MM/PSS_Locomotion","type":"trajectory","weight":1.0}
anim.ps_add_channel    {"schema":"/Game/MM/PSS_Locomotion","type":"pose",
                        "bones":["foot_l","foot_r"],"weight":1.0}
anim.ps_create_database{"folder":"/Game/MM","name":"PSDB_Locomotion",
                        "schema":"/Game/MM/PSS_Locomotion"}
anim.ps_add_animation  {"database":"/Game/MM/PSDB_Locomotion","anim":"/Game/Animations/A_Run"}
anim.ps_build          {"database":"/Game/MM/PSDB_Locomotion"}

anim.ps_build kicks the derived-data index build and waits for it, so it is the call that tells you whether the schema is actually valid: a channel referencing a bone that does not exist on the skeleton fails here, not at creation. Channel properties that are not covered by the bones, weight arguments are set through properties with dotted paths ("Bone.BoneName").

A chooser table

anim.chooser_create   {"folder":"/Game/MM","name":"CH_Attack","outputType":"AnimMontage"}
anim.chooser_add_column {"chooser":"/Game/MM/CH_Attack","type":"bool"}
anim.chooser_add_row  {"chooser":"/Game/MM/CH_Attack","result":"/Game/Anim/AM_AttackLight",
                       "cells":["true"]}
anim.chooser_add_row  {"chooser":"/Game/MM/CH_Attack","result":"/Game/Anim/AM_AttackHeavy",
                       "cells":["false"]}

Cells are written in text form and converted to the column's own value type; the bool column accepts "true", "false" and "any". The binding of a column to a property of the context object is not exposed yet: open the chooser asset to bind it, or set the column's InputValue through the generic property tools.

Recipes (playback in PIE)

play.start            {}
anim.spawn_test_actor {"mesh":"/Game/Chars/SK_Hero","label":"AnimTestActor"}
anim.play             {"actor":"AnimTestActor","anim":"/Game/Animations/A_Run","loop":true}
anim.get_anim_state   {"actor":"AnimTestActor"}
anim.set_position     {"actor":"AnimTestActor","time":0.5}
anim.get_bone_transform_runtime {"actor":"AnimTestActor","bone":"hand_r","space":"world"}
anim.snapshot_pose    {"actor":"AnimTestActor","folder":"/Game/Poses","name":"PA_RunFrame"}

To test a montage, the actor needs an anim instance with the montage's slot:

anim.set_anim_blueprint {"actor":"AnimTestActor","animBlueprint":"/Game/Chars/ABP_Hero"}
anim.montage_play       {"actor":"AnimTestActor","montage":"/Game/Anim/AM_Attack"}
anim.montage_jump_to_section {"actor":"AnimTestActor","section":"Combo2"}
anim.montage_stop       {"actor":"AnimTestActor","blendOut":0.2}

anim.set_anim_blueprint is the only runtime tool that also works outside PIE (on the actor of the editor world); everything else needs a running session and returns E_EDITOR_STATE otherwise. Actor arguments use the same loose lookup as the actor kit: label, object name or a unique class name.

Recipes (folder work)

anim.audit                     {"folder":"/Game/Animations"}
anim.batch_set_root_motion     {"folder":"/Game/Animations/Locomotion","enabled":true,
                                "lockType":"animFirstFrame","dryRun":false}
anim.batch_add_notify          {"folder":"/Game/Animations/Locomotion","name":"Footstep",
                                "timeRatio":0.25,"dryRun":false}
anim.find_by_notify            {"folder":"/Game/Animations","name":"Footstep"}
anim.find_montages_using       {"anim":"/Game/Animations/A_Run"}
anim.find_anim_blueprints_using{"anim":"/Game/Animations/A_Run"}

Every anim.batch_* tool defaults to dryRun: true and reports what it would change, with one row per sequence; pass "dryRun": false to commit. anim.batch_set_skeleton is risk 3 (it re-targets the sequences) — preview it first.

Gotchas

Plugins. anim.ikrig_* / anim.rtg_* need the IKRig plugin, anim.ps_* the PoseSearch plugin and anim.chooser_* the Chooser plugin, all of them UE 5 only. The tools are hidden from tools/list when the plugin is disabled, and tools/call refuses them naming the missing plugin. Enabling a plugin needs an editor restart.
Engine differences. UE 5.6 rewrote both the IK rig solver stack (UObject solvers → instanced structs) and the retargeter settings model (global/root/chain settings → retarget ops). The kit exposes one tool shape per concept and gates the halves with minEngine / maxEngine; read the annotations.uea of a tool before assuming it exists.
Retargeters need their default ops. anim.rtg_create adds them on 5.6+; a retargeter built by hand without them silently produces no motion.
The mesh drives the rig. anim.ikrig_set_mesh refuses a mesh whose bone hierarchy does not match the one already loaded; create a second rig instead.
Montages need a slot. anim.montage_play fails when the anim instance has no slot node for the montage's slot; anim.play (single node) always works.
Saving. Nothing is saved to disk automatically. Use asset.save_all at the end of a session, or the per-family *_save tools.

Tools

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

`anim.add_aim_offset` (risk 2, mutates, smoke)

Adds an aim offset node (rotation offset blend space applied on top of a base pose).

Argument	Type	Description
`blendSpace`	string	Blend space / aim offset asset; may be empty to set it later.
`playRate`	number	Default `1.0f`.
`loop`	boolean	Default `true`.

Returns: node, compileErrors, propertyErrors.

`anim.add_apply_additive` (risk 2, mutates, smoke)

Adds an apply-additive node (Base, Additive, Alpha).

Argument	Type	Description
`animBlueprint`	string	required.
`graph`	string	Target graph; empty = "AnimGraph".
`x`	integer	Default `0`.
`y`	integer	Default `0`.
`properties`	array of UeaKeyValue	Extra property assignments applied after the typed ones.
`connectToOutput`	boolean	Connect the node's output pose to the graph's result node. Default `false`.
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: node, compileErrors, propertyErrors.

`anim.add_blend_by_bool` (risk 2, mutates, smoke)

Adds a blend-list-by-bool node (true/false poses).

Argument	Type	Description
`animBlueprint`	string	required.
`graph`	string	Target graph; empty = "AnimGraph".
`x`	integer	Default `0`.
`y`	integer	Default `0`.
`properties`	array of UeaKeyValue	Extra property assignments applied after the typed ones.
`connectToOutput`	boolean	Connect the node's output pose to the graph's result node. Default `false`.
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: node, compileErrors, propertyErrors.

`anim.add_blend_by_enum` (risk 2, mutates, smoke)

Adds a blend-list-by-enum node bound to an enum (one blend pose per enumerator).

Argument	Type	Description
`enum`	string	required. Enum asset or native enum name driving the blend.

Returns: node, compileErrors, propertyErrors.

`anim.add_blend_by_int` (risk 2, mutates, smoke)

Adds a blend-list-by-int node with the requested number of blend poses.

Argument	Type	Description
`poses`	integer	Number of blend poses to expose (minimum 2). Default `2`.

Returns: node, compileErrors, propertyErrors.

`anim.add_blend_space_player` (risk 2, mutates, smoke)

Adds a blend space player node.

Argument	Type	Description
`blendSpace`	string	Blend space / aim offset asset; may be empty to set it later.
`playRate`	number	Default `1.0f`.
`loop`	boolean	Default `true`.

Returns: node, compileErrors, propertyErrors.

`anim.add_cached_pose` (risk 2, mutates, smoke)

Adds a save-cached-pose node under a cache name.

Argument	Type	Description
`name`	string	required.

Returns: node, compileErrors, propertyErrors.

`anim.add_control_rig` (risk 2, mutates, requires plugin ControlRig)

Adds a Control Rig node running a control rig class on the incoming pose.

Argument	Type	Description
`rig`	string	required. Control Rig Blueprint / class.

Returns: node, compileErrors, propertyErrors.

`anim.add_curve` (risk 2, mutates, smoke)

Adds an empty curve (float, vector or transform; 'metadata' makes it a constant metadata curve).

Argument	Type	Description
`anim`	string	required.
`curve`	string	required. Curve name.
`type`	string	float (default), vector or transform.
`metadata`	boolean	Create the curve as a metadata curve (a constant value, no keys). Default `false`.

Returns: anim, curve, type, keys, exists, message.

`anim.add_curve_key` (risk 2, mutates, smoke)

Adds one key to a float curve.

Argument	Type	Description
`anim`	string	required.
`curve`	string	required.
`time`	number	required. Key time in seconds.
`value`	number	required. Key value.
`create`	boolean	Create the curve when it does not exist yet. Default `true`.

Returns: anim, curve, type, keys, exists, message.

`anim.add_curve_keys` (risk 2, mutates, smoke)

Adds several keys to a float curve at once.

Argument	Type	Description
`anim`	string	required.
`curve`	string	required.
`times`	array of number	required. Key times in seconds.
`values`	array of number	required. One value per time.
`create`	boolean	Create the curve when it does not exist yet. Default `true`.

Returns: anim, curve, type, keys, exists, message.

`anim.add_inertialization` (risk 2, mutates, smoke)

Adds an inertialization node (used as the blend target of inertial blends).

Argument	Type	Description
`animBlueprint`	string	required.
`graph`	string	Target graph; empty = "AnimGraph".
`x`	integer	Default `0`.
`y`	integer	Default `0`.
`properties`	array of UeaKeyValue	Extra property assignments applied after the typed ones.
`connectToOutput`	boolean	Connect the node's output pose to the graph's result node. Default `false`.
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: node, compileErrors, propertyErrors.

`anim.add_layered_bone_blend` (risk 2, mutates, smoke)

Adds a layered bone blend node with one layer per bone (blend depth defaults to 1).

Argument	Type	Description
`bones`	array of string	Root bone of each blend layer (one layer per bone).
`blendDepth`	array of integer	Blend depth per layer; missing entries default to 1.
`meshSpaceRotationBlend`	boolean	Blend rotations in mesh space. Default `false`.

Returns: node, compileErrors, propertyErrors.

`anim.add_linked_anim_graph` (risk 2, mutates, smoke)

Adds a linked anim graph node running another Anim Blueprint / AnimInstance class.

Argument	Type	Description
`class`	string	required. Anim Blueprint (or AnimInstance class) to run in the linked graph.

Returns: node, compileErrors, propertyErrors.

`anim.add_linked_anim_layer` (risk 2, mutates, smoke)

Adds a linked anim layer node for a layer of an anim layer interface (or of this Anim Blueprint).

Argument	Type	Description
`layer`	string	required. Layer (anim graph function) name.
`interface`	string	Anim Layer Interface declaring the layer; empty = self layer.

Returns: node, compileErrors, propertyErrors.

`anim.add_look_at` (risk 2, mutates, smoke)

Adds a look-at node rotating a bone towards a target bone/socket or a location.

Argument	Type	Description
`bone`	string	required. Bone that will be rotated.
`lookAtBone`	string	Bone or socket to look at; empty uses LookAtLocation.
`lookAtLocation`	{x,y,z}

Returns: node, compileErrors, propertyErrors.

`anim.add_metadata` (risk 2, mutates)

Attaches a metadata object of a UAnimMetaData subclass. Not smoke-tested: UAnimMetaData is abstract and the engine ships no concrete subclass.

Argument	Type	Description
`anim`	string	required.
`class`	string	required. UAnimMetaData subclass (short name or path).
`properties`	array of UeaKeyValue	Properties applied to the created metadata object.

Returns: anim, metaData, count, message.

`anim.add_mirror` (risk 2, mutates, UE 5.1+, smoke)

Adds a mirror node driven by a mirror data table (UE 5.1+).

Argument	Type	Description
`mirrorTable`	string	Mirror data table asset.

Returns: node, compileErrors, propertyErrors.

`anim.add_modify_bone` (risk 2, mutates, smoke)

Adds a transform (modify) bone node. Modes default to "replace" for every component given a value.

Argument	Type	Description
`bone`	string	required.
`translation`	{x,y,z}
`rotation`	{x,y,z}	Rotation as pitch/yaw/roll.
`scale`	{x,y,z}
`translationMode`	string	ignore, replace or add for translation/rotation/scale. Default: ignore unless a value is given.
`rotationMode`	string
`scaleMode`	string

Returns: node, compileErrors, propertyErrors.

`anim.add_niagara_notify` (risk 2, mutates, UE 5.0+)

Adds a Play Niagara Effect notify (UE 5, Niagara plugin). Not smoke-tested: no Niagara system ships in engine content.

Argument	Type	Description
`anim`	string	required.
`time`	number	required.
`template`	string	Particle system (anim.add_particle_notify) or Niagara system (anim.add_niagara_notify).
`track`	string
`socket`	string	Socket the effect is spawned on.
`attached`	boolean	Keep the effect attached to the mesh. Default `true`.

Returns: anim, index, name, class, time, duration, track, removed, notifies, message.

`anim.add_node` (risk 2, mutates, smoke)

Adds a node of any anim graph node class ("SequencePlayer", "Slot", "TwoWayBlend"...), applies Properties and optionally wires its pose to the graph result.

Argument	Type	Description
`animBlueprint`	string	required.
`nodeClass`	string	required. Short name ("SequencePlayer", "Slot", "TwoWayBlend") or full class name.
`graph`	string	Target graph; empty = "AnimGraph".
`x`	integer	Default `0`.
`y`	integer	Default `0`.
`properties`	array of UeaKeyValue	Property assignments applied to the new node (names of the FAnimNode_* struct).
`connectToOutput`	boolean	Connect the node's output pose to the graph's result node. Default `false`.
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: node, compileErrors, propertyErrors.

`anim.add_notify` (risk 2, mutates, smoke)

Adds a notify: a plain named notify when no class is given, otherwise an instance of the UAnimNotify subclass.

Argument	Type	Description
`anim`	string	required.
`name`	string	Notify name (used when no class is given: a skeleton notify event).
`time`	number	required. Trigger time in seconds.
`track`	string	Notify track ("1" when empty).
`notifyClass`	string	UAnimNotify subclass (short name or path); empty creates a plain named notify.
`properties`	array of UeaKeyValue	Properties applied to the created notify object.

Returns: anim, index, name, class, time, duration, track, removed, notifies, message.

`anim.add_notify_object` (risk 2, mutates, smoke)

Adds a notify of a class and applies properties to the created notify object in one call.

Argument	Type	Description
`anim`	string	required.
`name`	string	Notify name (used when no class is given: a skeleton notify event).
`time`	number	required. Trigger time in seconds.
`track`	string	Notify track ("1" when empty).
`notifyClass`	string	UAnimNotify subclass (short name or path); empty creates a plain named notify.
`properties`	array of UeaKeyValue	Properties applied to the created notify object.

Returns: anim, index, name, class, time, duration, track, removed, notifies, message.

`anim.add_notify_state` (risk 2, mutates, smoke)

Adds a notify state (a notify with a duration) of the given UAnimNotifyState subclass.

Argument	Type	Description
`anim`	string	required.
`notifyClass`	string	required. UAnimNotifyState subclass (short name or path).
`time`	number	required.
`duration`	number	required. Duration in seconds.
`track`	string
`properties`	array of UeaKeyValue

Returns: anim, index, name, class, time, duration, track, removed, notifies, message.

`anim.add_notify_track` (risk 2, mutates, smoke)

Adds a notify track.

Argument	Type	Description
`anim`	string	required.
`track`	string	required. Notify track name.
`newName`	string	New track name (anim.rename_notify_track only).

Returns: anim, tracks, count, message.

`anim.add_particle_notify` (risk 2, mutates)

Adds a Play Particle Effect notify. Not smoke-tested: no particle system ships in engine content.

Argument	Type	Description
`anim`	string	required.
`time`	number	required.
`template`	string	Particle system (anim.add_particle_notify) or Niagara system (anim.add_niagara_notify).
`track`	string
`socket`	string	Socket the effect is spawned on.
`attached`	boolean	Keep the effect attached to the mesh. Default `true`.

Returns: anim, index, name, class, time, duration, track, removed, notifies, message.

`anim.add_play_sound_notify` (risk 2, mutates, smoke)

Adds a Play Sound notify with volume, pitch and attachment settings.

Argument	Type	Description
`anim`	string	required.
`time`	number	required.
`sound`	string	Sound asset to play; may be empty and set later.
`track`	string
`volume`	number	Default `1.0`.
`pitch`	number	Default `1.0`.
`follow`	boolean	Attach the sound to the mesh instead of playing it at the actor location. Default `false`.
`attachName`	string	Socket or bone the sound follows when 'follow' is set.

Returns: anim, index, name, class, time, duration, track, removed, notifies, message.

`anim.add_pose_asset_player` (risk 2, mutates)

Adds a pose asset player: a pose-by-name node when PoseName is given, a pose blend node otherwise.

Argument	Type	Description
`pose`	string	required. Pose asset.
`poseName`	string	Pose name for a "by name" player; empty adds a pose blend node.

Returns: node, compileErrors, propertyErrors.

`anim.add_random_player` (risk 2, mutates, smoke)

Adds a random player node with one entry per animation.

Argument	Type	Description
`anims`	array of string	Animation sequences to pick from.

Returns: node, compileErrors, propertyErrors.

`anim.add_rigid_body` (risk 2, mutates, smoke)

Adds a rigid body (physics simulation) node, optionally overriding the physics asset.

Argument	Type	Description
`physicsAsset`	string	Physics asset overriding the mesh's own.

Returns: node, compileErrors, propertyErrors.

`anim.add_sequence_evaluator` (risk 2, mutates, smoke)

Adds a sequence evaluator node (explicit time instead of playback).

Argument	Type	Description
`anim`	string	Animation sequence asset; may be empty.
`explicitTime`	number	Explicit evaluation time in seconds. Default `0.0f`.

Returns: node, compileErrors, propertyErrors.

`anim.add_sequence_player` (risk 2, mutates, smoke)

Adds a sequence player node. Anim may be empty to create the node and set the sequence later.

Argument	Type	Description
`anim`	string	Animation sequence asset; may be empty to create the node and set the sequence later.
`playRate`	number	Default `1.0f`.
`loop`	boolean	Default `true`.
`startPosition`	number	Default `0.0f`.

Returns: node, compileErrors, propertyErrors.

`anim.add_slot` (risk 2, mutates, smoke)

Adds a montage slot node (default slot name "DefaultSlot").

Argument	Type	Description
`slotName`	string	Montage slot name; default "DefaultSlot".

Returns: node, compileErrors, propertyErrors.

`anim.add_state_machine` (risk 2, mutates, smoke)

Adds a state machine node with an empty state machine graph; edit it with the anim.sm_* tools.

Argument	Type	Description
`name`	string	required.

Returns: node, compileErrors, propertyErrors.

`anim.add_sync_marker` (risk 2, mutates, smoke)

Adds a sync marker on a notify track.

Argument	Type	Description
`anim`	string	required.
`name`	string	required. Marker name.
`time`	number	required.
`track`	string	Notify track the marker sits on ("1" when empty).

Returns: anim, markers, names, count, removed, message.

`anim.add_trail_notify_state` (risk 2, mutates)

Adds a Trail notify state between two sockets. Not smoke-tested: it needs a particle system with a trail module.

Argument	Type	Description
`anim`	string	required.
`time`	number	required.
`duration`	number	required.
`track`	string
`template`	string	Particle system used by the trail.
`firstSocket`	string	First socket of the trail.
`secondSocket`	string	Second socket of the trail.

Returns: anim, index, name, class, time, duration, track, removed, notifies, message.

`anim.add_transform_curve_key` (risk 2, mutates, smoke)

Adds one key to a transform curve.

Argument	Type	Description
`anim`	string	required.
`curve`	string	required.
`time`	number	required.
`location`	{x,y,z}
`rotation`	{x,y,z}	Rotation as pitch/yaw/roll.
`scale`	{x,y,z}	Scale; (0,0,0) means 1,1,1.
`create`	boolean	Default `true`.

Returns: anim, curve, type, keys, exists, message.

`anim.add_two_bone_ik` (risk 2, mutates, smoke)

Adds a two bone IK node on an end-effector bone.

Argument	Type	Description
`ikBone`	string	required. End-effector bone of the two-bone chain.
`effectorLocation`	{x,y,z}
`jointTargetLocation`	{x,y,z}
`effectorSpace`	string	BCS_WorldSpace, BCS_ComponentSpace, BCS_ParentBoneSpace, BCS_BoneSpace.

Returns: node, compileErrors, propertyErrors.

`anim.add_two_way_blend` (risk 2, mutates, smoke)

Adds a two-way blend node (A, B, Alpha).

Argument	Type	Description
`animBlueprint`	string	required.
`graph`	string	Target graph; empty = "AnimGraph".
`x`	integer	Default `0`.
`y`	integer	Default `0`.
`properties`	array of UeaKeyValue	Extra property assignments applied after the typed ones.
`connectToOutput`	boolean	Connect the node's output pose to the graph's result node. Default `false`.
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: node, compileErrors, propertyErrors.

`anim.add_use_cached_pose` (risk 2, mutates, smoke)

Adds a use-cached-pose node referencing an existing save-cached-pose by name.

Argument	Type	Description
`name`	string	required.

Returns: node, compileErrors, propertyErrors.

`anim.add_vector_curve_key` (risk 2, mutates)

Adds one key to a vector curve. Not smoke-tested: the UE 5 animation data model stores float and transform curves only.

Argument	Type	Description
`anim`	string	required.
`curve`	string	required.
`time`	number	required.
`value`	{x,y,z}
`create`	boolean	Default `true`.

Returns: anim, curve, type, keys, exists, message.

`anim.add_virtual_bone` (risk 2, mutates)

Adds a virtual bone between two bones of the sequence's skeleton. Not smoke-tested: the engine fixture mesh has a minimal skeleton.

Argument	Type	Description
`anim`	string	required.
`sourceBone`	string	required. Bone the virtual bone starts from.
`targetBone`	string	required. Bone the virtual bone points at.

Returns: anim, names, count, message.

`anim.apply_compression` (risk 2, mutates, smoke)

Rebuilds the compressed animation data of a sequence.

Argument	Type	Description
`anim`	string	required. Animation sequence asset path or unique name.

Returns: anim, boneSettings, curveSettings, compressedSizeBytes, message.

`anim.apply_modifier` (risk 3, mutates)

Runs an animation modifier on a sequence. Not smoke-tested: the engine ships no animation modifier asset.

Argument	Type	Description
`anim`	string	required.
`modifierClass`	string	required. UAnimationModifier subclass (blueprint asset path or class name).
`properties`	array of UeaKeyValue	Properties applied to the modifier before running it.

Returns: anim, name, message.

`anim.arrange_nodes` (risk 2, mutates, smoke)

Lays the nodes of an anim graph out in columns from the result node leftwards.

Argument	Type	Description
`animBlueprint`	string	required.
`graph`	string
`spacingX`	integer	Horizontal spacing between columns (default 320). Default `320`.
`spacingY`	integer	Vertical spacing between rows (default 180). Default `180`.

Returns: count, details, compileErrors.

`anim.audit` (risk 0, smoke)

Audits every animation sequence of a folder: length, rate, root motion, additive, compression, notifies and curves.

Argument	Type	Description
`onlyOffenders`	boolean	Only return the flagged sequences. Default `false`.

Returns: anims, count, offenders, withRootMotion, additive, totalLength, message.

`anim.bake_curve_from_bone` (risk 2, mutates, smoke)

Bakes one component of a bone's animation (position, rotation, scale or distance to the parent) into a float curve. 'bone' accepts a name or a track index.

Argument	Type	Description
`anim`	string	required.
`bone`	string	required.
`component`	string	required. posX, posY, posZ, rotPitch, rotYaw, rotRoll, scaleX, scaleY, scaleZ or distance.
`curve`	string	required. Destination curve name.
`space`	string	local (default) or component space sampling.
`samples`	integer	Number of samples; 0 uses one sample per frame. Default `0`.

Returns: anim, curve, type, keys, exists, message.

`anim.batch_add_notify` (risk 2, mutates, dryRun, smoke)

Adds the same notify to every sequence of a folder, at a fraction of each sequence's length.

Argument	Type	Description
`name`	string	required. Notify name added to every sequence.
`timeRatio`	number	Position as a fraction of the sequence length (0..1). Default `0.5`.
`track`	string	Notify track (created when missing). Default `TEXT("1")`.
`dryRun`	boolean	Default `true`.

Returns: anims, count, changed, dryRun, message.

`anim.batch_apply_modifier` (risk 3, mutates, dryRun)

Applies (or reverts) an Animation Modifier on every sequence of a folder.

Argument	Type	Description
`modifierClass`	string	required. UAnimationModifier subclass (path or short name).
`revert`	boolean	Revert the modifier instead of applying it. Default `false`.
`dryRun`	boolean	Default `true`.

Returns: anims, count, changed, dryRun, message.

`anim.batch_remove_notifies_by_name` (risk 3, mutates, dryRun, smoke)

Removes every notify with a given name from every sequence of a folder.

Argument	Type	Description
`name`	string	required. Name to look for.
`dryRun`	boolean	Default `true`.

Returns: anims, count, changed, dryRun, message.

`anim.batch_rename_curve` (risk 2, mutates, dryRun, smoke)

Renames a float curve in every sequence of a folder that has it (keys are preserved).

Argument	Type	Description
`curve`	string	required. Existing float curve name.
`newName`	string	required. New curve name.
`dryRun`	boolean	Default `true`.

Returns: anims, count, changed, dryRun, message.

`anim.batch_set_compression` (risk 2, mutates, dryRun, smoke)

Assigns bone and/or curve compression settings to every sequence of a folder.

Argument	Type	Description
`boneSettings`	string	Bone compression settings asset (empty leaves it alone).
`curveSettings`	string	Curve compression settings asset (empty leaves it alone).
`dryRun`	boolean	Default `true`.

Returns: anims, count, changed, dryRun, message.

`anim.batch_set_rate_scale` (risk 2, mutates, dryRun, smoke)

Sets the play rate scale of every sequence of a folder.

Argument	Type	Description
`rateScale`	number	Default `1.0`.
`dryRun`	boolean	Default `true`.

Returns: anims, count, changed, dryRun, message.

`anim.batch_set_root_motion` (risk 2, mutates, dryRun, smoke)

Turns root motion on or off (and sets the root lock) for every sequence of a folder.

Argument	Type	Description
`enabled`	boolean	Default `true`.
`lockType`	string	"refPose", "animFirstFrame" or "zero" (empty leaves it alone).
`forceRootLock`	string	Force the root lock even when root motion is disabled ("true"/"false", empty leaves it alone).
`dryRun`	boolean	Default `true`.

Returns: anims, count, changed, dryRun, message.

`anim.batch_set_skeleton` (risk 3, mutates, dryRun, smoke)

Re-targets every sequence of a folder onto another skeleton.

Argument	Type	Description
`skeleton`	string	required. Skeleton assigned to every sequence of the folder.
`convertSpaces`	boolean	Remap the bone tracks to the new skeleton's bone names. Default `true`.
`dryRun`	boolean	Default `true`.

Returns: anims, count, changed, dryRun, message.

`anim.bind_property` (risk 2, mutates, smoke)

Binds a node property to an Anim Blueprint variable (5.x property bindings; the variable is created when missing).

Argument	Type	Description
`animBlueprint`	string	required.
`nodeId`	string	required.
`property`	string	required. Property of the FAnimNode_* struct to drive ("PlayRate").
`variable`	string	required. Variable name (or dotted property path) of the Anim Blueprint to read from.
`graph`	string
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: bindings, count, compileErrors.

`anim.bp_add_layer` (risk 2, mutates, smoke)

Adds an anim layer (an anim graph function with its own result node) to the Anim Blueprint.

Argument	Type	Description
`animBlueprint`	string	required.
`name`	string	required. Layer name (becomes an anim graph function).
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: layers, count, compileErrors.

`anim.bp_add_notify_event` (risk 2, mutates, smoke)

Adds an AnimNotify event node ("AnimNotify_") to the event graph of the Anim Blueprint.

Argument	Type	Description
`animBlueprint`	string	required.
`notifyName`	string	required. Notify name without the "AnimNotify_" prefix (e.g. "Footstep").
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: id, title, graph, compileErrors.

`anim.bp_add_variable` (risk 2, mutates, smoke)

Adds a member variable (bool/float/int/vector/rotator/name/object:Class...) used by transition rules and property bindings.

Argument	Type	Description
`animBlueprint`	string	required.
`name`	string	required.
`type`	string	required. bool, float, int, byte, name, string, vector, rotator, transform, object:Class, class:Class, enum:Name, struct:Name.
`defaultValue`	string	Default value as text ("true", "1.5", "0,0,0").
`category`	string	Details-panel category.
`instanceEditable`	boolean	Expose the variable on instances (default true). Default `true`.
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: variables, count, compileErrors.

`anim.bp_compile` (risk 2, mutates, smoke)

Compiles the Anim Blueprint and returns the errors and warnings of the compile.

Argument	Type	Description
`animBlueprint`	string	required. Anim Blueprint asset path or unique name.

Returns: success, status, errors, warnings, numErrors, numWarnings.

`anim.bp_create` (risk 2, mutates, smoke)

Creates an Anim Blueprint. Give Skeleton (a skeleton, skeletal mesh or animation asset) or FromAnim to derive it; Template=true makes a 5.x skeleton-less template. Returns the asset and its graphs.

Argument	Type	Description
`folder`	string	required. Destination folder, e.g. "/Game/Anim".
`name`	string	required. Asset name without path (no spaces, slashes or dots).
`skeleton`	string	Target skeleton asset. Optional when FromAnim is given or Template is true.
`fromAnim`	string	Any animation asset (sequence, montage, blend space) whose skeleton is used when Skeleton is empty.
`parentClass`	string	Parent AnimInstance class. Default: AnimInstance.
`template`	boolean	5.0+: create a skeleton-less Anim Blueprint template. Default `false`.
`previewMesh`	string	Optional preview skeletal mesh.

Returns: asset, skeleton, parentClass, generatedClass, previewMesh, status, isTemplate, isInterface, graphs, stateMachines, layers, interfaces, variableCount, compileErrors.

`anim.bp_create_layer_interface` (risk 2, mutates, smoke)

Creates an Anim Layer Interface (an interface Anim Blueprint) declaring the given layer names.

Argument	Type	Description
`folder`	string	required.
`name`	string	required.
`layers`	array of string	Layer (anim graph function) names to declare in the interface.

`anim.bp_delete` (risk 3, mutates, destructive, dryRun, smoke)

Deletes an Anim Blueprint asset. Fails when other assets still reference it unless DryRun is used to check first.

Argument	Type	Description
`animBlueprint`	string	required.
`dryRun`	boolean	Report only, do not delete. Default `false`.

Returns: deleted, path, wouldDelete.

`anim.bp_duplicate` (risk 2, mutates, smoke)

Duplicates an Anim Blueprint into a folder under a new name.

Argument	Type	Description
`animBlueprint`	string	required.
`folder`	string	Destination folder; default: the source folder.
`name`	string	New asset name; default: source name + "_Copy".

`anim.bp_get` (risk 0, smoke)

Full description of an Anim Blueprint: skeleton, parent, status, graphs, state machines, layers, interfaces and variable count.

Argument	Type	Description
`animBlueprint`	string	required. Anim Blueprint asset path or unique name.

`anim.bp_get_class_defaults` (risk 0, smoke)

Reads the editable class defaults of the generated AnimInstance CDO.

Argument	Type	Description
`animBlueprint`	string	required. Anim Blueprint asset path or unique name.

Returns: properties, count, errors.

`anim.bp_get_compile_errors` (risk 2, mutates, smoke)

Compiles silently and reports only the diagnostics (same as anim.bp_compile, kept for discoverability).

Argument	Type	Description
`animBlueprint`	string	required. Anim Blueprint asset path or unique name.

Returns: success, status, errors, warnings, numErrors, numWarnings.

`anim.bp_implement_interface` (risk 2, mutates, smoke)

Implements an Anim Layer Interface on an Anim Blueprint (its layers become anim graph functions).

Argument	Type	Description
`animBlueprint`	string	required.
`interface`	string	required. Anim Layer Interface asset (or its generated class name).

`anim.bp_list` (risk 0, smoke)

Lists Anim Blueprint assets under a folder, optionally filtered by target skeleton and name substring.

Argument	Type	Description
`folder`	string	Folder to search; default "/Game".
`skeleton`	string	Only Anim Blueprints targeting this skeleton.
`nameContains`	string	Case-insensitive substring of the asset name.
`limit`	integer	Maximum results; 0 = no limit. Default `0`.

Returns: assets, count.

`anim.bp_list_layers` (risk 0, smoke)

Lists the anim layers (anim graph functions) of the Anim Blueprint with the interface each comes from.

Argument	Type	Description
`animBlueprint`	string	required. Anim Blueprint asset path or unique name.

Returns: layers, count, compileErrors.

`anim.bp_list_slots_used` (risk 0, smoke)

Lists the montage slot names referenced by the slot nodes of the Anim Blueprint.

Argument	Type	Description
`animBlueprint`	string	required. Anim Blueprint asset path or unique name.

Returns: names, count.

`anim.bp_list_variables` (risk 0, smoke)

Lists the member variables of the Anim Blueprint with their types and defaults.

Argument	Type	Description
`animBlueprint`	string	required. Anim Blueprint asset path or unique name.

Returns: variables, count, compileErrors.

`anim.bp_remove_interface` (risk 3, mutates, destructive, smoke)

Removes an implemented Anim Layer Interface and its layer graphs.

Argument	Type	Description
`animBlueprint`	string	required.
`interface`	string	required. Anim Layer Interface asset (or its generated class name).

`anim.bp_remove_layer` (risk 3, mutates, destructive, smoke)

Removes an anim layer graph from the Anim Blueprint.

Argument	Type	Description
`animBlueprint`	string	required.
`name`	string	required. Layer name (becomes an anim graph function).
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: layers, count, compileErrors.

`anim.bp_remove_variable` (risk 3, mutates, destructive, smoke)

Removes a member variable.

Argument	Type	Description
`animBlueprint`	string	required.
`name`	string	required.

Returns: variables, count, compileErrors.

`anim.bp_set_class_defaults` (risk 2, mutates, smoke)

Sets arbitrary class-default properties on the generated AnimInstance CDO.

Argument	Type	Description
`animBlueprint`	string	required.
`properties`	array of UeaKeyValue	required. Property name -> value as text (RootMotionMode, bUseMultiThreadedAnimationUpdate, ...).
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: properties, count, errors.

`anim.bp_set_parent_class` (risk 2, mutates, smoke)

Sets the parent AnimInstance class and recompiles.

Argument	Type	Description
`animBlueprint`	string	required.
`parentClass`	string	required. New parent class (AnimInstance subclass, native name or Anim Blueprint path).

`anim.bp_set_preview_mesh` (risk 2, mutates, smoke)

Sets the skeletal mesh used by the Persona preview viewport.

Argument	Type	Description
`animBlueprint`	string	required.
`mesh`	string	required. Skeletal mesh asset used in the Persona preview.

`anim.bp_set_root_motion_mode` (risk 2, mutates, smoke)

Sets the root motion mode of the generated AnimInstance (NoRootMotionExtraction, IgnoreRootMotion, RootMotionFromEverything, RootMotionFromMontagesOnly).

Argument	Type	Description
`animBlueprint`	string	required.
`mode`	string	required. NoRootMotionExtraction, IgnoreRootMotion, RootMotionFromEverything, RootMotionFromMontagesOnly.

Returns: properties, count, errors.

`anim.bp_set_skeleton` (risk 3, mutates, smoke)

Retargets the Anim Blueprint to another skeleton (accepts a skeleton, skeletal mesh or animation asset) and recompiles.

Argument	Type	Description
`animBlueprint`	string	required.
`skeleton`	string	required. New skeleton asset, or an animation asset to take the skeleton from.
`compile`	boolean	Recompile after the change (default true). Default `true`.

`anim.bs_add_sample` (risk 2, mutates, smoke)

Places an animation at (x, y) in the blend space.

Argument	Type	Description
`blendSpace`	string	required.
`anim`	string	required. Animation sequence to place (must use the blend space skeleton).
`x`	number	Default `0.f`.
`y`	number	Default `0.f`.
`rateScale`	number	Playback rate multiplier of the sample. Default `1.f`.

Returns: blendSpace, skeleton, class, dimensions, sampleCount, axes, samples, axisToScaleAnimation, targetWeightInterpolationSpeed, notifyTriggerMode, preferredTriangulation, previewBasePose, message, notes.

`anim.bs_auto_fill_grid` (risk 2, mutates, smoke)

Spreads a list of animations evenly along one axis (the quickest way to fill a locomotion blend space).

Argument	Type	Description
`blendSpace`	string	required.
`anims`	array of string	required. Animations to spread over the axis, in order.
`axis`	string	Axis to spread the animations along: 0/x (default) or 1/y.
`other`	number	Position on the other axis. Default `0.f`.
`clear`	boolean	Remove the existing samples first. Default `false`.

`anim.bs_clear_samples` (risk 3, mutates, smoke)

Removes every sample of a blend space.

Argument	Type	Description
`blendSpace`	string	required. Blend space asset path or unique name.

`anim.bs_create` (risk 2, mutates, smoke)

Creates a blend space (kind: 2d, 1d, aimOffset2d, aimOffset1d) with the given axis ranges; the skeleton may be derived from fromAnim or mesh.

Argument	Type	Description
`folder`	string	required. Destination content folder.
`name`	string	required. Asset name without a path.
`skeleton`	string	Skeleton of the blend space; when empty it is taken from fromAnim or mesh.
`fromAnim`	string	Animation whose skeleton is used when skeleton is empty.
`mesh`	string	Skeletal mesh whose skeleton is used when skeleton and fromAnim are empty.
`kind`	string	Kind: 2d (default), 1d, aimOffset2d or aimOffset1d.
`axisX`	UeaBsAxisInfo	Horizontal axis settings.
`axisY`	UeaBsAxisInfo	Vertical axis settings (ignored by the 1D kinds).

`anim.bs_delete` (risk 3, mutates, destructive, smoke)

Deletes a blend space asset.

Argument	Type	Description
`blendSpace`	string	required. Blend space asset path or unique name.

`anim.bs_duplicate` (risk 2, mutates, smoke)

Copies a blend space into another asset.

Argument	Type	Description
`blendSpace`	string	required.
`folder`	string	Destination folder; empty keeps the source folder.
`name`	string	New asset name; empty appends _Copy.

`anim.bs_find_sample` (risk 0, smoke)

Index and distance of the sample closest to an input position.

Argument	Type	Description
`blendSpace`	string	required.
`x`	number	Default `0.f`.
`y`	number	Default `0.f`.

`anim.bs_get` (risk 0, smoke)

Axes, samples and settings of a blend space.

Argument	Type	Description
`blendSpace`	string	required. Blend space asset path or unique name.

`anim.bs_get_sample_weights` (risk 0, smoke)

Weights of every sample for a given input, highest first (how the blend space blends at that point).

Argument	Type	Description
`blendSpace`	string	required.
`x`	number	Default `0.f`.
`y`	number	Default `0.f`.

Returns: blendSpace, x, y, weights, message.

`anim.bs_list` (risk 0, smoke)

Lists blend spaces of a folder, optionally filtered by skeleton and name.

Argument	Type	Description
`folder`	string	Content folder to search; empty searches /Game.
`skeleton`	string	Only blend spaces using this skeleton.
`nameContains`	string	Case-insensitive substring of the asset name.
`limit`	integer	Default `200`.

Returns: blendSpaces, total.

`anim.bs_list_samples` (risk 0, smoke)

Samples of a blend space with their positions, animations and lengths.

Argument	Type	Description
`blendSpace`	string	required. Blend space asset path or unique name.

`anim.bs_remove_sample` (risk 2, mutates, smoke)

Removes one sample by index.

Argument	Type	Description
`blendSpace`	string	required.
`index`	integer	required.

`anim.bs_resample` (risk 2, mutates, smoke)

Rebuilds the grid/triangulation from the current samples (run after editing samples outside the editor).

Argument	Type	Description
`blendSpace`	string	required. Blend space asset path or unique name.

`anim.bs_set_axis` (risk 2, mutates, smoke)

Name, range, grid divisions, snapping and wrapping of one axis (existing samples are kept).

Argument	Type	Description
`blendSpace`	string	required.
`axis`	string	required. Axis to change: 0/x or 1/y.
`name`	string	New display name; empty keeps the current one.
`min`	number	Lowest input value; ignored when equal to max. Default `0.f`.
`max`	number	Default `0.f`.
`gridDivisions`	integer	Grid divisions; 0 keeps the current value. Default `0`.
`snapToGrid`	boolean	Default `false`.
`wrapInput`	boolean	Wrap the input around the axis limits (5.x only). Default `false`.

`anim.bs_set_interpolation` (risk 2, mutates, smoke)

Input smoothing of one axis (or all): smoothing time, type and, on 5.x, damping ratio and max speed.

Argument	Type	Description
`blendSpace`	string	required.
`axis`	string	Axis: 0/x, 1/y or "all".
`time`	number	Smoothing time in seconds (0 disables input smoothing). Default `0.f`.
`type`	string	Smoothing type: Averaged, Linear, Cubic, EaseInOut, ExponentialDecay or SpringDamper (5.x).
`dampingRatio`	number	Damping ratio of the spring damper type (5.x only). Default `0.f`.
`maxSpeed`	number	Maximum speed of the smoothed input, 0 = unlimited (5.x only). Default `0.f`.

`anim.bs_set_preview_base_pose` (risk 2, mutates, smoke)

Animation used as the additive preview base pose of the blend space.

Argument	Type	Description
`blendSpace`	string	required.
`anim`	string	Animation used as the additive preview base pose; empty clears it.

`anim.bs_set_sample` (risk 2, mutates, smoke)

Moves a sample, replaces its animation or changes its rate scale.

Argument	Type	Description
`blendSpace`	string	required.
`index`	integer	required. Index of the sample as reported by anim.bs_list_samples.
`x`	number	Default `0.f`.
`y`	number	Default `0.f`.
`anim`	string	Replacement animation; empty keeps the current one.
`rateScale`	number	Playback rate multiplier; 0 keeps the current one. Default `0.f`.
`move`	boolean	Set to false to leave the position untouched. Default `true`.

`anim.bs_set_settings` (risk 2, mutates, smoke)

Blend space settings: speed-scaling axis, target weight interpolation, sync phases, notify trigger mode and triangulation.

Argument	Type	Description
`blendSpace`	string	required.
`axisToScaleAnimation`	string	Axis whose input scales the animation speed: None, X or Y (5.x only).
`targetWeightInterpolationSpeed`	number	Target weight interpolation speed per second; negative keeps the current value. Default `-1.f`.
`smoothing`	boolean	Ease the target weight interpolation in and out (5.x only). Default `false`.
`setSmoothing`	boolean	Apply the smoothing flag (it is a bool, so it needs an explicit opt-in). Default `false`.
`matchSyncPhases`	boolean	Match the sync phases of the samples (5.x only). Default `false`.
`setMatchSyncPhases`	boolean	Default `false`.
`notifyTriggerMode`	string	Notify trigger mode: AllAnimations, HighestWeightedAnimation or None.
`preferredTriangulation`	string	Preferred triangulation direction: Tangential, Radial or None (5.x only).

`anim.bs_validate` (risk 0, smoke)

Checks a blend space: missing animations, wrong skeleton, samples outside the axis range and duplicate positions.

Argument	Type	Description
`blendSpace`	string	required. Blend space asset path or unique name.

Returns: blendSpace, valid, sampleCount, issues, message.

`anim.chooser_add_column` (risk 2, mutates, UE 5.4+, requires plugin Chooser, smoke)

Adds a column (a condition evaluated per row) to a chooser table.

Argument	Type	Description
`type`	string	required. Column type: "bool", "float", "enum", "gameplayTag", "objectClass", "object", "name", "outputFloat", ... or a struct path.

Returns: chooser, name, outputType, resultType, contextClasses, columns, rows, message.

`anim.chooser_add_row` (risk 2, mutates, UE 5.4+, requires plugin Chooser, smoke)

Adds a row returning an asset, with one cell value per existing column.

Argument	Type	Description
`result`	string	required. Asset returned when the row is selected.
`cells`	array of string	Cell values, in column order (text form).

Returns: chooser, name, outputType, resultType, contextClasses, columns, rows, message.

`anim.chooser_create` (risk 2, mutates, UE 5.4+, requires plugin Chooser, smoke)

Creates a chooser table that returns assets of a given class.

Argument	Type	Description
`folder`	string	required.
`name`	string	required.
`outputType`	string	Class of the objects the chooser returns (e.g. "AnimSequence"). Default `TEXT("AnimSequence")`.
`resultType`	string	"object" or "class". Default `TEXT("object")`.
`contextClass`	string	Class passed as the evaluation context (optional).

Returns: chooser, name, outputType, resultType, contextClasses, columns, rows, message.

`anim.chooser_delete` (risk 3, mutates, destructive, UE 5.4+, requires plugin Chooser)

Deletes a chooser table asset.

Argument	Type	Description
`chooser`	string	required. Chooser table asset.

Returns: database, result, message.

`anim.chooser_get` (risk 0, UE 5.4+, requires plugin Chooser, smoke)

Chooser table state: output type, context classes, columns and rows.

Argument	Type	Description
`chooser`	string	required. Chooser table asset.

Returns: chooser, name, outputType, resultType, contextClasses, columns, rows, message.

`anim.chooser_list_rows` (risk 0, UE 5.4+, requires plugin Chooser, smoke)

Lists the rows of a chooser table with their result asset and cell values.

Argument	Type	Description
`chooser`	string	required. Chooser table asset.

Returns: chooser, name, outputType, resultType, contextClasses, columns, rows, message.

`anim.chooser_remove_column` (risk 3, mutates, UE 5.4+, requires plugin Chooser, smoke)

Removes a column from a chooser table by index.

Argument	Type	Description
`index`	integer	required. Index of the column or row.

Returns: chooser, name, outputType, resultType, contextClasses, columns, rows, message.

`anim.chooser_remove_row` (risk 3, mutates, UE 5.4+, requires plugin Chooser, smoke)

Removes a row from a chooser table by index.

Argument	Type	Description
`index`	integer	required. Index of the column or row.

Returns: chooser, name, outputType, resultType, contextClasses, columns, rows, message.

`anim.chooser_set_cell` (risk 2, mutates, UE 5.4+, requires plugin Chooser, smoke)

Sets one cell (row x column) of a chooser table from its text form.

Argument	Type	Description
`row`	integer	required.
`column`	integer	required.
`value`	string	required. New cell value in text form.

Returns: chooser, name, outputType, resultType, contextClasses, columns, rows, message.

`anim.chooser_set_context_class` (risk 2, mutates, UE 5.4+, requires plugin Chooser, smoke)

Sets the class passed to the chooser as its evaluation context.

Argument	Type	Description
`contextClass`	string	required. Class passed as the evaluation context.
`replace`	boolean	Replace the context list instead of appending to it. Default `true`.

Returns: chooser, name, outputType, resultType, contextClasses, columns, rows, message.

`anim.composite_add_segment` (risk 2, mutates, smoke)

Appends an animation to the composite track.

Argument	Type	Description
`composite`	string	required.
`anim`	string	required.
`startPos`	number	Start on the timeline; negative appends after the last segment. Default `-1.f`.
`animStart`	number	Default `0.f`.
`animEnd`	number	Last time used from the animation; 0 or negative uses the full length. Default `0.f`.
`playRate`	number	Default `1.f`.
`loopCount`	integer	Default `1`.

Returns: composite, skeleton, length, segments, notifyCount, message, notes.

`anim.composite_create` (risk 2, mutates, smoke)

Creates a composite from a list of animations played back to back.

Argument	Type	Description
`folder`	string	required.
`name`	string	required.
`anims`	array of string	Animations appended to the composite track, in order.
`skeleton`	string	Skeleton; derived from the first animation or from mesh when empty.
`mesh`	string	Skeletal mesh whose skeleton is used when skeleton and anims are empty.

Returns: composite, skeleton, length, segments, notifyCount, message, notes.

`anim.composite_delete` (risk 3, mutates, destructive, smoke)

Deletes a composite asset.

Argument	Type	Description
`composite`	string	required. Composite asset path or unique name.

Returns: composite, skeleton, length, segments, notifyCount, message, notes.

`anim.composite_duplicate` (risk 2, mutates, smoke)

Copies a composite into another asset.

Argument	Type	Description
`composite`	string	required.
`folder`	string
`name`	string

Returns: composite, skeleton, length, segments, notifyCount, message, notes.

`anim.composite_get` (risk 0, smoke)

Segments, length and skeleton of a composite.

Argument	Type	Description
`composite`	string	required. Composite asset path or unique name.

Returns: composite, skeleton, length, segments, notifyCount, message, notes.

`anim.composite_list_segments` (risk 0, smoke)

Segments of a composite with their animations and timings.

Argument	Type	Description
`composite`	string	required. Composite asset path or unique name.

Returns: composite, skeleton, length, segments, notifyCount, message, notes.

`anim.composite_remove_segment` (risk 2, mutates, smoke)

Removes one segment from a composite.

Argument	Type	Description
`composite`	string	required.
`index`	integer	required.

Returns: composite, skeleton, length, segments, notifyCount, message, notes.

`anim.composite_set_segment` (risk 2, mutates, smoke)

Changes one segment of a composite.

Argument	Type	Description
`composite`	string	required.
`index`	integer	required.
`anim`	string	Replacement animation; empty keeps the current one.
`startPos`	number	Default `-1.f`.
`animStart`	number	Default `-1.f`.
`animEnd`	number	Default `-1.f`.
`playRate`	number	Default `0.f`.
`loopCount`	integer	Default `0`.

Returns: composite, skeleton, length, segments, notifyCount, message, notes.

`anim.connect` (risk 2, mutates, smoke)

Connects a pin of one node to a pin of another; empty pin names use the pose output and the first free pose input.

Argument	Type	Description
`animBlueprint`	string	required.
`fromId`	string	required. Source node (the one producing the pose).
`toId`	string	required. Target node.
`fromPin`	string	Output pin of the source node; empty = its pose output.
`toPin`	string	Input pin of the target node; empty = its first free pose input.
`graph`	string
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: node, compileErrors, propertyErrors.

`anim.connect_to_output` (risk 2, mutates, smoke)

Connects the pose output of a node to the result node of its anim graph.

Argument	Type	Description
`animBlueprint`	string	required.
`nodeId`	string	required.
`graph`	string
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: node, compileErrors, propertyErrors.

`anim.copy_curve` (risk 2, mutates, smoke)

Copies a float curve from one sequence to another.

Argument	Type	Description
`from`	string	required. Source sequence.
`to`	string	required. Destination sequence.
`curve`	string	required.
`newName`	string	Name of the copy; empty keeps the source name.

Returns: anim, curve, type, keys, exists, message.

`anim.copy_notifies` (risk 2, mutates, smoke)

Copies the notifies of one sequence onto another.

Argument	Type	Description
`from`	string	required. Source sequence.
`to`	string	required. Destination sequence.
`deleteExisting`	boolean	Remove the notifies already on the destination first. Default `false`.

Returns: anim, index, name, class, time, duration, track, removed, notifies, message.

`anim.create_from_mesh_pose` (risk 2, mutates, smoke)

Creates an animation sequence filled with the reference pose of a skeletal mesh. Optionally duplicates the mesh skeleton to 'newSkeletonPath' and binds the sequence to the copy; the reply returns the skeleton used.

Argument	Type	Description
`mesh`	string	required. Skeletal mesh whose reference pose fills the sequence.
`folder`	string	required. Destination content folder.
`name`	string	required. Name of the new sequence.
`frames`	integer	Number of frames of the new sequence (at least 1); the play length is frames/frameRate seconds. Default `1`.
`frameRate`	number	Sampling rate of the new sequence in frames per second (30 when omitted). Default `30.0`.
`skeleton`	string	Skeleton to bind; empty uses the skeleton of the mesh.
`newSkeletonPath`	string	When set, the skeleton of the mesh is duplicated to this asset path and used instead.

Returns: anim, name, skeleton, mesh, frames, length, boneTracks, message.

`anim.crop` (risk 2, mutates, smoke)

Keeps only the [startTime, endTime] window of a sequence.

Argument	Type	Description
`anim`	string	required.
`startTime`	number	required. First second kept.
`endTime`	number	required. Last second kept.

Returns: anim, length, frames, frameRate, boneTracks, message.

`anim.curve_exists` (risk 0, smoke)

Whether a curve exists on a sequence.

Argument	Type	Description
`anim`	string	required.
`curve`	string	required. Curve name.
`type`	string	float (default), vector or transform.
`metadata`	boolean	Create the curve as a metadata curve (a constant value, no keys). Default `false`.

Returns: anim, curve, type, keys, exists, message.

`anim.delete` (risk 3, mutates, destructive, smoke)

Deletes an animation sequence asset.

Argument	Type	Description
`anim`	string	required. Animation sequence asset path or unique name.

Returns: anim, name, message.

`anim.disconnect` (risk 2, mutates, smoke)

Breaks the links of one pin, or every link of a node when no pin is given.

Argument	Type	Description
`animBlueprint`	string	required.
`nodeId`	string	required.
`pin`	string	Pin to disconnect; empty breaks every link of the node.
`graph`	string
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: node, compileErrors, propertyErrors.

`anim.duplicate` (risk 2, mutates, smoke)

Duplicates an animation sequence into a folder.

Argument	Type	Description
`anim`	string	required.
`folder`	string	Destination folder; empty keeps the source folder.
`name`	string	required. Name of the new asset.

Returns: anim, name, message.

`anim.export_fbx` (risk 0)

Exports a sequence to an FBX file. Not smoke-tested: the self-test never writes files.

Argument	Type	Description
`anim`	string	required.
`file`	string	required. Absolute path of the .fbx file to write.
`mesh`	string	Skeletal mesh exported with the animation; optional.

Returns: anim, name, message.

`anim.export_graph` (risk 0, smoke)

Exports an anim graph as JSON (nodes with their properties plus the links) for anim.import_graph.

Argument	Type	Description
`animBlueprint`	string	required.
`graph`	string	Graph name; empty = "AnimGraph". State machine/state/transition subgraphs are addressable by name too.

Returns: json, nodeCount, linkCount.

`anim.expose_pin` (risk 2, mutates, smoke)

Shows or hides the optional pin of a node property (PlayRate, Alpha, ...) and reconstructs the node.

Argument	Type	Description
`animBlueprint`	string	required.
`nodeId`	string	required.
`property`	string	required. Property name of the FAnimNode_* struct ("PlayRate", "Alpha").
`exposed`	boolean	True to show the pin, false to hide it. Default `true`.
`graph`	string
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: node, compileErrors, propertyErrors.

`anim.find_anim_blueprints_using` (risk 0, smoke)

Anim blueprints that reference an animation asset in one of their graphs.

Argument	Type	Description
`anim`	string	required. Animation asset (sequence or blend space) to look for.
`folder`	string	Content folder searched ("/Game" when empty).
`recursive`	boolean	Default `true`.
`limit`	integer	Default `200`.

Returns: assets, count, scanned, message.

`anim.find_blend_spaces_using` (risk 0, smoke)

Blend spaces whose samples reference an animation sequence.

Argument	Type	Description
`anim`	string	required. Animation asset (sequence or blend space) to look for.
`folder`	string	Content folder searched ("/Game" when empty).
`recursive`	boolean	Default `true`.
`limit`	integer	Default `200`.

Returns: assets, count, scanned, message.

`anim.find_by_curve` (risk 0, smoke)

Sequences of a folder that carry a curve with the given name.

Argument	Type	Description
`name`	string	required. Notify / curve / sync marker name to look for.

Returns: assets, count, scanned, message.

`anim.find_by_notify` (risk 0, smoke)

Sequences of a folder that carry a notify with the given name.

Argument	Type	Description
`name`	string	required. Notify / curve / sync marker name to look for.

Returns: assets, count, scanned, message.

`anim.find_by_sync_marker` (risk 0, smoke)

Sequences of a folder that carry a sync marker with the given name.

Argument	Type	Description
`name`	string	required. Notify / curve / sync marker name to look for.

Returns: assets, count, scanned, message.

`anim.find_montages_using` (risk 0, smoke)

Montages whose segments reference an animation sequence.

Argument	Type	Description
`anim`	string	required. Animation asset (sequence or blend space) to look for.
`folder`	string	Content folder searched ("/Game" when empty).
`recursive`	boolean	Default `true`.
`limit`	integer	Default `200`.

Returns: assets, count, scanned, message.

`anim.find_nodes` (risk 0, smoke)

Finds nodes by node class (subclasses match) and/or by a substring of their title.

Argument	Type	Description
`animBlueprint`	string	required.
`nodeClass`	string	Node class short or full name; subclasses match.
`titleContains`	string	Case-insensitive substring of the node title.
`graph`	string	Restrict to one graph.
`limit`	integer	Maximum results; 0 = no limit. Default `0`.

Returns: nodes, count.

`anim.find_unused` (risk 0, smoke)

Sequences under a folder that no other asset references.

Argument	Type	Description
`folder`	string	Content folder to scan ("/Game" when empty).
`recursive`	boolean	Default `true`.
`limit`	integer	Default `200`.

Returns: unused, count, scanned, message.

`anim.get` (risk 0, smoke)

Everything about a sequence: skeleton, length, frames, rate, additive and root motion settings, curve/notify/marker counts and compression settings.

Argument	Type	Description
`anim`	string	required. Animation sequence asset path or unique name.

Returns: anim, name, class, skeleton, length, frames, frameRate, rateScale, additiveType, basePoseType, interpolation, rootMotionEnabled, rootMotionLockType, forceRootLock, retargetSource, boneTracks, floatCurves, transformCurves, notifies, syncMarkers, notifyTracks, boneCompressionSettings, curveCompressionSettings, metaDataCount, message.

`anim.get_additive` (risk 0, smoke)

Current additive settings of a sequence.

Argument	Type	Description
`anim`	string	required. Animation sequence asset path or unique name.

Returns: anim, type, basePoseType, basePoseAnim, refFrameIndex, message.

`anim.get_anim_state` (risk 0, requires PIE, requires world, smoke)

Everything the anim instance of an actor is doing: mode, current animation, position, montages and curves.

Argument	Type	Description
`actor`	string	required. Actor label, name or class of the actor carrying the skeletal mesh.

Returns: actor, component, mesh, skeleton, mode, animBlueprint, animInstanceClass, currentAnim, position, length, playRate, playing, looping, montages, curves, message.

`anim.get_bone_pose` (risk 0, smoke)

Bone transforms at a time or frame, in local (parent relative) or component space. 'bones' accepts names or track indices; empty samples every track.

Argument	Type	Description
`anim`	string	required.
`bones`	array of string	Bones to sample; empty samples every bone that has a track.
`time`	number	Time in seconds (ignored when 'frame' is >= 0). Default `0.0`.
`frame`	integer	Frame index; -1 uses 'time'. Default `-1`.
`space`	string	local (relative to the parent bone, default) or component.

Returns: anim, time, frame, space, poses, count, message.

`anim.get_bone_track_names` (risk 0, smoke)

Names of the bone animation tracks of a sequence.

Argument	Type	Description
`anim`	string	required. Animation sequence asset path or unique name.

Returns: anim, tracks, count, message.

`anim.get_bone_transform_runtime` (risk 0, requires PIE, requires world, smoke)

Transform of a bone of a running actor in world, component or local space.

Argument	Type	Description
`bone`	string	Bone name (empty = the root bone of the mesh).
`space`	string	"world", "component" or "local". Default `TEXT("world")`.

Returns: actor, name, space, location, rotation, scale, message.

`anim.get_compression` (risk 0, smoke)

Current compression settings and compressed size of a sequence.

Argument	Type	Description
`anim`	string	required. Animation sequence asset path or unique name.

Returns: anim, boneSettings, curveSettings, compressedSizeBytes, message.

`anim.get_curve_keys` (risk 0, smoke)

Keys of a curve (float, vector or transform).

Argument	Type	Description
`anim`	string	required.
`curve`	string	required. Curve name.
`type`	string	float (default), vector or transform.
`metadata`	boolean	Create the curve as a metadata curve (a constant value, no keys). Default `false`.

Returns: anim, curve, type, times, values, vectors, count, message.

`anim.get_curve_value` (risk 0, requires PIE, requires world, smoke)

Value of one animation curve (or every active curve) on an actor.

Argument	Type	Description
`curve`	string	Curve name (empty lists every active curve).

Returns: actor, curve, value, curves, message.

`anim.get_frame_at_time` (risk 0, smoke)

Frame index of a time in seconds.

Argument	Type	Description
`anim`	string	required.
`time`	number	Time in seconds (anim.get_frame_at_time). Default `0.0`.
`frame`	integer	Frame index (anim.get_time_at_frame). Default `0`.

Returns: anim, time, frame, length, frames, frameRate, valid, message.

`anim.get_frame_rate` (risk 0, smoke)

Sampling frame rate of a sequence, in frames per second.

Argument	Type	Description
`anim`	string	required. Animation sequence asset path or unique name.

Returns: anim, time, frame, length, frames, frameRate, valid, message.

`anim.get_graph` (risk 0, smoke)

Dumps a whole anim graph: nodes, links and the id of the result node.

Argument	Type	Description
`animBlueprint`	string	required.
`graph`	string	Graph name; empty = "AnimGraph". State machine/state/transition subgraphs are addressable by name too.

Returns: graph, kind, nodes, links, resultNodeId.

`anim.get_import_settings` (risk 0, smoke)

FBX import settings stored on a sequence, with its source files.

Argument	Type	Description
`anim`	string	required. Animation sequence asset path or unique name.

Returns: anim, importDataClass, sourceFiles, settings, canReimport, message.

`anim.get_length` (risk 0, smoke)

Play length of a sequence in seconds, with its frame count and rate.

Argument	Type	Description
`anim`	string	required. Animation sequence asset path or unique name.

Returns: anim, length, frames, frameRate, boneTracks, message.

`anim.get_node` (risk 0, smoke)

Full detail of one anim graph node: pins, the FAnimNode_* struct behind it, every editable property and its property bindings.

Argument	Type	Description
`animBlueprint`	string	required.
`nodeId`	string	required. Node GUID, or a title/class name that is unique in the searched graphs.
`graph`	string	Restrict the search to this graph.

Returns: node, animNodeStruct, properties, bindings.

`anim.get_node_class_info` (risk 0, smoke)

Describes one anim graph node class: its FAnimNode_* struct, editable properties and pose pins.

Argument	Type	Description
`nodeClass`	string	required.

Returns: info, properties, poseInputs, hasPoseOutput.

`anim.get_node_properties` (risk 0, smoke)

Reads every editable property of an anim graph node with its current value.

Argument	Type	Description
`animBlueprint`	string	required.
`nodeId`	string	required. Node GUID, or a title/class name that is unique in the searched graphs.
`graph`	string	Restrict the search to this graph.

Returns: properties, count, errors, compileErrors.

`anim.get_notify_class_info` (risk 0, smoke)

Editable properties of a notify class.

Argument	Type	Description
`class`	string	required. Class short name or asset path.

Returns: class, path, parent, isState, properties, message.

`anim.get_root_motion` (risk 0, smoke)

Current root motion settings of a sequence.

Argument	Type	Description
`anim`	string	required. Animation sequence asset path or unique name.

Returns: anim, enabled, lockType, forceRootLock, useNormalizedRootMotionScale, hasRootTrack, message.

`anim.get_root_motion_runtime` (risk 0, requires PIE, requires world, smoke)

Root motion state of an actor: whether it is enabled, the mode and the last extracted delta.

Argument	Type	Description
`actor`	string	required. Actor label, name or class of the actor carrying the skeletal mesh.

Returns: actor, rootMotionEnabled, rootMotionMode, translation, rotation, message.

`anim.get_skeleton` (risk 0, smoke)

Skeleton a sequence is bound to, with its bone count and preview mesh.

Argument	Type	Description
`anim`	string	required. Animation sequence asset path or unique name.

Returns: anim, skeleton, skeletonName, boneCount, previewMesh, message.

`anim.get_socket_transform_runtime` (risk 0, requires PIE, requires world, smoke)

Transform of a socket (or bone) of a running actor.

Argument	Type	Description
`socket`	string	Socket or bone name (empty = the root bone of the mesh).
`space`	string	"world", "component" or "local". Default `TEXT("world")`.

Returns: actor, name, space, location, rotation, scale, message.

`anim.get_stats` (risk 0, smoke)

Size and content statistics of a sequence (length, frames, tracks, curves, notifies, compressed size).

Argument	Type	Description
`anim`	string	required. Animation sequence asset path or unique name.

Returns: anim, length, frames, frameRate, boneTracks, floatCurves, transformCurves, notifies, syncMarkers, notifyTracks, compressedSizeBytes, rawSizeBytes, message.

`anim.get_time_at_frame` (risk 0, smoke)

Time in seconds of a frame index.

Argument	Type	Description
`anim`	string	required.
`time`	number	Time in seconds (anim.get_frame_at_time). Default `0.0`.
`frame`	integer	Frame index (anim.get_time_at_frame). Default `0`.

Returns: anim, time, frame, length, frames, frameRate, valid, message.

`anim.get_unique_marker_names` (risk 0, smoke)

Unique sync marker names of a sequence (the set used by sync groups).

Argument	Type	Description
`anim`	string	required. Animation sequence asset path or unique name.

Returns: anim, markers, names, count, removed, message.

`anim.ikrig_add_chain` (risk 2, mutates, UE 5.5+, requires plugin IKRig, smoke)

Adds a retarget bone chain (start bone to end bone), optionally driven by an IK goal.

Argument	Type	Description
`name`	string	required. Chain name (e.g. LeftArm).
`startBone`	string	required.
`endBone`	string	required.
`goal`	string	Optional IK goal driving the chain.

Returns: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.

`anim.ikrig_add_goal` (risk 2, mutates, UE 5.5+, requires plugin IKRig, smoke)

Adds an IK goal (effector) on a bone. The goal name is made unique inside the rig.

Argument	Type	Description
`name`	string	required. Goal name (made unique by the rig).
`bone`	string	required. Bone the goal drives.

Returns: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.

`anim.ikrig_add_solver` (risk 2, mutates, UE 5.6+, requires plugin IKRig, smoke)

Adds a solver to the solver stack and returns its index. Use anim.ikrig_list_solver_types for the accepted names.

Argument	Type	Description
`type`	string	required. Solver type: a short name ("FullBodyIK", "LimbIK", "PoleSolver", "SetTransform", "BodyMover") or a full script-struct path.

Returns: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.

`anim.ikrig_auto_chains` (risk 2, mutates, UE 5.6+, requires plugin IKRig, smoke)

Characterises the skeleton against the engine templates and generates the retarget chains and pelvis automatically. Reports matched=false when no template fits.

Argument	Type	Description
`ikRig`	string	required. IK rig asset (path or unique name).

Returns: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.

`anim.ikrig_auto_fbik` (risk 2, mutates, UE 5.6+, requires plugin IKRig, smoke)

Generates a full-body IK setup automatically from the engine skeleton templates. Reports matched=false when no template fits.

Argument	Type	Description
`ikRig`	string	required. IK rig asset (path or unique name).

Returns: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.

`anim.ikrig_connect_goal` (risk 2, mutates, UE 5.6+, requires plugin IKRig, smoke)

Connects an IK goal to a solver so that solver drives it.

Argument	Type	Description
`solverIndex`	integer	required. Index of the solver in the stack.

Returns: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.

`anim.ikrig_create` (risk 2, mutates, UE 5.5+, requires plugin IKRig, smoke)

Creates an IK Rig asset from a skeletal mesh and returns its bones, goals, chains and solvers.

Argument	Type	Description
`folder`	string	required. Destination content folder.
`name`	string	required. Asset name of the new IK rig.
`mesh`	string	required. Skeletal mesh the rig is built from (its skeleton supplies the bone hierarchy).

Returns: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.

`anim.ikrig_delete` (risk 3, mutates, destructive, UE 5.5+, requires plugin IKRig)

Deletes an IK Rig asset.

Argument	Type	Description
`ikRig`	string	required. IK rig asset (path or unique name).

Returns: deleted, message.

`anim.ikrig_disconnect_goal` (risk 2, mutates, UE 5.6+, requires plugin IKRig, smoke)

Disconnects an IK goal from a solver.

Argument	Type	Description
`solverIndex`	integer	required. Index of the solver in the stack.

Returns: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.

`anim.ikrig_get` (risk 0, UE 5.5+, requires plugin IKRig, smoke)

Full state of an IK Rig: preview mesh, skeleton, retarget root, goals, chains and solver stack.

Argument	Type	Description
`ikRig`	string	required. IK rig asset (path or unique name).

Returns: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.

`anim.ikrig_list` (risk 0, UE 5.5+, requires plugin IKRig, smoke)

Lists the IK Rig assets of a folder.

Argument	Type	Description
`folder`	string	Content folder to scan ("/Game" when empty).
`recursive`	boolean	Default `true`.
`limit`	integer	Default `100`.

Returns: ikRigs, count, message.

`anim.ikrig_list_bones` (risk 0, UE 5.5+, requires plugin IKRig, smoke)

Bone names of the skeleton loaded in an IK Rig, plus the bones excluded from solving.

Argument	Type	Description
`ikRig`	string	required. IK rig asset (path or unique name).

Returns: bones, excludedBones, count, message.

`anim.ikrig_list_chains` (risk 0, UE 5.5+, requires plugin IKRig, smoke)

Lists the retarget chains of an IK Rig.

Argument	Type	Description
`ikRig`	string	required. IK rig asset (path or unique name).

Returns: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.

`anim.ikrig_list_goals` (risk 0, UE 5.5+, requires plugin IKRig, smoke)

Lists the IK goals of a rig with their bone, alphas and connected solvers.

Argument	Type	Description
`ikRig`	string	required. IK rig asset (path or unique name).

Returns: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.

`anim.ikrig_list_solver_types` (risk 0, UE 5.6+, requires plugin IKRig, smoke)

Solver types available in this engine, as short names plus their script-struct paths.

Argument	Type	Description
`folder`	string	Content folder to scan ("/Game" when empty).
`recursive`	boolean	Default `true`.
`limit`	integer	Default `100`.

Returns: types, count, message.

`anim.ikrig_list_solvers` (risk 0, UE 5.6+, requires plugin IKRig, smoke)

Lists the solver stack of an IK Rig.

Argument	Type	Description
`ikRig`	string	required. IK rig asset (path or unique name).

Returns: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.

`anim.ikrig_remove_chain` (risk 3, mutates, UE 5.5+, requires plugin IKRig, smoke)

Removes a retarget chain.

Argument	Type	Description
`chain`	string	required. Existing chain name.

Returns: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.

`anim.ikrig_remove_goal` (risk 3, mutates, UE 5.5+, requires plugin IKRig, smoke)

Removes an IK goal.

Argument	Type	Description
`goal`	string	required. Existing goal name.

Returns: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.

`anim.ikrig_remove_solver` (risk 3, mutates, UE 5.6+, requires plugin IKRig, smoke)

Removes a solver from the stack by index.

Argument	Type	Description
`index`	integer	required. Index in the solver stack.

Returns: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.

`anim.ikrig_rename_chain` (risk 2, mutates, UE 5.5+, requires plugin IKRig, smoke)

Renames a retarget chain.

Argument	Type	Description
`newName`	string	required.

Returns: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.

`anim.ikrig_rename_goal` (risk 2, mutates, UE 5.5+, requires plugin IKRig, smoke)

Renames an IK goal (the rig makes the new name unique).

Argument	Type	Description
`newName`	string	required. New goal name.

Returns: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.

`anim.ikrig_set_bone_excluded` (risk 2, mutates, UE 5.5+, requires plugin IKRig, smoke)

Excludes (or re-includes) a bone from every solver of the rig.

Argument	Type	Description
`excluded`	boolean	Exclude the bone from every solver. Default `true`.

Returns: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.

`anim.ikrig_set_chain_goal` (risk 2, mutates, UE 5.5+, requires plugin IKRig, smoke)

Assigns (or clears, with an empty goal) the IK goal of a retarget chain.

Argument	Type	Description
`goal`	string	Goal name, or empty to clear.

Returns: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.

`anim.ikrig_set_goal_bone` (risk 2, mutates, UE 5.5+, requires plugin IKRig, smoke)

Moves an IK goal to another bone.

Argument	Type	Description
`bone`	string	required. Bone the goal moves to.

Returns: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.

`anim.ikrig_set_goal_settings` (risk 2, mutates, UE 5.5+, requires plugin IKRig, smoke)

Sets the blend alphas, pin exposure and viewport size of an IK goal.

Argument	Type	Description
`positionAlpha`	number	Position blend 0..1 (negative = leave unchanged). Default `-1.0`.
`rotationAlpha`	number	Rotation blend 0..1 (negative = leave unchanged). Default `-1.0`.
`exposePosition`	string	"true"/"false" to change, empty to leave alone.
`exposeRotation`	string
`sizeMultiplier`	number	Viewport size multiplier (negative = leave unchanged). Default `-1.0`.

Returns: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.

`anim.ikrig_set_mesh` (risk 2, mutates, UE 5.5+, requires plugin IKRig, smoke)

Sets the skeletal mesh (and therefore the bone hierarchy) of an IK Rig.

Argument	Type	Description
`mesh`	string	required. Skeletal mesh to drive the rig with.

Returns: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.

`anim.ikrig_set_retarget_root` (risk 2, mutates, UE 5.5+, requires plugin IKRig, smoke)

Sets the retarget root (pelvis) bone used when this rig is a retarget source or target.

Argument	Type	Description
`bone`	string	required. Bone name.

Returns: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.

`anim.ikrig_set_solver_enabled` (risk 2, mutates, UE 5.6+, requires plugin IKRig, smoke)

Enables or disables a solver.

Argument	Type	Description
`enabled`	boolean	Default `true`.

Returns: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.

`anim.ikrig_set_solver_root_bone` (risk 2, mutates, UE 5.6+, requires plugin IKRig, smoke)

Sets the root (start) bone a solver operates from.

Argument	Type	Description
`bone`	string	required. Root (start) bone of the solver.

Returns: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.

`anim.ikrig_set_solver_setting` (risk 2, mutates, UE 5.6+, requires plugin IKRig, smoke)

Sets one property of a solver by name (dotted paths supported) and returns the solver settings.

Argument	Type	Description
`property`	string	required. Property of the solver struct (dotted paths allowed).
`value`	string	required. New value in text form.

Returns: index, type, settings, message.

`anim.import_graph` (risk 2, mutates)

Recreates nodes and links in an anim graph from the JSON produced by anim.export_graph.

Argument	Type	Description
`animBlueprint`	string	required.
`json`	string	required. JSON text in the shape produced by anim.export_graph.
`graph`	string	Target graph; empty = "AnimGraph".
`replace`	boolean	Delete the existing nodes (except the result node) before importing. Default `false`.
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: nodes, count.

`anim.insert_frames` (risk 2, mutates, smoke)

Inserts frames into a sequence (the frame at startFrame is duplicated).

Argument	Type	Description
`anim`	string	required.
`startFrame`	integer	required. First frame of the change.
`count`	integer	required. Number of frames inserted or removed.

Returns: anim, length, frames, frameRate, boneTracks, message.

`anim.list` (risk 0, smoke)

Lists animation assets under a folder, optionally filtered by skeleton, class and name.

Argument	Type	Description
`folder`	string	Content folder to search ("/Game" when empty).
`skeleton`	string	Keep only animations bound to this skeleton.
`classFilter`	string	sequence (default), montage, composite, blendSpace, poseAsset or any.
`nameContains`	string	Keep only assets whose name contains this text.
`recursive`	boolean	Search sub-folders too. Default `true`.
`limit`	integer	Maximum number of assets returned. Default `100`.

Returns: anims, count, message.

`anim.list_bindings` (risk 0, smoke)

Lists the property bindings of one node, or of every node of the Anim Blueprint.

Argument	Type	Description
`animBlueprint`	string	required.
`nodeId`	string	Node id; empty lists the bindings of every anim graph node.
`graph`	string

Returns: bindings, count, compileErrors.

`anim.list_bone_tracks` (risk 0, smoke)

Bone animation tracks of a sequence.

Argument	Type	Description
`anim`	string	required. Animation sequence asset path or unique name.

Returns: anim, tracks, count, message.

`anim.list_by_skeleton` (risk 0, smoke)

Lists every animation asset bound to a skeleton.

Argument	Type	Description
`skeleton`	string	required. Skeleton asset path or unique name.
`classFilter`	string	sequence (default), montage, composite, blendSpace, poseAsset or any.
`folder`	string	Content folder to search ("/Game" when empty).
`limit`	integer	Default `100`.

Returns: anims, count, message.

`anim.list_curves` (risk 0, smoke)

Curves of a sequence with their type and key count.

Argument	Type	Description
`anim`	string	required.
`type`	string	float (default), vector, transform or all.

Returns: anim, curves, count, message.

`anim.list_graph_nodes` (risk 0, smoke)

Lists the nodes of one anim graph (default "AnimGraph") with their id, class, title, position and pins.

Argument	Type	Description
`animBlueprint`	string	required.
`graph`	string	Graph name; empty = "AnimGraph". State machine/state/transition subgraphs are addressable by name too.

Returns: nodes, count.

`anim.list_metadata` (risk 0, smoke)

Metadata objects attached to a sequence, with their properties.

Argument	Type	Description
`anim`	string	required. Animation sequence asset path or unique name.

Returns: anim, metaData, count, message.

`anim.list_metadata_classes` (risk 0, smoke)

Available UAnimMetaData subclasses.

Argument	Type	Description
`nameContains`	string	Keep only classes whose name contains this text.
`includeStates`	boolean	Include UAnimNotifyState subclasses too. Default `true`.
`limit`	integer	Default `200`.

Returns: classes, count, message.

`anim.list_modifier_classes` (risk 0, smoke)

Available UAnimationModifier subclasses (native and blueprint).

Argument	Type	Description
`nameContains`	string	Keep only classes whose name contains this text.
`includeStates`	boolean	Include UAnimNotifyState subclasses too. Default `true`.
`limit`	integer	Default `200`.

Returns: classes, count, message.

`anim.list_node_classes` (risk 0, smoke)

Lists the anim graph node classes available in this editor, with the short name accepted by anim.add_node.

Argument	Type	Description
`nameContains`	string	Case-insensitive substring filter on the class or short name.
`limit`	integer	Maximum results; 0 = no limit. Default `0`.

Returns: classes, count.

`anim.list_notifies` (risk 0, smoke)

Notifies of a sequence with index, time, duration, track and class.

Argument	Type	Description
`anim`	string	required.
`track`	string	Keep only the notifies of this notify track.

Returns: anim, notifies, count, message.

`anim.list_notify_classes` (risk 0, smoke)

Available notify (and notify state) classes, native and blueprint.

Argument	Type	Description
`nameContains`	string	Keep only classes whose name contains this text.
`includeStates`	boolean	Include UAnimNotifyState subclasses too. Default `true`.
`limit`	integer	Default `200`.

Returns: classes, count, message.

`anim.list_notify_tracks` (risk 0, smoke)

Notify tracks of a sequence.

Argument	Type	Description
`anim`	string	required. Animation sequence asset path or unique name.

Returns: anim, tracks, count, message.

`anim.list_sync_markers` (risk 0, smoke)

Sync markers of a sequence with their time and track.

Argument	Type	Description
`anim`	string	required. Animation sequence asset path or unique name.

Returns: anim, markers, names, count, removed, message.

`anim.make_source_sequence` (risk 2, mutates, smoke)

Creates a one-frame animation holding the reference pose of a skeletal mesh; the cheapest source clip for montages, composites and blend spaces.

Argument	Type	Description
`folder`	string	required. Destination content folder.
`name`	string	required. Asset name without a path.
`mesh`	string	required. Skeletal mesh whose reference pose and skeleton are used.

Returns: anim, skeleton, length, message.

`anim.montage_add_branching_point` (risk 2, mutates, smoke)

Adds a branching point: a notify evaluated immediately instead of being queued.

Argument	Type	Description
`montage`	string	required.
`name`	string	required. Notify name (the anim blueprint event is AnimNotify_).
`time`	number	Trigger time in seconds. Default `0.f`.
`track`	string	Notify track; created when it does not exist.
`notifyClass`	string	UAnimNotify or UAnimNotifyState subclass to instantiate; empty creates a plain named notify.
`duration`	number	Duration in seconds; greater than zero makes it a notify state. Default `0.f`.
`branchingPoint`	boolean	Fire as a branching point (evaluated immediately instead of being queued). Default `false`.

Returns: montage, count, notifies, tracks, message.

`anim.montage_add_notify` (risk 2, mutates, smoke)

Adds a notify (or notify state when duration is greater than zero) at a time on a track.

Argument	Type	Description
`montage`	string	required.
`name`	string	required. Notify name (the anim blueprint event is AnimNotify_).
`time`	number	Trigger time in seconds. Default `0.f`.
`track`	string	Notify track; created when it does not exist.
`notifyClass`	string	UAnimNotify or UAnimNotifyState subclass to instantiate; empty creates a plain named notify.
`duration`	number	Duration in seconds; greater than zero makes it a notify state. Default `0.f`.
`branchingPoint`	boolean	Fire as a branching point (evaluated immediately instead of being queued). Default `false`.

Returns: montage, count, notifies, tracks, message.

`anim.montage_add_notify_track` (risk 2, mutates, smoke)

Adds a notify track (the lane notifies are drawn on).

Argument	Type	Description
`montage`	string	required.
`track`	string	required. Notify track name.

Returns: montage, skeleton, length, slots, segments, sections, notifyCount, notifyTracks, blendIn, blendOut, blendInCurve, blendOutCurve, blendOutTriggerTime, enableAutoBlendOut, syncGroup, syncSlotIndex, enableRootMotionTranslation, enableRootMotionRotation, timeStretchCurveName, message, notes.

`anim.montage_add_section` (risk 2, mutates, smoke)

Adds a named section starting at a given time.

Argument	Type	Description
`montage`	string	required.
`name`	string	required. Section name, unique in the montage.
`time`	number	Start time in seconds (clamped to the montage length). Default `0.f`.

`anim.montage_add_segment` (risk 2, mutates, smoke)

Appends an animation to a slot track (start, animation range, play rate and loop count).

Argument	Type	Description
`montage`	string	required.
`slot`	string	Slot to append to; empty uses the first slot.
`anim`	string	required.
`startPos`	number	Start on the montage timeline; negative appends after the last segment. Default `-1.f`.
`animStart`	number	First time used from the animation. Default `0.f`.
`animEnd`	number	Last time used from the animation; 0 or negative uses the full length. Default `0.f`.
`playRate`	number	Default `1.f`.
`loopCount`	integer	Default `1`.

`anim.montage_add_slot` (risk 2, mutates, smoke)

Adds an empty slot track to a montage.

Argument	Type	Description
`montage`	string	required.
`slot`	string	required. Slot name (the anim graph Slot node must use the same name).

`anim.montage_clear_links` (risk 2, mutates, smoke)

Clears every next-section link of the montage.

Argument	Type	Description
`montage`	string	required. Montage asset path or unique name.

`anim.montage_create` (risk 2, mutates, smoke)

Creates a montage, optionally with a first animation in a slot; the skeleton comes from anim, skeleton or mesh.

Argument	Type	Description
`folder`	string	required.
`name`	string	required.
`anim`	string	Animation placed in the first slot; may be empty for an empty montage.
`skeleton`	string	Skeleton of the montage; derived from anim or mesh when empty.
`mesh`	string	Skeletal mesh whose skeleton is used when skeleton and anim are empty.
`slot`	string	Slot name of the first track; defaults to DefaultSlot.
`blendIn`	number	Blend in time in seconds. Default `0.25f`.
`blendOut`	number	Blend out time in seconds. Default `0.25f`.

`anim.montage_create_from_sequence_list` (risk 2, mutates, smoke)

Builds a montage from a list of animations in one call: one segment per clip, one section per clip and the links between them.

Argument	Type	Description
`folder`	string	required.
`name`	string	required.
`anims`	array of string	required. Animations appended one after another, in order.
`slot`	string	Slot of the track; defaults to DefaultSlot.
`sectionsPerAnim`	boolean	Create one section per animation (named or after the animation). Default `true`.
`sectionPrefix`	string	Prefix of the generated section names; empty uses the animation names.
`linkSections`	boolean	Link every section to the next one so the montage plays through. Default `true`.
`blendIn`	number	Default `0.25f`.
`blendOut`	number	Default `0.25f`.

`anim.montage_delete` (risk 3, mutates, destructive, smoke)

Deletes a montage asset.

Argument	Type	Description
`montage`	string	required. Montage asset path or unique name.

`anim.montage_duplicate` (risk 2, mutates, smoke)

Copies a montage into another asset.

Argument	Type	Description
`montage`	string	required.
`folder`	string	Destination folder; empty keeps the source folder.
`name`	string	New name; empty appends _Copy.

`anim.montage_get` (risk 0, smoke)

Slots, segments, sections, blend settings and notify count of a montage.

Argument	Type	Description
`montage`	string	required. Montage asset path or unique name.

`anim.montage_get_length` (risk 0, smoke)

Total length of the montage in seconds, with its section and segment counts.

Argument	Type	Description
`montage`	string	required. Montage asset path or unique name.

`anim.montage_get_section_timing` (risk 0, smoke)

Section timings and the chain of sections the montage plays through, following the links.

Argument	Type	Description
`montage`	string	required. Montage asset path or unique name.

Returns: montage, length, sections, playOrder, loops, message.

`anim.montage_jump_to_section` (risk 1, requires PIE, requires world, smoke)

Jumps the playing montage to a section (empty section = the first one); restarts the montage when it is no longer playing.

Argument	Type	Description
`montage`	string	Montage to address (empty = the first active montage).
`section`	string	Section name (empty = the first section of the montage).

`anim.montage_link_sections` (risk 2, mutates, smoke)

Links one section to the next one ("to" empty stops the montage after "from").

Argument	Type	Description
`montage`	string	required.
`from`	string	required. Section the link starts from.
`to`	string	Section played next; empty unlinks (the montage stops after "from").

`anim.montage_list` (risk 0, smoke)

Lists montages of a folder, optionally filtered by skeleton and name.

Argument	Type	Description
`folder`	string	Content folder to search; empty searches /Game.
`skeleton`	string	Only montages using this skeleton.
`nameContains`	string
`limit`	integer	Default `200`.

Returns: montages, total.

`anim.montage_list_notifies` (risk 0, smoke)

Notifies of a montage with their times, tracks and classes.

Argument	Type	Description
`montage`	string	required. Montage asset path or unique name.

Returns: montage, count, notifies, tracks, message.

`anim.montage_list_notify_tracks` (risk 0, smoke)

Notify tracks of a montage.

Argument	Type	Description
`montage`	string	required. Montage asset path or unique name.

`anim.montage_list_sections` (risk 0, smoke)

Sections of a montage with their times, lengths and next-section links.

Argument	Type	Description
`montage`	string	required. Montage asset path or unique name.

`anim.montage_list_segments` (risk 0, smoke)

Segments of a montage with their animations and timings.

Argument	Type	Description
`montage`	string	required. Montage asset path or unique name.

`anim.montage_list_slots` (risk 0, smoke)

Slot names used by a montage.

Argument	Type	Description
`montage`	string	required. Montage asset path or unique name.

`anim.montage_play` (risk 1, requires PIE, requires world, smoke)

Plays a montage on the anim instance of an actor, optionally starting at a section.

Argument	Type	Description
`montage`	string	required.
`playRate`	number	Default `1.0`.
`section`	string	Section to start from (empty = the first section).

`anim.montage_remove_all_notifies` (risk 3, mutates, smoke)

Removes every notify of the montage.

Argument	Type	Description
`montage`	string	required. Montage asset path or unique name.

Returns: montage, count, notifies, tracks, message.

`anim.montage_remove_notifies_by_name` (risk 2, mutates, smoke)

Removes every notify with a given name.

Argument	Type	Description
`montage`	string	required.
`name`	string	required.

Returns: montage, count, notifies, tracks, message.

`anim.montage_remove_notify` (risk 2, mutates, smoke)

Removes one notify by index.

Argument	Type	Description
`montage`	string	required.
`index`	integer	required. Index as reported by anim.montage_list_notifies.

Returns: montage, count, notifies, tracks, message.

`anim.montage_remove_section` (risk 2, mutates, smoke)

Removes a section.

Argument	Type	Description
`montage`	string	required.
`name`	string	required.

`anim.montage_remove_segment` (risk 2, mutates, smoke)

Removes one segment from a slot track.

Argument	Type	Description
`montage`	string	required.
`slot`	string	Slot of the segment; empty uses the first slot.
`index`	integer	required.

`anim.montage_remove_slot` (risk 3, mutates, smoke)

Removes a slot track and every segment in it.

Argument	Type	Description
`montage`	string	required.
`slot`	string	required. Slot name (the anim graph Slot node must use the same name).

`anim.montage_rename_section` (risk 2, mutates, smoke)

Renames a section and fixes the links pointing at it.

Argument	Type	Description
`montage`	string	required.
`name`	string	required.
`newName`	string	required.

`anim.montage_set_auto_blend_out` (risk 2, mutates, smoke)

Whether the montage blends out automatically when it reaches its end.

Argument	Type	Description
`montage`	string	required.
`enabled`	boolean	Default `true`.

`anim.montage_set_blend` (risk 2, mutates, smoke)

Blend in/out times, their blend options and the blend out trigger time.

Argument	Type	Description
`montage`	string	required.
`blendIn`	number	Blend in time in seconds; negative keeps it. Default `-1.f`.
`blendOut`	number	Blend out time in seconds; negative keeps it. Default `-1.f`.
`blendInCurve`	string	Blend in option: Linear, Cubic, HermiteCubic, Sinusoidal, QuadraticInOut, CircularIn...
`blendOutCurve`	string	Blend out option, same values as blendInCurve.
`blendOutTriggerTime`	number	Seconds before the end at which the blend out starts; below -1 keeps the current value. Default `-2.f`.

`anim.montage_set_blend_profile` (risk 2, mutates, UE 5.0+)

Blend profile of the skeleton used to weight the montage blend per bone (UE 5.0+). SmokeSkip: needs a blend profile authored on the skeleton, which the sandbox has none of.

Argument	Type	Description
`montage`	string	required.
`side`	string	Which blend to change: in, out or both.
`blendProfile`	string	Blend profile of the skeleton (by name or path); empty clears it.

`anim.montage_set_next_section` (risk 1, requires PIE, requires world, smoke)

Sets which section plays after another one; restarts the montage when it is no longer playing.

Argument	Type	Description
`montage`	string
`section`	string	Section whose successor is being set (empty = the first section).
`nextSection`	string	Section played next (empty = the first section).

`anim.montage_set_root_motion` (risk 2, mutates, smoke)

Whether the montage drives root motion translation and rotation.

Argument	Type	Description
`montage`	string	required.
`translation`	boolean	Let the montage drive root motion translation. Default `true`.
`rotation`	boolean	Let the montage drive root motion rotation. Default `true`.

`anim.montage_set_section_time` (risk 2, mutates, smoke)

Moves a section to another time.

Argument	Type	Description
`montage`	string	required.
`name`	string	required.
`time`	number	required. New start time in seconds.

`anim.montage_set_segment` (risk 2, mutates, smoke)

Changes one segment: animation, timeline position, animation range, play rate or loop count.

Argument	Type	Description
`montage`	string	required.
`slot`	string	Slot of the segment; empty uses the first slot.
`index`	integer	required.
`anim`	string	Replacement animation; empty keeps the current one.
`startPos`	number	New start on the timeline; negative keeps it. Default `-1.f`.
`animStart`	number	New animation start time; negative keeps it. Default `-1.f`.
`animEnd`	number	New animation end time; negative keeps it. Default `-1.f`.
`playRate`	number	New play rate; 0 keeps it. Default `0.f`.
`loopCount`	integer	New loop count; 0 keeps it. Default `0`.

`anim.montage_set_sync_group` (risk 2, mutates, smoke)

Sync group and the slot index that drives it.

Argument	Type	Description
`montage`	string	required.
`group`	string	Sync group name; empty clears the group.
`slotIndex`	integer	Index of the slot track that drives the sync group. Default `0`.

`anim.montage_set_time_stretch_curve` (risk 2, mutates, smoke)

Curve driving the montage time stretch, with its sampling settings.

Argument	Type	Description
`montage`	string	required.
`curveName`	string	Name of the float curve driving the stretch; empty disables it.
`samplingRate`	number	Sampling rate of the baked curve; 0 keeps the current value. Default `0.f`.
`curveValueMinPrecision`	number	Minimum precision of the curve value; 0 keeps the current value. Default `0.f`.

`anim.montage_sort_sections` (risk 2, mutates, smoke)

Sorts the sections by start time (the order the editor keeps them in).

Argument	Type	Description
`montage`	string	required. Montage asset path or unique name.

`anim.montage_stop` (risk 1, requires PIE, requires world, smoke)

Stops a montage (or every montage) on an actor with a blend out time.

Argument	Type	Description
`blendOut`	number	Blend out time in seconds. Default `0.25`.
`montage`	string	Montage to stop (empty = every montage).

`anim.montage_validate` (risk 0, smoke)

Checks a montage: empty slots, gaps between segments, sections out of range, broken links, missing animations.

Argument	Type	Description
`montage`	string	required. Montage asset path or unique name.

Returns: montage, valid, issues, message.

`anim.move_node` (risk 2, mutates, smoke)

Moves a node to a new position in its graph.

Argument	Type	Description
`animBlueprint`	string	required.
`nodeId`	string	required.
`x`	integer	required.
`y`	integer	required.
`graph`	string

Returns: node, compileErrors, propertyErrors.

`anim.move_notify` (risk 2, mutates, smoke)

Moves a notify to another time and (optionally) another track.

Argument	Type	Description
`anim`	string	required.
`index`	integer	required. Index in the list returned by anim.list_notifies.
`time`	number	New trigger time in seconds (anim.move_notify). Default `0.0`.
`track`	string	New notify track (anim.move_notify); empty keeps the current one.
`properties`	array of UeaKeyValue	Properties applied to the notify object (anim.set_notify_property).

Returns: anim, index, name, class, time, duration, track, removed, notifies, message.

`anim.play` (risk 1, requires PIE, requires world, smoke)

Plays an animation sequence on an actor in single-node mode.

Argument	Type	Description
`anim`	string	required. Animation sequence to play.
`loop`	boolean	Default `true`.
`playRate`	number	Default `1.0`.
`position`	number	Start position in seconds. Default `0.0`.

`anim.pose_add_from_animation` (risk 2, mutates, smoke)

Adds one pose captured from an animation at a given time (or the mesh reference pose when anim is omitted).

Argument	Type	Description
`pose`	string	required.
`anim`	string	Animation sampled at "time"; empty captures the reference pose of the mesh.
`time`	number	Time in seconds sampled from the animation. Default `0.f`.
`name`	string	Name of the new pose; empty keeps the generated unique name.
`mesh`	string	Skeletal mesh used to evaluate the pose; defaults to the preview mesh of the skeleton.

Returns: pose, skeleton, poseCount, curveCount, trackCount, poses, curves, tracks, additive, basePose, sourceAnimation, message, notes.

`anim.pose_create` (risk 2, mutates, smoke)

Creates a pose asset, baking one pose per frame of an animation (or an empty asset when anim is omitted).

Argument	Type	Description
`folder`	string	required.
`name`	string	required.
`anim`	string	Animation the poses are baked from (one pose per frame); empty creates an empty pose asset.
`skeleton`	string	Skeleton of the asset; derived from anim or mesh when empty.
`mesh`	string	Skeletal mesh whose skeleton is used, and whose reference pose is captured when anim is empty.
`poseNames`	array of string	Names given to the generated poses, in frame order.

Returns: pose, skeleton, poseCount, curveCount, trackCount, poses, curves, tracks, additive, basePose, sourceAnimation, message, notes.

`anim.pose_delete` (risk 3, mutates, destructive, smoke)

Deletes a pose asset.

Argument	Type	Description
`pose`	string	required. Pose asset path or unique name.

Returns: pose, skeleton, poseCount, curveCount, trackCount, poses, curves, tracks, additive, basePose, sourceAnimation, message, notes.

`anim.pose_duplicate` (risk 2, mutates, smoke)

Copies a pose asset into another asset.

Argument	Type	Description
`pose`	string	required.
`folder`	string	Destination folder; empty keeps the source folder.
`name`	string	New name; empty appends _Copy.

Returns: pose, skeleton, poseCount, curveCount, trackCount, poses, curves, tracks, additive, basePose, sourceAnimation, message, notes.

`anim.pose_get` (risk 0, smoke)

Poses, curves, tracks and additive settings of a pose asset.

Argument	Type	Description
`pose`	string	required. Pose asset path or unique name.

Returns: pose, skeleton, poseCount, curveCount, trackCount, poses, curves, tracks, additive, basePose, sourceAnimation, message, notes.

`anim.pose_list` (risk 0, smoke)

Lists pose assets of a folder, optionally filtered by skeleton and name.

Argument	Type	Description
`folder`	string	Content folder to search; empty searches /Game.
`skeleton`	string	Only pose assets using this skeleton.
`nameContains`	string
`limit`	integer	Default `200`.

Returns: poseAssets, total.

`anim.pose_list_curves` (risk 0, smoke)

Curve names driven by the poses.

Argument	Type	Description
`pose`	string	required. Pose asset path or unique name.

Returns: pose, skeleton, poseCount, curveCount, trackCount, poses, curves, tracks, additive, basePose, sourceAnimation, message, notes.

`anim.pose_list_poses` (risk 0, smoke)

Pose names stored in the asset.

Argument	Type	Description
`pose`	string	required. Pose asset path or unique name.

Returns: pose, skeleton, poseCount, curveCount, trackCount, poses, curves, tracks, additive, basePose, sourceAnimation, message, notes.

`anim.pose_list_tracks` (risk 0, smoke)

Bone tracks the poses write to.

Argument	Type	Description
`pose`	string	required. Pose asset path or unique name.

Returns: pose, skeleton, poseCount, curveCount, trackCount, poses, curves, tracks, additive, basePose, sourceAnimation, message, notes.

`anim.pose_remove` (risk 2, mutates, smoke)

Removes poses by name.

Argument	Type	Description
`pose`	string	required.
`names`	array of string	required. Pose names to delete.

Returns: pose, skeleton, poseCount, curveCount, trackCount, poses, curves, tracks, additive, basePose, sourceAnimation, message, notes.

`anim.pose_rename` (risk 2, mutates, smoke)

Renames one pose.

Argument	Type	Description
`pose`	string	required.
`name`	string	required. Current pose name.
`newName`	string	required.

Returns: pose, skeleton, poseCount, curveCount, trackCount, poses, curves, tracks, additive, basePose, sourceAnimation, message, notes.

`anim.pose_set_additive` (risk 2, mutates, smoke)

Converts the poses to additive against a base pose (or back to full poses).

Argument	Type	Description
`pose`	string	required.
`additive`	boolean	required. True stores the poses as additive, false converts them back to full poses.
`basePose`	string	Pose used as the additive base; empty uses the reference pose.

Returns: pose, skeleton, poseCount, curveCount, trackCount, poses, curves, tracks, additive, basePose, sourceAnimation, message, notes.

`anim.pose_update_from_animation` (risk 2, mutates, smoke)

Re-bakes the poses from an animation, keeping the pose names.

Argument	Type	Description
`pose`	string	required.
`anim`	string	required. Animation the poses are re-baked from.

Returns: pose, skeleton, poseCount, curveCount, trackCount, poses, curves, tracks, additive, basePose, sourceAnimation, message, notes.

`anim.pose_validate` (risk 0, smoke)

Checks a pose asset: missing skeleton, no pose, no track, invalid additive base pose.

Argument	Type	Description
`pose`	string	required. Pose asset path or unique name.

Returns: pose, valid, issues, message.

`anim.ps_add_animation` (risk 2, mutates, UE 5.7+, requires plugin PoseSearch, smoke)

Adds an animation sequence (or composite / montage) to a database.

Argument	Type	Description
`anim`	string	required. Animation sequence, composite, montage or blend space to index.
`samplingStart`	number	Start of the sampled range, relative to the asset start (0 = whole asset). Default `0.0`.
`samplingEnd`	number	End of the sampled range, relative to the asset end (0 = whole asset). Default `0.0`.
`useSingleSample`	boolean	Index a single blend space sample instead of the whole grid. Default `false`.
`blendParamX`	number	Blend space coordinates used when useSingleSample is set. Default `0.0`.
`blendParamY`	number	Default `0.0`.

Returns: database, name, schema, normalizationSet, count, anims, settings, message.

`anim.ps_add_blend_space` (risk 2, mutates, UE 5.7+, requires plugin PoseSearch, smoke)

Adds a blend space to a database, sampling its grid or a single point.

Argument	Type	Description
`anim`	string	required. Animation sequence, composite, montage or blend space to index.
`samplingStart`	number	Start of the sampled range, relative to the asset start (0 = whole asset). Default `0.0`.
`samplingEnd`	number	End of the sampled range, relative to the asset end (0 = whole asset). Default `0.0`.
`useSingleSample`	boolean	Index a single blend space sample instead of the whole grid. Default `false`.
`blendParamX`	number	Blend space coordinates used when useSingleSample is set. Default `0.0`.
`blendParamY`	number	Default `0.0`.

Returns: database, name, schema, normalizationSet, count, anims, settings, message.

`anim.ps_add_channel` (risk 2, mutates, UE 5.7+, requires plugin PoseSearch, smoke)

Adds a feature channel to a schema (pose, trajectory, position, heading, velocity, phase, ...).

Argument	Type	Description
`type`	string	required. Channel type: "pose", "trajectory", "position", "heading", "velocity", "phase", "curve" or a class path.
`bones`	array of string	Bones sampled by a "pose" channel.
`weight`	number	Channel weight. Default `1.0`.
`properties`	array of UeaKeyValue	Extra property assignments on the channel (dotted paths allowed, e.g. "Bone.BoneName").

Returns: schema, name, skeleton, mirrorDataTable, sampleRate, cardinality, channels, settings, message.

`anim.ps_build` (risk 2, mutates, UE 5.7+, requires plugin PoseSearch, smoke)

Builds (indexes) a database and waits for the derived data to be ready.

Argument	Type	Description
`database`	string	required. Pose search database asset.

Returns: database, result, message.

`anim.ps_create_database` (risk 2, mutates, UE 5.7+, requires plugin PoseSearch, smoke)

Creates a pose search (motion matching) database bound to a schema.

Argument	Type	Description
`folder`	string	required.
`name`	string	required.
`schema`	string	required. Schema describing the features the database indexes.

Returns: database, name, schema, normalizationSet, count, anims, settings, message.

`anim.ps_create_normalization_set` (risk 2, mutates, UE 5.7+, requires plugin PoseSearch, smoke)

Creates a normalization set so several databases share one cost normalisation.

Argument	Type	Description
`folder`	string	required.
`name`	string	required.
`databases`	array of string	Databases normalised together.

Returns: database, name, schema, normalizationSet, count, anims, settings, message.

`anim.ps_create_schema` (risk 2, mutates, UE 5.7+, requires plugin PoseSearch, smoke)

Creates a pose search schema for a skeleton (add channels next with anim.ps_add_channel).

Argument	Type	Description
`folder`	string	required.
`name`	string	required.
`skeleton`	string	required. Skeleton the schema samples.
`sampleRate`	integer	Sampling rate in Hz. Default `30`.
`mirrorDataTable`	string	Mirror data table (needed for mirrored matching).

Returns: schema, name, skeleton, mirrorDataTable, sampleRate, cardinality, channels, settings, message.

`anim.ps_delete_database` (risk 3, mutates, destructive, UE 5.7+, requires plugin PoseSearch)

Deletes a pose search database asset.

Argument	Type	Description
`database`	string	required. Pose search database asset.

Returns: database, result, message.

`anim.ps_delete_schema` (risk 3, mutates, destructive, UE 5.7+, requires plugin PoseSearch)

Deletes a pose search schema asset.

Argument	Type	Description
`schema`	string	required. Pose search schema asset.

Returns: database, result, message.

`anim.ps_get_database` (risk 0, UE 5.7+, requires plugin PoseSearch, smoke)

Database state: schema, normalization set, indexed animations and settings.

Argument	Type	Description
`database`	string	required. Pose search database asset.

Returns: database, name, schema, normalizationSet, count, anims, settings, message.

`anim.ps_get_schema` (risk 0, UE 5.7+, requires plugin PoseSearch, smoke)

Schema state: skeleton, sample rate, channels and settings.

Argument	Type	Description
`schema`	string	required. Pose search schema asset.

Returns: schema, name, skeleton, mirrorDataTable, sampleRate, cardinality, channels, settings, message.

`anim.ps_list_animations` (risk 0, UE 5.7+, requires plugin PoseSearch, smoke)

Lists the animations indexed by a database.

Argument	Type	Description
`database`	string	required. Pose search database asset.

Returns: database, name, schema, normalizationSet, count, anims, settings, message.

`anim.ps_remove_animation` (risk 3, mutates, UE 5.7+, requires plugin PoseSearch, smoke)

Removes an indexed animation from a database by index.

Argument	Type	Description
`index`	integer	required. Index of the animation entry.

Returns: database, name, schema, normalizationSet, count, anims, settings, message.

`anim.ps_remove_channel` (risk 3, mutates, UE 5.7+, requires plugin PoseSearch, smoke)

Removes a feature channel from a schema by index.

Argument	Type	Description
`index`	integer	required. Index of the channel in the schema.

Returns: schema, name, skeleton, mirrorDataTable, sampleRate, cardinality, channels, settings, message.

`anim.ps_set_database_settings` (risk 2, mutates, UE 5.7+, requires plugin PoseSearch, smoke)

Reads or changes the database settings (cost biases, search mode, KD-tree, normalization set).

Argument	Type	Description
`properties`	array of UeaKeyValue	Property assignments on the database; empty lists the current values.
`normalizationSet`	string	Normalization set asset (optional).

Returns: database, name, schema, normalizationSet, count, anims, settings, message.

`anim.ps_set_schema_settings` (risk 2, mutates, UE 5.7+, requires plugin PoseSearch, smoke)

Reads or changes the schema settings (sample rate, permutations, padding, data preprocessor).

Argument	Type	Description
`properties`	array of UeaKeyValue	Property assignments on the schema; empty lists the current values.

Returns: schema, name, skeleton, mirrorDataTable, sampleRate, cardinality, channels, settings, message.

`anim.record_from_actor` (risk 2, mutates, requires PIE, requires world)

Starts recording the pose of a PIE actor into a new sequence. Not smoke-tested: it needs a running PIE session.

Argument	Type	Description
`actor`	string	required. Actor with a skeletal mesh component, in the running PIE world.
`folder`	string	required. Destination content folder.
`name`	string	required. Name of the recorded sequence.
`duration`	number	Maximum recording length in seconds. Default `5.0`.
`recordInWorldSpace`	boolean	Record in world space instead of component space. Default `false`.
`removeRootAnimation`	boolean	Drop the root bone animation. Default `false`.

Returns: actor, anim, recording, message.

`anim.reimport` (risk 3, mutates)

Reimports a sequence from its source file (or from the file given). Not smoke-tested: the sandbox sequence has no source file.

Argument	Type	Description
`anim`	string	required.
`file`	string	Source file; empty uses the stored one.

Returns: anim, name, message.

`anim.remove_all_bone_tracks` (risk 3, mutates, destructive, smoke)

Removes every bone animation track of a sequence.

Argument	Type	Description
`anim`	string	required. Animation sequence asset path or unique name.

Returns: anim, tracks, count, message.

`anim.remove_all_curves` (risk 3, mutates, destructive, smoke)

Removes every curve of a sequence.

Argument	Type	Description
`anim`	string	required. Animation sequence asset path or unique name.

Returns: anim, curves, count, message.

`anim.remove_all_notifies` (risk 3, mutates, destructive, smoke)

Removes every notify of a sequence.

Argument	Type	Description
`anim`	string	required. Animation sequence asset path or unique name.

Returns: anim, index, name, class, time, duration, track, removed, notifies, message.

`anim.remove_all_sync_markers` (risk 3, mutates, destructive, smoke)

Removes every sync marker of a sequence.

Argument	Type	Description
`anim`	string	required. Animation sequence asset path or unique name.

Returns: anim, markers, names, count, removed, message.

`anim.remove_bone_track` (risk 3, mutates, smoke)

Removes the animation track of a bone (and optionally of its children). 'bone' accepts a name or a track index.

Argument	Type	Description
`anim`	string	required.
`bone`	string	required.
`includeChildren`	boolean	Also remove the tracks of the child bones. Default `true`.

Returns: anim, tracks, count, message.

`anim.remove_curve` (risk 3, mutates, smoke)

Removes a curve from a sequence.

Argument	Type	Description
`anim`	string	required.
`curve`	string	required. Curve name.
`type`	string	float (default), vector or transform.
`metadata`	boolean	Create the curve as a metadata curve (a constant value, no keys). Default `false`.

Returns: anim, curve, type, keys, exists, message.

`anim.remove_frames` (risk 3, mutates, smoke)

Removes frames from a sequence.

Argument	Type	Description
`anim`	string	required.
`startFrame`	integer	required. First frame of the change.
`count`	integer	required. Number of frames inserted or removed.

Returns: anim, length, frames, frameRate, boneTracks, message.

`anim.remove_metadata` (risk 3, mutates)

Removes the metadata objects of a class. Not smoke-tested: the engine ships no concrete UAnimMetaData subclass.

Argument	Type	Description
`anim`	string	required.
`class`	string	required. UAnimMetaData subclass (short name or path).
`properties`	array of UeaKeyValue	Properties applied to the created metadata object.

Returns: anim, metaData, count, message.

`anim.remove_node` (risk 3, mutates, destructive, smoke)

Deletes one node from its anim graph (result nodes are refused).

Argument	Type	Description
`animBlueprint`	string	required.
`nodeId`	string	required. Node id, or a title/class name that is unique in the searched graphs.
`graph`	string
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: count, details, compileErrors.

`anim.remove_nodes` (risk 3, mutates, destructive, smoke)

Deletes several nodes in one call (result nodes are skipped and reported).

Argument	Type	Description
`animBlueprint`	string	required.
`nodeIds`	array of string	required. Node ids (or unique titles) to delete.
`graph`	string
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: count, details, compileErrors.

`anim.remove_notifies_by_name` (risk 3, mutates, smoke)

Removes every notify with a name.

Argument	Type	Description
`anim`	string	required.
`name`	string	required. Notify name or notify track name, depending on the tool.

Returns: anim, index, name, class, time, duration, track, removed, notifies, message.

`anim.remove_notifies_by_track` (risk 3, mutates, smoke)

Removes every notify of a notify track.

Argument	Type	Description
`anim`	string	required.
`name`	string	required. Notify name or notify track name, depending on the tool.

Returns: anim, index, name, class, time, duration, track, removed, notifies, message.

`anim.remove_notify` (risk 3, mutates, smoke)

Removes the notify at an index.

Argument	Type	Description
`anim`	string	required.
`index`	integer	required. Index in the list returned by anim.list_notifies.
`time`	number	New trigger time in seconds (anim.move_notify). Default `0.0`.
`track`	string	New notify track (anim.move_notify); empty keeps the current one.
`properties`	array of UeaKeyValue	Properties applied to the notify object (anim.set_notify_property).

Returns: anim, index, name, class, time, duration, track, removed, notifies, message.

`anim.remove_notify_track` (risk 3, mutates, smoke)

Removes a notify track and the notifies on it.

Argument	Type	Description
`anim`	string	required.
`track`	string	required. Notify track name.
`newName`	string	New track name (anim.rename_notify_track only).

Returns: anim, tracks, count, message.

`anim.remove_sync_markers_by_name` (risk 3, mutates, smoke)

Removes every sync marker with a name.

Argument	Type	Description
`anim`	string	required.
`name`	string	required. Notify name or notify track name, depending on the tool.

Returns: anim, markers, names, count, removed, message.

`anim.remove_virtual_bones` (risk 3, mutates)

Removes virtual bones from the sequence's skeleton. Not smoke-tested: the engine fixture mesh has a minimal skeleton.

Argument	Type	Description
`anim`	string	required.
`names`	array of string	Virtual bone names; empty removes every virtual bone of the skeleton.

Returns: anim, names, count, message.

`anim.rename` (risk 3, mutates, smoke)

Renames (moves) an animation sequence.

Argument	Type	Description
`anim`	string	required.
`folder`	string	Destination folder; empty keeps the source folder.
`name`	string	required. Name of the new asset.

Returns: anim, name, message.

`anim.rename_curve` (risk 2, mutates, smoke)

Renames a curve (the keys are copied to the new name).

Argument	Type	Description
`anim`	string	required.
`curve`	string	required.
`newName`	string	required.
`type`	string	float (default), vector or transform.

Returns: anim, curve, type, keys, exists, message.

`anim.rename_notify_track` (risk 2, mutates, smoke)

Renames a notify track, keeping its notifies.

Argument	Type	Description
`anim`	string	required.
`track`	string	required. Notify track name.
`newName`	string	New track name (anim.rename_notify_track only).

Returns: anim, tracks, count, message.

`anim.resize` (risk 2, mutates, UE 5.0+, smoke)

Sets the play length of a sequence, resampling its keys (UE 5 only).

Argument	Type	Description
`anim`	string	required.
`length`	number	required. New play length in seconds.

Returns: anim, length, frames, frameRate, boneTracks, message.

`anim.reverse` (risk 2, mutates, UE 5.0+, smoke)

Reverses the bone track keys of a sequence (UE 5 only).

Argument	Type	Description
`anim`	string	required. Animation sequence asset path or unique name.

Returns: anim, length, frames, frameRate, boneTracks, message.

`anim.revert_modifier` (risk 3, mutates)

Reverts an animation modifier applied to a sequence. Not smoke-tested: the engine ships no animation modifier asset.

Argument	Type	Description
`anim`	string	required.
`modifierClass`	string	required. UAnimationModifier subclass (blueprint asset path or class name).
`properties`	array of UeaKeyValue	Properties applied to the modifier before running it.

Returns: anim, name, message.

`anim.rtg_add_pose` (risk 2, mutates, UE 5.5+, requires plugin IKRig, smoke)

Creates a retarget pose on the source or target side.

Argument	Type	Description
`side`	string	required. "source" or "target".
`name`	string	required. Retarget pose name.

Returns: side, poses, current, count, message.

`anim.rtg_auto_map_chains` (risk 2, mutates, UE 5.5+, requires plugin IKRig, smoke)

Maps target chains to source chains automatically ("exact", "fuzzy" or "clear").

Argument	Type	Description
`mode`	string	"exact", "fuzzy" or "clear". Default `TEXT("exact")`.
`force`	boolean	Remap chains that already have a source chain. Default `false`.

Returns: retargeter, name, sourceRig, targetRig, sourceMesh, targetMesh, sourcePose, targetPose, chainMap, sourcePoses, targetPoses, opCount, message.

`anim.rtg_create` (risk 2, mutates, UE 5.5+, requires plugin IKRig, smoke)

Creates an IK Retargeter from a source and a target IK Rig, with the default retarget ops.

Argument	Type	Description
`folder`	string	required.
`name`	string	required.
`sourceRig`	string	required. IK rig of the animation being copied from.
`targetRig`	string	required. IK rig of the character being animated.

Returns: retargeter, name, sourceRig, targetRig, sourceMesh, targetMesh, sourcePose, targetPose, chainMap, sourcePoses, targetPoses, opCount, message.

`anim.rtg_delete` (risk 3, mutates, destructive, UE 5.5+, requires plugin IKRig)

Deletes an IK Retargeter asset.

Argument	Type	Description
`retargeter`	string	required. IK retargeter asset.

Returns: deleted, message.

`anim.rtg_get` (risk 0, UE 5.5+, requires plugin IKRig, smoke)

Full state of an IK Retargeter: rigs, preview meshes, chain mapping and retarget poses.

Argument	Type	Description
`retargeter`	string	required. IK retargeter asset.

Returns: retargeter, name, sourceRig, targetRig, sourceMesh, targetMesh, sourcePose, targetPose, chainMap, sourcePoses, targetPoses, opCount, message.

`anim.rtg_list_chain_map` (risk 0, UE 5.5+, requires plugin IKRig, smoke)

Lists the target-to-source chain mapping of a retargeter.

Argument	Type	Description
`retargeter`	string	required. IK retargeter asset.

Returns: retargeter, name, sourceRig, targetRig, sourceMesh, targetMesh, sourcePose, targetPose, chainMap, sourcePoses, targetPoses, opCount, message.

`anim.rtg_list_ops` (risk 0, UE 5.6+, requires plugin IKRig, smoke)

Lists the retarget ops of a retargeter and their settings (5.6+ op-based retargeting model).

Argument	Type	Description
`retargeter`	string	required. IK retargeter asset.

Returns: settings, applied, errors, message.

`anim.rtg_list_poses` (risk 0, UE 5.5+, requires plugin IKRig, smoke)

Lists the retarget poses of one side and the current one.

Argument	Type	Description
`side`	string	required.
`pose`	string	Retarget pose name (empty = the current pose of that side).

Returns: side, poses, current, count, message.

`anim.rtg_map_chain` (risk 2, mutates, UE 5.5+, requires plugin IKRig, smoke)

Maps one target chain to a source chain (empty source chain unmaps it).

Argument	Type	Description
`targetChain`	string	required. Chain of the target rig.
`sourceChain`	string	Chain of the source rig, or empty to unmap.

Returns: retargeter, name, sourceRig, targetRig, sourceMesh, targetMesh, sourcePose, targetPose, chainMap, sourcePoses, targetPoses, opCount, message.

`anim.rtg_remove_pose` (risk 3, mutates, UE 5.5+, requires plugin IKRig, smoke)

Removes a retarget pose.

Argument	Type	Description
`side`	string	required.
`pose`	string	required.

Returns: side, poses, current, count, message.

`anim.rtg_rename_pose` (risk 2, mutates, UE 5.5+, requires plugin IKRig, smoke)

Renames a retarget pose.

Argument	Type	Description
`newName`	string	required.

Returns: side, poses, current, count, message.

`anim.rtg_reset_pose` (risk 2, mutates, UE 5.5+, requires plugin IKRig, smoke)

Resets a retarget pose, or only the bones listed.

Argument	Type	Description
`bones`	array of string	Bones to reset; empty resets the whole pose.

Returns: side, poses, current, count, message.

`anim.rtg_retarget_animations` (risk 2, mutates, UE 5.8+, requires plugin IKRig)

Duplicates and retargets a list of animation assets onto the target skeleton of a retargeter.

Argument	Type	Description
`anims`	array of string	required. Animation assets to retarget.
`folder`	string	required. Destination folder for the new assets.
`prefix`	string
`suffix`	string
`search`	string	Substring replaced in the asset name.
`replace`	string
`includeReferencedAssets`	boolean	Also retarget the assets referenced by the ones listed. Default `true`.
`overwriteExistingFiles`	boolean	Overwrite assets with the same name instead of creating unique names. Default `false`.

Returns: created, count, message.

`anim.rtg_set_chain_settings` (risk 2, mutates, UE 5.5+, UE ≤5.5, requires plugin IKRig, smoke)

Reads or changes the FK / IK / speed-planting settings of one target chain.

Argument	Type	Description
`targetChain`	string	required.
`properties`	array of UeaKeyValue	Property assignments on FTargetChainSettings (e.g. "FK.RotationAlpha" = "0.5"). Empty lists the current values.

Returns: settings, applied, errors, message.

`anim.rtg_set_current_pose` (risk 2, mutates, UE 5.5+, requires plugin IKRig, smoke)

Makes a retarget pose the current one for that side.

Argument	Type	Description
`side`	string	required.
`pose`	string	required.

Returns: side, poses, current, count, message.

`anim.rtg_set_global_settings` (risk 2, mutates, UE 5.5+, UE ≤5.5, requires plugin IKRig, smoke)

Reads or changes the global settings of a retargeter (enable FK / IK / root, warping, ...).

Argument	Type	Description
`properties`	array of UeaKeyValue	Property assignments; empty lists the current values.

Returns: settings, applied, errors, message.

`anim.rtg_set_op_setting` (risk 2, mutates, UE 5.6+, requires plugin IKRig)

Sets a property on one retarget op, addressed as "." (5.6+).

Argument	Type	Description
`properties`	array of UeaKeyValue	Property assignments; empty lists the current values.

Returns: settings, applied, errors, message.

`anim.rtg_set_pose_bone_rotation` (risk 2, mutates, UE 5.5+, requires plugin IKRig, smoke)

Sets the rotation offset of one bone inside a retarget pose (degrees).

Argument	Type	Description
`bone`	string	required.
`rotation`	{x,y,z}	Rotation offset applied to the bone, in degrees (pitch, yaw, roll).

Returns: side, poses, current, count, message.

`anim.rtg_set_pose_root_offset` (risk 2, mutates, UE 5.5+, requires plugin IKRig, smoke)

Sets the global translation offset of the pelvis inside a retarget pose.

Argument	Type	Description
`offset`	{x,y,z}	Global translation offset of the pelvis bone.

Returns: side, poses, current, count, message.

`anim.rtg_set_preview_mesh` (risk 2, mutates, UE 5.5+, requires plugin IKRig, smoke)

Sets the preview skeletal mesh of the source or target side.

Argument	Type	Description
`side`	string	required. "source" or "target".
`mesh`	string	required.

Returns: retargeter, name, sourceRig, targetRig, sourceMesh, targetMesh, sourcePose, targetPose, chainMap, sourcePoses, targetPoses, opCount, message.

`anim.rtg_set_rig` (risk 2, mutates, UE 5.5+, requires plugin IKRig, smoke)

Assigns the source or target IK Rig of a retargeter.

Argument	Type	Description
`side`	string	required. "source" or "target".
`ikRig`	string	required.

Returns: retargeter, name, sourceRig, targetRig, sourceMesh, targetMesh, sourcePose, targetPose, chainMap, sourcePoses, targetPoses, opCount, message.

`anim.rtg_set_root_settings` (risk 2, mutates, UE 5.5+, UE ≤5.5, requires plugin IKRig, smoke)

Reads or changes the retarget root (pelvis) settings of a retargeter.

Argument	Type	Description
`properties`	array of UeaKeyValue	Property assignments; empty lists the current values.

Returns: settings, applied, errors, message.

`anim.rtg_validate` (risk 0, UE 5.5+, requires plugin IKRig, smoke)

Checks a retargeter for missing rigs, missing meshes and unmapped target chains.

Argument	Type	Description
`retargeter`	string	required. IK retargeter asset.

Returns: valid, issues, mappedChains, unmappedChains, message.

`anim.save` (risk 2, mutates)

Saves the package of an animation sequence to disk. Not smoke-tested: the self-test never writes files.

Argument	Type	Description
`anim`	string	required. Animation sequence asset path or unique name.

Returns: anim, name, message.

`anim.set_additive` (risk 2, mutates, smoke)

Additive settings: additive type, base pose type, base pose animation and reference frame.

Argument	Type	Description
`anim`	string	required.
`type`	string	required. none, localSpaceBase (local) or meshSpaceRotation (mesh).
`basePoseType`	string	none, refPose, animScaled, animFrame or localAnimFrame.
`basePoseAnim`	string	Sequence used as the base pose when basePoseType is animScaled/animFrame.
`refFrameIndex`	integer	Frame of the base pose animation when basePoseType is animFrame. Default `0`.

Returns: anim, type, basePoseType, basePoseAnim, refFrameIndex, message.

`anim.set_anim_blueprint` (risk 2, mutates, requires world)

Assigns (or clears) the anim blueprint of the skeletal mesh component of an actor. Works in the editor and in PIE.

Argument	Type	Description
`animBlueprint`	string	Anim blueprint asset, or empty to clear it.

`anim.set_anim_mode` (risk 1, requires PIE, requires world, smoke)

Switches the animation mode of an actor between "blueprint", "singleNode" and "custom".

Argument	Type	Description
`mode`	string	required. "blueprint", "singleNode" or "custom".

`anim.set_bone_track_keys` (risk 2, mutates, UE 5.0+)

Replaces the keys of one bone track (UE 5 only). Not smoke-tested: it needs one key per frame of the target sequence.

Argument	Type	Description
`anim`	string	required.
`bone`	string	required.
`positions`	array of {x,y,z}	One position per key.
`rotations`	array of {x,y,z}	One rotation (pitch/yaw/roll) per key.
`scales`	array of {x,y,z}	One scale per key; empty uses 1,1,1.

Returns: anim, length, frames, frameRate, boneTracks, message.

`anim.set_compression` (risk 2, mutates, smoke)

Bone and curve compression settings assets of a sequence (empty arguments only report the current ones).

Argument	Type	Description
`anim`	string	required.
`boneSettings`	string	UAnimBoneCompressionSettings asset; empty leaves it unchanged.
`curveSettings`	string	UAnimCurveCompressionSettings asset; empty leaves it unchanged.

Returns: anim, boneSettings, curveSettings, compressedSizeBytes, message.

`anim.set_curve_from_expression` (risk 2, mutates, smoke)

Fills a float curve from an expression sampled over the sequence: constant, linear, sine, cosine or pulse.

Argument	Type	Description
`anim`	string	required.
`curve`	string	required.
`expression`	string	required. constant, linear, sine, cosine or pulse.
`samples`	integer	Number of samples spread over the sequence. Default `10`.
`amplitude`	number	Peak value (constant value for 'constant', end value for 'linear'). Default `1.0`.
`frequency`	number	Cycles over the whole sequence (sine/cosine/pulse). Default `1.0`.
`offset`	number	Value added to every sample. Default `0.0`.

Returns: anim, curve, type, keys, exists, message.

`anim.set_curve_keys` (risk 2, mutates, smoke)

Replaces every key of a float curve.

Argument	Type	Description
`anim`	string	required.
`curve`	string	required.
`times`	array of number	required. Key times in seconds.
`values`	array of number	required. One value per time.
`create`	boolean	Create the curve when it does not exist yet. Default `true`.

Returns: anim, curve, type, keys, exists, message.

`anim.set_frame_rate` (risk 2, mutates, UE 5.0+, smoke)

Changes the sampling frame rate, resampling the keys (UE 5 only: 4.27 has no animation data controller).

Argument	Type	Description
`anim`	string	required.
`frameRate`	number	required. New sampling rate in frames per second.

Returns: anim, time, frame, length, frames, frameRate, valid, message.

`anim.set_import_settings` (risk 2, mutates, smoke)

Changes the FBX import settings used by the next reimport (creates them when the sequence has none).

Argument	Type	Description
`anim`	string	required.
`animationLength`	string	exportedTime, animatedKey, setRange (FBX animation length import type); empty leaves it.
`frameImportRangeMin`	integer	First frame imported when animationLength is setRange; -1 leaves it. Default `-1`.
`frameImportRangeMax`	integer	Last frame imported when animationLength is setRange; -1 leaves it. Default `-1`.
`customSampleRate`	integer	Sample rate used when useDefaultSampleRate is false; -1 leaves it. Default `-1`.
`importCustomAttribute`	string	"true"/"false"; empty leaves the current value.
`importBoneTracks`	string
`useDefaultSampleRate`	string
`deleteExistingMorphTargetCurves`	string
`doNotImportCurveWithZero`	string
`removeRedundantKeys`	string
`setMaterialDriveParameterOnCustomAttribute`	string
`preserveLocalTransform`	string
`snapToClosestFrameBoundary`	string	UE 5 only.

Returns: anim, importDataClass, sourceFiles, settings, canReimport, message.

`anim.set_interpolation` (risk 2, mutates, smoke)

Key interpolation of a sequence: linear or step.

Argument	Type	Description
`anim`	string	required.
`type`	string	required. linear or step.

Returns: anim, name, message.

`anim.set_node_comment` (risk 2, mutates, smoke)

Sets the comment bubble of a node.

Argument	Type	Description
`animBlueprint`	string	required.
`nodeId`	string	required.
`comment`	string
`graph`	string

Returns: node, compileErrors, propertyErrors.

`anim.set_node_functions` (risk 2, mutates, UE 5.0+)

Sets the anim node functions of a node (OnInitialize / OnBecomeRelevant / OnUpdate), UE 5.0+.

Argument	Type	Description
`animBlueprint`	string	required.
`nodeId`	string	required.
`onInitialize`	string	Function name called when the node is initialised.
`onBecomeRelevant`	string	Function name called when the node becomes relevant.
`onUpdate`	string	Function name called every update.
`graph`	string
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: node, compileErrors, propertyErrors.

`anim.set_node_properties` (risk 2, mutates, smoke)

Sets several properties of an anim graph node in one call.

Argument	Type	Description
`animBlueprint`	string	required.
`nodeId`	string	required.
`properties`	array of UeaKeyValue	required.
`graph`	string
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: properties, count, errors, compileErrors.

`anim.set_node_property` (risk 2, mutates, smoke)

Sets one property of an anim graph node (inside its FAnimNode_* struct or on the node itself); dotted paths reach nested struct members.

Argument	Type	Description
`animBlueprint`	string	required.
`nodeId`	string	required.
`property`	string	required. Property name inside the FAnimNode_* struct, or on the node itself; dotted paths allowed.
`value`	string	Value as text; asset references are accepted for object properties.
`graph`	string
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: properties, count, errors, compileErrors.

`anim.set_notify_property` (risk 2, mutates, smoke)

Applies properties to the notify object at an index (see anim.list_notifies).

Argument	Type	Description
`anim`	string	required.
`index`	integer	required. Index in the list returned by anim.list_notifies.
`time`	number	New trigger time in seconds (anim.move_notify). Default `0.0`.
`track`	string	New notify track (anim.move_notify); empty keeps the current one.
`properties`	array of UeaKeyValue	Properties applied to the notify object (anim.set_notify_property).

Returns: anim, index, name, class, time, duration, track, removed, notifies, message.

`anim.set_play_rate` (risk 1, requires PIE, requires world, smoke)

Sets the play rate of the current single-node animation.

Argument	Type	Description
`playRate`	number	Default `1.0`.

`anim.set_position` (risk 1, requires PIE, requires world, smoke)

Scrubs the current single-node animation to a position in seconds.

Argument	Type	Description
`time`	number	Position in seconds. Default `0.0`.
`fireNotifies`	boolean	Fire the notifies between the old and the new position. Default `false`.

`anim.set_rate_scale` (risk 2, mutates, smoke)

Playback speed multiplier stored on the asset.

Argument	Type	Description
`anim`	string	required.
`rateScale`	number	required. Playback multiplier stored on the asset (1 = authored speed).

Returns: anim, name, message.

`anim.set_retarget_source` (risk 2, mutates, smoke)

Retarget source of a sequence (a name registered on the skeleton, or a skeletal mesh on UE 5).

Argument	Type	Description
`anim`	string	required.
`source`	string	Retarget source name registered on the skeleton; empty clears it.
`mesh`	string	Skeletal mesh used as the retarget source (UE 5 only).

Returns: anim, name, message.

`anim.set_root_motion` (risk 2, mutates, smoke)

Root motion settings: extraction, root lock type, forced lock and normalised scale.

Argument	Type	Description
`anim`	string	required.
`enabled`	boolean	Enable root motion extraction. Default `true`.
`lockType`	string	refPose / anim_first_frame / zero / animFirstFrame (empty leaves it unchanged).
`forceRootLock`	boolean	Force the root lock even when root motion is disabled. Default `false`.
`useNormalizedRootMotionScale`	boolean	Normalise the root motion scale with the mesh scale. Default `true`.

Returns: anim, enabled, lockType, forceRootLock, useNormalizedRootMotionScale, hasRootTrack, message.

`anim.set_skeleton` (risk 3, mutates, smoke)

Binds a sequence to another skeleton; 'convertSpaces' remaps the tracks to the new hierarchy.

Argument	Type	Description
`anim`	string	required.
`skeleton`	string	required. Skeleton asset path or unique name.
`convertSpaces`	boolean	Remap the tracks to the new bone hierarchy instead of only rebinding. Default `false`.

Returns: anim, skeleton, skeletonName, boneCount, previewMesh, message.

`anim.sm_add_alias` (risk 2, mutates, UE 5.0+, smoke)

Adds a state alias pointing at one or more states (shared transition source), UE 5.0+.

Argument	Type	Description
`animBlueprint`	string	required.
`machine`	string	State machine name or node id; empty = the only one.
`name`	string	required.
`x`	integer	Default `0`.
`y`	integer	Default `0`.
`entry`	boolean	Make this state the entry state of the machine. Default `false`.
`states`	array of string	States the alias points at (anim.sm_add_alias only).
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: state, machine, compileErrors.

`anim.sm_add_conduit` (risk 2, mutates, smoke)

Adds a conduit (a transition hub without a pose) to a state machine.

Argument	Type	Description
`animBlueprint`	string	required.
`machine`	string	State machine name or node id; empty = the only one.
`name`	string	required.
`x`	integer	Default `0`.
`y`	integer	Default `0`.
`entry`	boolean	Make this state the entry state of the machine. Default `false`.
`states`	array of string	States the alias points at (anim.sm_add_alias only).
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: state, machine, compileErrors.

`anim.sm_add_state` (risk 2, mutates, smoke)

Adds a state with its own anim graph to a state machine; Entry=true makes it the entry state.

Argument	Type	Description
`animBlueprint`	string	required.
`machine`	string	State machine name or node id; empty = the only one.
`name`	string	required.
`x`	integer	Default `0`.
`y`	integer	Default `0`.
`entry`	boolean	Make this state the entry state of the machine. Default `false`.
`states`	array of string	States the alias points at (anim.sm_add_alias only).
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: state, machine, compileErrors.

`anim.sm_add_state_blend_space` (risk 2, mutates, smoke)

Adds a blend space player inside a state, optionally driven by two Anim Blueprint float variables.

Argument	Type	Description
`animBlueprint`	string	required.
`machine`	string
`state`	string	required.
`blendSpace`	string	Blend space asset; may be empty to wire the asset later.
`xVariable`	string	Anim Blueprint variable driving the X axis (a Get node is wired to the X pin).
`yVariable`	string	Anim Blueprint variable driving the Y axis.
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: state, boundGraph, nodes, count, resultNodeId, nodeId, compileErrors.

`anim.sm_add_state_node` (risk 2, mutates, smoke)

Adds an anim node of any class inside a state, optionally wiring it to the state result.

Argument	Type	Description
`animBlueprint`	string	required.
`machine`	string
`state`	string	required.
`nodeClass`	string	required. Node class short name ("BlendSpacePlayer", "Slot").
`properties`	array of UeaKeyValue
`connectToResult`	boolean	Wire the node's pose output to the state result (default true). Default `true`.
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: state, boundGraph, nodes, count, resultNodeId, nodeId, compileErrors.

`anim.sm_add_state_sequence` (risk 2, mutates, smoke)

Adds a sequence player inside a state and wires it to the state result. Anim may be empty and set later.

Argument	Type	Description
`animBlueprint`	string	required.
`machine`	string
`state`	string	required.
`anim`	string	Animation sequence asset; may be empty to wire the asset later.
`loop`	boolean	Default `true`.
`playRate`	number	Default `1.0f`.
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: state, boundGraph, nodes, count, resultNodeId, nodeId, compileErrors.

`anim.sm_add_transition` (risk 2, mutates, smoke)

Adds a transition between two states/conduits with a crossfade duration, priority and blend mode.

Argument	Type	Description
`animBlueprint`	string	required.
`machine`	string
`from`	string	required. Source state name or id.
`to`	string	required. Target state name or id.
`crossfade`	number	Crossfade duration in seconds (default 0.2). Default `0.2f`.
`blendMode`	string	Alpha blend option: Linear, Cubic, HermiteCubic, Sinusoidal, QuadraticInOut, ...
`priority`	integer	Default `0`.
`bidirectional`	boolean	Allow the transition in both directions. Default `false`.
`automaticRule`	boolean	Drive the rule from the remaining time of the source state's asset player. Default `false`.
`logicType`	string	StandardBlend or Custom.
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: transition, machine, compileErrors.

`anim.sm_create_locomotion` (risk 2, mutates, smoke)

Builds a complete locomotion state machine (Idle/Move plus optional jump states) with the speed and in-air rules wired, in one call.

Argument	Type	Description
`animBlueprint`	string	required.
`machine`	string	Name of the state machine to create (default "Locomotion").
`idle`	string	Idle animation sequence; may be empty to build the skeleton of the machine and fill it later.
`moveBlendSpace`	string	Blend space used for the moving state (preferred over WalkAnim/RunAnim).
`moveAnim`	string	Animation used for the moving state when no blend space is given.
`jumpStart`	string	Jump start animation (optional).
`jumpLoop`	string	Jump loop animation (optional).
`jumpEnd`	string	Jump land animation (optional).
`speedVariable`	string	Float variable holding the speed; created when missing (default "Speed").
`isInAirVariable`	string	Bool variable holding the in-air state; created when missing (default "IsInAir").
`moveThreshold`	number	Speed above which the character is considered moving (default 10). Default `10.0f`.
`connectToOutput`	boolean	Connect the state machine to the AnimGraph result (default true). Default `true`.
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: machine, nodeId, states, transitions, variables, compileErrors, warnings.

`anim.sm_export` (risk 0, smoke)

Exports a state machine (states, transitions, rules) as JSON for anim.sm_import.

Argument	Type	Description
`animBlueprint`	string	required.
`machine`	string	State machine name or node id; empty = the only one in the Anim Blueprint.

Returns: json, stateCount, transitionCount.

`anim.sm_get` (risk 0, smoke)

Full description of a state machine: states (with their inner node count), transitions, rules and entry state.

Argument	Type	Description
`animBlueprint`	string	required.
`machine`	string	State machine name or node id; empty = the only one in the Anim Blueprint.

Returns: machine, nodeId, graph, stateMachineGraph, entryState, states, transitions, compileErrors.

`anim.sm_get_transition_rule` (risk 0, smoke)

Dumps the rule of a transition: its graph name, the node titles and a short description.

Argument	Type	Description
`animBlueprint`	string	required.
`machine`	string
`transition`	string	required. Transition node id or "From->To".
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: transition, ruleGraph, rule, automaticRule, nodes, compileErrors.

`anim.sm_import` (risk 2, mutates)

Recreates states and transitions from the JSON produced by anim.sm_export (the machine is created when missing).

Argument	Type	Description
`animBlueprint`	string	required.
`json`	string	required. JSON in the shape produced by anim.sm_export.
`machine`	string	State machine to fill; created when it does not exist.
`graph`	string	Target graph for a new state machine; empty = "AnimGraph".
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: machine, nodeId, graph, stateMachineGraph, entryState, states, transitions, compileErrors.

`anim.sm_list` (risk 0, smoke)

Lists the state machines of an Anim Blueprint with their node ids and the graphs they live in.

Argument	Type	Description
`animBlueprint`	string	required.
`machine`	string	State machine name or node id; empty = the only one in the Anim Blueprint.

Returns: machines, nodeIds, graphs, count.

`anim.sm_list_state_nodes` (risk 0, smoke)

Lists the anim graph nodes inside a state and the id of its result node.

Argument	Type	Description
`animBlueprint`	string	required.
`machine`	string
`state`	string	required. State name or node id.
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: state, boundGraph, nodes, count, resultNodeId, nodeId, compileErrors.

`anim.sm_remove_state` (risk 3, mutates, destructive, smoke)

Deletes a state (or conduit/alias) and the transitions attached to it.

Argument	Type	Description
`animBlueprint`	string	required.
`machine`	string
`state`	string	required. State name or node id.
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: machine, nodeId, graph, stateMachineGraph, entryState, states, transitions, compileErrors.

`anim.sm_remove_transition` (risk 3, mutates, destructive, smoke)

Deletes a transition.

Argument	Type	Description
`animBlueprint`	string	required.
`machine`	string
`transition`	string	required. Transition node id or "From->To".
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: machine, nodeId, graph, stateMachineGraph, entryState, states, transitions, compileErrors.

`anim.sm_rename_state` (risk 2, mutates, smoke)

Renames a state, conduit or alias (its inner graph is renamed too).

Argument	Type	Description
`animBlueprint`	string	required.
`machine`	string
`state`	string	required.
`newName`	string	required.
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: state, machine, compileErrors.

`anim.sm_set_entry_state` (risk 2, mutates, smoke)

Makes a state the entry state of its machine (the previous entry link is replaced).

Argument	Type	Description
`animBlueprint`	string	required.
`machine`	string
`state`	string	required. State name or node id.
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: state, machine, compileErrors.

`anim.sm_set_state_notifies` (risk 2, mutates, smoke)

Sets the entered / left / fully-blended notify names of a state.

Argument	Type	Description
`animBlueprint`	string	required.
`machine`	string
`state`	string	required.
`entered`	string	Notify name fired when the state is entered.
`left`	string	Notify name fired when the state is left.
`fullyBlended`	string	Notify name fired when the state is fully blended in.
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: state, machine, compileErrors.

`anim.sm_set_transition` (risk 2, mutates, smoke)

Edits a transition: crossfade, priority, blend mode, blend profile, bidirectional and automatic rule.

Argument	Type	Description
`animBlueprint`	string	required.
`machine`	string
`transition`	string	required. Transition node id or "From->To".
`crossfade`	number	Crossfade duration in seconds; negative = leave unchanged. Default `-1.0f`.
`priority`	integer	Default `-1`.
`blendMode`	string	Alpha blend option name; empty = leave unchanged.
`blendProfile`	string	Blend profile asset (4.27 only; 5.6+ replaced the member, reported as unsupported).
`bidirectional`	boolean	Allow the transition in both directions. Default `false`.
`setBidirectional`	boolean	Apply the Bidirectional value (it is a bool, so it needs an explicit opt-in). Default `false`.
`automaticRule`	boolean	Drive the rule from the remaining time of the source state's asset player. Default `false`.
`setAutomaticRule`	boolean	Apply the AutomaticRule value. Default `false`.
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: transition, machine, compileErrors.

`anim.sm_set_transition_rule_compare` (risk 2, mutates, smoke)

Builds the transition rule as "variable value" using a float variable (created when missing).

Argument	Type	Description
`animBlueprint`	string	required.
`machine`	string
`transition`	string	required.
`variable`	string	required. Float or int member variable of the Anim Blueprint.
`op`	string	required. Comparison operator: >, <, >=, <=, ==, !=.
`value`	number	Right-hand constant. Default `0.0f`.
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: transition, ruleGraph, rule, automaticRule, nodes, compileErrors.

`anim.sm_set_transition_rule_time_remaining` (risk 2, mutates, smoke)

Switches the transition to the automatic rule based on the remaining time of the source state's asset player.

Argument	Type	Description
`animBlueprint`	string	required.
`machine`	string
`transition`	string	required.
`crossfade`	number	Crossfade duration used as the trigger window, in seconds (default: keep the current one). Default `-1.0f`.
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: transition, ruleGraph, rule, automaticRule, nodes, compileErrors.

`anim.sm_set_transition_rule_variable` (risk 2, mutates, smoke)

Builds the transition rule from a bool variable of the Anim Blueprint (created when missing), optionally negated.

Argument	Type	Description
`animBlueprint`	string	required.
`machine`	string
`transition`	string	required.
`variable`	string	required. Bool member variable of the Anim Blueprint.
`negate`	boolean	Invert the variable with a NOT node. Default `false`.
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: transition, ruleGraph, rule, automaticRule, nodes, compileErrors.

`anim.snapshot_pose` (risk 2, mutates, requires PIE, requires world, smoke)

Saves the current pose of a running actor into a new pose asset.

Argument	Type	Description
`folder`	string	required. Destination folder of the pose asset.
`name`	string	required. Asset name of the pose asset.
`poseName`	string	Name of the pose inside the asset (empty = generated).

Returns: poseAsset, poseName, poseCount, message.

`anim.spawn_test_actor` (risk 1, requires PIE, requires world, smoke)

Spawns a skeletal mesh actor in the PIE world to test animations on, and returns its label.

Argument	Type	Description
`mesh`	string	Skeletal mesh of the spawned actor. Default `TEXT("/Engine/EngineMeshes/SkeletalCube")`.
`label`	string	Label given to the actor (also used to find it again). Default `TEXT("AnimTestActor")`.
`location`	{x,y,z}	Spawn location in the PIE world.
`animBlueprint`	string	Anim blueprint set on the spawned actor (optional).

`anim.stop` (risk 1, requires PIE, requires world, smoke)

Stops the single-node playback of an actor.

Argument	Type	Description
`actor`	string	required. Actor label, name or class of the actor carrying the skeletal mesh.

`anim.stop_recording` (risk 2, mutates, requires PIE, requires world)

Stops an animation recording started by anim.record_from_actor. Not smoke-tested: it needs a running PIE session.

Argument	Type	Description
`actor`	string	Actor being recorded; empty stops every recording.

Returns: actor, anim, recording, message.

`anim.unbind_property` (risk 2, mutates, smoke)

Removes a property binding from a node.

Argument	Type	Description
`animBlueprint`	string	required.
`nodeId`	string	required.
`property`	string	required.
`graph`	string
`compile`	boolean	Recompile after the change (default true). Default `true`.

Returns: bindings, count, compileErrors.

`anim.validate` (risk 0, smoke)

Sanity check of a sequence: missing skeleton, zero length, notifies out of range, curves without keys, root motion without a root track.

Argument	Type	Description
`anim`	string	required. Animation sequence asset path or unique name.

Returns: anim, errors, warnings, valid, message.

Guide
Start here
Recipes (sequences)
Recipes (montages, blend spaces, pose assets)
Recipes (anim blueprints)
Recipes (IK rigs and retargeting, UE 5)
Recipes (motion matching and choosers, UE 5.4+)
- A motion matching database
- A chooser table
Recipes (playback in PIE)
Recipes (folder work)
Gotchas
Tools

Guide​

Start here​

Recipes (sequences)​

Recipes (montages, blend spaces, pose assets)​

Recipes (anim blueprints)​

Recipes (IK rigs and retargeting, UE 5)​

An IK rig for a character​

Solving with a solver stack (UE 5.6+)​

Retargeting a pack of animations onto another skeleton​

Recipes (motion matching and choosers, UE 5.4+)​

A motion matching database​

A chooser table​

Recipes (playback in PIE)​

Recipes (folder work)​

Gotchas​

Tools​

anim.add_aim_offset (risk 2, mutates, smoke)​

anim.add_apply_additive (risk 2, mutates, smoke)​

anim.add_blend_by_bool (risk 2, mutates, smoke)​

anim.add_blend_by_enum (risk 2, mutates, smoke)​

anim.add_blend_by_int (risk 2, mutates, smoke)​

anim.add_blend_space_player (risk 2, mutates, smoke)​

anim.add_cached_pose (risk 2, mutates, smoke)​

anim.add_control_rig (risk 2, mutates, requires plugin ControlRig)​

anim.add_curve (risk 2, mutates, smoke)​

anim.add_curve_key (risk 2, mutates, smoke)​

anim.add_curve_keys (risk 2, mutates, smoke)​

anim.add_inertialization (risk 2, mutates, smoke)​

anim.add_layered_bone_blend (risk 2, mutates, smoke)​

anim.add_linked_anim_graph (risk 2, mutates, smoke)​

anim.add_linked_anim_layer (risk 2, mutates, smoke)​

anim.add_look_at (risk 2, mutates, smoke)​

anim.add_metadata (risk 2, mutates)​

anim.add_mirror (risk 2, mutates, UE 5.1+, smoke)​

anim.add_modify_bone (risk 2, mutates, smoke)​

anim.add_niagara_notify (risk 2, mutates, UE 5.0+)​

anim.add_node (risk 2, mutates, smoke)​

anim.add_notify (risk 2, mutates, smoke)​

anim.add_notify_object (risk 2, mutates, smoke)​

anim.add_notify_state (risk 2, mutates, smoke)​

anim.add_notify_track (risk 2, mutates, smoke)​

anim.add_particle_notify (risk 2, mutates)​

anim.add_play_sound_notify (risk 2, mutates, smoke)​

anim.add_pose_asset_player (risk 2, mutates)​

anim.add_random_player (risk 2, mutates, smoke)​

anim.add_rigid_body (risk 2, mutates, smoke)​

anim.add_sequence_evaluator (risk 2, mutates, smoke)​

anim.add_sequence_player (risk 2, mutates, smoke)​

anim.add_slot (risk 2, mutates, smoke)​

anim.add_state_machine (risk 2, mutates, smoke)​

anim.add_sync_marker (risk 2, mutates, smoke)​

anim.add_trail_notify_state (risk 2, mutates)​

anim.add_transform_curve_key (risk 2, mutates, smoke)​

anim.add_two_bone_ik (risk 2, mutates, smoke)​

anim.add_two_way_blend (risk 2, mutates, smoke)​

anim.add_use_cached_pose (risk 2, mutates, smoke)​

anim.add_vector_curve_key (risk 2, mutates)​

anim.add_virtual_bone (risk 2, mutates)​

anim.apply_compression (risk 2, mutates, smoke)​

anim.apply_modifier (risk 3, mutates)​

anim.arrange_nodes (risk 2, mutates, smoke)​

anim.audit (risk 0, smoke)​

anim.bake_curve_from_bone (risk 2, mutates, smoke)​

anim.batch_add_notify (risk 2, mutates, dryRun, smoke)​

anim.batch_apply_modifier (risk 3, mutates, dryRun)​

anim.batch_remove_notifies_by_name (risk 3, mutates, dryRun, smoke)​

anim.batch_rename_curve (risk 2, mutates, dryRun, smoke)​

anim.batch_set_compression (risk 2, mutates, dryRun, smoke)​

anim.batch_set_rate_scale (risk 2, mutates, dryRun, smoke)​

anim.batch_set_root_motion (risk 2, mutates, dryRun, smoke)​

anim.batch_set_skeleton (risk 3, mutates, dryRun, smoke)​

anim.bind_property (risk 2, mutates, smoke)​

anim.bp_add_layer (risk 2, mutates, smoke)​

anim.bp_add_notify_event (risk 2, mutates, smoke)​

anim.bp_add_variable (risk 2, mutates, smoke)​

anim.bp_compile (risk 2, mutates, smoke)​

anim.bp_create (risk 2, mutates, smoke)​

anim.bp_create_layer_interface (risk 2, mutates, smoke)​

anim.bp_delete (risk 3, mutates, destructive, dryRun, smoke)​

anim.bp_duplicate (risk 2, mutates, smoke)​

Guide

Start here

Recipes (sequences)

Recipes (montages, blend spaces, pose assets)

Recipes (anim blueprints)

Recipes (IK rigs and retargeting, UE 5)

An IK rig for a character

Solving with a solver stack (UE 5.6+)

Retargeting a pack of animations onto another skeleton

Recipes (motion matching and choosers, UE 5.4+)

A motion matching database

A chooser table

Recipes (playback in PIE)

Recipes (folder work)

Gotchas

Tools

`anim.add_aim_offset` (risk 2, mutates, smoke)

`anim.add_apply_additive` (risk 2, mutates, smoke)

`anim.add_blend_by_bool` (risk 2, mutates, smoke)

`anim.add_blend_by_enum` (risk 2, mutates, smoke)

`anim.add_blend_by_int` (risk 2, mutates, smoke)

`anim.add_blend_space_player` (risk 2, mutates, smoke)

`anim.add_cached_pose` (risk 2, mutates, smoke)

`anim.add_control_rig` (risk 2, mutates, requires plugin ControlRig)

`anim.add_curve` (risk 2, mutates, smoke)

`anim.add_curve_key` (risk 2, mutates, smoke)

`anim.add_curve_keys` (risk 2, mutates, smoke)

`anim.add_inertialization` (risk 2, mutates, smoke)

`anim.add_layered_bone_blend` (risk 2, mutates, smoke)

`anim.add_linked_anim_graph` (risk 2, mutates, smoke)

`anim.add_linked_anim_layer` (risk 2, mutates, smoke)

`anim.add_look_at` (risk 2, mutates, smoke)

`anim.add_metadata` (risk 2, mutates)

`anim.add_mirror` (risk 2, mutates, UE 5.1+, smoke)

`anim.add_modify_bone` (risk 2, mutates, smoke)

`anim.add_niagara_notify` (risk 2, mutates, UE 5.0+)

`anim.add_node` (risk 2, mutates, smoke)

`anim.add_notify` (risk 2, mutates, smoke)

`anim.add_notify_object` (risk 2, mutates, smoke)

`anim.add_notify_state` (risk 2, mutates, smoke)

`anim.add_notify_track` (risk 2, mutates, smoke)

`anim.add_particle_notify` (risk 2, mutates)

`anim.add_play_sound_notify` (risk 2, mutates, smoke)

`anim.add_pose_asset_player` (risk 2, mutates)

`anim.add_random_player` (risk 2, mutates, smoke)

`anim.add_rigid_body` (risk 2, mutates, smoke)

`anim.add_sequence_evaluator` (risk 2, mutates, smoke)

`anim.add_sequence_player` (risk 2, mutates, smoke)

`anim.add_slot` (risk 2, mutates, smoke)

`anim.add_state_machine` (risk 2, mutates, smoke)

`anim.add_sync_marker` (risk 2, mutates, smoke)

`anim.add_trail_notify_state` (risk 2, mutates)

`anim.add_transform_curve_key` (risk 2, mutates, smoke)

`anim.add_two_bone_ik` (risk 2, mutates, smoke)

`anim.add_two_way_blend` (risk 2, mutates, smoke)

`anim.add_use_cached_pose` (risk 2, mutates, smoke)

`anim.add_vector_curve_key` (risk 2, mutates)

`anim.add_virtual_bone` (risk 2, mutates)

`anim.apply_compression` (risk 2, mutates, smoke)

`anim.apply_modifier` (risk 3, mutates)

`anim.arrange_nodes` (risk 2, mutates, smoke)

`anim.audit` (risk 0, smoke)

`anim.bake_curve_from_bone` (risk 2, mutates, smoke)

`anim.batch_add_notify` (risk 2, mutates, dryRun, smoke)

`anim.batch_apply_modifier` (risk 3, mutates, dryRun)

`anim.batch_remove_notifies_by_name` (risk 3, mutates, dryRun, smoke)

`anim.batch_rename_curve` (risk 2, mutates, dryRun, smoke)

`anim.batch_set_compression` (risk 2, mutates, dryRun, smoke)

`anim.batch_set_rate_scale` (risk 2, mutates, dryRun, smoke)

`anim.batch_set_root_motion` (risk 2, mutates, dryRun, smoke)

`anim.batch_set_skeleton` (risk 3, mutates, dryRun, smoke)

`anim.bind_property` (risk 2, mutates, smoke)

`anim.bp_add_layer` (risk 2, mutates, smoke)

`anim.bp_add_notify_event` (risk 2, mutates, smoke)

`anim.bp_add_variable` (risk 2, mutates, smoke)

`anim.bp_compile` (risk 2, mutates, smoke)

`anim.bp_create` (risk 2, mutates, smoke)

`anim.bp_create_layer_interface` (risk 2, mutates, smoke)

`anim.bp_delete` (risk 3, mutates, destructive, dryRun, smoke)

`anim.bp_duplicate` (risk 2, mutates, smoke)