All skills
thedivergentai avatar

/godot-animation-tree-mastery

@9d6e91e
by Divergent AIthedivergentai/gd-agentic-skills783 stars
48

Expert patterns for AnimationTree including StateMachine transitions, BlendSpace2D for directional movement, BlendTree for layered animations, root motion, transition conditions, advance expressions, and state machine sub-states. Use for complex character animation systems with movement blending and state management. Trigger keywords: AnimationTree, AnimationNodeStateMachine, BlendSpace2D, BlendSpace1D, BlendTree, transition_request, blend_position, advance_expression, AnimationNodeAdd2, AnimationNodeBlend2, root_motion.

Use this Skill: https://skilld.dev/gh/thedivergentai/gd-agentic-skills/godot-animation-tree-mastery

This session only. Nothing lands on disk.

SKILL.md

โ‰ˆ139 tokens always: the name and description. โ‰ˆ3.4k when used: this file. โ‰ˆ2.7k more on demand in 3 files.

AnimationTree Mastery

Expert guidance for Godot's advanced animation blending and state machines.

NEVER Do

  • NEVER call play() on AnimationPlayer when using AnimationTree โ€” AnimationTree controls the player. Directly calling play() causes conflicts and jitter. Use set("parameters/transition_request") or travel() instead.
  • NEVER forget to set active = true โ€” AnimationTree is inactive by default. Animations won't play until $AnimationTree.active = true.
  • NEVER use absolute paths for parameter access โ€” Use relative paths like "parameters/StateMachine/transition_request". This ensures compatibility when nodes move in the hierarchy.
  • NEVER leave auto_advance enabled for interactive states โ€” It causes immediate transitions. Use it only for automated sequences like combo chains or death-to-respawn.
  • NEVER use BlendSpace2D for 1D blending โ€” Blending only speed? Use BlendSpace1D. Blending only two states? Use Blend2. BlendSpace2D is specifically for X+Y directional inputs (strafe).
  • NEVER update AnimationTree parameters every frame without a guard โ€” Setting parameters via set() every frame regardless of change causes cache invalidation and potential stutter. Check equality first.
  • NEVER use deep, nested BlendTrees for simple logic โ€” Every layer adds CPU overhead. If logic can be handled in a StateMachine or a simple script-driven Blend2, do it there.
  • NEVER forget to handle await get_tree().process_frame when updating parameters synchronously โ€” Sometimes the tree needs one frame to reconcile state before the next parameter change takes effect.
  • NEVER rely on auto_advance for long cutscenes โ€” If an animation is interrupted, auto_advance can put the character in a broken state. Use Method Tracks to signal state completion instead.
  • NEVER use Sync groups for animations with wildly different lengths โ€” It forces one animation to play at an extreme speed. Use TimeScale or separate layers for mismatching cycles.

Available Scripts

MANDATORY: Read the appropriate script before implementing the corresponding pattern. Do NOT Load references/advanced-graph-recipes.md unless nested combat graphs, IK look-at, or deep BlendTree layering are in scope.

sync_parameter_manager.gd

Guarded AnimationTree parameter writes โ€” prevent redundant set() churn every physics frame.

statemachine_travel_code.gd

Programmatic AnimationNodeStateMachinePlayback via travel() / start().

tree_travel_manager.gd

Trigger: multi-machine travel / request queue. Centralizes travel requests across nested playback paths without calling AnimationPlayer.play().

nested_state_machine.gd

Trigger: locomotion + combat (or air) sub-machines. Nested StateMachine parameter paths and playback handoff.

skeleton_ik_lookat.gd

Trigger: aim/look-at beside the tree. LookAtModifier3D / IK that must not fight bone tracks the tree owns.

reactive_oneshot_vfx.gd

AnimationNodeOneShot for recoil, blinks, and hit reactions.

dynamic_timescale_control.gd

Runtime playback speed for bullet-time or haste multipliers.

advanced_transition_masking.gd

Bone filter masks on Add2/Blend2 for upper/lower body separation.

blendtree_logic_mixing.gd

Interactive combat layer mixing inside BlendTree graphs.

root_motion_animtree_sync.gd

CharacterBody motion extraction from AnimationTree root motion.

sync_group_layering.gd

Sync groups for multi-layer clips that share length (e.g. walk + reload).

nested_tree_architecture.gd

Hierarchical StateMachine / nested parameter path architecture.

runtime_tree_debugging.gd

Visualize current states, travel paths, and blend values at runtime.

animation_event_dispatcher.gd

Method-track โ†’ dispatch_event(name, metadata) signal bridge; decouple VFX/audio from graph code.

animation_complexity_manager.gd

Swap tree_root hero vs crowd graph when VisibleOnScreenNotifier3D culls off-screen actors.


Decision Tree (replace inline tutorials)

Need Prefer Script
Simple clip swap / UI / prop AnimationPlayer only Peer godot-animation-player
5+ gameplay states, travel StateMachine root statemachine_travel_code.gd, tree_travel_manager.gd
Speed only blend BlendSpace1D Guarded writes via sync_parameter_manager.gd
Strafe / aim X+Y BlendSpace2D Same + blend_position
Upper-body overlay / combat layer BlendTree Add2/Blend2/OneShot blendtree_logic_mixing.gd, reactive_oneshot_vfx.gd
Nested combat/air under locomotion Nested SM MANDATORY nested_state_machine.gd
Look-at / IK Modifier beside tree MANDATORY skeleton_ik_lookat.gd
Deep graph recipes references/ Do NOT Load unless needed โ†’ advanced-graph-recipes.md

Core Concepts (compact): AnimationTree owns an AnimationPlayer via anim_player; root is StateMachine / BlendTree / BlendSpace; parameters use relative "parameters/..." paths; set active = true once in _ready.

@onready var anim_tree: AnimationTree = $AnimationTree
@onready var playback: AnimationNodeStateMachinePlayback = anim_tree.get("parameters/StateMachine/playback")

func _ready() -> void:
    anim_tree.active = true

Do not paste full StateMachine/BlendSpace editor walkthroughs โ€” author graphs in the AnimationTree editor, then drive them with the scripts above.


Expert insights (WHY โ€” keep in body)

  • Advance conditions vs travel โ€” WHY: bool conditions auto-fire transitions; travel() is explicit pathing. Use conditions for damage/death events; travel for locomotion intent.
  • BlendSpace2D cost โ€” WHY: 8-way blending samples multiple clips. Use BlendSpace1D for speed-only; Blend2 for two-state crossfades.
  • Parameter guard โ€” WHY: redundant set() invalidates tree cache every frame. Route writes through sync_parameter_manager.gd.
  • Method tracks โ€” WHY: gameplay should listen to dispatcher signals, not parse animation names. See animation_event_dispatcher.gd.

Deep recipes (on demand)

Topic Reference / script
StateMachine / BlendSpace editor recipes statemachine-and-blendspace.md
Nested combat / IK / root motion advanced-graph-recipes.md

Reference

Progressive disclosure: open Official Documentation links only when researching a specific API; load Related Skills when routing work to a peer domain โ€” do not preload the whole lattice.

Official Documentation

  • Using AnimationTree โ€” Canonical BlendTree / StateMachine / BlendSpace graph workflow that drives an AnimationPlayer without calling play() yourself.
  • Introduction to the animation features โ€” When to graduate from AnimationPlayer-only clips to an AnimationTree for blending, travel, and layered presentation.
  • Animation track types โ€” Method and value tracks that fire gameplay events (footsteps, hitboxes) from clips the tree is already blending.
  • AnimationTree โ€” active, tree_root, anim_player, root-motion getters, and the parameters/* path contract used throughout this skill.
  • AnimationNodeStateMachine โ€” Authoring nested locomotion/combat graphs and wiring transitions before code calls travel().
  • AnimationNodeStateMachinePlayback โ€” Runtime travel(), start(), get_current_node(), and travel-path inspection for code-driven state changes.
  • AnimationNodeStateMachineTransition โ€” Advance conditions, auto_advance, Sync, xfade, and priority rules that prevent sticky or immediate unwanted transitions.
  • AnimationNodeBlendSpace2D โ€” Directional strafe/aim blending via blend_position (use BlendSpace1D when only speed is needed).
  • AnimationNodeBlendTree โ€” Layered Add2/Blend2/OneShot graphs for upper-body aim, combat overlays, and filter masks.
  • AnimationNodeOneShot โ€” FIRE/ABORT request enum for recoil, hitreact, and other high-priority non-looping overlays.
  • AnimationNodeTimeScale โ€” Per-subtree playback speed for haste, stun, and bullet-time without mutating Engine.time_scale.
  • LookAtModifier3D โ€” Skeleton look-at driven beside the tree; see migration-notes.md for relative default change.

Related Skills

Prerequisites
  • godot-animation-player โ€” AnimationTree owns playback of clips authored on AnimationPlayer; track layout and ownership must be correct before blending.
  • godot-input-handling โ€” Stick/keyboard vectors and actions that feed blend_position, advance conditions, and travel targets each physics frame.
  • godot-signal-architecture โ€” Safe wiring for method-track dispatchers and animation-finished style signals without lifecycle leaks.
Complements
  • godot-2d-animation โ€” Sheet/cutout and 2D locomotion presentation that still uses AnimationTree BlendSpaces or simple travel graphs.
  • godot-state-machine-advanced โ€” Gameplay FSMs that should own intent while AnimationTree owns presentation travel and blends.
  • godot-physics-3d โ€” CharacterBody3D / move_and_slide integration for AnimationTree root-motion extraction.
  • godot-characterbody-2d โ€” Fixed-timestep 2D locomotion inputs that drive StateMachine travel and BlendSpace positions.
  • godot-tweening โ€” Tweening TimeScale or blend amounts when bullet-time and combat mix ramps should be interruptible.
  • godot-combat-system โ€” Hitreact/combo layers that consume OneShot requests, upper-body Add2 masks, and nested combat sub-machines.
  • godot-debugging-profiling โ€” Profiling and logging discipline when validating travel paths, blend values, and off-screen active culling.
Downstream / consumers
  • godot-genre-action-rpg โ€” Locomotion + combat stance trees and ability cast OneShots built on these graph patterns.
  • godot-genre-fighting โ€” Frame-sensitive combo auto-advance and masked upper-body attacks depend on transition and BlendTree discipline here.
  • godot-genre-shooter-fps โ€” Aim/reload overlays, recoil OneShots, and look-at modifiers layered over locomotion BlendSpaces.
Master
  • godot-master โ€” Library router and mirrored module entry for cross-skill discovery.

Source: SKILL.md on GitHub

1 warning17d4 checks ยท Risk SAFE
  • Gen Agent Trust Hub17d

    No security issues detected. The skill provides expert patterns for Godot's AnimationTree system using standard GDScript and Markdown documentation.

  • Socket17d

    No alerts

  • Snyk17d

    Risk: LOW ยท No issues

  • Runlayer7mo

    4/4 files flagged

Signed by skilld at 9d6e91e. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 3 weeks ago.

Activeupdated 2 months ago

README badge

README badge for thedivergentai/gd-agentic-skills/godot-animation-tree-mastery