Kit anim
383 herramientas. Generado a partir del código fuente del plugin; no lo edites a mano.
Las descripciones de las herramientas y de los argumentos se muestran en inglés porque reflejan el schema de las herramientas (el mismo texto que el agente recibe en
tools/list).
Guía
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 andanim.chooser_*the Chooser plugin, all of them UE 5 only. The tools are hidden fromtools/listwhen the plugin is disabled, andtools/callrefuses 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 theannotations.ueaof a tool before assuming it exists. - Retargeters need their default ops.
anim.rtg_createadds them on 5.6+; a retargeter built by hand without them silently produces no motion. - The mesh drives the rig.
anim.ikrig_set_meshrefuses a mesh whose bone hierarchy does not match the one already loaded; create a second rig instead. - Montages need a slot.
anim.montage_playfails 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_allat the end of a session, or the per-family*_savetools.
Herramientas
Leyenda. riesgo 0 = solo lectura, 1 = operación inofensiva del editor, 2 = modifica un asset, 3 = elimina/reemplaza un asset, 4 = proyecto/configuración/build, 5 = potencialmente destructivo (las llamadas por encima de
MaxAutoRiskrequieren"_confirm": true). modifica = se ejecuta en una transacción (edit.undo la revierte). requiere PIE / requiere mundo = se rechaza sin una sesión PIE / sin un nivel abierto. requiere el plugin = no disponible cuando el plugin está desactivado. dryRun = acepta el argumentodryRun. smoke = cubierto poredit.self_test.
anim.add_aim_offset (riesgo 2, modifica, smoke)
Adds an aim offset node (rotation offset blend space applied on top of a base pose).
| Argumento | Tipo | Descripción |
|---|---|---|
blendSpace | string | Blend space / aim offset asset; may be empty to set it later. |
playRate | number | Valor predeterminado 1.0f. |
loop | boolean | Valor predeterminado true. |
Devuelve: node, compileErrors, propertyErrors.
anim.add_apply_additive (riesgo 2, modifica, smoke)
Adds an apply-additive node (Base, Additive, Alpha).
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
graph | string | Target graph; empty = "AnimGraph". |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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. Valor predeterminado false. |
compile | boolean | Recompile after the change (default true). Valor predeterminado true. |
Devuelve: node, compileErrors, propertyErrors.
anim.add_blend_by_bool (riesgo 2, modifica, smoke)
Adds a blend-list-by-bool node (true/false poses).
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
graph | string | Target graph; empty = "AnimGraph". |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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. Valor predeterminado false. |
compile | boolean | Recompile after the change (default true). Valor predeterminado true. |
Devuelve: node, compileErrors, propertyErrors.
anim.add_blend_by_enum (riesgo 2, modifica, smoke)
Adds a blend-list-by-enum node bound to an enum (one blend pose per enumerator).
| Argumento | Tipo | Descripción |
|---|---|---|
enum | string | obligatorio. Enum asset or native enum name driving the blend. |
Devuelve: node, compileErrors, propertyErrors.
anim.add_blend_by_int (riesgo 2, modifica, smoke)
Adds a blend-list-by-int node with the requested number of blend poses.
| Argumento | Tipo | Descripción |
|---|---|---|
poses | integer | Number of blend poses to expose (minimum 2). Valor predeterminado 2. |
Devuelve: node, compileErrors, propertyErrors.
anim.add_blend_space_player (riesgo 2, modifica, smoke)
Adds a blend space player node.
| Argumento | Tipo | Descripción |
|---|---|---|
blendSpace | string | Blend space / aim offset asset; may be empty to set it later. |
playRate | number | Valor predeterminado 1.0f. |
loop | boolean | Valor predeterminado true. |
Devuelve: node, compileErrors, propertyErrors.
anim.add_cached_pose (riesgo 2, modifica, smoke)
Adds a save-cached-pose node under a cache name.
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | obligatorio. |
Devuelve: node, compileErrors, propertyErrors.
anim.add_control_rig (riesgo 2, modifica, requiere el plugin ControlRig)
Adds a Control Rig node running a control rig class on the incoming pose.
| Argumento | Tipo | Descripción |
|---|---|---|
rig | string | obligatorio. Control Rig Blueprint / class. |
Devuelve: node, compileErrors, propertyErrors.
anim.add_curve (riesgo 2, modifica, smoke)
Adds an empty curve (float, vector or transform; 'metadata' makes it a constant metadata curve).
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
curve | string | obligatorio. Curve name. |
type | string | float (default), vector or transform. |
metadata | boolean | Create the curve as a metadata curve (a constant value, no keys). Valor predeterminado false. |
Devuelve: anim, curve, type, keys, exists, message.
anim.add_curve_key (riesgo 2, modifica, smoke)
Adds one key to a float curve.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
curve | string | obligatorio. |
time | number | obligatorio. Key time in seconds. |
value | number | obligatorio. Key value. |
create | boolean | Create the curve when it does not exist yet. Valor predeterminado true. |
Devuelve: anim, curve, type, keys, exists, message.
anim.add_curve_keys (riesgo 2, modifica, smoke)
Adds several keys to a float curve at once.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
curve | string | obligatorio. |
times | array of number | obligatorio. Key times in seconds. |
values | array of number | obligatorio. One value per time. |
create | boolean | Create the curve when it does not exist yet. Valor predeterminado true. |
Devuelve: anim, curve, type, keys, exists, message.
anim.add_inertialization (riesgo 2, modifica, smoke)
Adds an inertialization node (used as the blend target of inertial blends).
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
graph | string | Target graph; empty = "AnimGraph". |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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. Valor predeterminado false. |
compile | boolean | Recompile after the change (default true). Valor predeterminado true. |
Devuelve: node, compileErrors, propertyErrors.
anim.add_layered_bone_blend (riesgo 2, modifica, smoke)
Adds a layered bone blend node with one layer per bone (blend depth defaults to 1).
| Argumento | Tipo | Descripción |
|---|---|---|
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. Valor predeterminado false. |
Devuelve: node, compileErrors, propertyErrors.
anim.add_linked_anim_graph (riesgo 2, modifica, smoke)
Adds a linked anim graph node running another Anim Blueprint / AnimInstance class.
| Argumento | Tipo | Descripción |
|---|---|---|
class | string | obligatorio. Anim Blueprint (or AnimInstance class) to run in the linked graph. |
Devuelve: node, compileErrors, propertyErrors.
anim.add_linked_anim_layer (riesgo 2, modifica, smoke)
Adds a linked anim layer node for a layer of an anim layer interface (or of this Anim Blueprint).
| Argumento | Tipo | Descripción |
|---|---|---|
layer | string | obligatorio. Layer (anim graph function) name. |
interface | string | Anim Layer Interface declaring the layer; empty = self layer. |
Devuelve: node, compileErrors, propertyErrors.
anim.add_look_at (riesgo 2, modifica, smoke)
Adds a look-at node rotating a bone towards a target bone/socket or a location.
| Argumento | Tipo | Descripción |
|---|---|---|
bone | string | obligatorio. Bone that will be rotated. |
lookAtBone | string | Bone or socket to look at; empty uses LookAtLocation. |
lookAtLocation | {x,y,z} |
Devuelve: node, compileErrors, propertyErrors.
anim.add_metadata (riesgo 2, modifica)
Attaches a metadata object of a UAnimMetaData subclass. Not smoke-tested: UAnimMetaData is abstract and the engine ships no concrete subclass.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
class | string | obligatorio. UAnimMetaData subclass (short name or path). |
properties | array of UeaKeyValue | Properties applied to the created metadata object. |
Devuelve: anim, metaData, count, message.
anim.add_mirror (riesgo 2, modifica, UE 5.1+, smoke)
Adds a mirror node driven by a mirror data table (UE 5.1+).
| Argumento | Tipo | Descripción |
|---|---|---|
mirrorTable | string | Mirror data table asset. |
Devuelve: node, compileErrors, propertyErrors.
anim.add_modify_bone (riesgo 2, modifica, smoke)
Adds a transform (modify) bone node. Modes default to "replace" for every component given a value.
| Argumento | Tipo | Descripción |
|---|---|---|
bone | string | obligatorio. |
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 |
Devuelve: node, compileErrors, propertyErrors.
anim.add_niagara_notify (riesgo 2, modifica, UE 5.0+)
Adds a Play Niagara Effect notify (UE 5, Niagara plugin). Not smoke-tested: no Niagara system ships in engine content.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
time | number | obligatorio. |
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. Valor predeterminado true. |
Devuelve: anim, index, name, class, time, duration, track, removed, notifies, message.
anim.add_node (riesgo 2, modifica, smoke)
Adds a node of any anim graph node class ("SequencePlayer", "Slot", "TwoWayBlend"...), applies Properties and optionally wires its pose to the graph result.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
nodeClass | string | obligatorio. Short name ("SequencePlayer", "Slot", "TwoWayBlend") or full class name. |
graph | string | Target graph; empty = "AnimGraph". |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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. Valor predeterminado false. |
compile | boolean | Recompile after the change (default true). Valor predeterminado true. |
Devuelve: node, compileErrors, propertyErrors.
anim.add_notify (riesgo 2, modifica, smoke)
Adds a notify: a plain named notify when no class is given, otherwise an instance of the UAnimNotify subclass.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
name | string | Notify name (used when no class is given: a skeleton notify event). |
time | number | obligatorio. 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. |
Devuelve: anim, index, name, class, time, duration, track, removed, notifies, message.
anim.add_notify_object (riesgo 2, modifica, smoke)
Adds a notify of a class and applies properties to the created notify object in one call.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
name | string | Notify name (used when no class is given: a skeleton notify event). |
time | number | obligatorio. 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. |
Devuelve: anim, index, name, class, time, duration, track, removed, notifies, message.
anim.add_notify_state (riesgo 2, modifica, smoke)
Adds a notify state (a notify with a duration) of the given UAnimNotifyState subclass.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
notifyClass | string | obligatorio. UAnimNotifyState subclass (short name or path). |
time | number | obligatorio. |
duration | number | obligatorio. Duration in seconds. |
track | string | |
properties | array of UeaKeyValue |
Devuelve: anim, index, name, class, time, duration, track, removed, notifies, message.
anim.add_notify_track (riesgo 2, modifica, smoke)
Adds a notify track.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
track | string | obligatorio. Notify track name. |
newName | string | New track name (anim.rename_notify_track only). |
Devuelve: anim, tracks, count, message.
anim.add_particle_notify (riesgo 2, modifica)
Adds a Play Particle Effect notify. Not smoke-tested: no particle system ships in engine content.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
time | number | obligatorio. |
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. Valor predeterminado true. |
Devuelve: anim, index, name, class, time, duration, track, removed, notifies, message.
anim.add_play_sound_notify (riesgo 2, modifica, smoke)
Adds a Play Sound notify with volume, pitch and attachment settings.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
time | number | obligatorio. |
sound | string | Sound asset to play; may be empty and set later. |
track | string | |
volume | number | Valor predeterminado 1.0. |
pitch | number | Valor predeterminado 1.0. |
follow | boolean | Attach the sound to the mesh instead of playing it at the actor location. Valor predeterminado false. |
attachName | string | Socket or bone the sound follows when 'follow' is set. |
Devuelve: anim, index, name, class, time, duration, track, removed, notifies, message.
anim.add_pose_asset_player (riesgo 2, modifica)
Adds a pose asset player: a pose-by-name node when PoseName is given, a pose blend node otherwise.
| Argumento | Tipo | Descripción |
|---|---|---|
pose | string | obligatorio. Pose asset. |
poseName | string | Pose name for a "by name" player; empty adds a pose blend node. |
Devuelve: node, compileErrors, propertyErrors.
anim.add_random_player (riesgo 2, modifica, smoke)
Adds a random player node with one entry per animation.
| Argumento | Tipo | Descripción |
|---|---|---|
anims | array of string | Animation sequences to pick from. |
Devuelve: node, compileErrors, propertyErrors.
anim.add_rigid_body (riesgo 2, modifica, smoke)
Adds a rigid body (physics simulation) node, optionally overriding the physics asset.
| Argumento | Tipo | Descripción |
|---|---|---|
physicsAsset | string | Physics asset overriding the mesh's own. |
Devuelve: node, compileErrors, propertyErrors.
anim.add_sequence_evaluator (riesgo 2, modifica, smoke)
Adds a sequence evaluator node (explicit time instead of playback).
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | Animation sequence asset; may be empty. |
explicitTime | number | Explicit evaluation time in seconds. Valor predeterminado 0.0f. |
Devuelve: node, compileErrors, propertyErrors.
anim.add_sequence_player (riesgo 2, modifica, smoke)
Adds a sequence player node. Anim may be empty to create the node and set the sequence later.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | Animation sequence asset; may be empty to create the node and set the sequence later. |
playRate | number | Valor predeterminado 1.0f. |
loop | boolean | Valor predeterminado true. |
startPosition | number | Valor predeterminado 0.0f. |
Devuelve: node, compileErrors, propertyErrors.
anim.add_slot (riesgo 2, modifica, smoke)
Adds a montage slot node (default slot name "DefaultSlot").
| Argumento | Tipo | Descripción |
|---|---|---|
slotName | string | Montage slot name; default "DefaultSlot". |
Devuelve: node, compileErrors, propertyErrors.
anim.add_state_machine (riesgo 2, modifica, smoke)
Adds a state machine node with an empty state machine graph; edit it with the anim.sm_* tools.
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | obligatorio. |
Devuelve: node, compileErrors, propertyErrors.
anim.add_sync_marker (riesgo 2, modifica, smoke)
Adds a sync marker on a notify track.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
name | string | obligatorio. Marker name. |
time | number | obligatorio. |
track | string | Notify track the marker sits on ("1" when empty). |
Devuelve: anim, markers, names, count, removed, message.
anim.add_trail_notify_state (riesgo 2, modifica)
Adds a Trail notify state between two sockets. Not smoke-tested: it needs a particle system with a trail module.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
time | number | obligatorio. |
duration | number | obligatorio. |
track | string | |
template | string | Particle system used by the trail. |
firstSocket | string | First socket of the trail. |
secondSocket | string | Second socket of the trail. |
Devuelve: anim, index, name, class, time, duration, track, removed, notifies, message.
anim.add_transform_curve_key (riesgo 2, modifica, smoke)
Adds one key to a transform curve.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
curve | string | obligatorio. |
time | number | obligatorio. |
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 | Valor predeterminado true. |
Devuelve: anim, curve, type, keys, exists, message.
anim.add_two_bone_ik (riesgo 2, modifica, smoke)
Adds a two bone IK node on an end-effector bone.
| Argumento | Tipo | Descripción |
|---|---|---|
ikBone | string | obligatorio. 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. |
Devuelve: node, compileErrors, propertyErrors.
anim.add_two_way_blend (riesgo 2, modifica, smoke)
Adds a two-way blend node (A, B, Alpha).
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
graph | string | Target graph; empty = "AnimGraph". |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 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. Valor predeterminado false. |
compile | boolean | Recompile after the change (default true). Valor predeterminado true. |
Devuelve: node, compileErrors, propertyErrors.
anim.add_use_cached_pose (riesgo 2, modifica, smoke)
Adds a use-cached-pose node referencing an existing save-cached-pose by name.
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | obligatorio. |
Devuelve: node, compileErrors, propertyErrors.
anim.add_vector_curve_key (riesgo 2, modifica)
Adds one key to a vector curve. Not smoke-tested: the UE 5 animation data model stores float and transform curves only.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
curve | string | obligatorio. |
time | number | obligatorio. |
value | {x,y,z} | |
create | boolean | Valor predeterminado true. |
Devuelve: anim, curve, type, keys, exists, message.
anim.add_virtual_bone (riesgo 2, modifica)
Adds a virtual bone between two bones of the sequence's skeleton. Not smoke-tested: the engine fixture mesh has a minimal skeleton.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
sourceBone | string | obligatorio. Bone the virtual bone starts from. |
targetBone | string | obligatorio. Bone the virtual bone points at. |
Devuelve: anim, names, count, message.
anim.apply_compression (riesgo 2, modifica, smoke)
Rebuilds the compressed animation data of a sequence.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. Animation sequence asset path or unique name. |
Devuelve: anim, boneSettings, curveSettings, compressedSizeBytes, message.
anim.apply_modifier (riesgo 3, modifica)
Runs an animation modifier on a sequence. Not smoke-tested: the engine ships no animation modifier asset.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
modifierClass | string | obligatorio. UAnimationModifier subclass (blueprint asset path or class name). |
properties | array of UeaKeyValue | Properties applied to the modifier before running it. |
Devuelve: anim, name, message.
anim.arrange_nodes (riesgo 2, modifica, smoke)
Lays the nodes of an anim graph out in columns from the result node leftwards.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
graph | string | |
spacingX | integer | Horizontal spacing between columns (default 320). Valor predeterminado 320. |
spacingY | integer | Vertical spacing between rows (default 180). Valor predeterminado 180. |
Devuelve: count, details, compileErrors.
anim.audit (riesgo 0, smoke)
Audits every animation sequence of a folder: length, rate, root motion, additive, compression, notifies and curves.
| Argumento | Tipo | Descripción |
|---|---|---|
onlyOffenders | boolean | Only return the flagged sequences. Valor predeterminado false. |
Devuelve: anims, count, offenders, withRootMotion, additive, totalLength, message.
anim.bake_curve_from_bone (riesgo 2, modifica, 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.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
bone | string | obligatorio. |
component | string | obligatorio. posX, posY, posZ, rotPitch, rotYaw, rotRoll, scaleX, scaleY, scaleZ or distance. |
curve | string | obligatorio. Destination curve name. |
space | string | local (default) or component space sampling. |
samples | integer | Number of samples; 0 uses one sample per frame. Valor predeterminado 0. |
Devuelve: anim, curve, type, keys, exists, message.
anim.batch_add_notify (riesgo 2, modifica, dryRun, smoke)
Adds the same notify to every sequence of a folder, at a fraction of each sequence's length.
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | obligatorio. Notify name added to every sequence. |
timeRatio | number | Position as a fraction of the sequence length (0..1). Valor predeterminado 0.5. |
track | string | Notify track (created when missing). Valor predeterminado TEXT("1"). |
dryRun | boolean | Valor predeterminado true. |
Devuelve: anims, count, changed, dryRun, message.
anim.batch_apply_modifier (riesgo 3, modifica, dryRun)
Applies (or reverts) an Animation Modifier on every sequence of a folder.
| Argumento | Tipo | Descripción |
|---|---|---|
modifierClass | string | obligatorio. UAnimationModifier subclass (path or short name). |
revert | boolean | Revert the modifier instead of applying it. Valor predeterminado false. |
dryRun | boolean | Valor predeterminado true. |
Devuelve: anims, count, changed, dryRun, message.
anim.batch_remove_notifies_by_name (riesgo 3, modifica, dryRun, smoke)
Removes every notify with a given name from every sequence of a folder.
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | obligatorio. Name to look for. |
dryRun | boolean | Valor predeterminado true. |
Devuelve: anims, count, changed, dryRun, message.
anim.batch_rename_curve (riesgo 2, modifica, dryRun, smoke)
Renames a float curve in every sequence of a folder that has it (keys are preserved).
| Argumento | Tipo | Descripción |
|---|---|---|
curve | string | obligatorio. Existing float curve name. |
newName | string | obligatorio. New curve name. |
dryRun | boolean | Valor predeterminado true. |
Devuelve: anims, count, changed, dryRun, message.
anim.batch_set_compression (riesgo 2, modifica, dryRun, smoke)
Assigns bone and/or curve compression settings to every sequence of a folder.
| Argumento | Tipo | Descripción |
|---|---|---|
boneSettings | string | Bone compression settings asset (empty leaves it alone). |
curveSettings | string | Curve compression settings asset (empty leaves it alone). |
dryRun | boolean | Valor predeterminado true. |
Devuelve: anims, count, changed, dryRun, message.
anim.batch_set_rate_scale (riesgo 2, modifica, dryRun, smoke)
Sets the play rate scale of every sequence of a folder.
| Argumento | Tipo | Descripción |
|---|---|---|
rateScale | number | Valor predeterminado 1.0. |
dryRun | boolean | Valor predeterminado true. |
Devuelve: anims, count, changed, dryRun, message.
anim.batch_set_root_motion (riesgo 2, modifica, dryRun, smoke)
Turns root motion on or off (and sets the root lock) for every sequence of a folder.
| Argumento | Tipo | Descripción |
|---|---|---|
enabled | boolean | Valor predeterminado 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 | Valor predeterminado true. |
Devuelve: anims, count, changed, dryRun, message.
anim.batch_set_skeleton (riesgo 3, modifica, dryRun, smoke)
Re-targets every sequence of a folder onto another skeleton.
| Argumento | Tipo | Descripción |
|---|---|---|
skeleton | string | obligatorio. Skeleton assigned to every sequence of the folder. |
convertSpaces | boolean | Remap the bone tracks to the new skeleton's bone names. Valor predeterminado true. |
dryRun | boolean | Valor predeterminado true. |
Devuelve: anims, count, changed, dryRun, message.
anim.bind_property (riesgo 2, modifica, smoke)
Binds a node property to an Anim Blueprint variable (5.x property bindings; the variable is created when missing).
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
nodeId | string | obligatorio. |
property | string | obligatorio. Property of the FAnimNode_* struct to drive ("PlayRate"). |
variable | string | obligatorio. Variable name (or dotted property path) of the Anim Blueprint to read from. |
graph | string | |
compile | boolean | Recompile after the change (default true). Valor predeterminado true. |
Devuelve: bindings, count, compileErrors.
anim.bp_add_layer (riesgo 2, modifica, smoke)
Adds an anim layer (an anim graph function with its own result node) to the Anim Blueprint.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
name | string | obligatorio. Layer name (becomes an anim graph function). |
compile | boolean | Recompile after the change (default true). Valor predeterminado true. |
Devuelve: layers, count, compileErrors.
anim.bp_add_notify_event (riesgo 2, modifica, smoke)
Adds an AnimNotify event node ("AnimNotify_
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
notifyName | string | obligatorio. Notify name without the "AnimNotify_" prefix (e.g. "Footstep"). |
compile | boolean | Recompile after the change (default true). Valor predeterminado true. |
Devuelve: id, title, graph, compileErrors.
anim.bp_add_variable (riesgo 2, modifica, smoke)
Adds a member variable (bool/float/int/vector/rotator/name/object:Class...) used by transition rules and property bindings.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
name | string | obligatorio. |
type | string | obligatorio. 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). Valor predeterminado true. |
compile | boolean | Recompile after the change (default true). Valor predeterminado true. |
Devuelve: variables, count, compileErrors.
anim.bp_compile (riesgo 2, modifica, smoke)
Compiles the Anim Blueprint and returns the errors and warnings of the compile.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. Anim Blueprint asset path or unique name. |
Devuelve: success, status, errors, warnings, numErrors, numWarnings.
anim.bp_create (riesgo 2, modifica, 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.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. Destination folder, e.g. "/Game/Anim". |
name | string | obligatorio. 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. Valor predeterminado false. |
previewMesh | string | Optional preview skeletal mesh. |
Devuelve: asset, skeleton, parentClass, generatedClass, previewMesh, status, isTemplate, isInterface, graphs, stateMachines, layers, interfaces, variableCount, compileErrors.
anim.bp_create_layer_interface (riesgo 2, modifica, smoke)
Creates an Anim Layer Interface (an interface Anim Blueprint) declaring the given layer names.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. |
name | string | obligatorio. |
layers | array of string | Layer (anim graph function) names to declare in the interface. |
Devuelve: asset, skeleton, parentClass, generatedClass, previewMesh, status, isTemplate, isInterface, graphs, stateMachines, layers, interfaces, variableCount, compileErrors.
anim.bp_delete (riesgo 3, modifica, destructivo, dryRun, smoke)
Deletes an Anim Blueprint asset. Fails when other assets still reference it unless DryRun is used to check first.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
dryRun | boolean | Report only, do not delete. Valor predeterminado false. |
Devuelve: deleted, path, wouldDelete.
anim.bp_duplicate (riesgo 2, modifica, smoke)
Duplicates an Anim Blueprint into a folder under a new name.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
folder | string | Destination folder; default: the source folder. |
name | string | New asset name; default: source name + "_Copy". |
Devuelve: asset, skeleton, parentClass, generatedClass, previewMesh, status, isTemplate, isInterface, graphs, stateMachines, layers, interfaces, variableCount, compileErrors.
anim.bp_get (riesgo 0, smoke)
Full description of an Anim Blueprint: skeleton, parent, status, graphs, state machines, layers, interfaces and variable count.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. Anim Blueprint asset path or unique name. |
Devuelve: asset, skeleton, parentClass, generatedClass, previewMesh, status, isTemplate, isInterface, graphs, stateMachines, layers, interfaces, variableCount, compileErrors.
anim.bp_get_class_defaults (riesgo 0, smoke)
Reads the editable class defaults of the generated AnimInstance CDO.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. Anim Blueprint asset path or unique name. |
Devuelve: properties, count, errors.
anim.bp_get_compile_errors (riesgo 2, modifica, smoke)
Compiles silently and reports only the diagnostics (same as anim.bp_compile, kept for discoverability).
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. Anim Blueprint asset path or unique name. |
Devuelve: success, status, errors, warnings, numErrors, numWarnings.
anim.bp_implement_interface (riesgo 2, modifica, smoke)
Implements an Anim Layer Interface on an Anim Blueprint (its layers become anim graph functions).
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
interface | string | obligatorio. Anim Layer Interface asset (or its generated class name). |
Devuelve: asset, skeleton, parentClass, generatedClass, previewMesh, status, isTemplate, isInterface, graphs, stateMachines, layers, interfaces, variableCount, compileErrors.
anim.bp_list (riesgo 0, smoke)
Lists Anim Blueprint assets under a folder, optionally filtered by target skeleton and name substring.
| Argumento | Tipo | Descripción |
|---|---|---|
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. Valor predeterminado 0. |
Devuelve: assets, count.
anim.bp_list_layers (riesgo 0, smoke)
Lists the anim layers (anim graph functions) of the Anim Blueprint with the interface each comes from.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. Anim Blueprint asset path or unique name. |
Devuelve: layers, count, compileErrors.
anim.bp_list_slots_used (riesgo 0, smoke)
Lists the montage slot names referenced by the slot nodes of the Anim Blueprint.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. Anim Blueprint asset path or unique name. |
Devuelve: names, count.
anim.bp_list_variables (riesgo 0, smoke)
Lists the member variables of the Anim Blueprint with their types and defaults.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. Anim Blueprint asset path or unique name. |
Devuelve: variables, count, compileErrors.
anim.bp_remove_interface (riesgo 3, modifica, destructivo, smoke)
Removes an implemented Anim Layer Interface and its layer graphs.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
interface | string | obligatorio. Anim Layer Interface asset (or its generated class name). |
Devuelve: asset, skeleton, parentClass, generatedClass, previewMesh, status, isTemplate, isInterface, graphs, stateMachines, layers, interfaces, variableCount, compileErrors.
anim.bp_remove_layer (riesgo 3, modifica, destructivo, smoke)
Removes an anim layer graph from the Anim Blueprint.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
name | string | obligatorio. Layer name (becomes an anim graph function). |
compile | boolean | Recompile after the change (default true). Valor predeterminado true. |
Devuelve: layers, count, compileErrors.
anim.bp_remove_variable (riesgo 3, modifica, destructivo, smoke)
Removes a member variable.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
name | string | obligatorio. |
Devuelve: variables, count, compileErrors.
anim.bp_set_class_defaults (riesgo 2, modifica, smoke)
Sets arbitrary class-default properties on the generated AnimInstance CDO.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
properties | array of UeaKeyValue | obligatorio. Property name -> value as text (RootMotionMode, bUseMultiThreadedAnimationUpdate, ...). |
compile | boolean | Recompile after the change (default true). Valor predeterminado true. |
Devuelve: properties, count, errors.
anim.bp_set_parent_class (riesgo 2, modifica, smoke)
Sets the parent AnimInstance class and recompiles.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
parentClass | string | obligatorio. New parent class (AnimInstance subclass, native name or Anim Blueprint path). |
Devuelve: asset, skeleton, parentClass, generatedClass, previewMesh, status, isTemplate, isInterface, graphs, stateMachines, layers, interfaces, variableCount, compileErrors.
anim.bp_set_preview_mesh (riesgo 2, modifica, smoke)
Sets the skeletal mesh used by the Persona preview viewport.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
mesh | string | obligatorio. Skeletal mesh asset used in the Persona preview. |
Devuelve: asset, skeleton, parentClass, generatedClass, previewMesh, status, isTemplate, isInterface, graphs, stateMachines, layers, interfaces, variableCount, compileErrors.
anim.bp_set_root_motion_mode (riesgo 2, modifica, smoke)
Sets the root motion mode of the generated AnimInstance (NoRootMotionExtraction, IgnoreRootMotion, RootMotionFromEverything, RootMotionFromMontagesOnly).
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
mode | string | obligatorio. NoRootMotionExtraction, IgnoreRootMotion, RootMotionFromEverything, RootMotionFromMontagesOnly. |
Devuelve: properties, count, errors.
anim.bp_set_skeleton (riesgo 3, modifica, smoke)
Retargets the Anim Blueprint to another skeleton (accepts a skeleton, skeletal mesh or animation asset) and recompiles.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
skeleton | string | obligatorio. New skeleton asset, or an animation asset to take the skeleton from. |
compile | boolean | Recompile after the change (default true). Valor predeterminado true. |
Devuelve: asset, skeleton, parentClass, generatedClass, previewMesh, status, isTemplate, isInterface, graphs, stateMachines, layers, interfaces, variableCount, compileErrors.
anim.bs_add_sample (riesgo 2, modifica, smoke)
Places an animation at (x, y) in the blend space.
| Argumento | Tipo | Descripción |
|---|---|---|
blendSpace | string | obligatorio. |
anim | string | obligatorio. Animation sequence to place (must use the blend space skeleton). |
x | number | Valor predeterminado 0.f. |
y | number | Valor predeterminado 0.f. |
rateScale | number | Playback rate multiplier of the sample. Valor predeterminado 1.f. |
Devuelve: blendSpace, skeleton, class, dimensions, sampleCount, axes, samples, axisToScaleAnimation, targetWeightInterpolationSpeed, notifyTriggerMode, preferredTriangulation, previewBasePose, message, notes.
anim.bs_auto_fill_grid (riesgo 2, modifica, smoke)
Spreads a list of animations evenly along one axis (the quickest way to fill a locomotion blend space).
| Argumento | Tipo | Descripción |
|---|---|---|
blendSpace | string | obligatorio. |
anims | array of string | obligatorio. 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. Valor predeterminado 0.f. |
clear | boolean | Remove the existing samples first. Valor predeterminado false. |
Devuelve: blendSpace, skeleton, class, dimensions, sampleCount, axes, samples, axisToScaleAnimation, targetWeightInterpolationSpeed, notifyTriggerMode, preferredTriangulation, previewBasePose, message, notes.
anim.bs_clear_samples (riesgo 3, modifica, smoke)
Removes every sample of a blend space.
| Argumento | Tipo | Descripción |
|---|---|---|
blendSpace | string | obligatorio. Blend space asset path or unique name. |
Devuelve: blendSpace, skeleton, class, dimensions, sampleCount, axes, samples, axisToScaleAnimation, targetWeightInterpolationSpeed, notifyTriggerMode, preferredTriangulation, previewBasePose, message, notes.
anim.bs_create (riesgo 2, modifica, smoke)
Creates a blend space (kind: 2d, 1d, aimOffset2d, aimOffset1d) with the given axis ranges; the skeleton may be derived from fromAnim or mesh.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. Destination content folder. |
name | string | obligatorio. 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). |
Devuelve: blendSpace, skeleton, class, dimensions, sampleCount, axes, samples, axisToScaleAnimation, targetWeightInterpolationSpeed, notifyTriggerMode, preferredTriangulation, previewBasePose, message, notes.
anim.bs_delete (riesgo 3, modifica, destructivo, smoke)
Deletes a blend space asset.
| Argumento | Tipo | Descripción |
|---|---|---|
blendSpace | string | obligatorio. Blend space asset path or unique name. |
Devuelve: blendSpace, skeleton, class, dimensions, sampleCount, axes, samples, axisToScaleAnimation, targetWeightInterpolationSpeed, notifyTriggerMode, preferredTriangulation, previewBasePose, message, notes.
anim.bs_duplicate (riesgo 2, modifica, smoke)
Copies a blend space into another asset.
| Argumento | Tipo | Descripción |
|---|---|---|
blendSpace | string | obligatorio. |
folder | string | Destination folder; empty keeps the source folder. |
name | string | New asset name; empty appends _Copy. |
Devuelve: blendSpace, skeleton, class, dimensions, sampleCount, axes, samples, axisToScaleAnimation, targetWeightInterpolationSpeed, notifyTriggerMode, preferredTriangulation, previewBasePose, message, notes.
anim.bs_find_sample (riesgo 0, smoke)
Index and distance of the sample closest to an input position.
| Argumento | Tipo | Descripción |
|---|---|---|
blendSpace | string | obligatorio. |
x | number | Valor predeterminado 0.f. |
y | number | Valor predeterminado 0.f. |
Devuelve: blendSpace, skeleton, class, dimensions, sampleCount, axes, samples, axisToScaleAnimation, targetWeightInterpolationSpeed, notifyTriggerMode, preferredTriangulation, previewBasePose, message, notes.
anim.bs_get (riesgo 0, smoke)
Axes, samples and settings of a blend space.
| Argumento | Tipo | Descripción |
|---|---|---|
blendSpace | string | obligatorio. Blend space asset path or unique name. |
Devuelve: blendSpace, skeleton, class, dimensions, sampleCount, axes, samples, axisToScaleAnimation, targetWeightInterpolationSpeed, notifyTriggerMode, preferredTriangulation, previewBasePose, message, notes.
anim.bs_get_sample_weights (riesgo 0, smoke)
Weights of every sample for a given input, highest first (how the blend space blends at that point).
| Argumento | Tipo | Descripción |
|---|---|---|
blendSpace | string | obligatorio. |
x | number | Valor predeterminado 0.f. |
y | number | Valor predeterminado 0.f. |
Devuelve: blendSpace, x, y, weights, message.
anim.bs_list (riesgo 0, smoke)
Lists blend spaces of a folder, optionally filtered by skeleton and name.
| Argumento | Tipo | Descripción |
|---|---|---|
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 | Valor predeterminado 200. |
Devuelve: blendSpaces, total.
anim.bs_list_samples (riesgo 0, smoke)
Samples of a blend space with their positions, animations and lengths.
| Argumento | Tipo | Descripción |
|---|---|---|
blendSpace | string | obligatorio. Blend space asset path or unique name. |
Devuelve: blendSpace, skeleton, class, dimensions, sampleCount, axes, samples, axisToScaleAnimation, targetWeightInterpolationSpeed, notifyTriggerMode, preferredTriangulation, previewBasePose, message, notes.
anim.bs_remove_sample (riesgo 2, modifica, smoke)
Removes one sample by index.
| Argumento | Tipo | Descripción |
|---|---|---|
blendSpace | string | obligatorio. |
index | integer | obligatorio. |
Devuelve: blendSpace, skeleton, class, dimensions, sampleCount, axes, samples, axisToScaleAnimation, targetWeightInterpolationSpeed, notifyTriggerMode, preferredTriangulation, previewBasePose, message, notes.
anim.bs_resample (riesgo 2, modifica, smoke)
Rebuilds the grid/triangulation from the current samples (run after editing samples outside the editor).
| Argumento | Tipo | Descripción |
|---|---|---|
blendSpace | string | obligatorio. Blend space asset path or unique name. |
Devuelve: blendSpace, skeleton, class, dimensions, sampleCount, axes, samples, axisToScaleAnimation, targetWeightInterpolationSpeed, notifyTriggerMode, preferredTriangulation, previewBasePose, message, notes.
anim.bs_set_axis (riesgo 2, modifica, smoke)
Name, range, grid divisions, snapping and wrapping of one axis (existing samples are kept).
| Argumento | Tipo | Descripción |
|---|---|---|
blendSpace | string | obligatorio. |
axis | string | obligatorio. 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. Valor predeterminado 0.f. |
max | number | Valor predeterminado 0.f. |
gridDivisions | integer | Grid divisions; 0 keeps the current value. Valor predeterminado 0. |
snapToGrid | boolean | Valor predeterminado false. |
wrapInput | boolean | Wrap the input around the axis limits (5.x only). Valor predeterminado false. |
Devuelve: blendSpace, skeleton, class, dimensions, sampleCount, axes, samples, axisToScaleAnimation, targetWeightInterpolationSpeed, notifyTriggerMode, preferredTriangulation, previewBasePose, message, notes.
anim.bs_set_interpolation (riesgo 2, modifica, smoke)
Input smoothing of one axis (or all): smoothing time, type and, on 5.x, damping ratio and max speed.
| Argumento | Tipo | Descripción |
|---|---|---|
blendSpace | string | obligatorio. |
axis | string | Axis: 0/x, 1/y or "all". |
time | number | Smoothing time in seconds (0 disables input smoothing). Valor predeterminado 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). Valor predeterminado 0.f. |
maxSpeed | number | Maximum speed of the smoothed input, 0 = unlimited (5.x only). Valor predeterminado 0.f. |
Devuelve: blendSpace, skeleton, class, dimensions, sampleCount, axes, samples, axisToScaleAnimation, targetWeightInterpolationSpeed, notifyTriggerMode, preferredTriangulation, previewBasePose, message, notes.
anim.bs_set_preview_base_pose (riesgo 2, modifica, smoke)
Animation used as the additive preview base pose of the blend space.
| Argumento | Tipo | Descripción |
|---|---|---|
blendSpace | string | obligatorio. |
anim | string | Animation used as the additive preview base pose; empty clears it. |
Devuelve: blendSpace, skeleton, class, dimensions, sampleCount, axes, samples, axisToScaleAnimation, targetWeightInterpolationSpeed, notifyTriggerMode, preferredTriangulation, previewBasePose, message, notes.
anim.bs_set_sample (riesgo 2, modifica, smoke)
Moves a sample, replaces its animation or changes its rate scale.
| Argumento | Tipo | Descripción |
|---|---|---|
blendSpace | string | obligatorio. |
index | integer | obligatorio. Index of the sample as reported by anim.bs_list_samples. |
x | number | Valor predeterminado 0.f. |
y | number | Valor predeterminado 0.f. |
anim | string | Replacement animation; empty keeps the current one. |
rateScale | number | Playback rate multiplier; 0 keeps the current one. Valor predeterminado 0.f. |
move | boolean | Set to false to leave the position untouched. Valor predeterminado true. |
Devuelve: blendSpace, skeleton, class, dimensions, sampleCount, axes, samples, axisToScaleAnimation, targetWeightInterpolationSpeed, notifyTriggerMode, preferredTriangulation, previewBasePose, message, notes.
anim.bs_set_settings (riesgo 2, modifica, smoke)
Blend space settings: speed-scaling axis, target weight interpolation, sync phases, notify trigger mode and triangulation.
| Argumento | Tipo | Descripción |
|---|---|---|
blendSpace | string | obligatorio. |
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. Valor predeterminado -1.f. |
smoothing | boolean | Ease the target weight interpolation in and out (5.x only). Valor predeterminado false. |
setSmoothing | boolean | Apply the smoothing flag (it is a bool, so it needs an explicit opt-in). Valor predeterminado false. |
matchSyncPhases | boolean | Match the sync phases of the samples (5.x only). Valor predeterminado false. |
setMatchSyncPhases | boolean | Valor predeterminado false. |
notifyTriggerMode | string | Notify trigger mode: AllAnimations, HighestWeightedAnimation or None. |
preferredTriangulation | string | Preferred triangulation direction: Tangential, Radial or None (5.x only). |
Devuelve: blendSpace, skeleton, class, dimensions, sampleCount, axes, samples, axisToScaleAnimation, targetWeightInterpolationSpeed, notifyTriggerMode, preferredTriangulation, previewBasePose, message, notes.
anim.bs_validate (riesgo 0, smoke)
Checks a blend space: missing animations, wrong skeleton, samples outside the axis range and duplicate positions.
| Argumento | Tipo | Descripción |
|---|---|---|
blendSpace | string | obligatorio. Blend space asset path or unique name. |
Devuelve: blendSpace, valid, sampleCount, issues, message.
anim.chooser_add_column (riesgo 2, modifica, UE 5.4+, requiere el plugin Chooser, smoke)
Adds a column (a condition evaluated per row) to a chooser table.
| Argumento | Tipo | Descripción |
|---|---|---|
type | string | obligatorio. Column type: "bool", "float", "enum", "gameplayTag", "objectClass", "object", "name", "outputFloat", ... or a struct path. |
Devuelve: chooser, name, outputType, resultType, contextClasses, columns, rows, message.
anim.chooser_add_row (riesgo 2, modifica, UE 5.4+, requiere el plugin Chooser, smoke)
Adds a row returning an asset, with one cell value per existing column.
| Argumento | Tipo | Descripción |
|---|---|---|
result | string | obligatorio. Asset returned when the row is selected. |
cells | array of string | Cell values, in column order (text form). |
Devuelve: chooser, name, outputType, resultType, contextClasses, columns, rows, message.
anim.chooser_create (riesgo 2, modifica, UE 5.4+, requiere el plugin Chooser, smoke)
Creates a chooser table that returns assets of a given class.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. |
name | string | obligatorio. |
outputType | string | Class of the objects the chooser returns (e.g. "AnimSequence"). Valor predeterminado TEXT("AnimSequence"). |
resultType | string | "object" or "class". Valor predeterminado TEXT("object"). |
contextClass | string | Class passed as the evaluation context (optional). |
Devuelve: chooser, name, outputType, resultType, contextClasses, columns, rows, message.
anim.chooser_delete (riesgo 3, modifica, destructivo, UE 5.4+, requiere el plugin Chooser)
Deletes a chooser table asset.
| Argumento | Tipo | Descripción |
|---|---|---|
chooser | string | obligatorio. Chooser table asset. |
Devuelve: database, result, message.
anim.chooser_get (riesgo 0, UE 5.4+, requiere el plugin Chooser, smoke)
Chooser table state: output type, context classes, columns and rows.
| Argumento | Tipo | Descripción |
|---|---|---|
chooser | string | obligatorio. Chooser table asset. |
Devuelve: chooser, name, outputType, resultType, contextClasses, columns, rows, message.
anim.chooser_list_rows (riesgo 0, UE 5.4+, requiere el plugin Chooser, smoke)
Lists the rows of a chooser table with their result asset and cell values.
| Argumento | Tipo | Descripción |
|---|---|---|
chooser | string | obligatorio. Chooser table asset. |
Devuelve: chooser, name, outputType, resultType, contextClasses, columns, rows, message.
anim.chooser_remove_column (riesgo 3, modifica, UE 5.4+, requiere el plugin Chooser, smoke)
Removes a column from a chooser table by index.
| Argumento | Tipo | Descripción |
|---|---|---|
index | integer | obligatorio. Index of the column or row. |
Devuelve: chooser, name, outputType, resultType, contextClasses, columns, rows, message.
anim.chooser_remove_row (riesgo 3, modifica, UE 5.4+, requiere el plugin Chooser, smoke)
Removes a row from a chooser table by index.
| Argumento | Tipo | Descripción |
|---|---|---|
index | integer | obligatorio. Index of the column or row. |
Devuelve: chooser, name, outputType, resultType, contextClasses, columns, rows, message.
anim.chooser_set_cell (riesgo 2, modifica, UE 5.4+, requiere el plugin Chooser, smoke)
Sets one cell (row x column) of a chooser table from its text form.
| Argumento | Tipo | Descripción |
|---|---|---|
row | integer | obligatorio. |
column | integer | obligatorio. |
value | string | obligatorio. New cell value in text form. |
Devuelve: chooser, name, outputType, resultType, contextClasses, columns, rows, message.
anim.chooser_set_context_class (riesgo 2, modifica, UE 5.4+, requiere el plugin Chooser, smoke)
Sets the class passed to the chooser as its evaluation context.
| Argumento | Tipo | Descripción |
|---|---|---|
contextClass | string | obligatorio. Class passed as the evaluation context. |
replace | boolean | Replace the context list instead of appending to it. Valor predeterminado true. |
Devuelve: chooser, name, outputType, resultType, contextClasses, columns, rows, message.
anim.composite_add_segment (riesgo 2, modifica, smoke)
Appends an animation to the composite track.
| Argumento | Tipo | Descripción |
|---|---|---|
composite | string | obligatorio. |
anim | string | obligatorio. |
startPos | number | Start on the timeline; negative appends after the last segment. Valor predeterminado -1.f. |
animStart | number | Valor predeterminado 0.f. |
animEnd | number | Last time used from the animation; 0 or negative uses the full length. Valor predeterminado 0.f. |
playRate | number | Valor predeterminado 1.f. |
loopCount | integer | Valor predeterminado 1. |
Devuelve: composite, skeleton, length, segments, notifyCount, message, notes.
anim.composite_create (riesgo 2, modifica, smoke)
Creates a composite from a list of animations played back to back.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. |
name | string | obligatorio. |
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. |
Devuelve: composite, skeleton, length, segments, notifyCount, message, notes.
anim.composite_delete (riesgo 3, modifica, destructivo, smoke)
Deletes a composite asset.
| Argumento | Tipo | Descripción |
|---|---|---|
composite | string | obligatorio. Composite asset path or unique name. |
Devuelve: composite, skeleton, length, segments, notifyCount, message, notes.
anim.composite_duplicate (riesgo 2, modifica, smoke)
Copies a composite into another asset.
| Argumento | Tipo | Descripción |
|---|---|---|
composite | string | obligatorio. |
folder | string | |
name | string |
Devuelve: composite, skeleton, length, segments, notifyCount, message, notes.
anim.composite_get (riesgo 0, smoke)
Segments, length and skeleton of a composite.
| Argumento | Tipo | Descripción |
|---|---|---|
composite | string | obligatorio. Composite asset path or unique name. |
Devuelve: composite, skeleton, length, segments, notifyCount, message, notes.
anim.composite_list_segments (riesgo 0, smoke)
Segments of a composite with their animations and timings.
| Argumento | Tipo | Descripción |
|---|---|---|
composite | string | obligatorio. Composite asset path or unique name. |
Devuelve: composite, skeleton, length, segments, notifyCount, message, notes.
anim.composite_remove_segment (riesgo 2, modifica, smoke)
Removes one segment from a composite.
| Argumento | Tipo | Descripción |
|---|---|---|
composite | string | obligatorio. |
index | integer | obligatorio. |
Devuelve: composite, skeleton, length, segments, notifyCount, message, notes.
anim.composite_set_segment (riesgo 2, modifica, smoke)
Changes one segment of a composite.
| Argumento | Tipo | Descripción |
|---|---|---|
composite | string | obligatorio. |
index | integer | obligatorio. |
anim | string | Replacement animation; empty keeps the current one. |
startPos | number | Valor predeterminado -1.f. |
animStart | number | Valor predeterminado -1.f. |
animEnd | number | Valor predeterminado -1.f. |
playRate | number | Valor predeterminado 0.f. |
loopCount | integer | Valor predeterminado 0. |
Devuelve: composite, skeleton, length, segments, notifyCount, message, notes.
anim.connect (riesgo 2, modifica, 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.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
fromId | string | obligatorio. Source node (the one producing the pose). |
toId | string | obligatorio. 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). Valor predeterminado true. |
Devuelve: node, compileErrors, propertyErrors.
anim.connect_to_output (riesgo 2, modifica, smoke)
Connects the pose output of a node to the result node of its anim graph.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
nodeId | string | obligatorio. |
graph | string | |
compile | boolean | Recompile after the change (default true). Valor predeterminado true. |
Devuelve: node, compileErrors, propertyErrors.
anim.copy_curve (riesgo 2, modifica, smoke)
Copies a float curve from one sequence to another.
| Argumento | Tipo | Descripción |
|---|---|---|
from | string | obligatorio. Source sequence. |
to | string | obligatorio. Destination sequence. |
curve | string | obligatorio. |
newName | string | Name of the copy; empty keeps the source name. |
Devuelve: anim, curve, type, keys, exists, message.
anim.copy_notifies (riesgo 2, modifica, smoke)
Copies the notifies of one sequence onto another.
| Argumento | Tipo | Descripción |
|---|---|---|
from | string | obligatorio. Source sequence. |
to | string | obligatorio. Destination sequence. |
deleteExisting | boolean | Remove the notifies already on the destination first. Valor predeterminado false. |
Devuelve: anim, index, name, class, time, duration, track, removed, notifies, message.
anim.create_from_mesh_pose (riesgo 2, modifica, 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.
| Argumento | Tipo | Descripción |
|---|---|---|
mesh | string | obligatorio. Skeletal mesh whose reference pose fills the sequence. |
folder | string | obligatorio. Destination content folder. |
name | string | obligatorio. Name of the new sequence. |
frames | integer | Number of frames of the new sequence (at least 1); the play length is frames/frameRate seconds. Valor predeterminado 1. |
frameRate | number | Sampling rate of the new sequence in frames per second (30 when omitted). Valor predeterminado 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. |
Devuelve: anim, name, skeleton, mesh, frames, length, boneTracks, message.
anim.crop (riesgo 2, modifica, smoke)
Keeps only the [startTime, endTime] window of a sequence.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
startTime | number | obligatorio. First second kept. |
endTime | number | obligatorio. Last second kept. |
Devuelve: anim, length, frames, frameRate, boneTracks, message.
anim.curve_exists (riesgo 0, smoke)
Whether a curve exists on a sequence.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
curve | string | obligatorio. Curve name. |
type | string | float (default), vector or transform. |
metadata | boolean | Create the curve as a metadata curve (a constant value, no keys). Valor predeterminado false. |
Devuelve: anim, curve, type, keys, exists, message.
anim.delete (riesgo 3, modifica, destructivo, smoke)
Deletes an animation sequence asset.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. Animation sequence asset path or unique name. |
Devuelve: anim, name, message.
anim.disconnect (riesgo 2, modifica, smoke)
Breaks the links of one pin, or every link of a node when no pin is given.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
nodeId | string | obligatorio. |
pin | string | Pin to disconnect; empty breaks every link of the node. |
graph | string | |
compile | boolean | Recompile after the change (default true). Valor predeterminado true. |
Devuelve: node, compileErrors, propertyErrors.
anim.duplicate (riesgo 2, modifica, smoke)
Duplicates an animation sequence into a folder.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
folder | string | Destination folder; empty keeps the source folder. |
name | string | obligatorio. Name of the new asset. |
Devuelve: anim, name, message.
anim.export_fbx (riesgo 0)
Exports a sequence to an FBX file. Not smoke-tested: the self-test never writes files.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
file | string | obligatorio. Absolute path of the .fbx file to write. |
mesh | string | Skeletal mesh exported with the animation; optional. |
Devuelve: anim, name, message.
anim.export_graph (riesgo 0, smoke)
Exports an anim graph as JSON (nodes with their properties plus the links) for anim.import_graph.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
graph | string | Graph name; empty = "AnimGraph". State machine/state/transition subgraphs are addressable by name too. |
Devuelve: json, nodeCount, linkCount.
anim.expose_pin (riesgo 2, modifica, smoke)
Shows or hides the optional pin of a node property (PlayRate, Alpha, ...) and reconstructs the node.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
nodeId | string | obligatorio. |
property | string | obligatorio. Property name of the FAnimNode_* struct ("PlayRate", "Alpha"). |
exposed | boolean | True to show the pin, false to hide it. Valor predeterminado true. |
graph | string | |
compile | boolean | Recompile after the change (default true). Valor predeterminado true. |
Devuelve: node, compileErrors, propertyErrors.
anim.find_anim_blueprints_using (riesgo 0, smoke)
Anim blueprints that reference an animation asset in one of their graphs.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. Animation asset (sequence or blend space) to look for. |
folder | string | Content folder searched ("/Game" when empty). |
recursive | boolean | Valor predeterminado true. |
limit | integer | Valor predeterminado 200. |
Devuelve: assets, count, scanned, message.
anim.find_blend_spaces_using (riesgo 0, smoke)
Blend spaces whose samples reference an animation sequence.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. Animation asset (sequence or blend space) to look for. |
folder | string | Content folder searched ("/Game" when empty). |
recursive | boolean | Valor predeterminado true. |
limit | integer | Valor predeterminado 200. |
Devuelve: assets, count, scanned, message.
anim.find_by_curve (riesgo 0, smoke)
Sequences of a folder that carry a curve with the given name.
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | obligatorio. Notify / curve / sync marker name to look for. |
Devuelve: assets, count, scanned, message.
anim.find_by_notify (riesgo 0, smoke)
Sequences of a folder that carry a notify with the given name.
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | obligatorio. Notify / curve / sync marker name to look for. |
Devuelve: assets, count, scanned, message.
anim.find_by_sync_marker (riesgo 0, smoke)
Sequences of a folder that carry a sync marker with the given name.
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | obligatorio. Notify / curve / sync marker name to look for. |
Devuelve: assets, count, scanned, message.
anim.find_montages_using (riesgo 0, smoke)
Montages whose segments reference an animation sequence.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. Animation asset (sequence or blend space) to look for. |
folder | string | Content folder searched ("/Game" when empty). |
recursive | boolean | Valor predeterminado true. |
limit | integer | Valor predeterminado 200. |
Devuelve: assets, count, scanned, message.
anim.find_nodes (riesgo 0, smoke)
Finds nodes by node class (subclasses match) and/or by a substring of their title.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
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. Valor predeterminado 0. |
Devuelve: nodes, count.
anim.find_unused (riesgo 0, smoke)
Sequences under a folder that no other asset references.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Content folder to scan ("/Game" when empty). |
recursive | boolean | Valor predeterminado true. |
limit | integer | Valor predeterminado 200. |
Devuelve: unused, count, scanned, message.
anim.get (riesgo 0, smoke)
Everything about a sequence: skeleton, length, frames, rate, additive and root motion settings, curve/notify/marker counts and compression settings.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. Animation sequence asset path or unique name. |
Devuelve: 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 (riesgo 0, smoke)
Current additive settings of a sequence.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. Animation sequence asset path or unique name. |
Devuelve: anim, type, basePoseType, basePoseAnim, refFrameIndex, message.
anim.get_anim_state (riesgo 0, requiere PIE, requiere mundo, smoke)
Everything the anim instance of an actor is doing: mode, current animation, position, montages and curves.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label, name or class of the actor carrying the skeletal mesh. |
Devuelve: actor, component, mesh, skeleton, mode, animBlueprint, animInstanceClass, currentAnim, position, length, playRate, playing, looping, montages, curves, message.
anim.get_bone_pose (riesgo 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.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
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). Valor predeterminado 0.0. |
frame | integer | Frame index; -1 uses 'time'. Valor predeterminado -1. |
space | string | local (relative to the parent bone, default) or component. |
Devuelve: anim, time, frame, space, poses, count, message.
anim.get_bone_track_names (riesgo 0, smoke)
Names of the bone animation tracks of a sequence.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. Animation sequence asset path or unique name. |
Devuelve: anim, tracks, count, message.
anim.get_bone_transform_runtime (riesgo 0, requiere PIE, requiere mundo, smoke)
Transform of a bone of a running actor in world, component or local space.
| Argumento | Tipo | Descripción |
|---|---|---|
bone | string | Bone name (empty = the root bone of the mesh). |
space | string | "world", "component" or "local". Valor predeterminado TEXT("world"). |
Devuelve: actor, name, space, location, rotation, scale, message.
anim.get_compression (riesgo 0, smoke)
Current compression settings and compressed size of a sequence.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. Animation sequence asset path or unique name. |
Devuelve: anim, boneSettings, curveSettings, compressedSizeBytes, message.
anim.get_curve_keys (riesgo 0, smoke)
Keys of a curve (float, vector or transform).
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
curve | string | obligatorio. Curve name. |
type | string | float (default), vector or transform. |
metadata | boolean | Create the curve as a metadata curve (a constant value, no keys). Valor predeterminado false. |
Devuelve: anim, curve, type, times, values, vectors, count, message.
anim.get_curve_value (riesgo 0, requiere PIE, requiere mundo, smoke)
Value of one animation curve (or every active curve) on an actor.
| Argumento | Tipo | Descripción |
|---|---|---|
curve | string | Curve name (empty lists every active curve). |
Devuelve: actor, curve, value, curves, message.
anim.get_frame_at_time (riesgo 0, smoke)
Frame index of a time in seconds.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
time | number | Time in seconds (anim.get_frame_at_time). Valor predeterminado 0.0. |
frame | integer | Frame index (anim.get_time_at_frame). Valor predeterminado 0. |
Devuelve: anim, time, frame, length, frames, frameRate, valid, message.
anim.get_frame_rate (riesgo 0, smoke)
Sampling frame rate of a sequence, in frames per second.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. Animation sequence asset path or unique name. |
Devuelve: anim, time, frame, length, frames, frameRate, valid, message.
anim.get_graph (riesgo 0, smoke)
Dumps a whole anim graph: nodes, links and the id of the result node.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
graph | string | Graph name; empty = "AnimGraph". State machine/state/transition subgraphs are addressable by name too. |
Devuelve: graph, kind, nodes, links, resultNodeId.
anim.get_import_settings (riesgo 0, smoke)
FBX import settings stored on a sequence, with its source files.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. Animation sequence asset path or unique name. |
Devuelve: anim, importDataClass, sourceFiles, settings, canReimport, message.
anim.get_length (riesgo 0, smoke)
Play length of a sequence in seconds, with its frame count and rate.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. Animation sequence asset path or unique name. |
Devuelve: anim, length, frames, frameRate, boneTracks, message.
anim.get_node (riesgo 0, smoke)
Full detail of one anim graph node: pins, the FAnimNode_* struct behind it, every editable property and its property bindings.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
nodeId | string | obligatorio. Node GUID, or a title/class name that is unique in the searched graphs. |
graph | string | Restrict the search to this graph. |
Devuelve: node, animNodeStruct, properties, bindings.
anim.get_node_class_info (riesgo 0, smoke)
Describes one anim graph node class: its FAnimNode_* struct, editable properties and pose pins.
| Argumento | Tipo | Descripción |
|---|---|---|
nodeClass | string | obligatorio. |
Devuelve: info, properties, poseInputs, hasPoseOutput.
anim.get_node_properties (riesgo 0, smoke)
Reads every editable property of an anim graph node with its current value.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
nodeId | string | obligatorio. Node GUID, or a title/class name that is unique in the searched graphs. |
graph | string | Restrict the search to this graph. |
Devuelve: properties, count, errors, compileErrors.
anim.get_notify_class_info (riesgo 0, smoke)
Editable properties of a notify class.
| Argumento | Tipo | Descripción |
|---|---|---|
class | string | obligatorio. Class short name or asset path. |
Devuelve: class, path, parent, isState, properties, message.
anim.get_root_motion (riesgo 0, smoke)
Current root motion settings of a sequence.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. Animation sequence asset path or unique name. |
Devuelve: anim, enabled, lockType, forceRootLock, useNormalizedRootMotionScale, hasRootTrack, message.
anim.get_root_motion_runtime (riesgo 0, requiere PIE, requiere mundo, smoke)
Root motion state of an actor: whether it is enabled, the mode and the last extracted delta.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label, name or class of the actor carrying the skeletal mesh. |
Devuelve: actor, rootMotionEnabled, rootMotionMode, translation, rotation, message.
anim.get_skeleton (riesgo 0, smoke)
Skeleton a sequence is bound to, with its bone count and preview mesh.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. Animation sequence asset path or unique name. |
Devuelve: anim, skeleton, skeletonName, boneCount, previewMesh, message.
anim.get_socket_transform_runtime (riesgo 0, requiere PIE, requiere mundo, smoke)
Transform of a socket (or bone) of a running actor.
| Argumento | Tipo | Descripción |
|---|---|---|
socket | string | Socket or bone name (empty = the root bone of the mesh). |
space | string | "world", "component" or "local". Valor predeterminado TEXT("world"). |
Devuelve: actor, name, space, location, rotation, scale, message.
anim.get_stats (riesgo 0, smoke)
Size and content statistics of a sequence (length, frames, tracks, curves, notifies, compressed size).
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. Animation sequence asset path or unique name. |
Devuelve: anim, length, frames, frameRate, boneTracks, floatCurves, transformCurves, notifies, syncMarkers, notifyTracks, compressedSizeBytes, rawSizeBytes, message.
anim.get_time_at_frame (riesgo 0, smoke)
Time in seconds of a frame index.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
time | number | Time in seconds (anim.get_frame_at_time). Valor predeterminado 0.0. |
frame | integer | Frame index (anim.get_time_at_frame). Valor predeterminado 0. |
Devuelve: anim, time, frame, length, frames, frameRate, valid, message.
anim.get_unique_marker_names (riesgo 0, smoke)
Unique sync marker names of a sequence (the set used by sync groups).
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. Animation sequence asset path or unique name. |
Devuelve: anim, markers, names, count, removed, message.
anim.ikrig_add_chain (riesgo 2, modifica, UE 5.5+, requiere el plugin IKRig, smoke)
Adds a retarget bone chain (start bone to end bone), optionally driven by an IK goal.
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | obligatorio. Chain name (e.g. LeftArm). |
startBone | string | obligatorio. |
endBone | string | obligatorio. |
goal | string | Optional IK goal driving the chain. |
Devuelve: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.
anim.ikrig_add_goal (riesgo 2, modifica, UE 5.5+, requiere el plugin IKRig, smoke)
Adds an IK goal (effector) on a bone. The goal name is made unique inside the rig.
| Argumento | Tipo | Descripción |
|---|---|---|
name | string | obligatorio. Goal name (made unique by the rig). |
bone | string | obligatorio. Bone the goal drives. |
Devuelve: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.
anim.ikrig_add_solver (riesgo 2, modifica, UE 5.6+, requiere el plugin IKRig, smoke)
Adds a solver to the solver stack and returns its index. Use anim.ikrig_list_solver_types for the accepted names.
| Argumento | Tipo | Descripción |
|---|---|---|
type | string | obligatorio. Solver type: a short name ("FullBodyIK", "LimbIK", "PoleSolver", "SetTransform", "BodyMover") or a full script-struct path. |
Devuelve: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.
anim.ikrig_auto_chains (riesgo 2, modifica, UE 5.6+, requiere el 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.
| Argumento | Tipo | Descripción |
|---|---|---|
ikRig | string | obligatorio. IK rig asset (path or unique name). |
Devuelve: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.
anim.ikrig_auto_fbik (riesgo 2, modifica, UE 5.6+, requiere el plugin IKRig, smoke)
Generates a full-body IK setup automatically from the engine skeleton templates. Reports matched=false when no template fits.
| Argumento | Tipo | Descripción |
|---|---|---|
ikRig | string | obligatorio. IK rig asset (path or unique name). |
Devuelve: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.
anim.ikrig_connect_goal (riesgo 2, modifica, UE 5.6+, requiere el plugin IKRig, smoke)
Connects an IK goal to a solver so that solver drives it.
| Argumento | Tipo | Descripción |
|---|---|---|
solverIndex | integer | obligatorio. Index of the solver in the stack. |
Devuelve: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.
anim.ikrig_create (riesgo 2, modifica, UE 5.5+, requiere el plugin IKRig, smoke)
Creates an IK Rig asset from a skeletal mesh and returns its bones, goals, chains and solvers.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. Destination content folder. |
name | string | obligatorio. Asset name of the new IK rig. |
mesh | string | obligatorio. Skeletal mesh the rig is built from (its skeleton supplies the bone hierarchy). |
Devuelve: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.
anim.ikrig_delete (riesgo 3, modifica, destructivo, UE 5.5+, requiere el plugin IKRig)
Deletes an IK Rig asset.
| Argumento | Tipo | Descripción |
|---|---|---|
ikRig | string | obligatorio. IK rig asset (path or unique name). |
Devuelve: deleted, message.
anim.ikrig_disconnect_goal (riesgo 2, modifica, UE 5.6+, requiere el plugin IKRig, smoke)
Disconnects an IK goal from a solver.
| Argumento | Tipo | Descripción |
|---|---|---|
solverIndex | integer | obligatorio. Index of the solver in the stack. |
Devuelve: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.
anim.ikrig_get (riesgo 0, UE 5.5+, requiere el plugin IKRig, smoke)
Full state of an IK Rig: preview mesh, skeleton, retarget root, goals, chains and solver stack.
| Argumento | Tipo | Descripción |
|---|---|---|
ikRig | string | obligatorio. IK rig asset (path or unique name). |
Devuelve: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.
anim.ikrig_list (riesgo 0, UE 5.5+, requiere el plugin IKRig, smoke)
Lists the IK Rig assets of a folder.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Content folder to scan ("/Game" when empty). |
recursive | boolean | Valor predeterminado true. |
limit | integer | Valor predeterminado 100. |
Devuelve: ikRigs, count, message.
anim.ikrig_list_bones (riesgo 0, UE 5.5+, requiere el plugin IKRig, smoke)
Bone names of the skeleton loaded in an IK Rig, plus the bones excluded from solving.
| Argumento | Tipo | Descripción |
|---|---|---|
ikRig | string | obligatorio. IK rig asset (path or unique name). |
Devuelve: bones, excludedBones, count, message.
anim.ikrig_list_chains (riesgo 0, UE 5.5+, requiere el plugin IKRig, smoke)
Lists the retarget chains of an IK Rig.
| Argumento | Tipo | Descripción |
|---|---|---|
ikRig | string | obligatorio. IK rig asset (path or unique name). |
Devuelve: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.
anim.ikrig_list_goals (riesgo 0, UE 5.5+, requiere el plugin IKRig, smoke)
Lists the IK goals of a rig with their bone, alphas and connected solvers.
| Argumento | Tipo | Descripción |
|---|---|---|
ikRig | string | obligatorio. IK rig asset (path or unique name). |
Devuelve: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.
anim.ikrig_list_solver_types (riesgo 0, UE 5.6+, requiere el plugin IKRig, smoke)
Solver types available in this engine, as short names plus their script-struct paths.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Content folder to scan ("/Game" when empty). |
recursive | boolean | Valor predeterminado true. |
limit | integer | Valor predeterminado 100. |
Devuelve: types, count, message.
anim.ikrig_list_solvers (riesgo 0, UE 5.6+, requiere el plugin IKRig, smoke)
Lists the solver stack of an IK Rig.
| Argumento | Tipo | Descripción |
|---|---|---|
ikRig | string | obligatorio. IK rig asset (path or unique name). |
Devuelve: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.
anim.ikrig_remove_chain (riesgo 3, modifica, UE 5.5+, requiere el plugin IKRig, smoke)
Removes a retarget chain.
| Argumento | Tipo | Descripción |
|---|---|---|
chain | string | obligatorio. Existing chain name. |
Devuelve: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.
anim.ikrig_remove_goal (riesgo 3, modifica, UE 5.5+, requiere el plugin IKRig, smoke)
Removes an IK goal.
| Argumento | Tipo | Descripción |
|---|---|---|
goal | string | obligatorio. Existing goal name. |
Devuelve: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.
anim.ikrig_remove_solver (riesgo 3, modifica, UE 5.6+, requiere el plugin IKRig, smoke)
Removes a solver from the stack by index.
| Argumento | Tipo | Descripción |
|---|---|---|
index | integer | obligatorio. Index in the solver stack. |
Devuelve: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.
anim.ikrig_rename_chain (riesgo 2, modifica, UE 5.5+, requiere el plugin IKRig, smoke)
Renames a retarget chain.
| Argumento | Tipo | Descripción |
|---|---|---|
newName | string | obligatorio. |
Devuelve: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.
anim.ikrig_rename_goal (riesgo 2, modifica, UE 5.5+, requiere el plugin IKRig, smoke)
Renames an IK goal (the rig makes the new name unique).
| Argumento | Tipo | Descripción |
|---|---|---|
newName | string | obligatorio. New goal name. |
Devuelve: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.
anim.ikrig_set_bone_excluded (riesgo 2, modifica, UE 5.5+, requiere el plugin IKRig, smoke)
Excludes (or re-includes) a bone from every solver of the rig.
| Argumento | Tipo | Descripción |
|---|---|---|
excluded | boolean | Exclude the bone from every solver. Valor predeterminado true. |
Devuelve: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.
anim.ikrig_set_chain_goal (riesgo 2, modifica, UE 5.5+, requiere el plugin IKRig, smoke)
Assigns (or clears, with an empty goal) the IK goal of a retarget chain.
| Argumento | Tipo | Descripción |
|---|---|---|
goal | string | Goal name, or empty to clear. |
Devuelve: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.
anim.ikrig_set_goal_bone (riesgo 2, modifica, UE 5.5+, requiere el plugin IKRig, smoke)
Moves an IK goal to another bone.
| Argumento | Tipo | Descripción |
|---|---|---|
bone | string | obligatorio. Bone the goal moves to. |
Devuelve: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.
anim.ikrig_set_goal_settings (riesgo 2, modifica, UE 5.5+, requiere el plugin IKRig, smoke)
Sets the blend alphas, pin exposure and viewport size of an IK goal.
| Argumento | Tipo | Descripción |
|---|---|---|
positionAlpha | number | Position blend 0..1 (negative = leave unchanged). Valor predeterminado -1.0. |
rotationAlpha | number | Rotation blend 0..1 (negative = leave unchanged). Valor predeterminado -1.0. |
exposePosition | string | "true"/"false" to change, empty to leave alone. |
exposeRotation | string | |
sizeMultiplier | number | Viewport size multiplier (negative = leave unchanged). Valor predeterminado -1.0. |
Devuelve: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.
anim.ikrig_set_mesh (riesgo 2, modifica, UE 5.5+, requiere el plugin IKRig, smoke)
Sets the skeletal mesh (and therefore the bone hierarchy) of an IK Rig.
| Argumento | Tipo | Descripción |
|---|---|---|
mesh | string | obligatorio. Skeletal mesh to drive the rig with. |
Devuelve: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.
anim.ikrig_set_retarget_root (riesgo 2, modifica, UE 5.5+, requiere el plugin IKRig, smoke)
Sets the retarget root (pelvis) bone used when this rig is a retarget source or target.
| Argumento | Tipo | Descripción |
|---|---|---|
bone | string | obligatorio. Bone name. |
Devuelve: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.
anim.ikrig_set_solver_enabled (riesgo 2, modifica, UE 5.6+, requiere el plugin IKRig, smoke)
Enables or disables a solver.
| Argumento | Tipo | Descripción |
|---|---|---|
enabled | boolean | Valor predeterminado true. |
Devuelve: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.
anim.ikrig_set_solver_root_bone (riesgo 2, modifica, UE 5.6+, requiere el plugin IKRig, smoke)
Sets the root (start) bone a solver operates from.
| Argumento | Tipo | Descripción |
|---|---|---|
bone | string | obligatorio. Root (start) bone of the solver. |
Devuelve: ikRig, name, mesh, skeleton, retargetRoot, boneCount, goals, chains, solvers, message.
anim.ikrig_set_solver_setting (riesgo 2, modifica, UE 5.6+, requiere el plugin IKRig, smoke)
Sets one property of a solver by name (dotted paths supported) and returns the solver settings.
| Argumento | Tipo | Descripción |
|---|---|---|
property | string | obligatorio. Property of the solver struct (dotted paths allowed). |
value | string | obligatorio. New value in text form. |
Devuelve: index, type, settings, message.
anim.import_graph (riesgo 2, modifica)
Recreates nodes and links in an anim graph from the JSON produced by anim.export_graph.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
json | string | obligatorio. 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. Valor predeterminado false. |
compile | boolean | Recompile after the change (default true). Valor predeterminado true. |
Devuelve: nodes, count.
anim.insert_frames (riesgo 2, modifica, smoke)
Inserts frames into a sequence (the frame at startFrame is duplicated).
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
startFrame | integer | obligatorio. First frame of the change. |
count | integer | obligatorio. Number of frames inserted or removed. |
Devuelve: anim, length, frames, frameRate, boneTracks, message.
anim.list (riesgo 0, smoke)
Lists animation assets under a folder, optionally filtered by skeleton, class and name.
| Argumento | Tipo | Descripción |
|---|---|---|
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. Valor predeterminado true. |
limit | integer | Maximum number of assets returned. Valor predeterminado 100. |
Devuelve: anims, count, message.
anim.list_bindings (riesgo 0, smoke)
Lists the property bindings of one node, or of every node of the Anim Blueprint.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
nodeId | string | Node id; empty lists the bindings of every anim graph node. |
graph | string |
Devuelve: bindings, count, compileErrors.
anim.list_bone_tracks (riesgo 0, smoke)
Bone animation tracks of a sequence.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. Animation sequence asset path or unique name. |
Devuelve: anim, tracks, count, message.
anim.list_by_skeleton (riesgo 0, smoke)
Lists every animation asset bound to a skeleton.
| Argumento | Tipo | Descripción |
|---|---|---|
skeleton | string | obligatorio. 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 | Valor predeterminado 100. |
Devuelve: anims, count, message.
anim.list_curves (riesgo 0, smoke)
Curves of a sequence with their type and key count.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
type | string | float (default), vector, transform or all. |
Devuelve: anim, curves, count, message.
anim.list_graph_nodes (riesgo 0, smoke)
Lists the nodes of one anim graph (default "AnimGraph") with their id, class, title, position and pins.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
graph | string | Graph name; empty = "AnimGraph". State machine/state/transition subgraphs are addressable by name too. |
Devuelve: nodes, count.
anim.list_metadata (riesgo 0, smoke)
Metadata objects attached to a sequence, with their properties.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. Animation sequence asset path or unique name. |
Devuelve: anim, metaData, count, message.
anim.list_metadata_classes (riesgo 0, smoke)
Available UAnimMetaData subclasses.
| Argumento | Tipo | Descripción |
|---|---|---|
nameContains | string | Keep only classes whose name contains this text. |
includeStates | boolean | Include UAnimNotifyState subclasses too. Valor predeterminado true. |
limit | integer | Valor predeterminado 200. |
Devuelve: classes, count, message.
anim.list_modifier_classes (riesgo 0, smoke)
Available UAnimationModifier subclasses (native and blueprint).
| Argumento | Tipo | Descripción |
|---|---|---|
nameContains | string | Keep only classes whose name contains this text. |
includeStates | boolean | Include UAnimNotifyState subclasses too. Valor predeterminado true. |
limit | integer | Valor predeterminado 200. |
Devuelve: classes, count, message.
anim.list_node_classes (riesgo 0, smoke)
Lists the anim graph node classes available in this editor, with the short name accepted by anim.add_node.
| Argumento | Tipo | Descripción |
|---|---|---|
nameContains | string | Case-insensitive substring filter on the class or short name. |
limit | integer | Maximum results; 0 = no limit. Valor predeterminado 0. |
Devuelve: classes, count.
anim.list_notifies (riesgo 0, smoke)
Notifies of a sequence with index, time, duration, track and class.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
track | string | Keep only the notifies of this notify track. |
Devuelve: anim, notifies, count, message.
anim.list_notify_classes (riesgo 0, smoke)
Available notify (and notify state) classes, native and blueprint.
| Argumento | Tipo | Descripción |
|---|---|---|
nameContains | string | Keep only classes whose name contains this text. |
includeStates | boolean | Include UAnimNotifyState subclasses too. Valor predeterminado true. |
limit | integer | Valor predeterminado 200. |
Devuelve: classes, count, message.
anim.list_notify_tracks (riesgo 0, smoke)
Notify tracks of a sequence.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. Animation sequence asset path or unique name. |
Devuelve: anim, tracks, count, message.
anim.list_sync_markers (riesgo 0, smoke)
Sync markers of a sequence with their time and track.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. Animation sequence asset path or unique name. |
Devuelve: anim, markers, names, count, removed, message.
anim.make_source_sequence (riesgo 2, modifica, smoke)
Creates a one-frame animation holding the reference pose of a skeletal mesh; the cheapest source clip for montages, composites and blend spaces.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. Destination content folder. |
name | string | obligatorio. Asset name without a path. |
mesh | string | obligatorio. Skeletal mesh whose reference pose and skeleton are used. |
Devuelve: anim, skeleton, length, message.
anim.montage_add_branching_point (riesgo 2, modifica, smoke)
Adds a branching point: a notify evaluated immediately instead of being queued.
| Argumento | Tipo | Descripción |
|---|---|---|
montage | string | obligatorio. |
name | string | obligatorio. Notify name (the anim blueprint event is AnimNotify_ |
time | number | Trigger time in seconds. Valor predeterminado 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. Valor predeterminado 0.f. |
branchingPoint | boolean | Fire as a branching point (evaluated immediately instead of being queued). Valor predeterminado false. |
Devuelve: montage, count, notifies, tracks, message.
anim.montage_add_notify (riesgo 2, modifica, smoke)
Adds a notify (or notify state when duration is greater than zero) at a time on a track.
| Argumento | Tipo | Descripción |
|---|---|---|
montage | string | obligatorio. |
name | string | obligatorio. Notify name (the anim blueprint event is AnimNotify_ |
time | number | Trigger time in seconds. Valor predeterminado 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. Valor predeterminado 0.f. |
branchingPoint | boolean | Fire as a branching point (evaluated immediately instead of being queued). Valor predeterminado false. |
Devuelve: montage, count, notifies, tracks, message.
anim.montage_add_notify_track (riesgo 2, modifica, smoke)
Adds a notify track (the lane notifies are drawn on).
| Argumento | Tipo | Descripción |
|---|---|---|
montage | string | obligatorio. |
track | string | obligatorio. Notify track name. |
Devuelve: 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 (riesgo 2, modifica, smoke)
Adds a named section starting at a given time.
| Argumento | Tipo | Descripción |
|---|---|---|
montage | string | obligatorio. |
name | string | obligatorio. Section name, unique in the montage. |
time | number | Start time in seconds (clamped to the montage length). Valor predeterminado 0.f. |
Devuelve: montage, skeleton, length, slots, segments, sections, notifyCount, notifyTracks, blendIn, blendOut, blendInCurve, blendOutCurve, blendOutTriggerTime, enableAutoBlendOut, syncGroup, syncSlotIndex, enableRootMotionTranslation, enableRootMotionRotation, timeStretchCurveName, message, notes.
anim.montage_add_segment (riesgo 2, modifica, smoke)
Appends an animation to a slot track (start, animation range, play rate and loop count).
| Argumento | Tipo | Descripción |
|---|---|---|
montage | string | obligatorio. |
slot | string | Slot to append to; empty uses the first slot. |
anim | string | obligatorio. |
startPos | number | Start on the montage timeline; negative appends after the last segment. Valor predeterminado -1.f. |
animStart | number | First time used from the animation. Valor predeterminado 0.f. |
animEnd | number | Last time used from the animation; 0 or negative uses the full length. Valor predeterminado 0.f. |
playRate | number | Valor predeterminado 1.f. |
loopCount | integer | Valor predeterminado 1. |
Devuelve: montage, skeleton, length, slots, segments, sections, notifyCount, notifyTracks, blendIn, blendOut, blendInCurve, blendOutCurve, blendOutTriggerTime, enableAutoBlendOut, syncGroup, syncSlotIndex, enableRootMotionTranslation, enableRootMotionRotation, timeStretchCurveName, message, notes.
anim.montage_add_slot (riesgo 2, modifica, smoke)
Adds an empty slot track to a montage.
| Argumento | Tipo | Descripción |
|---|---|---|
montage | string | obligatorio. |
slot | string | obligatorio. Slot name (the anim graph Slot node must use the same name). |
Devuelve: montage, skeleton, length, slots, segments, sections, notifyCount, notifyTracks, blendIn, blendOut, blendInCurve, blendOutCurve, blendOutTriggerTime, enableAutoBlendOut, syncGroup, syncSlotIndex, enableRootMotionTranslation, enableRootMotionRotation, timeStretchCurveName, message, notes.
anim.montage_clear_links (riesgo 2, modifica, smoke)
Clears every next-section link of the montage.
| Argumento | Tipo | Descripción |
|---|---|---|
montage | string | obligatorio. Montage asset path or unique name. |
Devuelve: montage, skeleton, length, slots, segments, sections, notifyCount, notifyTracks, blendIn, blendOut, blendInCurve, blendOutCurve, blendOutTriggerTime, enableAutoBlendOut, syncGroup, syncSlotIndex, enableRootMotionTranslation, enableRootMotionRotation, timeStretchCurveName, message, notes.
anim.montage_create (riesgo 2, modifica, smoke)
Creates a montage, optionally with a first animation in a slot; the skeleton comes from anim, skeleton or mesh.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. |
name | string | obligatorio. |
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. Valor predeterminado 0.25f. |
blendOut | number | Blend out time in seconds. Valor predeterminado 0.25f. |
Devuelve: montage, skeleton, length, slots, segments, sections, notifyCount, notifyTracks, blendIn, blendOut, blendInCurve, blendOutCurve, blendOutTriggerTime, enableAutoBlendOut, syncGroup, syncSlotIndex, enableRootMotionTranslation, enableRootMotionRotation, timeStretchCurveName, message, notes.
anim.montage_create_from_sequence_list (riesgo 2, modifica, 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.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. |
name | string | obligatorio. |
anims | array of string | obligatorio. Animations appended one after another, in order. |
slot | string | Slot of the track; defaults to DefaultSlot. |
sectionsPerAnim | boolean | Create one section per animation (named 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. Valor predeterminado true. |
blendIn | number | Valor predeterminado 0.25f. |
blendOut | number | Valor predeterminado 0.25f. |
Devuelve: montage, skeleton, length, slots, segments, sections, notifyCount, notifyTracks, blendIn, blendOut, blendInCurve, blendOutCurve, blendOutTriggerTime, enableAutoBlendOut, syncGroup, syncSlotIndex, enableRootMotionTranslation, enableRootMotionRotation, timeStretchCurveName, message, notes.
anim.montage_delete (riesgo 3, modifica, destructivo, smoke)
Deletes a montage asset.
| Argumento | Tipo | Descripción |
|---|---|---|
montage | string | obligatorio. Montage asset path or unique name. |
Devuelve: montage, skeleton, length, slots, segments, sections, notifyCount, notifyTracks, blendIn, blendOut, blendInCurve, blendOutCurve, blendOutTriggerTime, enableAutoBlendOut, syncGroup, syncSlotIndex, enableRootMotionTranslation, enableRootMotionRotation, timeStretchCurveName, message, notes.
anim.montage_duplicate (riesgo 2, modifica, smoke)
Copies a montage into another asset.
| Argumento | Tipo | Descripción |
|---|---|---|
montage | string | obligatorio. |
folder | string | Destination folder; empty keeps the source folder. |
name | string | New name; empty appends _Copy. |
Devuelve: montage, skeleton, length, slots, segments, sections, notifyCount, notifyTracks, blendIn, blendOut, blendInCurve, blendOutCurve, blendOutTriggerTime, enableAutoBlendOut, syncGroup, syncSlotIndex, enableRootMotionTranslation, enableRootMotionRotation, timeStretchCurveName, message, notes.
anim.montage_get (riesgo 0, smoke)
Slots, segments, sections, blend settings and notify count of a montage.
| Argumento | Tipo | Descripción |
|---|---|---|
montage | string | obligatorio. Montage asset path or unique name. |
Devuelve: montage, skeleton, length, slots, segments, sections, notifyCount, notifyTracks, blendIn, blendOut, blendInCurve, blendOutCurve, blendOutTriggerTime, enableAutoBlendOut, syncGroup, syncSlotIndex, enableRootMotionTranslation, enableRootMotionRotation, timeStretchCurveName, message, notes.
anim.montage_get_length (riesgo 0, smoke)
Total length of the montage in seconds, with its section and segment counts.
| Argumento | Tipo | Descripción |
|---|---|---|
montage | string | obligatorio. Montage asset path or unique name. |
Devuelve: montage, skeleton, length, slots, segments, sections, notifyCount, notifyTracks, blendIn, blendOut, blendInCurve, blendOutCurve, blendOutTriggerTime, enableAutoBlendOut, syncGroup, syncSlotIndex, enableRootMotionTranslation, enableRootMotionRotation, timeStretchCurveName, message, notes.
anim.montage_get_section_timing (riesgo 0, smoke)
Section timings and the chain of sections the montage plays through, following the links.
| Argumento | Tipo | Descripción |
|---|---|---|
montage | string | obligatorio. Montage asset path or unique name. |
Devuelve: montage, length, sections, playOrder, loops, message.
anim.montage_jump_to_section (riesgo 1, requiere PIE, requiere mundo, smoke)
Jumps the playing montage to a section (empty section = the first one); restarts the montage when it is no longer playing.
| Argumento | Tipo | Descripción |
|---|---|---|
montage | string | Montage to address (empty = the first active montage). |
section | string | Section name (empty = the first section of the montage). |
Devuelve: actor, component, mesh, skeleton, mode, animBlueprint, animInstanceClass, currentAnim, position, length, playRate, playing, looping, montages, curves, message.
anim.montage_link_sections (riesgo 2, modifica, smoke)
Links one section to the next one ("to" empty stops the montage after "from").
| Argumento | Tipo | Descripción |
|---|---|---|
montage | string | obligatorio. |
from | string | obligatorio. Section the link starts from. |
to | string | Section played next; empty unlinks (the montage stops after "from"). |
Devuelve: montage, skeleton, length, slots, segments, sections, notifyCount, notifyTracks, blendIn, blendOut, blendInCurve, blendOutCurve, blendOutTriggerTime, enableAutoBlendOut, syncGroup, syncSlotIndex, enableRootMotionTranslation, enableRootMotionRotation, timeStretchCurveName, message, notes.
anim.montage_list (riesgo 0, smoke)
Lists montages of a folder, optionally filtered by skeleton and name.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Content folder to search; empty searches /Game. |
skeleton | string | Only montages using this skeleton. |
nameContains | string | |
limit | integer | Valor predeterminado 200. |
Devuelve: montages, total.
anim.montage_list_notifies (riesgo 0, smoke)
Notifies of a montage with their times, tracks and classes.
| Argumento | Tipo | Descripción |
|---|---|---|
montage | string | obligatorio. Montage asset path or unique name. |
Devuelve: montage, count, notifies, tracks, message.
anim.montage_list_notify_tracks (riesgo 0, smoke)
Notify tracks of a montage.
| Argumento | Tipo | Descripción |
|---|---|---|
montage | string | obligatorio. Montage asset path or unique name. |
Devuelve: montage, skeleton, length, slots, segments, sections, notifyCount, notifyTracks, blendIn, blendOut, blendInCurve, blendOutCurve, blendOutTriggerTime, enableAutoBlendOut, syncGroup, syncSlotIndex, enableRootMotionTranslation, enableRootMotionRotation, timeStretchCurveName, message, notes.
anim.montage_list_sections (riesgo 0, smoke)
Sections of a montage with their times, lengths and next-section links.
| Argumento | Tipo | Descripción |
|---|---|---|
montage | string | obligatorio. Montage asset path or unique name. |
Devuelve: montage, skeleton, length, slots, segments, sections, notifyCount, notifyTracks, blendIn, blendOut, blendInCurve, blendOutCurve, blendOutTriggerTime, enableAutoBlendOut, syncGroup, syncSlotIndex, enableRootMotionTranslation, enableRootMotionRotation, timeStretchCurveName, message, notes.
anim.montage_list_segments (riesgo 0, smoke)
Segments of a montage with their animations and timings.
| Argumento | Tipo | Descripción |
|---|---|---|
montage | string | obligatorio. Montage asset path or unique name. |
Devuelve: montage, skeleton, length, slots, segments, sections, notifyCount, notifyTracks, blendIn, blendOut, blendInCurve, blendOutCurve, blendOutTriggerTime, enableAutoBlendOut, syncGroup, syncSlotIndex, enableRootMotionTranslation, enableRootMotionRotation, timeStretchCurveName, message, notes.
anim.montage_list_slots (riesgo 0, smoke)
Slot names used by a montage.
| Argumento | Tipo | Descripción |
|---|---|---|
montage | string | obligatorio. Montage asset path or unique name. |
Devuelve: montage, skeleton, length, slots, segments, sections, notifyCount, notifyTracks, blendIn, blendOut, blendInCurve, blendOutCurve, blendOutTriggerTime, enableAutoBlendOut, syncGroup, syncSlotIndex, enableRootMotionTranslation, enableRootMotionRotation, timeStretchCurveName, message, notes.
anim.montage_play (riesgo 1, requiere PIE, requiere mundo, smoke)
Plays a montage on the anim instance of an actor, optionally starting at a section.
| Argumento | Tipo | Descripción |
|---|---|---|
montage | string | obligatorio. |
playRate | number | Valor predeterminado 1.0. |
section | string | Section to start from (empty = the first section). |
Devuelve: actor, component, mesh, skeleton, mode, animBlueprint, animInstanceClass, currentAnim, position, length, playRate, playing, looping, montages, curves, message.
anim.montage_remove_all_notifies (riesgo 3, modifica, smoke)
Removes every notify of the montage.
| Argumento | Tipo | Descripción |
|---|---|---|
montage | string | obligatorio. Montage asset path or unique name. |
Devuelve: montage, count, notifies, tracks, message.
anim.montage_remove_notifies_by_name (riesgo 2, modifica, smoke)
Removes every notify with a given name.
| Argumento | Tipo | Descripción |
|---|---|---|
montage | string | obligatorio. |
name | string | obligatorio. |
Devuelve: montage, count, notifies, tracks, message.
anim.montage_remove_notify (riesgo 2, modifica, smoke)
Removes one notify by index.
| Argumento | Tipo | Descripción |
|---|---|---|
montage | string | obligatorio. |
index | integer | obligatorio. Index as reported by anim.montage_list_notifies. |
Devuelve: montage, count, notifies, tracks, message.
anim.montage_remove_section (riesgo 2, modifica, smoke)
Removes a section.
| Argumento | Tipo | Descripción |
|---|---|---|
montage | string | obligatorio. |
name | string | obligatorio. |
Devuelve: montage, skeleton, length, slots, segments, sections, notifyCount, notifyTracks, blendIn, blendOut, blendInCurve, blendOutCurve, blendOutTriggerTime, enableAutoBlendOut, syncGroup, syncSlotIndex, enableRootMotionTranslation, enableRootMotionRotation, timeStretchCurveName, message, notes.
anim.montage_remove_segment (riesgo 2, modifica, smoke)
Removes one segment from a slot track.
| Argumento | Tipo | Descripción |
|---|---|---|
montage | string | obligatorio. |
slot | string | Slot of the segment; empty uses the first slot. |
index | integer | obligatorio. |
Devuelve: montage, skeleton, length, slots, segments, sections, notifyCount, notifyTracks, blendIn, blendOut, blendInCurve, blendOutCurve, blendOutTriggerTime, enableAutoBlendOut, syncGroup, syncSlotIndex, enableRootMotionTranslation, enableRootMotionRotation, timeStretchCurveName, message, notes.
anim.montage_remove_slot (riesgo 3, modifica, smoke)
Removes a slot track and every segment in it.
| Argumento | Tipo | Descripción |
|---|---|---|
montage | string | obligatorio. |
slot | string | obligatorio. Slot name (the anim graph Slot node must use the same name). |
Devuelve: montage, skeleton, length, slots, segments, sections, notifyCount, notifyTracks, blendIn, blendOut, blendInCurve, blendOutCurve, blendOutTriggerTime, enableAutoBlendOut, syncGroup, syncSlotIndex, enableRootMotionTranslation, enableRootMotionRotation, timeStretchCurveName, message, notes.
anim.montage_rename_section (riesgo 2, modifica, smoke)
Renames a section and fixes the links pointing at it.
| Argumento | Tipo | Descripción |
|---|---|---|
montage | string | obligatorio. |
name | string | obligatorio. |
newName | string | obligatorio. |
Devuelve: montage, skeleton, length, slots, segments, sections, notifyCount, notifyTracks, blendIn, blendOut, blendInCurve, blendOutCurve, blendOutTriggerTime, enableAutoBlendOut, syncGroup, syncSlotIndex, enableRootMotionTranslation, enableRootMotionRotation, timeStretchCurveName, message, notes.
anim.montage_set_auto_blend_out (riesgo 2, modifica, smoke)
Whether the montage blends out automatically when it reaches its end.
| Argumento | Tipo | Descripción |
|---|---|---|
montage | string | obligatorio. |
enabled | boolean | Valor predeterminado true. |
Devuelve: montage, skeleton, length, slots, segments, sections, notifyCount, notifyTracks, blendIn, blendOut, blendInCurve, blendOutCurve, blendOutTriggerTime, enableAutoBlendOut, syncGroup, syncSlotIndex, enableRootMotionTranslation, enableRootMotionRotation, timeStretchCurveName, message, notes.
anim.montage_set_blend (riesgo 2, modifica, smoke)
Blend in/out times, their blend options and the blend out trigger time.
| Argumento | Tipo | Descripción |
|---|---|---|
montage | string | obligatorio. |
blendIn | number | Blend in time in seconds; negative keeps it. Valor predeterminado -1.f. |
blendOut | number | Blend out time in seconds; negative keeps it. Valor predeterminado -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. Valor predeterminado -2.f. |
Devuelve: montage, skeleton, length, slots, segments, sections, notifyCount, notifyTracks, blendIn, blendOut, blendInCurve, blendOutCurve, blendOutTriggerTime, enableAutoBlendOut, syncGroup, syncSlotIndex, enableRootMotionTranslation, enableRootMotionRotation, timeStretchCurveName, message, notes.
anim.montage_set_blend_profile (riesgo 2, modifica, 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.
| Argumento | Tipo | Descripción |
|---|---|---|
montage | string | obligatorio. |
side | string | Which blend to change: in, out or both. |
blendProfile | string | Blend profile of the skeleton (by name or path); empty clears it. |
Devuelve: montage, skeleton, length, slots, segments, sections, notifyCount, notifyTracks, blendIn, blendOut, blendInCurve, blendOutCurve, blendOutTriggerTime, enableAutoBlendOut, syncGroup, syncSlotIndex, enableRootMotionTranslation, enableRootMotionRotation, timeStretchCurveName, message, notes.
anim.montage_set_next_section (riesgo 1, requiere PIE, requiere mundo, smoke)
Sets which section plays after another one; restarts the montage when it is no longer playing.
| Argumento | Tipo | Descripción |
|---|---|---|
montage | string | |
section | string | Section whose successor is being set (empty = the first section). |
nextSection | string | Section played next (empty = the first section). |
Devuelve: actor, component, mesh, skeleton, mode, animBlueprint, animInstanceClass, currentAnim, position, length, playRate, playing, looping, montages, curves, message.
anim.montage_set_root_motion (riesgo 2, modifica, smoke)
Whether the montage drives root motion translation and rotation.
| Argumento | Tipo | Descripción |
|---|---|---|
montage | string | obligatorio. |
translation | boolean | Let the montage drive root motion translation. Valor predeterminado true. |
rotation | boolean | Let the montage drive root motion rotation. Valor predeterminado true. |
Devuelve: montage, skeleton, length, slots, segments, sections, notifyCount, notifyTracks, blendIn, blendOut, blendInCurve, blendOutCurve, blendOutTriggerTime, enableAutoBlendOut, syncGroup, syncSlotIndex, enableRootMotionTranslation, enableRootMotionRotation, timeStretchCurveName, message, notes.
anim.montage_set_section_time (riesgo 2, modifica, smoke)
Moves a section to another time.
| Argumento | Tipo | Descripción |
|---|---|---|
montage | string | obligatorio. |
name | string | obligatorio. |
time | number | obligatorio. New start time in seconds. |
Devuelve: montage, skeleton, length, slots, segments, sections, notifyCount, notifyTracks, blendIn, blendOut, blendInCurve, blendOutCurve, blendOutTriggerTime, enableAutoBlendOut, syncGroup, syncSlotIndex, enableRootMotionTranslation, enableRootMotionRotation, timeStretchCurveName, message, notes.
anim.montage_set_segment (riesgo 2, modifica, smoke)
Changes one segment: animation, timeline position, animation range, play rate or loop count.
| Argumento | Tipo | Descripción |
|---|---|---|
montage | string | obligatorio. |
slot | string | Slot of the segment; empty uses the first slot. |
index | integer | obligatorio. |
anim | string | Replacement animation; empty keeps the current one. |
startPos | number | New start on the timeline; negative keeps it. Valor predeterminado -1.f. |
animStart | number | New animation start time; negative keeps it. Valor predeterminado -1.f. |
animEnd | number | New animation end time; negative keeps it. Valor predeterminado -1.f. |
playRate | number | New play rate; 0 keeps it. Valor predeterminado 0.f. |
loopCount | integer | New loop count; 0 keeps it. Valor predeterminado 0. |
Devuelve: montage, skeleton, length, slots, segments, sections, notifyCount, notifyTracks, blendIn, blendOut, blendInCurve, blendOutCurve, blendOutTriggerTime, enableAutoBlendOut, syncGroup, syncSlotIndex, enableRootMotionTranslation, enableRootMotionRotation, timeStretchCurveName, message, notes.
anim.montage_set_sync_group (riesgo 2, modifica, smoke)
Sync group and the slot index that drives it.
| Argumento | Tipo | Descripción |
|---|---|---|
montage | string | obligatorio. |
group | string | Sync group name; empty clears the group. |
slotIndex | integer | Index of the slot track that drives the sync group. Valor predeterminado 0. |
Devuelve: montage, skeleton, length, slots, segments, sections, notifyCount, notifyTracks, blendIn, blendOut, blendInCurve, blendOutCurve, blendOutTriggerTime, enableAutoBlendOut, syncGroup, syncSlotIndex, enableRootMotionTranslation, enableRootMotionRotation, timeStretchCurveName, message, notes.
anim.montage_set_time_stretch_curve (riesgo 2, modifica, smoke)
Curve driving the montage time stretch, with its sampling settings.
| Argumento | Tipo | Descripción |
|---|---|---|
montage | string | obligatorio. |
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. Valor predeterminado 0.f. |
curveValueMinPrecision | number | Minimum precision of the curve value; 0 keeps the current value. Valor predeterminado 0.f. |
Devuelve: montage, skeleton, length, slots, segments, sections, notifyCount, notifyTracks, blendIn, blendOut, blendInCurve, blendOutCurve, blendOutTriggerTime, enableAutoBlendOut, syncGroup, syncSlotIndex, enableRootMotionTranslation, enableRootMotionRotation, timeStretchCurveName, message, notes.
anim.montage_sort_sections (riesgo 2, modifica, smoke)
Sorts the sections by start time (the order the editor keeps them in).
| Argumento | Tipo | Descripción |
|---|---|---|
montage | string | obligatorio. Montage asset path or unique name. |
Devuelve: montage, skeleton, length, slots, segments, sections, notifyCount, notifyTracks, blendIn, blendOut, blendInCurve, blendOutCurve, blendOutTriggerTime, enableAutoBlendOut, syncGroup, syncSlotIndex, enableRootMotionTranslation, enableRootMotionRotation, timeStretchCurveName, message, notes.
anim.montage_stop (riesgo 1, requiere PIE, requiere mundo, smoke)
Stops a montage (or every montage) on an actor with a blend out time.
| Argumento | Tipo | Descripción |
|---|---|---|
blendOut | number | Blend out time in seconds. Valor predeterminado 0.25. |
montage | string | Montage to stop (empty = every montage). |
Devuelve: actor, component, mesh, skeleton, mode, animBlueprint, animInstanceClass, currentAnim, position, length, playRate, playing, looping, montages, curves, message.
anim.montage_validate (riesgo 0, smoke)
Checks a montage: empty slots, gaps between segments, sections out of range, broken links, missing animations.
| Argumento | Tipo | Descripción |
|---|---|---|
montage | string | obligatorio. Montage asset path or unique name. |
Devuelve: montage, valid, issues, message.
anim.move_node (riesgo 2, modifica, smoke)
Moves a node to a new position in its graph.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
nodeId | string | obligatorio. |
x | integer | obligatorio. |
y | integer | obligatorio. |
graph | string |
Devuelve: node, compileErrors, propertyErrors.
anim.move_notify (riesgo 2, modifica, smoke)
Moves a notify to another time and (optionally) another track.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
index | integer | obligatorio. Index in the list returned by anim.list_notifies. |
time | number | New trigger time in seconds (anim.move_notify). Valor predeterminado 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). |
Devuelve: anim, index, name, class, time, duration, track, removed, notifies, message.
anim.play (riesgo 1, requiere PIE, requiere mundo, smoke)
Plays an animation sequence on an actor in single-node mode.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. Animation sequence to play. |
loop | boolean | Valor predeterminado true. |
playRate | number | Valor predeterminado 1.0. |
position | number | Start position in seconds. Valor predeterminado 0.0. |
Devuelve: actor, component, mesh, skeleton, mode, animBlueprint, animInstanceClass, currentAnim, position, length, playRate, playing, looping, montages, curves, message.
anim.pose_add_from_animation (riesgo 2, modifica, smoke)
Adds one pose captured from an animation at a given time (or the mesh reference pose when anim is omitted).
| Argumento | Tipo | Descripción |
|---|---|---|
pose | string | obligatorio. |
anim | string | Animation sampled at "time"; empty captures the reference pose of the mesh. |
time | number | Time in seconds sampled from the animation. Valor predeterminado 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. |
Devuelve: pose, skeleton, poseCount, curveCount, trackCount, poses, curves, tracks, additive, basePose, sourceAnimation, message, notes.
anim.pose_create (riesgo 2, modifica, smoke)
Creates a pose asset, baking one pose per frame of an animation (or an empty asset when anim is omitted).
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. |
name | string | obligatorio. |
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. |
Devuelve: pose, skeleton, poseCount, curveCount, trackCount, poses, curves, tracks, additive, basePose, sourceAnimation, message, notes.
anim.pose_delete (riesgo 3, modifica, destructivo, smoke)
Deletes a pose asset.
| Argumento | Tipo | Descripción |
|---|---|---|
pose | string | obligatorio. Pose asset path or unique name. |
Devuelve: pose, skeleton, poseCount, curveCount, trackCount, poses, curves, tracks, additive, basePose, sourceAnimation, message, notes.
anim.pose_duplicate (riesgo 2, modifica, smoke)
Copies a pose asset into another asset.
| Argumento | Tipo | Descripción |
|---|---|---|
pose | string | obligatorio. |
folder | string | Destination folder; empty keeps the source folder. |
name | string | New name; empty appends _Copy. |
Devuelve: pose, skeleton, poseCount, curveCount, trackCount, poses, curves, tracks, additive, basePose, sourceAnimation, message, notes.
anim.pose_get (riesgo 0, smoke)
Poses, curves, tracks and additive settings of a pose asset.
| Argumento | Tipo | Descripción |
|---|---|---|
pose | string | obligatorio. Pose asset path or unique name. |
Devuelve: pose, skeleton, poseCount, curveCount, trackCount, poses, curves, tracks, additive, basePose, sourceAnimation, message, notes.
anim.pose_list (riesgo 0, smoke)
Lists pose assets of a folder, optionally filtered by skeleton and name.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | Content folder to search; empty searches /Game. |
skeleton | string | Only pose assets using this skeleton. |
nameContains | string | |
limit | integer | Valor predeterminado 200. |
Devuelve: poseAssets, total.
anim.pose_list_curves (riesgo 0, smoke)
Curve names driven by the poses.
| Argumento | Tipo | Descripción |
|---|---|---|
pose | string | obligatorio. Pose asset path or unique name. |
Devuelve: pose, skeleton, poseCount, curveCount, trackCount, poses, curves, tracks, additive, basePose, sourceAnimation, message, notes.
anim.pose_list_poses (riesgo 0, smoke)
Pose names stored in the asset.
| Argumento | Tipo | Descripción |
|---|---|---|
pose | string | obligatorio. Pose asset path or unique name. |
Devuelve: pose, skeleton, poseCount, curveCount, trackCount, poses, curves, tracks, additive, basePose, sourceAnimation, message, notes.
anim.pose_list_tracks (riesgo 0, smoke)
Bone tracks the poses write to.
| Argumento | Tipo | Descripción |
|---|---|---|
pose | string | obligatorio. Pose asset path or unique name. |
Devuelve: pose, skeleton, poseCount, curveCount, trackCount, poses, curves, tracks, additive, basePose, sourceAnimation, message, notes.
anim.pose_remove (riesgo 2, modifica, smoke)
Removes poses by name.
| Argumento | Tipo | Descripción |
|---|---|---|
pose | string | obligatorio. |
names | array of string | obligatorio. Pose names to delete. |
Devuelve: pose, skeleton, poseCount, curveCount, trackCount, poses, curves, tracks, additive, basePose, sourceAnimation, message, notes.
anim.pose_rename (riesgo 2, modifica, smoke)
Renames one pose.
| Argumento | Tipo | Descripción |
|---|---|---|
pose | string | obligatorio. |
name | string | obligatorio. Current pose name. |
newName | string | obligatorio. |
Devuelve: pose, skeleton, poseCount, curveCount, trackCount, poses, curves, tracks, additive, basePose, sourceAnimation, message, notes.
anim.pose_set_additive (riesgo 2, modifica, smoke)
Converts the poses to additive against a base pose (or back to full poses).
| Argumento | Tipo | Descripción |
|---|---|---|
pose | string | obligatorio. |
additive | boolean | obligatorio. 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. |
Devuelve: pose, skeleton, poseCount, curveCount, trackCount, poses, curves, tracks, additive, basePose, sourceAnimation, message, notes.
anim.pose_update_from_animation (riesgo 2, modifica, smoke)
Re-bakes the poses from an animation, keeping the pose names.
| Argumento | Tipo | Descripción |
|---|---|---|
pose | string | obligatorio. |
anim | string | obligatorio. Animation the poses are re-baked from. |
Devuelve: pose, skeleton, poseCount, curveCount, trackCount, poses, curves, tracks, additive, basePose, sourceAnimation, message, notes.
anim.pose_validate (riesgo 0, smoke)
Checks a pose asset: missing skeleton, no pose, no track, invalid additive base pose.
| Argumento | Tipo | Descripción |
|---|---|---|
pose | string | obligatorio. Pose asset path or unique name. |
Devuelve: pose, valid, issues, message.
anim.ps_add_animation (riesgo 2, modifica, UE 5.7+, requiere el plugin PoseSearch, smoke)
Adds an animation sequence (or composite / montage) to a database.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. Animation sequence, composite, montage or blend space to index. |
samplingStart | number | Start of the sampled range, relative to the asset start (0 = whole asset). Valor predeterminado 0.0. |
samplingEnd | number | End of the sampled range, relative to the asset end (0 = whole asset). Valor predeterminado 0.0. |
useSingleSample | boolean | Index a single blend space sample instead of the whole grid. Valor predeterminado false. |
blendParamX | number | Blend space coordinates used when useSingleSample is set. Valor predeterminado 0.0. |
blendParamY | number | Valor predeterminado 0.0. |
Devuelve: database, name, schema, normalizationSet, count, anims, settings, message.
anim.ps_add_blend_space (riesgo 2, modifica, UE 5.7+, requiere el plugin PoseSearch, smoke)
Adds a blend space to a database, sampling its grid or a single point.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. Animation sequence, composite, montage or blend space to index. |
samplingStart | number | Start of the sampled range, relative to the asset start (0 = whole asset). Valor predeterminado 0.0. |
samplingEnd | number | End of the sampled range, relative to the asset end (0 = whole asset). Valor predeterminado 0.0. |
useSingleSample | boolean | Index a single blend space sample instead of the whole grid. Valor predeterminado false. |
blendParamX | number | Blend space coordinates used when useSingleSample is set. Valor predeterminado 0.0. |
blendParamY | number | Valor predeterminado 0.0. |
Devuelve: database, name, schema, normalizationSet, count, anims, settings, message.
anim.ps_add_channel (riesgo 2, modifica, UE 5.7+, requiere el plugin PoseSearch, smoke)
Adds a feature channel to a schema (pose, trajectory, position, heading, velocity, phase, ...).
| Argumento | Tipo | Descripción |
|---|---|---|
type | string | obligatorio. 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. Valor predeterminado 1.0. |
properties | array of UeaKeyValue | Extra property assignments on the channel (dotted paths allowed, e.g. "Bone.BoneName"). |
Devuelve: schema, name, skeleton, mirrorDataTable, sampleRate, cardinality, channels, settings, message.
anim.ps_build (riesgo 2, modifica, UE 5.7+, requiere el plugin PoseSearch, smoke)
Builds (indexes) a database and waits for the derived data to be ready.
| Argumento | Tipo | Descripción |
|---|---|---|
database | string | obligatorio. Pose search database asset. |
Devuelve: database, result, message.
anim.ps_create_database (riesgo 2, modifica, UE 5.7+, requiere el plugin PoseSearch, smoke)
Creates a pose search (motion matching) database bound to a schema.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. |
name | string | obligatorio. |
schema | string | obligatorio. Schema describing the features the database indexes. |
Devuelve: database, name, schema, normalizationSet, count, anims, settings, message.
anim.ps_create_normalization_set (riesgo 2, modifica, UE 5.7+, requiere el plugin PoseSearch, smoke)
Creates a normalization set so several databases share one cost normalisation.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. |
name | string | obligatorio. |
databases | array of string | Databases normalised together. |
Devuelve: database, name, schema, normalizationSet, count, anims, settings, message.
anim.ps_create_schema (riesgo 2, modifica, UE 5.7+, requiere el plugin PoseSearch, smoke)
Creates a pose search schema for a skeleton (add channels next with anim.ps_add_channel).
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. |
name | string | obligatorio. |
skeleton | string | obligatorio. Skeleton the schema samples. |
sampleRate | integer | Sampling rate in Hz. Valor predeterminado 30. |
mirrorDataTable | string | Mirror data table (needed for mirrored matching). |
Devuelve: schema, name, skeleton, mirrorDataTable, sampleRate, cardinality, channels, settings, message.
anim.ps_delete_database (riesgo 3, modifica, destructivo, UE 5.7+, requiere el plugin PoseSearch)
Deletes a pose search database asset.
| Argumento | Tipo | Descripción |
|---|---|---|
database | string | obligatorio. Pose search database asset. |
Devuelve: database, result, message.
anim.ps_delete_schema (riesgo 3, modifica, destructivo, UE 5.7+, requiere el plugin PoseSearch)
Deletes a pose search schema asset.
| Argumento | Tipo | Descripción |
|---|---|---|
schema | string | obligatorio. Pose search schema asset. |
Devuelve: database, result, message.
anim.ps_get_database (riesgo 0, UE 5.7+, requiere el plugin PoseSearch, smoke)
Database state: schema, normalization set, indexed animations and settings.
| Argumento | Tipo | Descripción |
|---|---|---|
database | string | obligatorio. Pose search database asset. |
Devuelve: database, name, schema, normalizationSet, count, anims, settings, message.
anim.ps_get_schema (riesgo 0, UE 5.7+, requiere el plugin PoseSearch, smoke)
Schema state: skeleton, sample rate, channels and settings.
| Argumento | Tipo | Descripción |
|---|---|---|
schema | string | obligatorio. Pose search schema asset. |
Devuelve: schema, name, skeleton, mirrorDataTable, sampleRate, cardinality, channels, settings, message.
anim.ps_list_animations (riesgo 0, UE 5.7+, requiere el plugin PoseSearch, smoke)
Lists the animations indexed by a database.
| Argumento | Tipo | Descripción |
|---|---|---|
database | string | obligatorio. Pose search database asset. |
Devuelve: database, name, schema, normalizationSet, count, anims, settings, message.
anim.ps_remove_animation (riesgo 3, modifica, UE 5.7+, requiere el plugin PoseSearch, smoke)
Removes an indexed animation from a database by index.
| Argumento | Tipo | Descripción |
|---|---|---|
index | integer | obligatorio. Index of the animation entry. |
Devuelve: database, name, schema, normalizationSet, count, anims, settings, message.
anim.ps_remove_channel (riesgo 3, modifica, UE 5.7+, requiere el plugin PoseSearch, smoke)
Removes a feature channel from a schema by index.
| Argumento | Tipo | Descripción |
|---|---|---|
index | integer | obligatorio. Index of the channel in the schema. |
Devuelve: schema, name, skeleton, mirrorDataTable, sampleRate, cardinality, channels, settings, message.
anim.ps_set_database_settings (riesgo 2, modifica, UE 5.7+, requiere el plugin PoseSearch, smoke)
Reads or changes the database settings (cost biases, search mode, KD-tree, normalization set).
| Argumento | Tipo | Descripción |
|---|---|---|
properties | array of UeaKeyValue | Property assignments on the database; empty lists the current values. |
normalizationSet | string | Normalization set asset (optional). |
Devuelve: database, name, schema, normalizationSet, count, anims, settings, message.
anim.ps_set_schema_settings (riesgo 2, modifica, UE 5.7+, requiere el plugin PoseSearch, smoke)
Reads or changes the schema settings (sample rate, permutations, padding, data preprocessor).
| Argumento | Tipo | Descripción |
|---|---|---|
properties | array of UeaKeyValue | Property assignments on the schema; empty lists the current values. |
Devuelve: schema, name, skeleton, mirrorDataTable, sampleRate, cardinality, channels, settings, message.
anim.record_from_actor (riesgo 2, modifica, requiere PIE, requiere mundo)
Starts recording the pose of a PIE actor into a new sequence. Not smoke-tested: it needs a running PIE session.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor with a skeletal mesh component, in the running PIE world. |
folder | string | obligatorio. Destination content folder. |
name | string | obligatorio. Name of the recorded sequence. |
duration | number | Maximum recording length in seconds. Valor predeterminado 5.0. |
recordInWorldSpace | boolean | Record in world space instead of component space. Valor predeterminado false. |
removeRootAnimation | boolean | Drop the root bone animation. Valor predeterminado false. |
Devuelve: actor, anim, recording, message.
anim.reimport (riesgo 3, modifica)
Reimports a sequence from its source file (or from the file given). Not smoke-tested: the sandbox sequence has no source file.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
file | string | Source file; empty uses the stored one. |
Devuelve: anim, name, message.
anim.remove_all_bone_tracks (riesgo 3, modifica, destructivo, smoke)
Removes every bone animation track of a sequence.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. Animation sequence asset path or unique name. |
Devuelve: anim, tracks, count, message.
anim.remove_all_curves (riesgo 3, modifica, destructivo, smoke)
Removes every curve of a sequence.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. Animation sequence asset path or unique name. |
Devuelve: anim, curves, count, message.
anim.remove_all_notifies (riesgo 3, modifica, destructivo, smoke)
Removes every notify of a sequence.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. Animation sequence asset path or unique name. |
Devuelve: anim, index, name, class, time, duration, track, removed, notifies, message.
anim.remove_all_sync_markers (riesgo 3, modifica, destructivo, smoke)
Removes every sync marker of a sequence.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. Animation sequence asset path or unique name. |
Devuelve: anim, markers, names, count, removed, message.
anim.remove_bone_track (riesgo 3, modifica, smoke)
Removes the animation track of a bone (and optionally of its children). 'bone' accepts a name or a track index.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
bone | string | obligatorio. |
includeChildren | boolean | Also remove the tracks of the child bones. Valor predeterminado true. |
Devuelve: anim, tracks, count, message.
anim.remove_curve (riesgo 3, modifica, smoke)
Removes a curve from a sequence.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
curve | string | obligatorio. Curve name. |
type | string | float (default), vector or transform. |
metadata | boolean | Create the curve as a metadata curve (a constant value, no keys). Valor predeterminado false. |
Devuelve: anim, curve, type, keys, exists, message.
anim.remove_frames (riesgo 3, modifica, smoke)
Removes frames from a sequence.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
startFrame | integer | obligatorio. First frame of the change. |
count | integer | obligatorio. Number of frames inserted or removed. |
Devuelve: anim, length, frames, frameRate, boneTracks, message.
anim.remove_metadata (riesgo 3, modifica)
Removes the metadata objects of a class. Not smoke-tested: the engine ships no concrete UAnimMetaData subclass.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
class | string | obligatorio. UAnimMetaData subclass (short name or path). |
properties | array of UeaKeyValue | Properties applied to the created metadata object. |
Devuelve: anim, metaData, count, message.
anim.remove_node (riesgo 3, modifica, destructivo, smoke)
Deletes one node from its anim graph (result nodes are refused).
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
nodeId | string | obligatorio. Node id, or a title/class name that is unique in the searched graphs. |
graph | string | |
compile | boolean | Recompile after the change (default true). Valor predeterminado true. |
Devuelve: count, details, compileErrors.
anim.remove_nodes (riesgo 3, modifica, destructivo, smoke)
Deletes several nodes in one call (result nodes are skipped and reported).
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
nodeIds | array of string | obligatorio. Node ids (or unique titles) to delete. |
graph | string | |
compile | boolean | Recompile after the change (default true). Valor predeterminado true. |
Devuelve: count, details, compileErrors.
anim.remove_notifies_by_name (riesgo 3, modifica, smoke)
Removes every notify with a name.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
name | string | obligatorio. Notify name or notify track name, depending on the tool. |
Devuelve: anim, index, name, class, time, duration, track, removed, notifies, message.
anim.remove_notifies_by_track (riesgo 3, modifica, smoke)
Removes every notify of a notify track.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
name | string | obligatorio. Notify name or notify track name, depending on the tool. |
Devuelve: anim, index, name, class, time, duration, track, removed, notifies, message.
anim.remove_notify (riesgo 3, modifica, smoke)
Removes the notify at an index.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
index | integer | obligatorio. Index in the list returned by anim.list_notifies. |
time | number | New trigger time in seconds (anim.move_notify). Valor predeterminado 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). |
Devuelve: anim, index, name, class, time, duration, track, removed, notifies, message.
anim.remove_notify_track (riesgo 3, modifica, smoke)
Removes a notify track and the notifies on it.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
track | string | obligatorio. Notify track name. |
newName | string | New track name (anim.rename_notify_track only). |
Devuelve: anim, tracks, count, message.
anim.remove_sync_markers_by_name (riesgo 3, modifica, smoke)
Removes every sync marker with a name.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
name | string | obligatorio. Notify name or notify track name, depending on the tool. |
Devuelve: anim, markers, names, count, removed, message.
anim.remove_virtual_bones (riesgo 3, modifica)
Removes virtual bones from the sequence's skeleton. Not smoke-tested: the engine fixture mesh has a minimal skeleton.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
names | array of string | Virtual bone names; empty removes every virtual bone of the skeleton. |
Devuelve: anim, names, count, message.
anim.rename (riesgo 3, modifica, smoke)
Renames (moves) an animation sequence.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
folder | string | Destination folder; empty keeps the source folder. |
name | string | obligatorio. Name of the new asset. |
Devuelve: anim, name, message.
anim.rename_curve (riesgo 2, modifica, smoke)
Renames a curve (the keys are copied to the new name).
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
curve | string | obligatorio. |
newName | string | obligatorio. |
type | string | float (default), vector or transform. |
Devuelve: anim, curve, type, keys, exists, message.
anim.rename_notify_track (riesgo 2, modifica, smoke)
Renames a notify track, keeping its notifies.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
track | string | obligatorio. Notify track name. |
newName | string | New track name (anim.rename_notify_track only). |
Devuelve: anim, tracks, count, message.
anim.resize (riesgo 2, modifica, UE 5.0+, smoke)
Sets the play length of a sequence, resampling its keys (UE 5 only).
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
length | number | obligatorio. New play length in seconds. |
Devuelve: anim, length, frames, frameRate, boneTracks, message.
anim.reverse (riesgo 2, modifica, UE 5.0+, smoke)
Reverses the bone track keys of a sequence (UE 5 only).
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. Animation sequence asset path or unique name. |
Devuelve: anim, length, frames, frameRate, boneTracks, message.
anim.revert_modifier (riesgo 3, modifica)
Reverts an animation modifier applied to a sequence. Not smoke-tested: the engine ships no animation modifier asset.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
modifierClass | string | obligatorio. UAnimationModifier subclass (blueprint asset path or class name). |
properties | array of UeaKeyValue | Properties applied to the modifier before running it. |
Devuelve: anim, name, message.
anim.rtg_add_pose (riesgo 2, modifica, UE 5.5+, requiere el plugin IKRig, smoke)
Creates a retarget pose on the source or target side.
| Argumento | Tipo | Descripción |
|---|---|---|
side | string | obligatorio. "source" or "target". |
name | string | obligatorio. Retarget pose name. |
Devuelve: side, poses, current, count, message.
anim.rtg_auto_map_chains (riesgo 2, modifica, UE 5.5+, requiere el plugin IKRig, smoke)
Maps target chains to source chains automatically ("exact", "fuzzy" or "clear").
| Argumento | Tipo | Descripción |
|---|---|---|
mode | string | "exact", "fuzzy" or "clear". Valor predeterminado TEXT("exact"). |
force | boolean | Remap chains that already have a source chain. Valor predeterminado false. |
Devuelve: retargeter, name, sourceRig, targetRig, sourceMesh, targetMesh, sourcePose, targetPose, chainMap, sourcePoses, targetPoses, opCount, message.
anim.rtg_create (riesgo 2, modifica, UE 5.5+, requiere el plugin IKRig, smoke)
Creates an IK Retargeter from a source and a target IK Rig, with the default retarget ops.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. |
name | string | obligatorio. |
sourceRig | string | obligatorio. IK rig of the animation being copied from. |
targetRig | string | obligatorio. IK rig of the character being animated. |
Devuelve: retargeter, name, sourceRig, targetRig, sourceMesh, targetMesh, sourcePose, targetPose, chainMap, sourcePoses, targetPoses, opCount, message.
anim.rtg_delete (riesgo 3, modifica, destructivo, UE 5.5+, requiere el plugin IKRig)
Deletes an IK Retargeter asset.
| Argumento | Tipo | Descripción |
|---|---|---|
retargeter | string | obligatorio. IK retargeter asset. |
Devuelve: deleted, message.
anim.rtg_get (riesgo 0, UE 5.5+, requiere el plugin IKRig, smoke)
Full state of an IK Retargeter: rigs, preview meshes, chain mapping and retarget poses.
| Argumento | Tipo | Descripción |
|---|---|---|
retargeter | string | obligatorio. IK retargeter asset. |
Devuelve: retargeter, name, sourceRig, targetRig, sourceMesh, targetMesh, sourcePose, targetPose, chainMap, sourcePoses, targetPoses, opCount, message.
anim.rtg_list_chain_map (riesgo 0, UE 5.5+, requiere el plugin IKRig, smoke)
Lists the target-to-source chain mapping of a retargeter.
| Argumento | Tipo | Descripción |
|---|---|---|
retargeter | string | obligatorio. IK retargeter asset. |
Devuelve: retargeter, name, sourceRig, targetRig, sourceMesh, targetMesh, sourcePose, targetPose, chainMap, sourcePoses, targetPoses, opCount, message.
anim.rtg_list_ops (riesgo 0, UE 5.6+, requiere el plugin IKRig, smoke)
Lists the retarget ops of a retargeter and their settings (5.6+ op-based retargeting model).
| Argumento | Tipo | Descripción |
|---|---|---|
retargeter | string | obligatorio. IK retargeter asset. |
Devuelve: settings, applied, errors, message.
anim.rtg_list_poses (riesgo 0, UE 5.5+, requiere el plugin IKRig, smoke)
Lists the retarget poses of one side and the current one.
| Argumento | Tipo | Descripción |
|---|---|---|
side | string | obligatorio. |
pose | string | Retarget pose name (empty = the current pose of that side). |
Devuelve: side, poses, current, count, message.
anim.rtg_map_chain (riesgo 2, modifica, UE 5.5+, requiere el plugin IKRig, smoke)
Maps one target chain to a source chain (empty source chain unmaps it).
| Argumento | Tipo | Descripción |
|---|---|---|
targetChain | string | obligatorio. Chain of the target rig. |
sourceChain | string | Chain of the source rig, or empty to unmap. |
Devuelve: retargeter, name, sourceRig, targetRig, sourceMesh, targetMesh, sourcePose, targetPose, chainMap, sourcePoses, targetPoses, opCount, message.
anim.rtg_remove_pose (riesgo 3, modifica, UE 5.5+, requiere el plugin IKRig, smoke)
Removes a retarget pose.
| Argumento | Tipo | Descripción |
|---|---|---|
side | string | obligatorio. |
pose | string | obligatorio. |
Devuelve: side, poses, current, count, message.
anim.rtg_rename_pose (riesgo 2, modifica, UE 5.5+, requiere el plugin IKRig, smoke)
Renames a retarget pose.
| Argumento | Tipo | Descripción |
|---|---|---|
newName | string | obligatorio. |
Devuelve: side, poses, current, count, message.
anim.rtg_reset_pose (riesgo 2, modifica, UE 5.5+, requiere el plugin IKRig, smoke)
Resets a retarget pose, or only the bones listed.
| Argumento | Tipo | Descripción |
|---|---|---|
bones | array of string | Bones to reset; empty resets the whole pose. |
Devuelve: side, poses, current, count, message.
anim.rtg_retarget_animations (riesgo 2, modifica, UE 5.8+, requiere el plugin IKRig)
Duplicates and retargets a list of animation assets onto the target skeleton of a retargeter.
| Argumento | Tipo | Descripción |
|---|---|---|
anims | array of string | obligatorio. Animation assets to retarget. |
folder | string | obligatorio. 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. Valor predeterminado true. |
overwriteExistingFiles | boolean | Overwrite assets with the same name instead of creating unique names. Valor predeterminado false. |
Devuelve: created, count, message.
anim.rtg_set_chain_settings (riesgo 2, modifica, UE 5.5+, UE ≤5.5, requiere el plugin IKRig, smoke)
Reads or changes the FK / IK / speed-planting settings of one target chain.
| Argumento | Tipo | Descripción |
|---|---|---|
targetChain | string | obligatorio. |
properties | array of UeaKeyValue | Property assignments on FTargetChainSettings (e.g. "FK.RotationAlpha" = "0.5"). Empty lists the current values. |
Devuelve: settings, applied, errors, message.
anim.rtg_set_current_pose (riesgo 2, modifica, UE 5.5+, requiere el plugin IKRig, smoke)
Makes a retarget pose the current one for that side.
| Argumento | Tipo | Descripción |
|---|---|---|
side | string | obligatorio. |
pose | string | obligatorio. |
Devuelve: side, poses, current, count, message.
anim.rtg_set_global_settings (riesgo 2, modifica, UE 5.5+, UE ≤5.5, requiere el plugin IKRig, smoke)
Reads or changes the global settings of a retargeter (enable FK / IK / root, warping, ...).
| Argumento | Tipo | Descripción |
|---|---|---|
properties | array of UeaKeyValue | Property assignments; empty lists the current values. |
Devuelve: settings, applied, errors, message.
anim.rtg_set_op_setting (riesgo 2, modifica, UE 5.6+, requiere el plugin IKRig)
Sets a property on one retarget op, addressed as "
| Argumento | Tipo | Descripción |
|---|---|---|
properties | array of UeaKeyValue | Property assignments; empty lists the current values. |
Devuelve: settings, applied, errors, message.
anim.rtg_set_pose_bone_rotation (riesgo 2, modifica, UE 5.5+, requiere el plugin IKRig, smoke)
Sets the rotation offset of one bone inside a retarget pose (degrees).
| Argumento | Tipo | Descripción |
|---|---|---|
bone | string | obligatorio. |
rotation | {x,y,z} | Rotation offset applied to the bone, in degrees (pitch, yaw, roll). |
Devuelve: side, poses, current, count, message.
anim.rtg_set_pose_root_offset (riesgo 2, modifica, UE 5.5+, requiere el plugin IKRig, smoke)
Sets the global translation offset of the pelvis inside a retarget pose.
| Argumento | Tipo | Descripción |
|---|---|---|
offset | {x,y,z} | Global translation offset of the pelvis bone. |
Devuelve: side, poses, current, count, message.
anim.rtg_set_preview_mesh (riesgo 2, modifica, UE 5.5+, requiere el plugin IKRig, smoke)
Sets the preview skeletal mesh of the source or target side.
| Argumento | Tipo | Descripción |
|---|---|---|
side | string | obligatorio. "source" or "target". |
mesh | string | obligatorio. |
Devuelve: retargeter, name, sourceRig, targetRig, sourceMesh, targetMesh, sourcePose, targetPose, chainMap, sourcePoses, targetPoses, opCount, message.
anim.rtg_set_rig (riesgo 2, modifica, UE 5.5+, requiere el plugin IKRig, smoke)
Assigns the source or target IK Rig of a retargeter.
| Argumento | Tipo | Descripción |
|---|---|---|
side | string | obligatorio. "source" or "target". |
ikRig | string | obligatorio. |
Devuelve: retargeter, name, sourceRig, targetRig, sourceMesh, targetMesh, sourcePose, targetPose, chainMap, sourcePoses, targetPoses, opCount, message.
anim.rtg_set_root_settings (riesgo 2, modifica, UE 5.5+, UE ≤5.5, requiere el plugin IKRig, smoke)
Reads or changes the retarget root (pelvis) settings of a retargeter.
| Argumento | Tipo | Descripción |
|---|---|---|
properties | array of UeaKeyValue | Property assignments; empty lists the current values. |
Devuelve: settings, applied, errors, message.
anim.rtg_validate (riesgo 0, UE 5.5+, requiere el plugin IKRig, smoke)
Checks a retargeter for missing rigs, missing meshes and unmapped target chains.
| Argumento | Tipo | Descripción |
|---|---|---|
retargeter | string | obligatorio. IK retargeter asset. |
Devuelve: valid, issues, mappedChains, unmappedChains, message.
anim.save (riesgo 2, modifica)
Saves the package of an animation sequence to disk. Not smoke-tested: the self-test never writes files.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. Animation sequence asset path or unique name. |
Devuelve: anim, name, message.
anim.set_additive (riesgo 2, modifica, smoke)
Additive settings: additive type, base pose type, base pose animation and reference frame.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
type | string | obligatorio. 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. Valor predeterminado 0. |
Devuelve: anim, type, basePoseType, basePoseAnim, refFrameIndex, message.
anim.set_anim_blueprint (riesgo 2, modifica, requiere mundo)
Assigns (or clears) the anim blueprint of the skeletal mesh component of an actor. Works in the editor and in PIE.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | Anim blueprint asset, or empty to clear it. |
Devuelve: actor, component, mesh, skeleton, mode, animBlueprint, animInstanceClass, currentAnim, position, length, playRate, playing, looping, montages, curves, message.
anim.set_anim_mode (riesgo 1, requiere PIE, requiere mundo, smoke)
Switches the animation mode of an actor between "blueprint", "singleNode" and "custom".
| Argumento | Tipo | Descripción |
|---|---|---|
mode | string | obligatorio. "blueprint", "singleNode" or "custom". |
Devuelve: actor, component, mesh, skeleton, mode, animBlueprint, animInstanceClass, currentAnim, position, length, playRate, playing, looping, montages, curves, message.
anim.set_bone_track_keys (riesgo 2, modifica, 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.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
bone | string | obligatorio. |
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. |
Devuelve: anim, length, frames, frameRate, boneTracks, message.
anim.set_compression (riesgo 2, modifica, smoke)
Bone and curve compression settings assets of a sequence (empty arguments only report the current ones).
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
boneSettings | string | UAnimBoneCompressionSettings asset; empty leaves it unchanged. |
curveSettings | string | UAnimCurveCompressionSettings asset; empty leaves it unchanged. |
Devuelve: anim, boneSettings, curveSettings, compressedSizeBytes, message.
anim.set_curve_from_expression (riesgo 2, modifica, smoke)
Fills a float curve from an expression sampled over the sequence: constant, linear, sine, cosine or pulse.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
curve | string | obligatorio. |
expression | string | obligatorio. constant, linear, sine, cosine or pulse. |
samples | integer | Number of samples spread over the sequence. Valor predeterminado 10. |
amplitude | number | Peak value (constant value for 'constant', end value for 'linear'). Valor predeterminado 1.0. |
frequency | number | Cycles over the whole sequence (sine/cosine/pulse). Valor predeterminado 1.0. |
offset | number | Value added to every sample. Valor predeterminado 0.0. |
Devuelve: anim, curve, type, keys, exists, message.
anim.set_curve_keys (riesgo 2, modifica, smoke)
Replaces every key of a float curve.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
curve | string | obligatorio. |
times | array of number | obligatorio. Key times in seconds. |
values | array of number | obligatorio. One value per time. |
create | boolean | Create the curve when it does not exist yet. Valor predeterminado true. |
Devuelve: anim, curve, type, keys, exists, message.
anim.set_frame_rate (riesgo 2, modifica, UE 5.0+, smoke)
Changes the sampling frame rate, resampling the keys (UE 5 only: 4.27 has no animation data controller).
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
frameRate | number | obligatorio. New sampling rate in frames per second. |
Devuelve: anim, time, frame, length, frames, frameRate, valid, message.
anim.set_import_settings (riesgo 2, modifica, smoke)
Changes the FBX import settings used by the next reimport (creates them when the sequence has none).
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
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. Valor predeterminado -1. |
frameImportRangeMax | integer | Last frame imported when animationLength is setRange; -1 leaves it. Valor predeterminado -1. |
customSampleRate | integer | Sample rate used when useDefaultSampleRate is false; -1 leaves it. Valor predeterminado -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. |
Devuelve: anim, importDataClass, sourceFiles, settings, canReimport, message.
anim.set_interpolation (riesgo 2, modifica, smoke)
Key interpolation of a sequence: linear or step.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
type | string | obligatorio. linear or step. |
Devuelve: anim, name, message.
anim.set_node_comment (riesgo 2, modifica, smoke)
Sets the comment bubble of a node.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
nodeId | string | obligatorio. |
comment | string | |
graph | string |
Devuelve: node, compileErrors, propertyErrors.
anim.set_node_functions (riesgo 2, modifica, UE 5.0+)
Sets the anim node functions of a node (OnInitialize / OnBecomeRelevant / OnUpdate), UE 5.0+.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
nodeId | string | obligatorio. |
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). Valor predeterminado true. |
Devuelve: node, compileErrors, propertyErrors.
anim.set_node_properties (riesgo 2, modifica, smoke)
Sets several properties of an anim graph node in one call.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
nodeId | string | obligatorio. |
properties | array of UeaKeyValue | obligatorio. |
graph | string | |
compile | boolean | Recompile after the change (default true). Valor predeterminado true. |
Devuelve: properties, count, errors, compileErrors.
anim.set_node_property (riesgo 2, modifica, smoke)
Sets one property of an anim graph node (inside its FAnimNode_* struct or on the node itself); dotted paths reach nested struct members.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
nodeId | string | obligatorio. |
property | string | obligatorio. 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). Valor predeterminado true. |
Devuelve: properties, count, errors, compileErrors.
anim.set_notify_property (riesgo 2, modifica, smoke)
Applies properties to the notify object at an index (see anim.list_notifies).
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
index | integer | obligatorio. Index in the list returned by anim.list_notifies. |
time | number | New trigger time in seconds (anim.move_notify). Valor predeterminado 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). |
Devuelve: anim, index, name, class, time, duration, track, removed, notifies, message.
anim.set_play_rate (riesgo 1, requiere PIE, requiere mundo, smoke)
Sets the play rate of the current single-node animation.
| Argumento | Tipo | Descripción |
|---|---|---|
playRate | number | Valor predeterminado 1.0. |
Devuelve: actor, component, mesh, skeleton, mode, animBlueprint, animInstanceClass, currentAnim, position, length, playRate, playing, looping, montages, curves, message.
anim.set_position (riesgo 1, requiere PIE, requiere mundo, smoke)
Scrubs the current single-node animation to a position in seconds.
| Argumento | Tipo | Descripción |
|---|---|---|
time | number | Position in seconds. Valor predeterminado 0.0. |
fireNotifies | boolean | Fire the notifies between the old and the new position. Valor predeterminado false. |
Devuelve: actor, component, mesh, skeleton, mode, animBlueprint, animInstanceClass, currentAnim, position, length, playRate, playing, looping, montages, curves, message.
anim.set_rate_scale (riesgo 2, modifica, smoke)
Playback speed multiplier stored on the asset.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
rateScale | number | obligatorio. Playback multiplier stored on the asset (1 = authored speed). |
Devuelve: anim, name, message.
anim.set_retarget_source (riesgo 2, modifica, smoke)
Retarget source of a sequence (a name registered on the skeleton, or a skeletal mesh on UE 5).
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
source | string | Retarget source name registered on the skeleton; empty clears it. |
mesh | string | Skeletal mesh used as the retarget source (UE 5 only). |
Devuelve: anim, name, message.
anim.set_root_motion (riesgo 2, modifica, smoke)
Root motion settings: extraction, root lock type, forced lock and normalised scale.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
enabled | boolean | Enable root motion extraction. Valor predeterminado 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. Valor predeterminado false. |
useNormalizedRootMotionScale | boolean | Normalise the root motion scale with the mesh scale. Valor predeterminado true. |
Devuelve: anim, enabled, lockType, forceRootLock, useNormalizedRootMotionScale, hasRootTrack, message.
anim.set_skeleton (riesgo 3, modifica, smoke)
Binds a sequence to another skeleton; 'convertSpaces' remaps the tracks to the new hierarchy.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. |
skeleton | string | obligatorio. Skeleton asset path or unique name. |
convertSpaces | boolean | Remap the tracks to the new bone hierarchy instead of only rebinding. Valor predeterminado false. |
Devuelve: anim, skeleton, skeletonName, boneCount, previewMesh, message.
anim.sm_add_alias (riesgo 2, modifica, UE 5.0+, smoke)
Adds a state alias pointing at one or more states (shared transition source), UE 5.0+.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
machine | string | State machine name or node id; empty = the only one. |
name | string | obligatorio. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 0. |
entry | boolean | Make this state the entry state of the machine. Valor predeterminado false. |
states | array of string | States the alias points at (anim.sm_add_alias only). |
compile | boolean | Recompile after the change (default true). Valor predeterminado true. |
Devuelve: state, machine, compileErrors.
anim.sm_add_conduit (riesgo 2, modifica, smoke)
Adds a conduit (a transition hub without a pose) to a state machine.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
machine | string | State machine name or node id; empty = the only one. |
name | string | obligatorio. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 0. |
entry | boolean | Make this state the entry state of the machine. Valor predeterminado false. |
states | array of string | States the alias points at (anim.sm_add_alias only). |
compile | boolean | Recompile after the change (default true). Valor predeterminado true. |
Devuelve: state, machine, compileErrors.
anim.sm_add_state (riesgo 2, modifica, smoke)
Adds a state with its own anim graph to a state machine; Entry=true makes it the entry state.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
machine | string | State machine name or node id; empty = the only one. |
name | string | obligatorio. |
x | integer | Valor predeterminado 0. |
y | integer | Valor predeterminado 0. |
entry | boolean | Make this state the entry state of the machine. Valor predeterminado false. |
states | array of string | States the alias points at (anim.sm_add_alias only). |
compile | boolean | Recompile after the change (default true). Valor predeterminado true. |
Devuelve: state, machine, compileErrors.
anim.sm_add_state_blend_space (riesgo 2, modifica, smoke)
Adds a blend space player inside a state, optionally driven by two Anim Blueprint float variables.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
machine | string | |
state | string | obligatorio. |
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). Valor predeterminado true. |
Devuelve: state, boundGraph, nodes, count, resultNodeId, nodeId, compileErrors.
anim.sm_add_state_node (riesgo 2, modifica, smoke)
Adds an anim node of any class inside a state, optionally wiring it to the state result.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
machine | string | |
state | string | obligatorio. |
nodeClass | string | obligatorio. Node class short name ("BlendSpacePlayer", "Slot"). |
properties | array of UeaKeyValue | |
connectToResult | boolean | Wire the node's pose output to the state result (default true). Valor predeterminado true. |
compile | boolean | Recompile after the change (default true). Valor predeterminado true. |
Devuelve: state, boundGraph, nodes, count, resultNodeId, nodeId, compileErrors.
anim.sm_add_state_sequence (riesgo 2, modifica, smoke)
Adds a sequence player inside a state and wires it to the state result. Anim may be empty and set later.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
machine | string | |
state | string | obligatorio. |
anim | string | Animation sequence asset; may be empty to wire the asset later. |
loop | boolean | Valor predeterminado true. |
playRate | number | Valor predeterminado 1.0f. |
compile | boolean | Recompile after the change (default true). Valor predeterminado true. |
Devuelve: state, boundGraph, nodes, count, resultNodeId, nodeId, compileErrors.
anim.sm_add_transition (riesgo 2, modifica, smoke)
Adds a transition between two states/conduits with a crossfade duration, priority and blend mode.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
machine | string | |
from | string | obligatorio. Source state name or id. |
to | string | obligatorio. Target state name or id. |
crossfade | number | Crossfade duration in seconds (default 0.2). Valor predeterminado 0.2f. |
blendMode | string | Alpha blend option: Linear, Cubic, HermiteCubic, Sinusoidal, QuadraticInOut, ... |
priority | integer | Valor predeterminado 0. |
bidirectional | boolean | Allow the transition in both directions. Valor predeterminado false. |
automaticRule | boolean | Drive the rule from the remaining time of the source state's asset player. Valor predeterminado false. |
logicType | string | StandardBlend or Custom. |
compile | boolean | Recompile after the change (default true). Valor predeterminado true. |
Devuelve: transition, machine, compileErrors.
anim.sm_create_locomotion (riesgo 2, modifica, smoke)
Builds a complete locomotion state machine (Idle/Move plus optional jump states) with the speed and in-air rules wired, in one call.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
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). Valor predeterminado 10.0f. |
connectToOutput | boolean | Connect the state machine to the AnimGraph result (default true). Valor predeterminado true. |
compile | boolean | Recompile after the change (default true). Valor predeterminado true. |
Devuelve: machine, nodeId, states, transitions, variables, compileErrors, warnings.
anim.sm_export (riesgo 0, smoke)
Exports a state machine (states, transitions, rules) as JSON for anim.sm_import.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
machine | string | State machine name or node id; empty = the only one in the Anim Blueprint. |
Devuelve: json, stateCount, transitionCount.
anim.sm_get (riesgo 0, smoke)
Full description of a state machine: states (with their inner node count), transitions, rules and entry state.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
machine | string | State machine name or node id; empty = the only one in the Anim Blueprint. |
Devuelve: machine, nodeId, graph, stateMachineGraph, entryState, states, transitions, compileErrors.
anim.sm_get_transition_rule (riesgo 0, smoke)
Dumps the rule of a transition: its graph name, the node titles and a short description.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
machine | string | |
transition | string | obligatorio. Transition node id or "From->To". |
compile | boolean | Recompile after the change (default true). Valor predeterminado true. |
Devuelve: transition, ruleGraph, rule, automaticRule, nodes, compileErrors.
anim.sm_import (riesgo 2, modifica)
Recreates states and transitions from the JSON produced by anim.sm_export (the machine is created when missing).
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
json | string | obligatorio. 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). Valor predeterminado true. |
Devuelve: machine, nodeId, graph, stateMachineGraph, entryState, states, transitions, compileErrors.
anim.sm_list (riesgo 0, smoke)
Lists the state machines of an Anim Blueprint with their node ids and the graphs they live in.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
machine | string | State machine name or node id; empty = the only one in the Anim Blueprint. |
Devuelve: machines, nodeIds, graphs, count.
anim.sm_list_state_nodes (riesgo 0, smoke)
Lists the anim graph nodes inside a state and the id of its result node.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
machine | string | |
state | string | obligatorio. State name or node id. |
compile | boolean | Recompile after the change (default true). Valor predeterminado true. |
Devuelve: state, boundGraph, nodes, count, resultNodeId, nodeId, compileErrors.
anim.sm_remove_state (riesgo 3, modifica, destructivo, smoke)
Deletes a state (or conduit/alias) and the transitions attached to it.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
machine | string | |
state | string | obligatorio. State name or node id. |
compile | boolean | Recompile after the change (default true). Valor predeterminado true. |
Devuelve: machine, nodeId, graph, stateMachineGraph, entryState, states, transitions, compileErrors.
anim.sm_remove_transition (riesgo 3, modifica, destructivo, smoke)
Deletes a transition.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
machine | string | |
transition | string | obligatorio. Transition node id or "From->To". |
compile | boolean | Recompile after the change (default true). Valor predeterminado true. |
Devuelve: machine, nodeId, graph, stateMachineGraph, entryState, states, transitions, compileErrors.
anim.sm_rename_state (riesgo 2, modifica, smoke)
Renames a state, conduit or alias (its inner graph is renamed too).
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
machine | string | |
state | string | obligatorio. |
newName | string | obligatorio. |
compile | boolean | Recompile after the change (default true). Valor predeterminado true. |
Devuelve: state, machine, compileErrors.
anim.sm_set_entry_state (riesgo 2, modifica, smoke)
Makes a state the entry state of its machine (the previous entry link is replaced).
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
machine | string | |
state | string | obligatorio. State name or node id. |
compile | boolean | Recompile after the change (default true). Valor predeterminado true. |
Devuelve: state, machine, compileErrors.
anim.sm_set_state_notifies (riesgo 2, modifica, smoke)
Sets the entered / left / fully-blended notify names of a state.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
machine | string | |
state | string | obligatorio. |
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). Valor predeterminado true. |
Devuelve: state, machine, compileErrors.
anim.sm_set_transition (riesgo 2, modifica, smoke)
Edits a transition: crossfade, priority, blend mode, blend profile, bidirectional and automatic rule.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
machine | string | |
transition | string | obligatorio. Transition node id or "From->To". |
crossfade | number | Crossfade duration in seconds; negative = leave unchanged. Valor predeterminado -1.0f. |
priority | integer | Valor predeterminado -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. Valor predeterminado false. |
setBidirectional | boolean | Apply the Bidirectional value (it is a bool, so it needs an explicit opt-in). Valor predeterminado false. |
automaticRule | boolean | Drive the rule from the remaining time of the source state's asset player. Valor predeterminado false. |
setAutomaticRule | boolean | Apply the AutomaticRule value. Valor predeterminado false. |
compile | boolean | Recompile after the change (default true). Valor predeterminado true. |
Devuelve: transition, machine, compileErrors.
anim.sm_set_transition_rule_compare (riesgo 2, modifica, smoke)
Builds the transition rule as "variable
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
machine | string | |
transition | string | obligatorio. |
variable | string | obligatorio. Float or int member variable of the Anim Blueprint. |
op | string | obligatorio. Comparison operator: >, <, >=, <=, ==, !=. |
value | number | Right-hand constant. Valor predeterminado 0.0f. |
compile | boolean | Recompile after the change (default true). Valor predeterminado true. |
Devuelve: transition, ruleGraph, rule, automaticRule, nodes, compileErrors.
anim.sm_set_transition_rule_time_remaining (riesgo 2, modifica, smoke)
Switches the transition to the automatic rule based on the remaining time of the source state's asset player.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
machine | string | |
transition | string | obligatorio. |
crossfade | number | Crossfade duration used as the trigger window, in seconds (default: keep the current one). Valor predeterminado -1.0f. |
compile | boolean | Recompile after the change (default true). Valor predeterminado true. |
Devuelve: transition, ruleGraph, rule, automaticRule, nodes, compileErrors.
anim.sm_set_transition_rule_variable (riesgo 2, modifica, smoke)
Builds the transition rule from a bool variable of the Anim Blueprint (created when missing), optionally negated.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
machine | string | |
transition | string | obligatorio. |
variable | string | obligatorio. Bool member variable of the Anim Blueprint. |
negate | boolean | Invert the variable with a NOT node. Valor predeterminado false. |
compile | boolean | Recompile after the change (default true). Valor predeterminado true. |
Devuelve: transition, ruleGraph, rule, automaticRule, nodes, compileErrors.
anim.snapshot_pose (riesgo 2, modifica, requiere PIE, requiere mundo, smoke)
Saves the current pose of a running actor into a new pose asset.
| Argumento | Tipo | Descripción |
|---|---|---|
folder | string | obligatorio. Destination folder of the pose asset. |
name | string | obligatorio. Asset name of the pose asset. |
poseName | string | Name of the pose inside the asset (empty = generated). |
Devuelve: poseAsset, poseName, poseCount, message.
anim.spawn_test_actor (riesgo 1, requiere PIE, requiere mundo, smoke)
Spawns a skeletal mesh actor in the PIE world to test animations on, and returns its label.
| Argumento | Tipo | Descripción |
|---|---|---|
mesh | string | Skeletal mesh of the spawned actor. Valor predeterminado TEXT("/Engine/EngineMeshes/SkeletalCube"). |
label | string | Label given to the actor (also used to find it again). Valor predeterminado TEXT("AnimTestActor"). |
location | {x,y,z} | Spawn location in the PIE world. |
animBlueprint | string | Anim blueprint set on the spawned actor (optional). |
Devuelve: actor, component, mesh, skeleton, mode, animBlueprint, animInstanceClass, currentAnim, position, length, playRate, playing, looping, montages, curves, message.
anim.stop (riesgo 1, requiere PIE, requiere mundo, smoke)
Stops the single-node playback of an actor.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | obligatorio. Actor label, name or class of the actor carrying the skeletal mesh. |
Devuelve: actor, component, mesh, skeleton, mode, animBlueprint, animInstanceClass, currentAnim, position, length, playRate, playing, looping, montages, curves, message.
anim.stop_recording (riesgo 2, modifica, requiere PIE, requiere mundo)
Stops an animation recording started by anim.record_from_actor. Not smoke-tested: it needs a running PIE session.
| Argumento | Tipo | Descripción |
|---|---|---|
actor | string | Actor being recorded; empty stops every recording. |
Devuelve: actor, anim, recording, message.
anim.unbind_property (riesgo 2, modifica, smoke)
Removes a property binding from a node.
| Argumento | Tipo | Descripción |
|---|---|---|
animBlueprint | string | obligatorio. |
nodeId | string | obligatorio. |
property | string | obligatorio. |
graph | string | |
compile | boolean | Recompile after the change (default true). Valor predeterminado true. |
Devuelve: bindings, count, compileErrors.
anim.validate (riesgo 0, smoke)
Sanity check of a sequence: missing skeleton, zero length, notifies out of range, curves without keys, root motion without a root track.
| Argumento | Tipo | Descripción |
|---|---|---|
anim | string | obligatorio. Animation sequence asset path or unique name. |
Devuelve: anim, errors, warnings, valid, message.