Pular para o conteúdo principal

Kit anim

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

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

Guia​

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:

ClassPrefixWhat
UUeaKit_AnimSequenceanim.sequence info, root motion, additive, compression, curves, bone tracks, notifies, sync markers, metadata, import/export
UUeaKit_AnimMontageanim.montage_montages: slots, segments, sections, links, blending, notifies
UUeaKit_AnimBlendSpaceanim.bs_1D/2D blend spaces and aim offsets: axes, samples, interpolation
UUeaKit_AnimPoseanim.pose_pose assets
UUeaKit_AnimBlueprintanim.bp_, anim.sm_anim blueprints, anim graph nodes, state machines, layers
UUeaKit_AnimIKanim.ikrig_, anim.rtg_IK Rigs and IK Retargeters (UE 5, IKRig plugin)
UUeaKit_AnimPoseSearchanim.ps_, anim.chooser_motion matching schemas/databases and chooser tables (UE 5.4+, PoseSearch / Chooser plugins)
UUeaKit_AnimRuntimeanim.playback on actors in PIE, montage control, curve and bone queries, pose snapshots
UUeaKit_AnimBatchanim.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​

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

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

Recipes (sequences)​

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

Recipes (montages, blend spaces, pose assets)​

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

Recipes (anim blueprints)​

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

Recipes (IK rigs and retargeting, UE 5)​

An IK rig for a character​

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

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

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

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

Solving with a solver stack (UE 5.6+)​

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

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

Retargeting a pack of animations onto another skeleton​

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

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

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

Recipes (motion matching and choosers, UE 5.4+)​

A motion matching database​

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

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

A chooser table​

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

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

Recipes (playback in PIE)​

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

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

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

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

Recipes (folder work)​

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

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

Gotchas​

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

Ferramentas​

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

anim.add_aim_offset (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
blendSpacestringBlend space / aim offset asset; may be empty to set it later.
playRatenumberPadrão 1.0f.
loopbooleanPadrão true.

Retorna: node, compileErrors, propertyErrors.

anim.add_apply_additive (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
graphstringTarget graph; empty = "AnimGraph".
xintegerPadrão 0.
yintegerPadrão 0.
propertiesarray of UeaKeyValueExtra property assignments applied after the typed ones.
connectToOutputbooleanConnect the node's output pose to the graph's result node. Padrão false.
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: node, compileErrors, propertyErrors.

anim.add_blend_by_bool (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
graphstringTarget graph; empty = "AnimGraph".
xintegerPadrão 0.
yintegerPadrão 0.
propertiesarray of UeaKeyValueExtra property assignments applied after the typed ones.
connectToOutputbooleanConnect the node's output pose to the graph's result node. Padrão false.
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: node, compileErrors, propertyErrors.

anim.add_blend_by_enum (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
enumstringobrigatório. Enum asset or native enum name driving the blend.

Retorna: node, compileErrors, propertyErrors.

anim.add_blend_by_int (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
posesintegerNumber of blend poses to expose (minimum 2). Padrão 2.

Retorna: node, compileErrors, propertyErrors.

anim.add_blend_space_player (risco 2, altera, smoke)​

Adds a blend space player node.

ArgumentoTipoDescrição
blendSpacestringBlend space / aim offset asset; may be empty to set it later.
playRatenumberPadrão 1.0f.
loopbooleanPadrão true.

Retorna: node, compileErrors, propertyErrors.

anim.add_cached_pose (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
namestringobrigatório.

Retorna: node, compileErrors, propertyErrors.

anim.add_control_rig (risco 2, altera, requer plugin ControlRig)​

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

ArgumentoTipoDescrição
rigstringobrigatório. Control Rig Blueprint / class.

Retorna: node, compileErrors, propertyErrors.

anim.add_curve (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
animstringobrigatório.
curvestringobrigatório. Curve name.
typestringfloat (default), vector or transform.
metadatabooleanCreate the curve as a metadata curve (a constant value, no keys). Padrão false.

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

anim.add_curve_key (risco 2, altera, smoke)​

Adds one key to a float curve.

ArgumentoTipoDescrição
animstringobrigatório.
curvestringobrigatório.
timenumberobrigatório. Key time in seconds.
valuenumberobrigatório. Key value.
createbooleanCreate the curve when it does not exist yet. Padrão true.

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

anim.add_curve_keys (risco 2, altera, smoke)​

Adds several keys to a float curve at once.

ArgumentoTipoDescrição
animstringobrigatório.
curvestringobrigatório.
timesarray of numberobrigatório. Key times in seconds.
valuesarray of numberobrigatório. One value per time.
createbooleanCreate the curve when it does not exist yet. Padrão true.

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

anim.add_inertialization (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
graphstringTarget graph; empty = "AnimGraph".
xintegerPadrão 0.
yintegerPadrão 0.
propertiesarray of UeaKeyValueExtra property assignments applied after the typed ones.
connectToOutputbooleanConnect the node's output pose to the graph's result node. Padrão false.
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: node, compileErrors, propertyErrors.

anim.add_layered_bone_blend (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
bonesarray of stringRoot bone of each blend layer (one layer per bone).
blendDeptharray of integerBlend depth per layer; missing entries default to 1.
meshSpaceRotationBlendbooleanBlend rotations in mesh space. Padrão false.

Retorna: node, compileErrors, propertyErrors.

anim.add_linked_anim_graph (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
classstringobrigatório. Anim Blueprint (or AnimInstance class) to run in the linked graph.

Retorna: node, compileErrors, propertyErrors.

anim.add_linked_anim_layer (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
layerstringobrigatório. Layer (anim graph function) name.
interfacestringAnim Layer Interface declaring the layer; empty = self layer.

Retorna: node, compileErrors, propertyErrors.

anim.add_look_at (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
bonestringobrigatório. Bone that will be rotated.
lookAtBonestringBone or socket to look at; empty uses LookAtLocation.
lookAtLocation{x,y,z}

Retorna: node, compileErrors, propertyErrors.

anim.add_metadata (risco 2, altera)​

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

ArgumentoTipoDescrição
animstringobrigatório.
classstringobrigatório. UAnimMetaData subclass (short name or path).
propertiesarray of UeaKeyValueProperties applied to the created metadata object.

Retorna: anim, metaData, count, message.

anim.add_mirror (risco 2, altera, UE 5.1+, smoke)​

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

ArgumentoTipoDescrição
mirrorTablestringMirror data table asset.

Retorna: node, compileErrors, propertyErrors.

anim.add_modify_bone (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
bonestringobrigatório.
translation{x,y,z}
rotation{x,y,z}Rotation as pitch/yaw/roll.
scale{x,y,z}
translationModestringignore, replace or add for translation/rotation/scale. Default: ignore unless a value is given.
rotationModestring
scaleModestring

Retorna: node, compileErrors, propertyErrors.

anim.add_niagara_notify (risco 2, altera, UE 5.0+)​

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

ArgumentoTipoDescrição
animstringobrigatório.
timenumberobrigatório.
templatestringParticle system (anim.add_particle_notify) or Niagara system (anim.add_niagara_notify).
trackstring
socketstringSocket the effect is spawned on.
attachedbooleanKeep the effect attached to the mesh. Padrão true.

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

anim.add_node (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
nodeClassstringobrigatório. Short name ("SequencePlayer", "Slot", "TwoWayBlend") or full class name.
graphstringTarget graph; empty = "AnimGraph".
xintegerPadrão 0.
yintegerPadrão 0.
propertiesarray of UeaKeyValueProperty assignments applied to the new node (names of the FAnimNode_* struct).
connectToOutputbooleanConnect the node's output pose to the graph's result node. Padrão false.
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: node, compileErrors, propertyErrors.

anim.add_notify (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
animstringobrigatório.
namestringNotify name (used when no class is given: a skeleton notify event).
timenumberobrigatório. Trigger time in seconds.
trackstringNotify track ("1" when empty).
notifyClassstringUAnimNotify subclass (short name or path); empty creates a plain named notify.
propertiesarray of UeaKeyValueProperties applied to the created notify object.

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

anim.add_notify_object (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
animstringobrigatório.
namestringNotify name (used when no class is given: a skeleton notify event).
timenumberobrigatório. Trigger time in seconds.
trackstringNotify track ("1" when empty).
notifyClassstringUAnimNotify subclass (short name or path); empty creates a plain named notify.
propertiesarray of UeaKeyValueProperties applied to the created notify object.

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

anim.add_notify_state (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
animstringobrigatório.
notifyClassstringobrigatório. UAnimNotifyState subclass (short name or path).
timenumberobrigatório.
durationnumberobrigatório. Duration in seconds.
trackstring
propertiesarray of UeaKeyValue

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

anim.add_notify_track (risco 2, altera, smoke)​

Adds a notify track.

ArgumentoTipoDescrição
animstringobrigatório.
trackstringobrigatório. Notify track name.
newNamestringNew track name (anim.rename_notify_track only).

Retorna: anim, tracks, count, message.

anim.add_particle_notify (risco 2, altera)​

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

ArgumentoTipoDescrição
animstringobrigatório.
timenumberobrigatório.
templatestringParticle system (anim.add_particle_notify) or Niagara system (anim.add_niagara_notify).
trackstring
socketstringSocket the effect is spawned on.
attachedbooleanKeep the effect attached to the mesh. Padrão true.

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

anim.add_play_sound_notify (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
animstringobrigatório.
timenumberobrigatório.
soundstringSound asset to play; may be empty and set later.
trackstring
volumenumberPadrão 1.0.
pitchnumberPadrão 1.0.
followbooleanAttach the sound to the mesh instead of playing it at the actor location. Padrão false.
attachNamestringSocket or bone the sound follows when 'follow' is set.

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

anim.add_pose_asset_player (risco 2, altera)​

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

ArgumentoTipoDescrição
posestringobrigatório. Pose asset.
poseNamestringPose name for a "by name" player; empty adds a pose blend node.

Retorna: node, compileErrors, propertyErrors.

anim.add_random_player (risco 2, altera, smoke)​

Adds a random player node with one entry per animation.

ArgumentoTipoDescrição
animsarray of stringAnimation sequences to pick from.

Retorna: node, compileErrors, propertyErrors.

anim.add_rigid_body (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
physicsAssetstringPhysics asset overriding the mesh's own.

Retorna: node, compileErrors, propertyErrors.

anim.add_sequence_evaluator (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
animstringAnimation sequence asset; may be empty.
explicitTimenumberExplicit evaluation time in seconds. Padrão 0.0f.

Retorna: node, compileErrors, propertyErrors.

anim.add_sequence_player (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
animstringAnimation sequence asset; may be empty to create the node and set the sequence later.
playRatenumberPadrão 1.0f.
loopbooleanPadrão true.
startPositionnumberPadrão 0.0f.

Retorna: node, compileErrors, propertyErrors.

anim.add_slot (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
slotNamestringMontage slot name; default "DefaultSlot".

Retorna: node, compileErrors, propertyErrors.

anim.add_state_machine (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
namestringobrigatório.

Retorna: node, compileErrors, propertyErrors.

anim.add_sync_marker (risco 2, altera, smoke)​

Adds a sync marker on a notify track.

ArgumentoTipoDescrição
animstringobrigatório.
namestringobrigatório. Marker name.
timenumberobrigatório.
trackstringNotify track the marker sits on ("1" when empty).

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

anim.add_trail_notify_state (risco 2, altera)​

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

ArgumentoTipoDescrição
animstringobrigatório.
timenumberobrigatório.
durationnumberobrigatório.
trackstring
templatestringParticle system used by the trail.
firstSocketstringFirst socket of the trail.
secondSocketstringSecond socket of the trail.

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

anim.add_transform_curve_key (risco 2, altera, smoke)​

Adds one key to a transform curve.

ArgumentoTipoDescrição
animstringobrigatório.
curvestringobrigatório.
timenumberobrigatório.
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.
createbooleanPadrão true.

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

anim.add_two_bone_ik (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
ikBonestringobrigatório. End-effector bone of the two-bone chain.
effectorLocation{x,y,z}
jointTargetLocation{x,y,z}
effectorSpacestringBCS_WorldSpace, BCS_ComponentSpace, BCS_ParentBoneSpace, BCS_BoneSpace.

Retorna: node, compileErrors, propertyErrors.

anim.add_two_way_blend (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
graphstringTarget graph; empty = "AnimGraph".
xintegerPadrão 0.
yintegerPadrão 0.
propertiesarray of UeaKeyValueExtra property assignments applied after the typed ones.
connectToOutputbooleanConnect the node's output pose to the graph's result node. Padrão false.
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: node, compileErrors, propertyErrors.

anim.add_use_cached_pose (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
namestringobrigatório.

Retorna: node, compileErrors, propertyErrors.

anim.add_vector_curve_key (risco 2, altera)​

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

ArgumentoTipoDescrição
animstringobrigatório.
curvestringobrigatório.
timenumberobrigatório.
value{x,y,z}
createbooleanPadrão true.

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

anim.add_virtual_bone (risco 2, altera)​

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

ArgumentoTipoDescrição
animstringobrigatório.
sourceBonestringobrigatório. Bone the virtual bone starts from.
targetBonestringobrigatório. Bone the virtual bone points at.

Retorna: anim, names, count, message.

anim.apply_compression (risco 2, altera, smoke)​

Rebuilds the compressed animation data of a sequence.

ArgumentoTipoDescrição
animstringobrigatório. Animation sequence asset path or unique name.

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

anim.apply_modifier (risco 3, altera)​

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

ArgumentoTipoDescrição
animstringobrigatório.
modifierClassstringobrigatório. UAnimationModifier subclass (blueprint asset path or class name).
propertiesarray of UeaKeyValueProperties applied to the modifier before running it.

Retorna: anim, name, message.

anim.arrange_nodes (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
graphstring
spacingXintegerHorizontal spacing between columns (default 320). Padrão 320.
spacingYintegerVertical spacing between rows (default 180). Padrão 180.

Retorna: count, details, compileErrors.

anim.audit (risco 0, smoke)​

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

ArgumentoTipoDescrição
onlyOffendersbooleanOnly return the flagged sequences. Padrão false.

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

anim.bake_curve_from_bone (risco 2, altera, 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.

ArgumentoTipoDescrição
animstringobrigatório.
bonestringobrigatório.
componentstringobrigatório. posX, posY, posZ, rotPitch, rotYaw, rotRoll, scaleX, scaleY, scaleZ or distance.
curvestringobrigatório. Destination curve name.
spacestringlocal (default) or component space sampling.
samplesintegerNumber of samples; 0 uses one sample per frame. Padrão 0.

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

anim.batch_add_notify (risco 2, altera, dryRun, smoke)​

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

ArgumentoTipoDescrição
namestringobrigatório. Notify name added to every sequence.
timeRationumberPosition as a fraction of the sequence length (0..1). Padrão 0.5.
trackstringNotify track (created when missing). Padrão TEXT("1").
dryRunbooleanPadrão true.

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

anim.batch_apply_modifier (risco 3, altera, dryRun)​

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

ArgumentoTipoDescrição
modifierClassstringobrigatório. UAnimationModifier subclass (path or short name).
revertbooleanRevert the modifier instead of applying it. Padrão false.
dryRunbooleanPadrão true.

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

anim.batch_remove_notifies_by_name (risco 3, altera, dryRun, smoke)​

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

ArgumentoTipoDescrição
namestringobrigatório. Name to look for.
dryRunbooleanPadrão true.

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

anim.batch_rename_curve (risco 2, altera, dryRun, smoke)​

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

ArgumentoTipoDescrição
curvestringobrigatório. Existing float curve name.
newNamestringobrigatório. New curve name.
dryRunbooleanPadrão true.

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

anim.batch_set_compression (risco 2, altera, dryRun, smoke)​

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

ArgumentoTipoDescrição
boneSettingsstringBone compression settings asset (empty leaves it alone).
curveSettingsstringCurve compression settings asset (empty leaves it alone).
dryRunbooleanPadrão true.

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

anim.batch_set_rate_scale (risco 2, altera, dryRun, smoke)​

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

ArgumentoTipoDescrição
rateScalenumberPadrão 1.0.
dryRunbooleanPadrão true.

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

anim.batch_set_root_motion (risco 2, altera, dryRun, smoke)​

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

ArgumentoTipoDescrição
enabledbooleanPadrão true.
lockTypestring"refPose", "animFirstFrame" or "zero" (empty leaves it alone).
forceRootLockstringForce the root lock even when root motion is disabled ("true"/"false", empty leaves it alone).
dryRunbooleanPadrão true.

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

anim.batch_set_skeleton (risco 3, altera, dryRun, smoke)​

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

ArgumentoTipoDescrição
skeletonstringobrigatório. Skeleton assigned to every sequence of the folder.
convertSpacesbooleanRemap the bone tracks to the new skeleton's bone names. Padrão true.
dryRunbooleanPadrão true.

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

anim.bind_property (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
nodeIdstringobrigatório.
propertystringobrigatório. Property of the FAnimNode_* struct to drive ("PlayRate").
variablestringobrigatório. Variable name (or dotted property path) of the Anim Blueprint to read from.
graphstring
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: bindings, count, compileErrors.

anim.bp_add_layer (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
namestringobrigatório. Layer name (becomes an anim graph function).
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: layers, count, compileErrors.

anim.bp_add_notify_event (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
notifyNamestringobrigatório. Notify name without the "AnimNotify_" prefix (e.g. "Footstep").
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: id, title, graph, compileErrors.

anim.bp_add_variable (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
namestringobrigatório.
typestringobrigatório. bool, float, int, byte, name, string, vector, rotator, transform, object:Class, class:Class, enum:Name, struct:Name.
defaultValuestringDefault value as text ("true", "1.5", "0,0,0").
categorystringDetails-panel category.
instanceEditablebooleanExpose the variable on instances (default true). Padrão true.
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: variables, count, compileErrors.

anim.bp_compile (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
animBlueprintstringobrigatório. Anim Blueprint asset path or unique name.

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

anim.bp_create (risco 2, altera, 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.

ArgumentoTipoDescrição
folderstringobrigatório. Destination folder, e.g. "/Game/Anim".
namestringobrigatório. Asset name without path (no spaces, slashes or dots).
skeletonstringTarget skeleton asset. Optional when FromAnim is given or Template is true.
fromAnimstringAny animation asset (sequence, montage, blend space) whose skeleton is used when Skeleton is empty.
parentClassstringParent AnimInstance class. Default: AnimInstance.
templateboolean5.0+: create a skeleton-less Anim Blueprint template. Padrão false.
previewMeshstringOptional preview skeletal mesh.

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

anim.bp_create_layer_interface (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
folderstringobrigatório.
namestringobrigatório.
layersarray of stringLayer (anim graph function) names to declare in the interface.

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

anim.bp_delete (risco 3, altera, destrutivo, dryRun, smoke)​

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

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
dryRunbooleanReport only, do not delete. Padrão false.

Retorna: deleted, path, wouldDelete.

anim.bp_duplicate (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
folderstringDestination folder; default: the source folder.
namestringNew asset name; default: source name + "_Copy".

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

anim.bp_get (risco 0, smoke)​

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

ArgumentoTipoDescrição
animBlueprintstringobrigatório. Anim Blueprint asset path or unique name.

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

anim.bp_get_class_defaults (risco 0, smoke)​

Reads the editable class defaults of the generated AnimInstance CDO.

ArgumentoTipoDescrição
animBlueprintstringobrigatório. Anim Blueprint asset path or unique name.

Retorna: properties, count, errors.

anim.bp_get_compile_errors (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
animBlueprintstringobrigatório. Anim Blueprint asset path or unique name.

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

anim.bp_implement_interface (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
interfacestringobrigatório. Anim Layer Interface asset (or its generated class name).

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

anim.bp_list (risco 0, smoke)​

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

ArgumentoTipoDescrição
folderstringFolder to search; default "/Game".
skeletonstringOnly Anim Blueprints targeting this skeleton.
nameContainsstringCase-insensitive substring of the asset name.
limitintegerMaximum results; 0 = no limit. Padrão 0.

Retorna: assets, count.

anim.bp_list_layers (risco 0, smoke)​

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

ArgumentoTipoDescrição
animBlueprintstringobrigatório. Anim Blueprint asset path or unique name.

Retorna: layers, count, compileErrors.

anim.bp_list_slots_used (risco 0, smoke)​

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

ArgumentoTipoDescrição
animBlueprintstringobrigatório. Anim Blueprint asset path or unique name.

Retorna: names, count.

anim.bp_list_variables (risco 0, smoke)​

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

ArgumentoTipoDescrição
animBlueprintstringobrigatório. Anim Blueprint asset path or unique name.

Retorna: variables, count, compileErrors.

anim.bp_remove_interface (risco 3, altera, destrutivo, smoke)​

Removes an implemented Anim Layer Interface and its layer graphs.

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
interfacestringobrigatório. Anim Layer Interface asset (or its generated class name).

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

anim.bp_remove_layer (risco 3, altera, destrutivo, smoke)​

Removes an anim layer graph from the Anim Blueprint.

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
namestringobrigatório. Layer name (becomes an anim graph function).
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: layers, count, compileErrors.

anim.bp_remove_variable (risco 3, altera, destrutivo, smoke)​

Removes a member variable.

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
namestringobrigatório.

Retorna: variables, count, compileErrors.

anim.bp_set_class_defaults (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
propertiesarray of UeaKeyValueobrigatório. Property name -> value as text (RootMotionMode, bUseMultiThreadedAnimationUpdate, ...).
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: properties, count, errors.

anim.bp_set_parent_class (risco 2, altera, smoke)​

Sets the parent AnimInstance class and recompiles.

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
parentClassstringobrigatório. New parent class (AnimInstance subclass, native name or Anim Blueprint path).

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

anim.bp_set_preview_mesh (risco 2, altera, smoke)​

Sets the skeletal mesh used by the Persona preview viewport.

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
meshstringobrigatório. Skeletal mesh asset used in the Persona preview.

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

anim.bp_set_root_motion_mode (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
modestringobrigatório. NoRootMotionExtraction, IgnoreRootMotion, RootMotionFromEverything, RootMotionFromMontagesOnly.

Retorna: properties, count, errors.

anim.bp_set_skeleton (risco 3, altera, smoke)​

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

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
skeletonstringobrigatório. New skeleton asset, or an animation asset to take the skeleton from.
compilebooleanRecompile after the change (default true). Padrão true.

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

anim.bs_add_sample (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
blendSpacestringobrigatório.
animstringobrigatório. Animation sequence to place (must use the blend space skeleton).
xnumberPadrão 0.f.
ynumberPadrão 0.f.
rateScalenumberPlayback rate multiplier of the sample. Padrão 1.f.

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

anim.bs_auto_fill_grid (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
blendSpacestringobrigatório.
animsarray of stringobrigatório. Animations to spread over the axis, in order.
axisstringAxis to spread the animations along: 0/x (default) or 1/y.
othernumberPosition on the other axis. Padrão 0.f.
clearbooleanRemove the existing samples first. Padrão false.

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

anim.bs_clear_samples (risco 3, altera, smoke)​

Removes every sample of a blend space.

ArgumentoTipoDescrição
blendSpacestringobrigatório. Blend space asset path or unique name.

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

anim.bs_create (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
folderstringobrigatório. Destination content folder.
namestringobrigatório. Asset name without a path.
skeletonstringSkeleton of the blend space; when empty it is taken from fromAnim or mesh.
fromAnimstringAnimation whose skeleton is used when skeleton is empty.
meshstringSkeletal mesh whose skeleton is used when skeleton and fromAnim are empty.
kindstringKind: 2d (default), 1d, aimOffset2d or aimOffset1d.
axisXUeaBsAxisInfoHorizontal axis settings.
axisYUeaBsAxisInfoVertical axis settings (ignored by the 1D kinds).

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

anim.bs_delete (risco 3, altera, destrutivo, smoke)​

Deletes a blend space asset.

ArgumentoTipoDescrição
blendSpacestringobrigatório. Blend space asset path or unique name.

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

anim.bs_duplicate (risco 2, altera, smoke)​

Copies a blend space into another asset.

ArgumentoTipoDescrição
blendSpacestringobrigatório.
folderstringDestination folder; empty keeps the source folder.
namestringNew asset name; empty appends _Copy.

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

anim.bs_find_sample (risco 0, smoke)​

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

ArgumentoTipoDescrição
blendSpacestringobrigatório.
xnumberPadrão 0.f.
ynumberPadrão 0.f.

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

anim.bs_get (risco 0, smoke)​

Axes, samples and settings of a blend space.

ArgumentoTipoDescrição
blendSpacestringobrigatório. Blend space asset path or unique name.

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

anim.bs_get_sample_weights (risco 0, smoke)​

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

ArgumentoTipoDescrição
blendSpacestringobrigatório.
xnumberPadrão 0.f.
ynumberPadrão 0.f.

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

anim.bs_list (risco 0, smoke)​

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

ArgumentoTipoDescrição
folderstringContent folder to search; empty searches /Game.
skeletonstringOnly blend spaces using this skeleton.
nameContainsstringCase-insensitive substring of the asset name.
limitintegerPadrão 200.

Retorna: blendSpaces, total.

anim.bs_list_samples (risco 0, smoke)​

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

ArgumentoTipoDescrição
blendSpacestringobrigatório. Blend space asset path or unique name.

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

anim.bs_remove_sample (risco 2, altera, smoke)​

Removes one sample by index.

ArgumentoTipoDescrição
blendSpacestringobrigatório.
indexintegerobrigatório.

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

anim.bs_resample (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
blendSpacestringobrigatório. Blend space asset path or unique name.

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

anim.bs_set_axis (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
blendSpacestringobrigatório.
axisstringobrigatório. Axis to change: 0/x or 1/y.
namestringNew display name; empty keeps the current one.
minnumberLowest input value; ignored when equal to max. Padrão 0.f.
maxnumberPadrão 0.f.
gridDivisionsintegerGrid divisions; 0 keeps the current value. Padrão 0.
snapToGridbooleanPadrão false.
wrapInputbooleanWrap the input around the axis limits (5.x only). Padrão false.

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

anim.bs_set_interpolation (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
blendSpacestringobrigatório.
axisstringAxis: 0/x, 1/y or "all".
timenumberSmoothing time in seconds (0 disables input smoothing). Padrão 0.f.
typestringSmoothing type: Averaged, Linear, Cubic, EaseInOut, ExponentialDecay or SpringDamper (5.x).
dampingRationumberDamping ratio of the spring damper type (5.x only). Padrão 0.f.
maxSpeednumberMaximum speed of the smoothed input, 0 = unlimited (5.x only). Padrão 0.f.

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

anim.bs_set_preview_base_pose (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
blendSpacestringobrigatório.
animstringAnimation used as the additive preview base pose; empty clears it.

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

anim.bs_set_sample (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
blendSpacestringobrigatório.
indexintegerobrigatório. Index of the sample as reported by anim.bs_list_samples.
xnumberPadrão 0.f.
ynumberPadrão 0.f.
animstringReplacement animation; empty keeps the current one.
rateScalenumberPlayback rate multiplier; 0 keeps the current one. Padrão 0.f.
movebooleanSet to false to leave the position untouched. Padrão true.

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

anim.bs_set_settings (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
blendSpacestringobrigatório.
axisToScaleAnimationstringAxis whose input scales the animation speed: None, X or Y (5.x only).
targetWeightInterpolationSpeednumberTarget weight interpolation speed per second; negative keeps the current value. Padrão -1.f.
smoothingbooleanEase the target weight interpolation in and out (5.x only). Padrão false.
setSmoothingbooleanApply the smoothing flag (it is a bool, so it needs an explicit opt-in). Padrão false.
matchSyncPhasesbooleanMatch the sync phases of the samples (5.x only). Padrão false.
setMatchSyncPhasesbooleanPadrão false.
notifyTriggerModestringNotify trigger mode: AllAnimations, HighestWeightedAnimation or None.
preferredTriangulationstringPreferred triangulation direction: Tangential, Radial or None (5.x only).

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

anim.bs_validate (risco 0, smoke)​

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

ArgumentoTipoDescrição
blendSpacestringobrigatório. Blend space asset path or unique name.

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

anim.chooser_add_column (risco 2, altera, UE 5.4+, requer plugin Chooser, smoke)​

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

ArgumentoTipoDescrição
typestringobrigatório. Column type: "bool", "float", "enum", "gameplayTag", "objectClass", "object", "name", "outputFloat", ... or a struct path.

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

anim.chooser_add_row (risco 2, altera, UE 5.4+, requer plugin Chooser, smoke)​

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

ArgumentoTipoDescrição
resultstringobrigatório. Asset returned when the row is selected.
cellsarray of stringCell values, in column order (text form).

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

anim.chooser_create (risco 2, altera, UE 5.4+, requer plugin Chooser, smoke)​

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

ArgumentoTipoDescrição
folderstringobrigatório.
namestringobrigatório.
outputTypestringClass of the objects the chooser returns (e.g. "AnimSequence"). Padrão TEXT("AnimSequence").
resultTypestring"object" or "class". Padrão TEXT("object").
contextClassstringClass passed as the evaluation context (optional).

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

anim.chooser_delete (risco 3, altera, destrutivo, UE 5.4+, requer plugin Chooser)​

Deletes a chooser table asset.

ArgumentoTipoDescrição
chooserstringobrigatório. Chooser table asset.

Retorna: database, result, message.

anim.chooser_get (risco 0, UE 5.4+, requer plugin Chooser, smoke)​

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

ArgumentoTipoDescrição
chooserstringobrigatório. Chooser table asset.

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

anim.chooser_list_rows (risco 0, UE 5.4+, requer plugin Chooser, smoke)​

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

ArgumentoTipoDescrição
chooserstringobrigatório. Chooser table asset.

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

anim.chooser_remove_column (risco 3, altera, UE 5.4+, requer plugin Chooser, smoke)​

Removes a column from a chooser table by index.

ArgumentoTipoDescrição
indexintegerobrigatório. Index of the column or row.

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

anim.chooser_remove_row (risco 3, altera, UE 5.4+, requer plugin Chooser, smoke)​

Removes a row from a chooser table by index.

ArgumentoTipoDescrição
indexintegerobrigatório. Index of the column or row.

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

anim.chooser_set_cell (risco 2, altera, UE 5.4+, requer plugin Chooser, smoke)​

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

ArgumentoTipoDescrição
rowintegerobrigatório.
columnintegerobrigatório.
valuestringobrigatório. New cell value in text form.

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

anim.chooser_set_context_class (risco 2, altera, UE 5.4+, requer plugin Chooser, smoke)​

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

ArgumentoTipoDescrição
contextClassstringobrigatório. Class passed as the evaluation context.
replacebooleanReplace the context list instead of appending to it. Padrão true.

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

anim.composite_add_segment (risco 2, altera, smoke)​

Appends an animation to the composite track.

ArgumentoTipoDescrição
compositestringobrigatório.
animstringobrigatório.
startPosnumberStart on the timeline; negative appends after the last segment. Padrão -1.f.
animStartnumberPadrão 0.f.
animEndnumberLast time used from the animation; 0 or negative uses the full length. Padrão 0.f.
playRatenumberPadrão 1.f.
loopCountintegerPadrão 1.

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

anim.composite_create (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
folderstringobrigatório.
namestringobrigatório.
animsarray of stringAnimations appended to the composite track, in order.
skeletonstringSkeleton; derived from the first animation or from mesh when empty.
meshstringSkeletal mesh whose skeleton is used when skeleton and anims are empty.

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

anim.composite_delete (risco 3, altera, destrutivo, smoke)​

Deletes a composite asset.

ArgumentoTipoDescrição
compositestringobrigatório. Composite asset path or unique name.

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

anim.composite_duplicate (risco 2, altera, smoke)​

Copies a composite into another asset.

ArgumentoTipoDescrição
compositestringobrigatório.
folderstring
namestring

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

anim.composite_get (risco 0, smoke)​

Segments, length and skeleton of a composite.

ArgumentoTipoDescrição
compositestringobrigatório. Composite asset path or unique name.

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

anim.composite_list_segments (risco 0, smoke)​

Segments of a composite with their animations and timings.

ArgumentoTipoDescrição
compositestringobrigatório. Composite asset path or unique name.

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

anim.composite_remove_segment (risco 2, altera, smoke)​

Removes one segment from a composite.

ArgumentoTipoDescrição
compositestringobrigatório.
indexintegerobrigatório.

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

anim.composite_set_segment (risco 2, altera, smoke)​

Changes one segment of a composite.

ArgumentoTipoDescrição
compositestringobrigatório.
indexintegerobrigatório.
animstringReplacement animation; empty keeps the current one.
startPosnumberPadrão -1.f.
animStartnumberPadrão -1.f.
animEndnumberPadrão -1.f.
playRatenumberPadrão 0.f.
loopCountintegerPadrão 0.

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

anim.connect (risco 2, altera, 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.

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
fromIdstringobrigatório. Source node (the one producing the pose).
toIdstringobrigatório. Target node.
fromPinstringOutput pin of the source node; empty = its pose output.
toPinstringInput pin of the target node; empty = its first free pose input.
graphstring
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: node, compileErrors, propertyErrors.

anim.connect_to_output (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
nodeIdstringobrigatório.
graphstring
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: node, compileErrors, propertyErrors.

anim.copy_curve (risco 2, altera, smoke)​

Copies a float curve from one sequence to another.

ArgumentoTipoDescrição
fromstringobrigatório. Source sequence.
tostringobrigatório. Destination sequence.
curvestringobrigatório.
newNamestringName of the copy; empty keeps the source name.

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

anim.copy_notifies (risco 2, altera, smoke)​

Copies the notifies of one sequence onto another.

ArgumentoTipoDescrição
fromstringobrigatório. Source sequence.
tostringobrigatório. Destination sequence.
deleteExistingbooleanRemove the notifies already on the destination first. Padrão false.

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

anim.create_from_mesh_pose (risco 2, altera, 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.

ArgumentoTipoDescrição
meshstringobrigatório. Skeletal mesh whose reference pose fills the sequence.
folderstringobrigatório. Destination content folder.
namestringobrigatório. Name of the new sequence.
framesintegerNumber of frames of the new sequence (at least 1); the play length is frames/frameRate seconds. Padrão 1.
frameRatenumberSampling rate of the new sequence in frames per second (30 when omitted). Padrão 30.0.
skeletonstringSkeleton to bind; empty uses the skeleton of the mesh.
newSkeletonPathstringWhen set, the skeleton of the mesh is duplicated to this asset path and used instead.

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

anim.crop (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
animstringobrigatório.
startTimenumberobrigatório. First second kept.
endTimenumberobrigatório. Last second kept.

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

anim.curve_exists (risco 0, smoke)​

Whether a curve exists on a sequence.

ArgumentoTipoDescrição
animstringobrigatório.
curvestringobrigatório. Curve name.
typestringfloat (default), vector or transform.
metadatabooleanCreate the curve as a metadata curve (a constant value, no keys). Padrão false.

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

anim.delete (risco 3, altera, destrutivo, smoke)​

Deletes an animation sequence asset.

ArgumentoTipoDescrição
animstringobrigatório. Animation sequence asset path or unique name.

Retorna: anim, name, message.

anim.disconnect (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
nodeIdstringobrigatório.
pinstringPin to disconnect; empty breaks every link of the node.
graphstring
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: node, compileErrors, propertyErrors.

anim.duplicate (risco 2, altera, smoke)​

Duplicates an animation sequence into a folder.

ArgumentoTipoDescrição
animstringobrigatório.
folderstringDestination folder; empty keeps the source folder.
namestringobrigatório. Name of the new asset.

Retorna: anim, name, message.

anim.export_fbx (risco 0)​

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

ArgumentoTipoDescrição
animstringobrigatório.
filestringobrigatório. Absolute path of the .fbx file to write.
meshstringSkeletal mesh exported with the animation; optional.

Retorna: anim, name, message.

anim.export_graph (risco 0, smoke)​

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

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
graphstringGraph name; empty = "AnimGraph". State machine/state/transition subgraphs are addressable by name too.

Retorna: json, nodeCount, linkCount.

anim.expose_pin (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
nodeIdstringobrigatório.
propertystringobrigatório. Property name of the FAnimNode_* struct ("PlayRate", "Alpha").
exposedbooleanTrue to show the pin, false to hide it. Padrão true.
graphstring
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: node, compileErrors, propertyErrors.

anim.find_anim_blueprints_using (risco 0, smoke)​

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

ArgumentoTipoDescrição
animstringobrigatório. Animation asset (sequence or blend space) to look for.
folderstringContent folder searched ("/Game" when empty).
recursivebooleanPadrão true.
limitintegerPadrão 200.

Retorna: assets, count, scanned, message.

anim.find_blend_spaces_using (risco 0, smoke)​

Blend spaces whose samples reference an animation sequence.

ArgumentoTipoDescrição
animstringobrigatório. Animation asset (sequence or blend space) to look for.
folderstringContent folder searched ("/Game" when empty).
recursivebooleanPadrão true.
limitintegerPadrão 200.

Retorna: assets, count, scanned, message.

anim.find_by_curve (risco 0, smoke)​

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

ArgumentoTipoDescrição
namestringobrigatório. Notify / curve / sync marker name to look for.

Retorna: assets, count, scanned, message.

anim.find_by_notify (risco 0, smoke)​

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

ArgumentoTipoDescrição
namestringobrigatório. Notify / curve / sync marker name to look for.

Retorna: assets, count, scanned, message.

anim.find_by_sync_marker (risco 0, smoke)​

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

ArgumentoTipoDescrição
namestringobrigatório. Notify / curve / sync marker name to look for.

Retorna: assets, count, scanned, message.

anim.find_montages_using (risco 0, smoke)​

Montages whose segments reference an animation sequence.

ArgumentoTipoDescrição
animstringobrigatório. Animation asset (sequence or blend space) to look for.
folderstringContent folder searched ("/Game" when empty).
recursivebooleanPadrão true.
limitintegerPadrão 200.

Retorna: assets, count, scanned, message.

anim.find_nodes (risco 0, smoke)​

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

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
nodeClassstringNode class short or full name; subclasses match.
titleContainsstringCase-insensitive substring of the node title.
graphstringRestrict to one graph.
limitintegerMaximum results; 0 = no limit. Padrão 0.

Retorna: nodes, count.

anim.find_unused (risco 0, smoke)​

Sequences under a folder that no other asset references.

ArgumentoTipoDescrição
folderstringContent folder to scan ("/Game" when empty).
recursivebooleanPadrão true.
limitintegerPadrão 200.

Retorna: unused, count, scanned, message.

anim.get (risco 0, smoke)​

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

ArgumentoTipoDescrição
animstringobrigatório. Animation sequence asset path or unique name.

Retorna: 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 (risco 0, smoke)​

Current additive settings of a sequence.

ArgumentoTipoDescrição
animstringobrigatório. Animation sequence asset path or unique name.

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

anim.get_anim_state (risco 0, requer PIE, requer mundo, smoke)​

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

ArgumentoTipoDescrição
actorstringobrigatório. Actor label, name or class of the actor carrying the skeletal mesh.

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

anim.get_bone_pose (risco 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.

ArgumentoTipoDescrição
animstringobrigatório.
bonesarray of stringBones to sample; empty samples every bone that has a track.
timenumberTime in seconds (ignored when 'frame' is >= 0). Padrão 0.0.
frameintegerFrame index; -1 uses 'time'. Padrão -1.
spacestringlocal (relative to the parent bone, default) or component.

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

anim.get_bone_track_names (risco 0, smoke)​

Names of the bone animation tracks of a sequence.

ArgumentoTipoDescrição
animstringobrigatório. Animation sequence asset path or unique name.

Retorna: anim, tracks, count, message.

anim.get_bone_transform_runtime (risco 0, requer PIE, requer mundo, smoke)​

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

ArgumentoTipoDescrição
bonestringBone name (empty = the root bone of the mesh).
spacestring"world", "component" or "local". Padrão TEXT("world").

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

anim.get_compression (risco 0, smoke)​

Current compression settings and compressed size of a sequence.

ArgumentoTipoDescrição
animstringobrigatório. Animation sequence asset path or unique name.

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

anim.get_curve_keys (risco 0, smoke)​

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

ArgumentoTipoDescrição
animstringobrigatório.
curvestringobrigatório. Curve name.
typestringfloat (default), vector or transform.
metadatabooleanCreate the curve as a metadata curve (a constant value, no keys). Padrão false.

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

anim.get_curve_value (risco 0, requer PIE, requer mundo, smoke)​

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

ArgumentoTipoDescrição
curvestringCurve name (empty lists every active curve).

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

anim.get_frame_at_time (risco 0, smoke)​

Frame index of a time in seconds.

ArgumentoTipoDescrição
animstringobrigatório.
timenumberTime in seconds (anim.get_frame_at_time). Padrão 0.0.
frameintegerFrame index (anim.get_time_at_frame). Padrão 0.

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

anim.get_frame_rate (risco 0, smoke)​

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

ArgumentoTipoDescrição
animstringobrigatório. Animation sequence asset path or unique name.

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

anim.get_graph (risco 0, smoke)​

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

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
graphstringGraph name; empty = "AnimGraph". State machine/state/transition subgraphs are addressable by name too.

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

anim.get_import_settings (risco 0, smoke)​

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

ArgumentoTipoDescrição
animstringobrigatório. Animation sequence asset path or unique name.

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

anim.get_length (risco 0, smoke)​

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

ArgumentoTipoDescrição
animstringobrigatório. Animation sequence asset path or unique name.

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

anim.get_node (risco 0, smoke)​

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

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
nodeIdstringobrigatório. Node GUID, or a title/class name that is unique in the searched graphs.
graphstringRestrict the search to this graph.

Retorna: node, animNodeStruct, properties, bindings.

anim.get_node_class_info (risco 0, smoke)​

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

ArgumentoTipoDescrição
nodeClassstringobrigatório.

Retorna: info, properties, poseInputs, hasPoseOutput.

anim.get_node_properties (risco 0, smoke)​

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

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
nodeIdstringobrigatório. Node GUID, or a title/class name that is unique in the searched graphs.
graphstringRestrict the search to this graph.

Retorna: properties, count, errors, compileErrors.

anim.get_notify_class_info (risco 0, smoke)​

Editable properties of a notify class.

ArgumentoTipoDescrição
classstringobrigatório. Class short name or asset path.

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

anim.get_root_motion (risco 0, smoke)​

Current root motion settings of a sequence.

ArgumentoTipoDescrição
animstringobrigatório. Animation sequence asset path or unique name.

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

anim.get_root_motion_runtime (risco 0, requer PIE, requer mundo, smoke)​

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

ArgumentoTipoDescrição
actorstringobrigatório. Actor label, name or class of the actor carrying the skeletal mesh.

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

anim.get_skeleton (risco 0, smoke)​

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

ArgumentoTipoDescrição
animstringobrigatório. Animation sequence asset path or unique name.

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

anim.get_socket_transform_runtime (risco 0, requer PIE, requer mundo, smoke)​

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

ArgumentoTipoDescrição
socketstringSocket or bone name (empty = the root bone of the mesh).
spacestring"world", "component" or "local". Padrão TEXT("world").

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

anim.get_stats (risco 0, smoke)​

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

ArgumentoTipoDescrição
animstringobrigatório. Animation sequence asset path or unique name.

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

anim.get_time_at_frame (risco 0, smoke)​

Time in seconds of a frame index.

ArgumentoTipoDescrição
animstringobrigatório.
timenumberTime in seconds (anim.get_frame_at_time). Padrão 0.0.
frameintegerFrame index (anim.get_time_at_frame). Padrão 0.

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

anim.get_unique_marker_names (risco 0, smoke)​

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

ArgumentoTipoDescrição
animstringobrigatório. Animation sequence asset path or unique name.

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

anim.ikrig_add_chain (risco 2, altera, UE 5.5+, requer plugin IKRig, smoke)​

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

ArgumentoTipoDescrição
namestringobrigatório. Chain name (e.g. LeftArm).
startBonestringobrigatório.
endBonestringobrigatório.
goalstringOptional IK goal driving the chain.

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

anim.ikrig_add_goal (risco 2, altera, UE 5.5+, requer plugin IKRig, smoke)​

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

ArgumentoTipoDescrição
namestringobrigatório. Goal name (made unique by the rig).
bonestringobrigatório. Bone the goal drives.

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

anim.ikrig_add_solver (risco 2, altera, UE 5.6+, requer plugin IKRig, smoke)​

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

ArgumentoTipoDescrição
typestringobrigatório. Solver type: a short name ("FullBodyIK", "LimbIK", "PoleSolver", "SetTransform", "BodyMover") or a full script-struct path.

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

anim.ikrig_auto_chains (risco 2, altera, UE 5.6+, requer 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.

ArgumentoTipoDescrição
ikRigstringobrigatório. IK rig asset (path or unique name).

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

anim.ikrig_auto_fbik (risco 2, altera, UE 5.6+, requer plugin IKRig, smoke)​

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

ArgumentoTipoDescrição
ikRigstringobrigatório. IK rig asset (path or unique name).

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

anim.ikrig_connect_goal (risco 2, altera, UE 5.6+, requer plugin IKRig, smoke)​

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

ArgumentoTipoDescrição
solverIndexintegerobrigatório. Index of the solver in the stack.

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

anim.ikrig_create (risco 2, altera, UE 5.5+, requer plugin IKRig, smoke)​

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

ArgumentoTipoDescrição
folderstringobrigatório. Destination content folder.
namestringobrigatório. Asset name of the new IK rig.
meshstringobrigatório. Skeletal mesh the rig is built from (its skeleton supplies the bone hierarchy).

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

anim.ikrig_delete (risco 3, altera, destrutivo, UE 5.5+, requer plugin IKRig)​

Deletes an IK Rig asset.

ArgumentoTipoDescrição
ikRigstringobrigatório. IK rig asset (path or unique name).

Retorna: deleted, message.

anim.ikrig_disconnect_goal (risco 2, altera, UE 5.6+, requer plugin IKRig, smoke)​

Disconnects an IK goal from a solver.

ArgumentoTipoDescrição
solverIndexintegerobrigatório. Index of the solver in the stack.

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

anim.ikrig_get (risco 0, UE 5.5+, requer plugin IKRig, smoke)​

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

ArgumentoTipoDescrição
ikRigstringobrigatório. IK rig asset (path or unique name).

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

anim.ikrig_list (risco 0, UE 5.5+, requer plugin IKRig, smoke)​

Lists the IK Rig assets of a folder.

ArgumentoTipoDescrição
folderstringContent folder to scan ("/Game" when empty).
recursivebooleanPadrão true.
limitintegerPadrão 100.

Retorna: ikRigs, count, message.

anim.ikrig_list_bones (risco 0, UE 5.5+, requer plugin IKRig, smoke)​

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

ArgumentoTipoDescrição
ikRigstringobrigatório. IK rig asset (path or unique name).

Retorna: bones, excludedBones, count, message.

anim.ikrig_list_chains (risco 0, UE 5.5+, requer plugin IKRig, smoke)​

Lists the retarget chains of an IK Rig.

ArgumentoTipoDescrição
ikRigstringobrigatório. IK rig asset (path or unique name).

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

anim.ikrig_list_goals (risco 0, UE 5.5+, requer plugin IKRig, smoke)​

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

ArgumentoTipoDescrição
ikRigstringobrigatório. IK rig asset (path or unique name).

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

anim.ikrig_list_solver_types (risco 0, UE 5.6+, requer plugin IKRig, smoke)​

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

ArgumentoTipoDescrição
folderstringContent folder to scan ("/Game" when empty).
recursivebooleanPadrão true.
limitintegerPadrão 100.

Retorna: types, count, message.

anim.ikrig_list_solvers (risco 0, UE 5.6+, requer plugin IKRig, smoke)​

Lists the solver stack of an IK Rig.

ArgumentoTipoDescrição
ikRigstringobrigatório. IK rig asset (path or unique name).

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

anim.ikrig_remove_chain (risco 3, altera, UE 5.5+, requer plugin IKRig, smoke)​

Removes a retarget chain.

ArgumentoTipoDescrição
chainstringobrigatório. Existing chain name.

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

anim.ikrig_remove_goal (risco 3, altera, UE 5.5+, requer plugin IKRig, smoke)​

Removes an IK goal.

ArgumentoTipoDescrição
goalstringobrigatório. Existing goal name.

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

anim.ikrig_remove_solver (risco 3, altera, UE 5.6+, requer plugin IKRig, smoke)​

Removes a solver from the stack by index.

ArgumentoTipoDescrição
indexintegerobrigatório. Index in the solver stack.

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

anim.ikrig_rename_chain (risco 2, altera, UE 5.5+, requer plugin IKRig, smoke)​

Renames a retarget chain.

ArgumentoTipoDescrição
newNamestringobrigatório.

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

anim.ikrig_rename_goal (risco 2, altera, UE 5.5+, requer plugin IKRig, smoke)​

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

ArgumentoTipoDescrição
newNamestringobrigatório. New goal name.

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

anim.ikrig_set_bone_excluded (risco 2, altera, UE 5.5+, requer plugin IKRig, smoke)​

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

ArgumentoTipoDescrição
excludedbooleanExclude the bone from every solver. Padrão true.

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

anim.ikrig_set_chain_goal (risco 2, altera, UE 5.5+, requer plugin IKRig, smoke)​

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

ArgumentoTipoDescrição
goalstringGoal name, or empty to clear.

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

anim.ikrig_set_goal_bone (risco 2, altera, UE 5.5+, requer plugin IKRig, smoke)​

Moves an IK goal to another bone.

ArgumentoTipoDescrição
bonestringobrigatório. Bone the goal moves to.

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

anim.ikrig_set_goal_settings (risco 2, altera, UE 5.5+, requer plugin IKRig, smoke)​

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

ArgumentoTipoDescrição
positionAlphanumberPosition blend 0..1 (negative = leave unchanged). Padrão -1.0.
rotationAlphanumberRotation blend 0..1 (negative = leave unchanged). Padrão -1.0.
exposePositionstring"true"/"false" to change, empty to leave alone.
exposeRotationstring
sizeMultipliernumberViewport size multiplier (negative = leave unchanged). Padrão -1.0.

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

anim.ikrig_set_mesh (risco 2, altera, UE 5.5+, requer plugin IKRig, smoke)​

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

ArgumentoTipoDescrição
meshstringobrigatório. Skeletal mesh to drive the rig with.

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

anim.ikrig_set_retarget_root (risco 2, altera, UE 5.5+, requer plugin IKRig, smoke)​

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

ArgumentoTipoDescrição
bonestringobrigatório. Bone name.

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

anim.ikrig_set_solver_enabled (risco 2, altera, UE 5.6+, requer plugin IKRig, smoke)​

Enables or disables a solver.

ArgumentoTipoDescrição
enabledbooleanPadrão true.

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

anim.ikrig_set_solver_root_bone (risco 2, altera, UE 5.6+, requer plugin IKRig, smoke)​

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

ArgumentoTipoDescrição
bonestringobrigatório. Root (start) bone of the solver.

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

anim.ikrig_set_solver_setting (risco 2, altera, UE 5.6+, requer plugin IKRig, smoke)​

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

ArgumentoTipoDescrição
propertystringobrigatório. Property of the solver struct (dotted paths allowed).
valuestringobrigatório. New value in text form.

Retorna: index, type, settings, message.

anim.import_graph (risco 2, altera)​

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

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
jsonstringobrigatório. JSON text in the shape produced by anim.export_graph.
graphstringTarget graph; empty = "AnimGraph".
replacebooleanDelete the existing nodes (except the result node) before importing. Padrão false.
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: nodes, count.

anim.insert_frames (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
animstringobrigatório.
startFrameintegerobrigatório. First frame of the change.
countintegerobrigatório. Number of frames inserted or removed.

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

anim.list (risco 0, smoke)​

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

ArgumentoTipoDescrição
folderstringContent folder to search ("/Game" when empty).
skeletonstringKeep only animations bound to this skeleton.
classFilterstringsequence (default), montage, composite, blendSpace, poseAsset or any.
nameContainsstringKeep only assets whose name contains this text.
recursivebooleanSearch sub-folders too. Padrão true.
limitintegerMaximum number of assets returned. Padrão 100.

Retorna: anims, count, message.

anim.list_bindings (risco 0, smoke)​

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

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
nodeIdstringNode id; empty lists the bindings of every anim graph node.
graphstring

Retorna: bindings, count, compileErrors.

anim.list_bone_tracks (risco 0, smoke)​

Bone animation tracks of a sequence.

ArgumentoTipoDescrição
animstringobrigatório. Animation sequence asset path or unique name.

Retorna: anim, tracks, count, message.

anim.list_by_skeleton (risco 0, smoke)​

Lists every animation asset bound to a skeleton.

ArgumentoTipoDescrição
skeletonstringobrigatório. Skeleton asset path or unique name.
classFilterstringsequence (default), montage, composite, blendSpace, poseAsset or any.
folderstringContent folder to search ("/Game" when empty).
limitintegerPadrão 100.

Retorna: anims, count, message.

anim.list_curves (risco 0, smoke)​

Curves of a sequence with their type and key count.

ArgumentoTipoDescrição
animstringobrigatório.
typestringfloat (default), vector, transform or all.

Retorna: anim, curves, count, message.

anim.list_graph_nodes (risco 0, smoke)​

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

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
graphstringGraph name; empty = "AnimGraph". State machine/state/transition subgraphs are addressable by name too.

Retorna: nodes, count.

anim.list_metadata (risco 0, smoke)​

Metadata objects attached to a sequence, with their properties.

ArgumentoTipoDescrição
animstringobrigatório. Animation sequence asset path or unique name.

Retorna: anim, metaData, count, message.

anim.list_metadata_classes (risco 0, smoke)​

Available UAnimMetaData subclasses.

ArgumentoTipoDescrição
nameContainsstringKeep only classes whose name contains this text.
includeStatesbooleanInclude UAnimNotifyState subclasses too. Padrão true.
limitintegerPadrão 200.

Retorna: classes, count, message.

anim.list_modifier_classes (risco 0, smoke)​

Available UAnimationModifier subclasses (native and blueprint).

ArgumentoTipoDescrição
nameContainsstringKeep only classes whose name contains this text.
includeStatesbooleanInclude UAnimNotifyState subclasses too. Padrão true.
limitintegerPadrão 200.

Retorna: classes, count, message.

anim.list_node_classes (risco 0, smoke)​

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

ArgumentoTipoDescrição
nameContainsstringCase-insensitive substring filter on the class or short name.
limitintegerMaximum results; 0 = no limit. Padrão 0.

Retorna: classes, count.

anim.list_notifies (risco 0, smoke)​

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

ArgumentoTipoDescrição
animstringobrigatório.
trackstringKeep only the notifies of this notify track.

Retorna: anim, notifies, count, message.

anim.list_notify_classes (risco 0, smoke)​

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

ArgumentoTipoDescrição
nameContainsstringKeep only classes whose name contains this text.
includeStatesbooleanInclude UAnimNotifyState subclasses too. Padrão true.
limitintegerPadrão 200.

Retorna: classes, count, message.

anim.list_notify_tracks (risco 0, smoke)​

Notify tracks of a sequence.

ArgumentoTipoDescrição
animstringobrigatório. Animation sequence asset path or unique name.

Retorna: anim, tracks, count, message.

anim.list_sync_markers (risco 0, smoke)​

Sync markers of a sequence with their time and track.

ArgumentoTipoDescrição
animstringobrigatório. Animation sequence asset path or unique name.

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

anim.make_source_sequence (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
folderstringobrigatório. Destination content folder.
namestringobrigatório. Asset name without a path.
meshstringobrigatório. Skeletal mesh whose reference pose and skeleton are used.

Retorna: anim, skeleton, length, message.

anim.montage_add_branching_point (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
montagestringobrigatório.
namestringobrigatório. Notify name (the anim blueprint event is AnimNotify_).
timenumberTrigger time in seconds. Padrão 0.f.
trackstringNotify track; created when it does not exist.
notifyClassstringUAnimNotify or UAnimNotifyState subclass to instantiate; empty creates a plain named notify.
durationnumberDuration in seconds; greater than zero makes it a notify state. Padrão 0.f.
branchingPointbooleanFire as a branching point (evaluated immediately instead of being queued). Padrão false.

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

anim.montage_add_notify (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
montagestringobrigatório.
namestringobrigatório. Notify name (the anim blueprint event is AnimNotify_).
timenumberTrigger time in seconds. Padrão 0.f.
trackstringNotify track; created when it does not exist.
notifyClassstringUAnimNotify or UAnimNotifyState subclass to instantiate; empty creates a plain named notify.
durationnumberDuration in seconds; greater than zero makes it a notify state. Padrão 0.f.
branchingPointbooleanFire as a branching point (evaluated immediately instead of being queued). Padrão false.

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

anim.montage_add_notify_track (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
montagestringobrigatório.
trackstringobrigatório. Notify track name.

Retorna: 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 (risco 2, altera, smoke)​

Adds a named section starting at a given time.

ArgumentoTipoDescrição
montagestringobrigatório.
namestringobrigatório. Section name, unique in the montage.
timenumberStart time in seconds (clamped to the montage length). Padrão 0.f.

Retorna: 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 (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
montagestringobrigatório.
slotstringSlot to append to; empty uses the first slot.
animstringobrigatório.
startPosnumberStart on the montage timeline; negative appends after the last segment. Padrão -1.f.
animStartnumberFirst time used from the animation. Padrão 0.f.
animEndnumberLast time used from the animation; 0 or negative uses the full length. Padrão 0.f.
playRatenumberPadrão 1.f.
loopCountintegerPadrão 1.

Retorna: 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 (risco 2, altera, smoke)​

Adds an empty slot track to a montage.

ArgumentoTipoDescrição
montagestringobrigatório.
slotstringobrigatório. Slot name (the anim graph Slot node must use the same name).

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

Clears every next-section link of the montage.

ArgumentoTipoDescrição
montagestringobrigatório. Montage asset path or unique name.

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

anim.montage_create (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
folderstringobrigatório.
namestringobrigatório.
animstringAnimation placed in the first slot; may be empty for an empty montage.
skeletonstringSkeleton of the montage; derived from anim or mesh when empty.
meshstringSkeletal mesh whose skeleton is used when skeleton and anim are empty.
slotstringSlot name of the first track; defaults to DefaultSlot.
blendInnumberBlend in time in seconds. Padrão 0.25f.
blendOutnumberBlend out time in seconds. Padrão 0.25f.

Retorna: 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 (risco 2, altera, 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.

ArgumentoTipoDescrição
folderstringobrigatório.
namestringobrigatório.
animsarray of stringobrigatório. Animations appended one after another, in order.
slotstringSlot of the track; defaults to DefaultSlot.
sectionsPerAnimbooleanCreate one section per animation (named or after the animation). Padrão true.
sectionPrefixstringPrefix of the generated section names; empty uses the animation names.
linkSectionsbooleanLink every section to the next one so the montage plays through. Padrão true.
blendInnumberPadrão 0.25f.
blendOutnumberPadrão 0.25f.

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

anim.montage_delete (risco 3, altera, destrutivo, smoke)​

Deletes a montage asset.

ArgumentoTipoDescrição
montagestringobrigatório. Montage asset path or unique name.

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

anim.montage_duplicate (risco 2, altera, smoke)​

Copies a montage into another asset.

ArgumentoTipoDescrição
montagestringobrigatório.
folderstringDestination folder; empty keeps the source folder.
namestringNew name; empty appends _Copy.

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

anim.montage_get (risco 0, smoke)​

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

ArgumentoTipoDescrição
montagestringobrigatório. Montage asset path or unique name.

Retorna: 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 (risco 0, smoke)​

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

ArgumentoTipoDescrição
montagestringobrigatório. Montage asset path or unique name.

Retorna: 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 (risco 0, smoke)​

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

ArgumentoTipoDescrição
montagestringobrigatório. Montage asset path or unique name.

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

anim.montage_jump_to_section (risco 1, requer PIE, requer mundo, smoke)​

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

ArgumentoTipoDescrição
montagestringMontage to address (empty = the first active montage).
sectionstringSection name (empty = the first section of the montage).

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

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

ArgumentoTipoDescrição
montagestringobrigatório.
fromstringobrigatório. Section the link starts from.
tostringSection played next; empty unlinks (the montage stops after "from").

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

anim.montage_list (risco 0, smoke)​

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

ArgumentoTipoDescrição
folderstringContent folder to search; empty searches /Game.
skeletonstringOnly montages using this skeleton.
nameContainsstring
limitintegerPadrão 200.

Retorna: montages, total.

anim.montage_list_notifies (risco 0, smoke)​

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

ArgumentoTipoDescrição
montagestringobrigatório. Montage asset path or unique name.

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

anim.montage_list_notify_tracks (risco 0, smoke)​

Notify tracks of a montage.

ArgumentoTipoDescrição
montagestringobrigatório. Montage asset path or unique name.

Retorna: 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 (risco 0, smoke)​

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

ArgumentoTipoDescrição
montagestringobrigatório. Montage asset path or unique name.

Retorna: 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 (risco 0, smoke)​

Segments of a montage with their animations and timings.

ArgumentoTipoDescrição
montagestringobrigatório. Montage asset path or unique name.

Retorna: 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 (risco 0, smoke)​

Slot names used by a montage.

ArgumentoTipoDescrição
montagestringobrigatório. Montage asset path or unique name.

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

anim.montage_play (risco 1, requer PIE, requer mundo, smoke)​

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

ArgumentoTipoDescrição
montagestringobrigatório.
playRatenumberPadrão 1.0.
sectionstringSection to start from (empty = the first section).

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

anim.montage_remove_all_notifies (risco 3, altera, smoke)​

Removes every notify of the montage.

ArgumentoTipoDescrição
montagestringobrigatório. Montage asset path or unique name.

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

anim.montage_remove_notifies_by_name (risco 2, altera, smoke)​

Removes every notify with a given name.

ArgumentoTipoDescrição
montagestringobrigatório.
namestringobrigatório.

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

anim.montage_remove_notify (risco 2, altera, smoke)​

Removes one notify by index.

ArgumentoTipoDescrição
montagestringobrigatório.
indexintegerobrigatório. Index as reported by anim.montage_list_notifies.

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

anim.montage_remove_section (risco 2, altera, smoke)​

Removes a section.

ArgumentoTipoDescrição
montagestringobrigatório.
namestringobrigatório.

Retorna: 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 (risco 2, altera, smoke)​

Removes one segment from a slot track.

ArgumentoTipoDescrição
montagestringobrigatório.
slotstringSlot of the segment; empty uses the first slot.
indexintegerobrigatório.

Retorna: 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 (risco 3, altera, smoke)​

Removes a slot track and every segment in it.

ArgumentoTipoDescrição
montagestringobrigatório.
slotstringobrigatório. Slot name (the anim graph Slot node must use the same name).

Retorna: 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 (risco 2, altera, smoke)​

Renames a section and fixes the links pointing at it.

ArgumentoTipoDescrição
montagestringobrigatório.
namestringobrigatório.
newNamestringobrigatório.

Retorna: 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 (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
montagestringobrigatório.
enabledbooleanPadrão true.

Retorna: 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 (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
montagestringobrigatório.
blendInnumberBlend in time in seconds; negative keeps it. Padrão -1.f.
blendOutnumberBlend out time in seconds; negative keeps it. Padrão -1.f.
blendInCurvestringBlend in option: Linear, Cubic, HermiteCubic, Sinusoidal, QuadraticInOut, CircularIn...
blendOutCurvestringBlend out option, same values as blendInCurve.
blendOutTriggerTimenumberSeconds before the end at which the blend out starts; below -1 keeps the current value. Padrão -2.f.

Retorna: 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 (risco 2, altera, 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.

ArgumentoTipoDescrição
montagestringobrigatório.
sidestringWhich blend to change: in, out or both.
blendProfilestringBlend profile of the skeleton (by name or path); empty clears it.

Retorna: 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 (risco 1, requer PIE, requer mundo, smoke)​

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

ArgumentoTipoDescrição
montagestring
sectionstringSection whose successor is being set (empty = the first section).
nextSectionstringSection played next (empty = the first section).

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

anim.montage_set_root_motion (risco 2, altera, smoke)​

Whether the montage drives root motion translation and rotation.

ArgumentoTipoDescrição
montagestringobrigatório.
translationbooleanLet the montage drive root motion translation. Padrão true.
rotationbooleanLet the montage drive root motion rotation. Padrão true.

Retorna: 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 (risco 2, altera, smoke)​

Moves a section to another time.

ArgumentoTipoDescrição
montagestringobrigatório.
namestringobrigatório.
timenumberobrigatório. New start time in seconds.

Retorna: 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 (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
montagestringobrigatório.
slotstringSlot of the segment; empty uses the first slot.
indexintegerobrigatório.
animstringReplacement animation; empty keeps the current one.
startPosnumberNew start on the timeline; negative keeps it. Padrão -1.f.
animStartnumberNew animation start time; negative keeps it. Padrão -1.f.
animEndnumberNew animation end time; negative keeps it. Padrão -1.f.
playRatenumberNew play rate; 0 keeps it. Padrão 0.f.
loopCountintegerNew loop count; 0 keeps it. Padrão 0.

Retorna: 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 (risco 2, altera, smoke)​

Sync group and the slot index that drives it.

ArgumentoTipoDescrição
montagestringobrigatório.
groupstringSync group name; empty clears the group.
slotIndexintegerIndex of the slot track that drives the sync group. Padrão 0.

Retorna: 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 (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
montagestringobrigatório.
curveNamestringName of the float curve driving the stretch; empty disables it.
samplingRatenumberSampling rate of the baked curve; 0 keeps the current value. Padrão 0.f.
curveValueMinPrecisionnumberMinimum precision of the curve value; 0 keeps the current value. Padrão 0.f.

Retorna: 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 (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
montagestringobrigatório. Montage asset path or unique name.

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

anim.montage_stop (risco 1, requer PIE, requer mundo, smoke)​

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

ArgumentoTipoDescrição
blendOutnumberBlend out time in seconds. Padrão 0.25.
montagestringMontage to stop (empty = every montage).

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

anim.montage_validate (risco 0, smoke)​

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

ArgumentoTipoDescrição
montagestringobrigatório. Montage asset path or unique name.

Retorna: montage, valid, issues, message.

anim.move_node (risco 2, altera, smoke)​

Moves a node to a new position in its graph.

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
nodeIdstringobrigatório.
xintegerobrigatório.
yintegerobrigatório.
graphstring

Retorna: node, compileErrors, propertyErrors.

anim.move_notify (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
animstringobrigatório.
indexintegerobrigatório. Index in the list returned by anim.list_notifies.
timenumberNew trigger time in seconds (anim.move_notify). Padrão 0.0.
trackstringNew notify track (anim.move_notify); empty keeps the current one.
propertiesarray of UeaKeyValueProperties applied to the notify object (anim.set_notify_property).

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

anim.play (risco 1, requer PIE, requer mundo, smoke)​

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

ArgumentoTipoDescrição
animstringobrigatório. Animation sequence to play.
loopbooleanPadrão true.
playRatenumberPadrão 1.0.
positionnumberStart position in seconds. Padrão 0.0.

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

anim.pose_add_from_animation (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
posestringobrigatório.
animstringAnimation sampled at "time"; empty captures the reference pose of the mesh.
timenumberTime in seconds sampled from the animation. Padrão 0.f.
namestringName of the new pose; empty keeps the generated unique name.
meshstringSkeletal mesh used to evaluate the pose; defaults to the preview mesh of the skeleton.

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

anim.pose_create (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
folderstringobrigatório.
namestringobrigatório.
animstringAnimation the poses are baked from (one pose per frame); empty creates an empty pose asset.
skeletonstringSkeleton of the asset; derived from anim or mesh when empty.
meshstringSkeletal mesh whose skeleton is used, and whose reference pose is captured when anim is empty.
poseNamesarray of stringNames given to the generated poses, in frame order.

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

anim.pose_delete (risco 3, altera, destrutivo, smoke)​

Deletes a pose asset.

ArgumentoTipoDescrição
posestringobrigatório. Pose asset path or unique name.

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

anim.pose_duplicate (risco 2, altera, smoke)​

Copies a pose asset into another asset.

ArgumentoTipoDescrição
posestringobrigatório.
folderstringDestination folder; empty keeps the source folder.
namestringNew name; empty appends _Copy.

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

anim.pose_get (risco 0, smoke)​

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

ArgumentoTipoDescrição
posestringobrigatório. Pose asset path or unique name.

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

anim.pose_list (risco 0, smoke)​

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

ArgumentoTipoDescrição
folderstringContent folder to search; empty searches /Game.
skeletonstringOnly pose assets using this skeleton.
nameContainsstring
limitintegerPadrão 200.

Retorna: poseAssets, total.

anim.pose_list_curves (risco 0, smoke)​

Curve names driven by the poses.

ArgumentoTipoDescrição
posestringobrigatório. Pose asset path or unique name.

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

anim.pose_list_poses (risco 0, smoke)​

Pose names stored in the asset.

ArgumentoTipoDescrição
posestringobrigatório. Pose asset path or unique name.

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

anim.pose_list_tracks (risco 0, smoke)​

Bone tracks the poses write to.

ArgumentoTipoDescrição
posestringobrigatório. Pose asset path or unique name.

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

anim.pose_remove (risco 2, altera, smoke)​

Removes poses by name.

ArgumentoTipoDescrição
posestringobrigatório.
namesarray of stringobrigatório. Pose names to delete.

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

anim.pose_rename (risco 2, altera, smoke)​

Renames one pose.

ArgumentoTipoDescrição
posestringobrigatório.
namestringobrigatório. Current pose name.
newNamestringobrigatório.

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

anim.pose_set_additive (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
posestringobrigatório.
additivebooleanobrigatório. True stores the poses as additive, false converts them back to full poses.
basePosestringPose used as the additive base; empty uses the reference pose.

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

anim.pose_update_from_animation (risco 2, altera, smoke)​

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

ArgumentoTipoDescrição
posestringobrigatório.
animstringobrigatório. Animation the poses are re-baked from.

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

anim.pose_validate (risco 0, smoke)​

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

ArgumentoTipoDescrição
posestringobrigatório. Pose asset path or unique name.

Retorna: pose, valid, issues, message.

anim.ps_add_animation (risco 2, altera, UE 5.7+, requer plugin PoseSearch, smoke)​

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

ArgumentoTipoDescrição
animstringobrigatório. Animation sequence, composite, montage or blend space to index.
samplingStartnumberStart of the sampled range, relative to the asset start (0 = whole asset). Padrão 0.0.
samplingEndnumberEnd of the sampled range, relative to the asset end (0 = whole asset). Padrão 0.0.
useSingleSamplebooleanIndex a single blend space sample instead of the whole grid. Padrão false.
blendParamXnumberBlend space coordinates used when useSingleSample is set. Padrão 0.0.
blendParamYnumberPadrão 0.0.

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

anim.ps_add_blend_space (risco 2, altera, UE 5.7+, requer plugin PoseSearch, smoke)​

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

ArgumentoTipoDescrição
animstringobrigatório. Animation sequence, composite, montage or blend space to index.
samplingStartnumberStart of the sampled range, relative to the asset start (0 = whole asset). Padrão 0.0.
samplingEndnumberEnd of the sampled range, relative to the asset end (0 = whole asset). Padrão 0.0.
useSingleSamplebooleanIndex a single blend space sample instead of the whole grid. Padrão false.
blendParamXnumberBlend space coordinates used when useSingleSample is set. Padrão 0.0.
blendParamYnumberPadrão 0.0.

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

anim.ps_add_channel (risco 2, altera, UE 5.7+, requer plugin PoseSearch, smoke)​

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

ArgumentoTipoDescrição
typestringobrigatório. Channel type: "pose", "trajectory", "position", "heading", "velocity", "phase", "curve" or a class path.
bonesarray of stringBones sampled by a "pose" channel.
weightnumberChannel weight. Padrão 1.0.
propertiesarray of UeaKeyValueExtra property assignments on the channel (dotted paths allowed, e.g. "Bone.BoneName").

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

anim.ps_build (risco 2, altera, UE 5.7+, requer plugin PoseSearch, smoke)​

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

ArgumentoTipoDescrição
databasestringobrigatório. Pose search database asset.

Retorna: database, result, message.

anim.ps_create_database (risco 2, altera, UE 5.7+, requer plugin PoseSearch, smoke)​

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

ArgumentoTipoDescrição
folderstringobrigatório.
namestringobrigatório.
schemastringobrigatório. Schema describing the features the database indexes.

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

anim.ps_create_normalization_set (risco 2, altera, UE 5.7+, requer plugin PoseSearch, smoke)​

Creates a normalization set so several databases share one cost normalisation.

ArgumentoTipoDescrição
folderstringobrigatório.
namestringobrigatório.
databasesarray of stringDatabases normalised together.

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

anim.ps_create_schema (risco 2, altera, UE 5.7+, requer plugin PoseSearch, smoke)​

Creates a pose search schema for a skeleton (add channels next with anim.ps_add_channel).

ArgumentoTipoDescrição
folderstringobrigatório.
namestringobrigatório.
skeletonstringobrigatório. Skeleton the schema samples.
sampleRateintegerSampling rate in Hz. Padrão 30.
mirrorDataTablestringMirror data table (needed for mirrored matching).

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

anim.ps_delete_database (risco 3, altera, destrutivo, UE 5.7+, requer plugin PoseSearch)​

Deletes a pose search database asset.

ArgumentoTipoDescrição
databasestringobrigatório. Pose search database asset.

Retorna: database, result, message.

anim.ps_delete_schema (risco 3, altera, destrutivo, UE 5.7+, requer plugin PoseSearch)​

Deletes a pose search schema asset.

ArgumentoTipoDescrição
schemastringobrigatório. Pose search schema asset.

Retorna: database, result, message.

anim.ps_get_database (risco 0, UE 5.7+, requer plugin PoseSearch, smoke)​

Database state: schema, normalization set, indexed animations and settings.

ArgumentoTipoDescrição
databasestringobrigatório. Pose search database asset.

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

anim.ps_get_schema (risco 0, UE 5.7+, requer plugin PoseSearch, smoke)​

Schema state: skeleton, sample rate, channels and settings.

ArgumentoTipoDescrição
schemastringobrigatório. Pose search schema asset.

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

anim.ps_list_animations (risco 0, UE 5.7+, requer plugin PoseSearch, smoke)​

Lists the animations indexed by a database.

ArgumentoTipoDescrição
databasestringobrigatório. Pose search database asset.

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

anim.ps_remove_animation (risco 3, altera, UE 5.7+, requer plugin PoseSearch, smoke)​

Removes an indexed animation from a database by index.

ArgumentoTipoDescrição
indexintegerobrigatório. Index of the animation entry.

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

anim.ps_remove_channel (risco 3, altera, UE 5.7+, requer plugin PoseSearch, smoke)​

Removes a feature channel from a schema by index.

ArgumentoTipoDescrição
indexintegerobrigatório. Index of the channel in the schema.

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

anim.ps_set_database_settings (risco 2, altera, UE 5.7+, requer plugin PoseSearch, smoke)​

Reads or changes the database settings (cost biases, search mode, KD-tree, normalization set).

ArgumentoTipoDescrição
propertiesarray of UeaKeyValueProperty assignments on the database; empty lists the current values.
normalizationSetstringNormalization set asset (optional).

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

anim.ps_set_schema_settings (risco 2, altera, UE 5.7+, requer plugin PoseSearch, smoke)​

Reads or changes the schema settings (sample rate, permutations, padding, data preprocessor).

ArgumentoTipoDescrição
propertiesarray of UeaKeyValueProperty assignments on the schema; empty lists the current values.

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

anim.record_from_actor (risco 2, altera, requer PIE, requer mundo)​

Starts recording the pose of a PIE actor into a new sequence. Not smoke-tested: it needs a running PIE session.

ArgumentoTipoDescrição
actorstringobrigatório. Actor with a skeletal mesh component, in the running PIE world.
folderstringobrigatório. Destination content folder.
namestringobrigatório. Name of the recorded sequence.
durationnumberMaximum recording length in seconds. Padrão 5.0.
recordInWorldSpacebooleanRecord in world space instead of component space. Padrão false.
removeRootAnimationbooleanDrop the root bone animation. Padrão false.

Retorna: actor, anim, recording, message.

anim.reimport (risco 3, altera)​

Reimports a sequence from its source file (or from the file given). Not smoke-tested: the sandbox sequence has no source file.

ArgumentoTipoDescrição
animstringobrigatório.
filestringSource file; empty uses the stored one.

Retorna: anim, name, message.

anim.remove_all_bone_tracks (risco 3, altera, destrutivo, smoke)​

Removes every bone animation track of a sequence.

ArgumentoTipoDescrição
animstringobrigatório. Animation sequence asset path or unique name.

Retorna: anim, tracks, count, message.

anim.remove_all_curves (risco 3, altera, destrutivo, smoke)​

Removes every curve of a sequence.

ArgumentoTipoDescrição
animstringobrigatório. Animation sequence asset path or unique name.

Retorna: anim, curves, count, message.

anim.remove_all_notifies (risco 3, altera, destrutivo, smoke)​

Removes every notify of a sequence.

ArgumentoTipoDescrição
animstringobrigatório. Animation sequence asset path or unique name.

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

anim.remove_all_sync_markers (risco 3, altera, destrutivo, smoke)​

Removes every sync marker of a sequence.

ArgumentoTipoDescrição
animstringobrigatório. Animation sequence asset path or unique name.

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

anim.remove_bone_track (risco 3, altera, smoke)​

Removes the animation track of a bone (and optionally of its children). 'bone' accepts a name or a track index.

ArgumentoTipoDescrição
animstringobrigatório.
bonestringobrigatório.
includeChildrenbooleanAlso remove the tracks of the child bones. Padrão true.

Retorna: anim, tracks, count, message.

anim.remove_curve (risco 3, altera, smoke)​

Removes a curve from a sequence.

ArgumentoTipoDescrição
animstringobrigatório.
curvestringobrigatório. Curve name.
typestringfloat (default), vector or transform.
metadatabooleanCreate the curve as a metadata curve (a constant value, no keys). Padrão false.

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

anim.remove_frames (risco 3, altera, smoke)​

Removes frames from a sequence.

ArgumentoTipoDescrição
animstringobrigatório.
startFrameintegerobrigatório. First frame of the change.
countintegerobrigatório. Number of frames inserted or removed.

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

anim.remove_metadata (risco 3, altera)​

Removes the metadata objects of a class. Not smoke-tested: the engine ships no concrete UAnimMetaData subclass.

ArgumentoTipoDescrição
animstringobrigatório.
classstringobrigatório. UAnimMetaData subclass (short name or path).
propertiesarray of UeaKeyValueProperties applied to the created metadata object.

Retorna: anim, metaData, count, message.

anim.remove_node (risco 3, altera, destrutivo, smoke)​

Deletes one node from its anim graph (result nodes are refused).

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
nodeIdstringobrigatório. Node id, or a title/class name that is unique in the searched graphs.
graphstring
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: count, details, compileErrors.

anim.remove_nodes (risco 3, altera, destrutivo, smoke)​

Deletes several nodes in one call (result nodes are skipped and reported).

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
nodeIdsarray of stringobrigatório. Node ids (or unique titles) to delete.
graphstring
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: count, details, compileErrors.

anim.remove_notifies_by_name (risco 3, altera, smoke)​

Removes every notify with a name.

ArgumentoTipoDescrição
animstringobrigatório.
namestringobrigatório. Notify name or notify track name, depending on the tool.

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

anim.remove_notifies_by_track (risco 3, altera, smoke)​

Removes every notify of a notify track.

ArgumentoTipoDescrição
animstringobrigatório.
namestringobrigatório. Notify name or notify track name, depending on the tool.

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

anim.remove_notify (risco 3, altera, smoke)​

Removes the notify at an index.

ArgumentoTipoDescrição
animstringobrigatório.
indexintegerobrigatório. Index in the list returned by anim.list_notifies.
timenumberNew trigger time in seconds (anim.move_notify). Padrão 0.0.
trackstringNew notify track (anim.move_notify); empty keeps the current one.
propertiesarray of UeaKeyValueProperties applied to the notify object (anim.set_notify_property).

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

anim.remove_notify_track (risco 3, altera, smoke)​

Removes a notify track and the notifies on it.

ArgumentoTipoDescrição
animstringobrigatório.
trackstringobrigatório. Notify track name.
newNamestringNew track name (anim.rename_notify_track only).

Retorna: anim, tracks, count, message.

anim.remove_sync_markers_by_name (risco 3, altera, smoke)​

Removes every sync marker with a name.

ArgumentoTipoDescrição
animstringobrigatório.
namestringobrigatório. Notify name or notify track name, depending on the tool.

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

anim.remove_virtual_bones (risco 3, altera)​

Removes virtual bones from the sequence's skeleton. Not smoke-tested: the engine fixture mesh has a minimal skeleton.

ArgumentoTipoDescrição
animstringobrigatório.
namesarray of stringVirtual bone names; empty removes every virtual bone of the skeleton.

Retorna: anim, names, count, message.

anim.rename (risco 3, altera, smoke)​

Renames (moves) an animation sequence.

ArgumentoTipoDescrição
animstringobrigatório.
folderstringDestination folder; empty keeps the source folder.
namestringobrigatório. Name of the new asset.

Retorna: anim, name, message.

anim.rename_curve (risco 2, altera, smoke)​

Renames a curve (the keys are copied to the new name).

ArgumentoTipoDescrição
animstringobrigatório.
curvestringobrigatório.
newNamestringobrigatório.
typestringfloat (default), vector or transform.

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

anim.rename_notify_track (risco 2, altera, smoke)​

Renames a notify track, keeping its notifies.

ArgumentoTipoDescrição
animstringobrigatório.
trackstringobrigatório. Notify track name.
newNamestringNew track name (anim.rename_notify_track only).

Retorna: anim, tracks, count, message.

anim.resize (risco 2, altera, UE 5.0+, smoke)​

Sets the play length of a sequence, resampling its keys (UE 5 only).

ArgumentoTipoDescrição
animstringobrigatório.
lengthnumberobrigatório. New play length in seconds.

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

anim.reverse (risco 2, altera, UE 5.0+, smoke)​

Reverses the bone track keys of a sequence (UE 5 only).

ArgumentoTipoDescrição
animstringobrigatório. Animation sequence asset path or unique name.

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

anim.revert_modifier (risco 3, altera)​

Reverts an animation modifier applied to a sequence. Not smoke-tested: the engine ships no animation modifier asset.

ArgumentoTipoDescrição
animstringobrigatório.
modifierClassstringobrigatório. UAnimationModifier subclass (blueprint asset path or class name).
propertiesarray of UeaKeyValueProperties applied to the modifier before running it.

Retorna: anim, name, message.

anim.rtg_add_pose (risco 2, altera, UE 5.5+, requer plugin IKRig, smoke)​

Creates a retarget pose on the source or target side.

ArgumentoTipoDescrição
sidestringobrigatório. "source" or "target".
namestringobrigatório. Retarget pose name.

Retorna: side, poses, current, count, message.

anim.rtg_auto_map_chains (risco 2, altera, UE 5.5+, requer plugin IKRig, smoke)​

Maps target chains to source chains automatically ("exact", "fuzzy" or "clear").

ArgumentoTipoDescrição
modestring"exact", "fuzzy" or "clear". Padrão TEXT("exact").
forcebooleanRemap chains that already have a source chain. Padrão false.

Retorna: retargeter, name, sourceRig, targetRig, sourceMesh, targetMesh, sourcePose, targetPose, chainMap, sourcePoses, targetPoses, opCount, message.

anim.rtg_create (risco 2, altera, UE 5.5+, requer plugin IKRig, smoke)​

Creates an IK Retargeter from a source and a target IK Rig, with the default retarget ops.

ArgumentoTipoDescrição
folderstringobrigatório.
namestringobrigatório.
sourceRigstringobrigatório. IK rig of the animation being copied from.
targetRigstringobrigatório. IK rig of the character being animated.

Retorna: retargeter, name, sourceRig, targetRig, sourceMesh, targetMesh, sourcePose, targetPose, chainMap, sourcePoses, targetPoses, opCount, message.

anim.rtg_delete (risco 3, altera, destrutivo, UE 5.5+, requer plugin IKRig)​

Deletes an IK Retargeter asset.

ArgumentoTipoDescrição
retargeterstringobrigatório. IK retargeter asset.

Retorna: deleted, message.

anim.rtg_get (risco 0, UE 5.5+, requer plugin IKRig, smoke)​

Full state of an IK Retargeter: rigs, preview meshes, chain mapping and retarget poses.

ArgumentoTipoDescrição
retargeterstringobrigatório. IK retargeter asset.

Retorna: retargeter, name, sourceRig, targetRig, sourceMesh, targetMesh, sourcePose, targetPose, chainMap, sourcePoses, targetPoses, opCount, message.

anim.rtg_list_chain_map (risco 0, UE 5.5+, requer plugin IKRig, smoke)​

Lists the target-to-source chain mapping of a retargeter.

ArgumentoTipoDescrição
retargeterstringobrigatório. IK retargeter asset.

Retorna: retargeter, name, sourceRig, targetRig, sourceMesh, targetMesh, sourcePose, targetPose, chainMap, sourcePoses, targetPoses, opCount, message.

anim.rtg_list_ops (risco 0, UE 5.6+, requer plugin IKRig, smoke)​

Lists the retarget ops of a retargeter and their settings (5.6+ op-based retargeting model).

ArgumentoTipoDescrição
retargeterstringobrigatório. IK retargeter asset.

Retorna: settings, applied, errors, message.

anim.rtg_list_poses (risco 0, UE 5.5+, requer plugin IKRig, smoke)​

Lists the retarget poses of one side and the current one.

ArgumentoTipoDescrição
sidestringobrigatório.
posestringRetarget pose name (empty = the current pose of that side).

Retorna: side, poses, current, count, message.

anim.rtg_map_chain (risco 2, altera, UE 5.5+, requer plugin IKRig, smoke)​

Maps one target chain to a source chain (empty source chain unmaps it).

ArgumentoTipoDescrição
targetChainstringobrigatório. Chain of the target rig.
sourceChainstringChain of the source rig, or empty to unmap.

Retorna: retargeter, name, sourceRig, targetRig, sourceMesh, targetMesh, sourcePose, targetPose, chainMap, sourcePoses, targetPoses, opCount, message.

anim.rtg_remove_pose (risco 3, altera, UE 5.5+, requer plugin IKRig, smoke)​

Removes a retarget pose.

ArgumentoTipoDescrição
sidestringobrigatório.
posestringobrigatório.

Retorna: side, poses, current, count, message.

anim.rtg_rename_pose (risco 2, altera, UE 5.5+, requer plugin IKRig, smoke)​

Renames a retarget pose.

ArgumentoTipoDescrição
newNamestringobrigatório.

Retorna: side, poses, current, count, message.

anim.rtg_reset_pose (risco 2, altera, UE 5.5+, requer plugin IKRig, smoke)​

Resets a retarget pose, or only the bones listed.

ArgumentoTipoDescrição
bonesarray of stringBones to reset; empty resets the whole pose.

Retorna: side, poses, current, count, message.

anim.rtg_retarget_animations (risco 2, altera, UE 5.8+, requer plugin IKRig)​

Duplicates and retargets a list of animation assets onto the target skeleton of a retargeter.

ArgumentoTipoDescrição
animsarray of stringobrigatório. Animation assets to retarget.
folderstringobrigatório. Destination folder for the new assets.
prefixstring
suffixstring
searchstringSubstring replaced in the asset name.
replacestring
includeReferencedAssetsbooleanAlso retarget the assets referenced by the ones listed. Padrão true.
overwriteExistingFilesbooleanOverwrite assets with the same name instead of creating unique names. Padrão false.

Retorna: created, count, message.

anim.rtg_set_chain_settings (risco 2, altera, UE 5.5+, UE ≤5.5, requer plugin IKRig, smoke)​

Reads or changes the FK / IK / speed-planting settings of one target chain.

ArgumentoTipoDescrição
targetChainstringobrigatório.
propertiesarray of UeaKeyValueProperty assignments on FTargetChainSettings (e.g. "FK.RotationAlpha" = "0.5"). Empty lists the current values.

Retorna: settings, applied, errors, message.

anim.rtg_set_current_pose (risco 2, altera, UE 5.5+, requer plugin IKRig, smoke)​

Makes a retarget pose the current one for that side.

ArgumentoTipoDescrição
sidestringobrigatório.
posestringobrigatório.

Retorna: side, poses, current, count, message.

anim.rtg_set_global_settings (risco 2, altera, UE 5.5+, UE ≤5.5, requer plugin IKRig, smoke)​

Reads or changes the global settings of a retargeter (enable FK / IK / root, warping, ...).

ArgumentoTipoDescrição
propertiesarray of UeaKeyValueProperty assignments; empty lists the current values.

Retorna: settings, applied, errors, message.

anim.rtg_set_op_setting (risco 2, altera, UE 5.6+, requer plugin IKRig)​

Sets a property on one retarget op, addressed as "." (5.6+).

ArgumentoTipoDescrição
propertiesarray of UeaKeyValueProperty assignments; empty lists the current values.

Retorna: settings, applied, errors, message.

anim.rtg_set_pose_bone_rotation (risco 2, altera, UE 5.5+, requer plugin IKRig, smoke)​

Sets the rotation offset of one bone inside a retarget pose (degrees).

ArgumentoTipoDescrição
bonestringobrigatório.
rotation{x,y,z}Rotation offset applied to the bone, in degrees (pitch, yaw, roll).

Retorna: side, poses, current, count, message.

anim.rtg_set_pose_root_offset (risco 2, altera, UE 5.5+, requer plugin IKRig, smoke)​

Sets the global translation offset of the pelvis inside a retarget pose.

ArgumentoTipoDescrição
offset{x,y,z}Global translation offset of the pelvis bone.

Retorna: side, poses, current, count, message.

anim.rtg_set_preview_mesh (risco 2, altera, UE 5.5+, requer plugin IKRig, smoke)​

Sets the preview skeletal mesh of the source or target side.

ArgumentoTipoDescrição
sidestringobrigatório. "source" or "target".
meshstringobrigatório.

Retorna: retargeter, name, sourceRig, targetRig, sourceMesh, targetMesh, sourcePose, targetPose, chainMap, sourcePoses, targetPoses, opCount, message.

anim.rtg_set_rig (risco 2, altera, UE 5.5+, requer plugin IKRig, smoke)​

Assigns the source or target IK Rig of a retargeter.

ArgumentoTipoDescrição
sidestringobrigatório. "source" or "target".
ikRigstringobrigatório.

Retorna: retargeter, name, sourceRig, targetRig, sourceMesh, targetMesh, sourcePose, targetPose, chainMap, sourcePoses, targetPoses, opCount, message.

anim.rtg_set_root_settings (risco 2, altera, UE 5.5+, UE ≤5.5, requer plugin IKRig, smoke)​

Reads or changes the retarget root (pelvis) settings of a retargeter.

ArgumentoTipoDescrição
propertiesarray of UeaKeyValueProperty assignments; empty lists the current values.

Retorna: settings, applied, errors, message.

anim.rtg_validate (risco 0, UE 5.5+, requer plugin IKRig, smoke)​

Checks a retargeter for missing rigs, missing meshes and unmapped target chains.

ArgumentoTipoDescrição
retargeterstringobrigatório. IK retargeter asset.

Retorna: valid, issues, mappedChains, unmappedChains, message.

anim.save (risco 2, altera)​

Saves the package of an animation sequence to disk. Not smoke-tested: the self-test never writes files.

ArgumentoTipoDescrição
animstringobrigatório. Animation sequence asset path or unique name.

Retorna: anim, name, message.

anim.set_additive (risco 2, altera, smoke)​

Additive settings: additive type, base pose type, base pose animation and reference frame.

ArgumentoTipoDescrição
animstringobrigatório.
typestringobrigatório. none, localSpaceBase (local) or meshSpaceRotation (mesh).
basePoseTypestringnone, refPose, animScaled, animFrame or localAnimFrame.
basePoseAnimstringSequence used as the base pose when basePoseType is animScaled/animFrame.
refFrameIndexintegerFrame of the base pose animation when basePoseType is animFrame. Padrão 0.

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

anim.set_anim_blueprint (risco 2, altera, requer mundo)​

Assigns (or clears) the anim blueprint of the skeletal mesh component of an actor. Works in the editor and in PIE.

ArgumentoTipoDescrição
animBlueprintstringAnim blueprint asset, or empty to clear it.

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

anim.set_anim_mode (risco 1, requer PIE, requer mundo, smoke)​

Switches the animation mode of an actor between "blueprint", "singleNode" and "custom".

ArgumentoTipoDescrição
modestringobrigatório. "blueprint", "singleNode" or "custom".

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

anim.set_bone_track_keys (risco 2, altera, 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.

ArgumentoTipoDescrição
animstringobrigatório.
bonestringobrigatório.
positionsarray of {x,y,z}One position per key.
rotationsarray of {x,y,z}One rotation (pitch/yaw/roll) per key.
scalesarray of {x,y,z}One scale per key; empty uses 1,1,1.

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

anim.set_compression (risco 2, altera, smoke)​

Bone and curve compression settings assets of a sequence (empty arguments only report the current ones).

ArgumentoTipoDescrição
animstringobrigatório.
boneSettingsstringUAnimBoneCompressionSettings asset; empty leaves it unchanged.
curveSettingsstringUAnimCurveCompressionSettings asset; empty leaves it unchanged.

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

anim.set_curve_from_expression (risco 2, altera, smoke)​

Fills a float curve from an expression sampled over the sequence: constant, linear, sine, cosine or pulse.

ArgumentoTipoDescrição
animstringobrigatório.
curvestringobrigatório.
expressionstringobrigatório. constant, linear, sine, cosine or pulse.
samplesintegerNumber of samples spread over the sequence. Padrão 10.
amplitudenumberPeak value (constant value for 'constant', end value for 'linear'). Padrão 1.0.
frequencynumberCycles over the whole sequence (sine/cosine/pulse). Padrão 1.0.
offsetnumberValue added to every sample. Padrão 0.0.

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

anim.set_curve_keys (risco 2, altera, smoke)​

Replaces every key of a float curve.

ArgumentoTipoDescrição
animstringobrigatório.
curvestringobrigatório.
timesarray of numberobrigatório. Key times in seconds.
valuesarray of numberobrigatório. One value per time.
createbooleanCreate the curve when it does not exist yet. Padrão true.

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

anim.set_frame_rate (risco 2, altera, UE 5.0+, smoke)​

Changes the sampling frame rate, resampling the keys (UE 5 only: 4.27 has no animation data controller).

ArgumentoTipoDescrição
animstringobrigatório.
frameRatenumberobrigatório. New sampling rate in frames per second.

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

anim.set_import_settings (risco 2, altera, smoke)​

Changes the FBX import settings used by the next reimport (creates them when the sequence has none).

ArgumentoTipoDescrição
animstringobrigatório.
animationLengthstringexportedTime, animatedKey, setRange (FBX animation length import type); empty leaves it.
frameImportRangeMinintegerFirst frame imported when animationLength is setRange; -1 leaves it. Padrão -1.
frameImportRangeMaxintegerLast frame imported when animationLength is setRange; -1 leaves it. Padrão -1.
customSampleRateintegerSample rate used when useDefaultSampleRate is false; -1 leaves it. Padrão -1.
importCustomAttributestring"true"/"false"; empty leaves the current value.
importBoneTracksstring
useDefaultSampleRatestring
deleteExistingMorphTargetCurvesstring
doNotImportCurveWithZerostring
removeRedundantKeysstring
setMaterialDriveParameterOnCustomAttributestring
preserveLocalTransformstring
snapToClosestFrameBoundarystringUE 5 only.

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

anim.set_interpolation (risco 2, altera, smoke)​

Key interpolation of a sequence: linear or step.

ArgumentoTipoDescrição
animstringobrigatório.
typestringobrigatório. linear or step.

Retorna: anim, name, message.

anim.set_node_comment (risco 2, altera, smoke)​

Sets the comment bubble of a node.

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
nodeIdstringobrigatório.
commentstring
graphstring

Retorna: node, compileErrors, propertyErrors.

anim.set_node_functions (risco 2, altera, UE 5.0+)​

Sets the anim node functions of a node (OnInitialize / OnBecomeRelevant / OnUpdate), UE 5.0+.

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
nodeIdstringobrigatório.
onInitializestringFunction name called when the node is initialised.
onBecomeRelevantstringFunction name called when the node becomes relevant.
onUpdatestringFunction name called every update.
graphstring
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: node, compileErrors, propertyErrors.

anim.set_node_properties (risco 2, altera, smoke)​

Sets several properties of an anim graph node in one call.

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
nodeIdstringobrigatório.
propertiesarray of UeaKeyValueobrigatório.
graphstring
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: properties, count, errors, compileErrors.

anim.set_node_property (risco 2, altera, smoke)​

Sets one property of an anim graph node (inside its FAnimNode_* struct or on the node itself); dotted paths reach nested struct members.

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
nodeIdstringobrigatório.
propertystringobrigatório. Property name inside the FAnimNode_* struct, or on the node itself; dotted paths allowed.
valuestringValue as text; asset references are accepted for object properties.
graphstring
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: properties, count, errors, compileErrors.

anim.set_notify_property (risco 2, altera, smoke)​

Applies properties to the notify object at an index (see anim.list_notifies).

ArgumentoTipoDescrição
animstringobrigatório.
indexintegerobrigatório. Index in the list returned by anim.list_notifies.
timenumberNew trigger time in seconds (anim.move_notify). Padrão 0.0.
trackstringNew notify track (anim.move_notify); empty keeps the current one.
propertiesarray of UeaKeyValueProperties applied to the notify object (anim.set_notify_property).

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

anim.set_play_rate (risco 1, requer PIE, requer mundo, smoke)​

Sets the play rate of the current single-node animation.

ArgumentoTipoDescrição
playRatenumberPadrão 1.0.

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

anim.set_position (risco 1, requer PIE, requer mundo, smoke)​

Scrubs the current single-node animation to a position in seconds.

ArgumentoTipoDescrição
timenumberPosition in seconds. Padrão 0.0.
fireNotifiesbooleanFire the notifies between the old and the new position. Padrão false.

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

anim.set_rate_scale (risco 2, altera, smoke)​

Playback speed multiplier stored on the asset.

ArgumentoTipoDescrição
animstringobrigatório.
rateScalenumberobrigatório. Playback multiplier stored on the asset (1 = authored speed).

Retorna: anim, name, message.

anim.set_retarget_source (risco 2, altera, smoke)​

Retarget source of a sequence (a name registered on the skeleton, or a skeletal mesh on UE 5).

ArgumentoTipoDescrição
animstringobrigatório.
sourcestringRetarget source name registered on the skeleton; empty clears it.
meshstringSkeletal mesh used as the retarget source (UE 5 only).

Retorna: anim, name, message.

anim.set_root_motion (risco 2, altera, smoke)​

Root motion settings: extraction, root lock type, forced lock and normalised scale.

ArgumentoTipoDescrição
animstringobrigatório.
enabledbooleanEnable root motion extraction. Padrão true.
lockTypestringrefPose / anim_first_frame / zero / animFirstFrame (empty leaves it unchanged).
forceRootLockbooleanForce the root lock even when root motion is disabled. Padrão false.
useNormalizedRootMotionScalebooleanNormalise the root motion scale with the mesh scale. Padrão true.

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

anim.set_skeleton (risco 3, altera, smoke)​

Binds a sequence to another skeleton; 'convertSpaces' remaps the tracks to the new hierarchy.

ArgumentoTipoDescrição
animstringobrigatório.
skeletonstringobrigatório. Skeleton asset path or unique name.
convertSpacesbooleanRemap the tracks to the new bone hierarchy instead of only rebinding. Padrão false.

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

anim.sm_add_alias (risco 2, altera, UE 5.0+, smoke)​

Adds a state alias pointing at one or more states (shared transition source), UE 5.0+.

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
machinestringState machine name or node id; empty = the only one.
namestringobrigatório.
xintegerPadrão 0.
yintegerPadrão 0.
entrybooleanMake this state the entry state of the machine. Padrão false.
statesarray of stringStates the alias points at (anim.sm_add_alias only).
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: state, machine, compileErrors.

anim.sm_add_conduit (risco 2, altera, smoke)​

Adds a conduit (a transition hub without a pose) to a state machine.

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
machinestringState machine name or node id; empty = the only one.
namestringobrigatório.
xintegerPadrão 0.
yintegerPadrão 0.
entrybooleanMake this state the entry state of the machine. Padrão false.
statesarray of stringStates the alias points at (anim.sm_add_alias only).
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: state, machine, compileErrors.

anim.sm_add_state (risco 2, altera, smoke)​

Adds a state with its own anim graph to a state machine; Entry=true makes it the entry state.

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
machinestringState machine name or node id; empty = the only one.
namestringobrigatório.
xintegerPadrão 0.
yintegerPadrão 0.
entrybooleanMake this state the entry state of the machine. Padrão false.
statesarray of stringStates the alias points at (anim.sm_add_alias only).
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: state, machine, compileErrors.

anim.sm_add_state_blend_space (risco 2, altera, smoke)​

Adds a blend space player inside a state, optionally driven by two Anim Blueprint float variables.

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
machinestring
statestringobrigatório.
blendSpacestringBlend space asset; may be empty to wire the asset later.
xVariablestringAnim Blueprint variable driving the X axis (a Get node is wired to the X pin).
yVariablestringAnim Blueprint variable driving the Y axis.
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: state, boundGraph, nodes, count, resultNodeId, nodeId, compileErrors.

anim.sm_add_state_node (risco 2, altera, smoke)​

Adds an anim node of any class inside a state, optionally wiring it to the state result.

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
machinestring
statestringobrigatório.
nodeClassstringobrigatório. Node class short name ("BlendSpacePlayer", "Slot").
propertiesarray of UeaKeyValue
connectToResultbooleanWire the node's pose output to the state result (default true). Padrão true.
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: state, boundGraph, nodes, count, resultNodeId, nodeId, compileErrors.

anim.sm_add_state_sequence (risco 2, altera, smoke)​

Adds a sequence player inside a state and wires it to the state result. Anim may be empty and set later.

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
machinestring
statestringobrigatório.
animstringAnimation sequence asset; may be empty to wire the asset later.
loopbooleanPadrão true.
playRatenumberPadrão 1.0f.
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: state, boundGraph, nodes, count, resultNodeId, nodeId, compileErrors.

anim.sm_add_transition (risco 2, altera, smoke)​

Adds a transition between two states/conduits with a crossfade duration, priority and blend mode.

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
machinestring
fromstringobrigatório. Source state name or id.
tostringobrigatório. Target state name or id.
crossfadenumberCrossfade duration in seconds (default 0.2). Padrão 0.2f.
blendModestringAlpha blend option: Linear, Cubic, HermiteCubic, Sinusoidal, QuadraticInOut, ...
priorityintegerPadrão 0.
bidirectionalbooleanAllow the transition in both directions. Padrão false.
automaticRulebooleanDrive the rule from the remaining time of the source state's asset player. Padrão false.
logicTypestringStandardBlend or Custom.
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: transition, machine, compileErrors.

anim.sm_create_locomotion (risco 2, altera, smoke)​

Builds a complete locomotion state machine (Idle/Move plus optional jump states) with the speed and in-air rules wired, in one call.

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
machinestringName of the state machine to create (default "Locomotion").
idlestringIdle animation sequence; may be empty to build the skeleton of the machine and fill it later.
moveBlendSpacestringBlend space used for the moving state (preferred over WalkAnim/RunAnim).
moveAnimstringAnimation used for the moving state when no blend space is given.
jumpStartstringJump start animation (optional).
jumpLoopstringJump loop animation (optional).
jumpEndstringJump land animation (optional).
speedVariablestringFloat variable holding the speed; created when missing (default "Speed").
isInAirVariablestringBool variable holding the in-air state; created when missing (default "IsInAir").
moveThresholdnumberSpeed above which the character is considered moving (default 10). Padrão 10.0f.
connectToOutputbooleanConnect the state machine to the AnimGraph result (default true). Padrão true.
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: machine, nodeId, states, transitions, variables, compileErrors, warnings.

anim.sm_export (risco 0, smoke)​

Exports a state machine (states, transitions, rules) as JSON for anim.sm_import.

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
machinestringState machine name or node id; empty = the only one in the Anim Blueprint.

Retorna: json, stateCount, transitionCount.

anim.sm_get (risco 0, smoke)​

Full description of a state machine: states (with their inner node count), transitions, rules and entry state.

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
machinestringState machine name or node id; empty = the only one in the Anim Blueprint.

Retorna: machine, nodeId, graph, stateMachineGraph, entryState, states, transitions, compileErrors.

anim.sm_get_transition_rule (risco 0, smoke)​

Dumps the rule of a transition: its graph name, the node titles and a short description.

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
machinestring
transitionstringobrigatório. Transition node id or "From->To".
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: transition, ruleGraph, rule, automaticRule, nodes, compileErrors.

anim.sm_import (risco 2, altera)​

Recreates states and transitions from the JSON produced by anim.sm_export (the machine is created when missing).

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
jsonstringobrigatório. JSON in the shape produced by anim.sm_export.
machinestringState machine to fill; created when it does not exist.
graphstringTarget graph for a new state machine; empty = "AnimGraph".
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: machine, nodeId, graph, stateMachineGraph, entryState, states, transitions, compileErrors.

anim.sm_list (risco 0, smoke)​

Lists the state machines of an Anim Blueprint with their node ids and the graphs they live in.

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
machinestringState machine name or node id; empty = the only one in the Anim Blueprint.

Retorna: machines, nodeIds, graphs, count.

anim.sm_list_state_nodes (risco 0, smoke)​

Lists the anim graph nodes inside a state and the id of its result node.

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
machinestring
statestringobrigatório. State name or node id.
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: state, boundGraph, nodes, count, resultNodeId, nodeId, compileErrors.

anim.sm_remove_state (risco 3, altera, destrutivo, smoke)​

Deletes a state (or conduit/alias) and the transitions attached to it.

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
machinestring
statestringobrigatório. State name or node id.
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: machine, nodeId, graph, stateMachineGraph, entryState, states, transitions, compileErrors.

anim.sm_remove_transition (risco 3, altera, destrutivo, smoke)​

Deletes a transition.

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
machinestring
transitionstringobrigatório. Transition node id or "From->To".
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: machine, nodeId, graph, stateMachineGraph, entryState, states, transitions, compileErrors.

anim.sm_rename_state (risco 2, altera, smoke)​

Renames a state, conduit or alias (its inner graph is renamed too).

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
machinestring
statestringobrigatório.
newNamestringobrigatório.
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: state, machine, compileErrors.

anim.sm_set_entry_state (risco 2, altera, smoke)​

Makes a state the entry state of its machine (the previous entry link is replaced).

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
machinestring
statestringobrigatório. State name or node id.
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: state, machine, compileErrors.

anim.sm_set_state_notifies (risco 2, altera, smoke)​

Sets the entered / left / fully-blended notify names of a state.

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
machinestring
statestringobrigatório.
enteredstringNotify name fired when the state is entered.
leftstringNotify name fired when the state is left.
fullyBlendedstringNotify name fired when the state is fully blended in.
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: state, machine, compileErrors.

anim.sm_set_transition (risco 2, altera, smoke)​

Edits a transition: crossfade, priority, blend mode, blend profile, bidirectional and automatic rule.

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
machinestring
transitionstringobrigatório. Transition node id or "From->To".
crossfadenumberCrossfade duration in seconds; negative = leave unchanged. Padrão -1.0f.
priorityintegerPadrão -1.
blendModestringAlpha blend option name; empty = leave unchanged.
blendProfilestringBlend profile asset (4.27 only; 5.6+ replaced the member, reported as unsupported).
bidirectionalbooleanAllow the transition in both directions. Padrão false.
setBidirectionalbooleanApply the Bidirectional value (it is a bool, so it needs an explicit opt-in). Padrão false.
automaticRulebooleanDrive the rule from the remaining time of the source state's asset player. Padrão false.
setAutomaticRulebooleanApply the AutomaticRule value. Padrão false.
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: transition, machine, compileErrors.

anim.sm_set_transition_rule_compare (risco 2, altera, smoke)​

Builds the transition rule as "variable value" using a float variable (created when missing).

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
machinestring
transitionstringobrigatório.
variablestringobrigatório. Float or int member variable of the Anim Blueprint.
opstringobrigatório. Comparison operator: >, <, >=, <=, ==, !=.
valuenumberRight-hand constant. Padrão 0.0f.
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: transition, ruleGraph, rule, automaticRule, nodes, compileErrors.

anim.sm_set_transition_rule_time_remaining (risco 2, altera, smoke)​

Switches the transition to the automatic rule based on the remaining time of the source state's asset player.

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
machinestring
transitionstringobrigatório.
crossfadenumberCrossfade duration used as the trigger window, in seconds (default: keep the current one). Padrão -1.0f.
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: transition, ruleGraph, rule, automaticRule, nodes, compileErrors.

anim.sm_set_transition_rule_variable (risco 2, altera, smoke)​

Builds the transition rule from a bool variable of the Anim Blueprint (created when missing), optionally negated.

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
machinestring
transitionstringobrigatório.
variablestringobrigatório. Bool member variable of the Anim Blueprint.
negatebooleanInvert the variable with a NOT node. Padrão false.
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: transition, ruleGraph, rule, automaticRule, nodes, compileErrors.

anim.snapshot_pose (risco 2, altera, requer PIE, requer mundo, smoke)​

Saves the current pose of a running actor into a new pose asset.

ArgumentoTipoDescrição
folderstringobrigatório. Destination folder of the pose asset.
namestringobrigatório. Asset name of the pose asset.
poseNamestringName of the pose inside the asset (empty = generated).

Retorna: poseAsset, poseName, poseCount, message.

anim.spawn_test_actor (risco 1, requer PIE, requer mundo, smoke)​

Spawns a skeletal mesh actor in the PIE world to test animations on, and returns its label.

ArgumentoTipoDescrição
meshstringSkeletal mesh of the spawned actor. Padrão TEXT("/Engine/EngineMeshes/SkeletalCube").
labelstringLabel given to the actor (also used to find it again). Padrão TEXT("AnimTestActor").
location{x,y,z}Spawn location in the PIE world.
animBlueprintstringAnim blueprint set on the spawned actor (optional).

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

anim.stop (risco 1, requer PIE, requer mundo, smoke)​

Stops the single-node playback of an actor.

ArgumentoTipoDescrição
actorstringobrigatório. Actor label, name or class of the actor carrying the skeletal mesh.

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

anim.stop_recording (risco 2, altera, requer PIE, requer mundo)​

Stops an animation recording started by anim.record_from_actor. Not smoke-tested: it needs a running PIE session.

ArgumentoTipoDescrição
actorstringActor being recorded; empty stops every recording.

Retorna: actor, anim, recording, message.

anim.unbind_property (risco 2, altera, smoke)​

Removes a property binding from a node.

ArgumentoTipoDescrição
animBlueprintstringobrigatório.
nodeIdstringobrigatório.
propertystringobrigatório.
graphstring
compilebooleanRecompile after the change (default true). Padrão true.

Retorna: bindings, count, compileErrors.

anim.validate (risco 0, smoke)​

Sanity check of a sequence: missing skeleton, zero length, notifies out of range, curves without keys, root motion without a root track.

ArgumentoTipoDescrição
animstringobrigatório. Animation sequence asset path or unique name.

Retorna: anim, errors, warnings, valid, message.