Animation Blueprint Editor

An overview of the Animation Blueprint Editor and its user interface.

Choose your operating system:

Windows

macOS

Linux

The Animation Blueprint Editor shares similar functionality to the Blueprint Editor, but contains different features, tools, and windows to aid in character animation scripting.

This document provides an overview of the Animation Blueprint Editor interface.

Prerequisites

Upon opening an Animation Blueprint, the following interface will be displayed:

animation blueprint editor

  1. Toolbar, which contains buttons for Animation Blueprint management and editor type switching.

  2. Viewport, where you can preview the behavior of your Animation Blueprint logic on your character. For more information, refer to the Viewport section of the Animation Editors page.

  3. My Blueprint, similarly found in the Blueprint Editor, contains a list of your graphs, functions, variables and other related properties within the Animation Blueprint. Also contained here is the Pose Watch Manager panel, refer to the Animation Shortcuts and Tips page for more information.

  4. Graph, which displays the different graphs for visual scripting in your Animation Blueprint.

  5. Details, which displays properties for the selected item.

  6. Anim Preview Editor, where you can make changes to your variables and class defaults. Docked on a separate tab is the Asset Browser where you can view and open the animation assets that are associated with this Skeleton. Visit the Asset Editor section of the Animation Sequence Editor page for more information.

Toolbar

The Toolbar is where you compile your Blueprints, Save, locate the Animation Blueprint asset in the Content Browser, and define Class Settings and Class Defaults settings. Several buttons and tools here are common for most Animation Editors, such as Preview Mesh. You can learn more about these common menus from the Animation Editors Toolbar Section.

animation blueprint toolbar

The Animation Blueprint Editor Toolbar provides the following buttons and menus:

Name

Icon

Description

Compile

ToolbarCompile.png

Compiles this Animation Blueprint. This icon will change depending on the compilation state of the Blueprint. In most cases, making changes to any Graph will require you to recompile.

Clicking the Options menu will reveal additional behaviors when compiling. Save On Compile can be used to automatically save the Animation Blueprint upon compiling. Jump to Error Node can also be enabled to automatically frame the graph node preventing a successful compile.

animation blueprint compile settings

Diff

ToolbarDiff.png

If you are using a Source Control Package in Unreal Engine, then this dropdown menu can be used to compare your current Animation Blueprint against previous revisions.

Find

ToolbarFind.png

Opens a search panel where you can search for references to functions, events, variables, nodes, and pins within all graphs. You can also press Ctrl + F. Additionally, pressing Ctrl + Shift + F will open a search window where you can search through all Blueprints in your project, Animation or otherwise.

Hide Unrelated

ToolbarHide.png

Enabling this will fade out any nodes not currently selected or directly linked to your selected node in the Graph. You can also enable Lock Node State from the options menu, which will maintain the current hidden state of all nodes, regardless of your selection afterwards.

animation blueprint hide unrelated

Class Settings

ToolbarSettings.png

Clicking this exposes several Blueprint class settings in the Details panel. Most of these properties are general Blueprint class settings. However the following settings are specific to Animation Blueprints.

  • Target Skeleton: Specifies the Skeleton Asset to use for this Animation Blueprint.

  • Use Multi Threaded Animation Update: Enables the Animation Blueprint to update its native update, blend tree, montages, and asset players on a worker thread. The compiler will attempt to pick up any issues that may occur with the threaded update.

  • Warn About Blueprint Usage: Enabling this causes warnings to occur whenever a call into the Blueprint is made from the AnimGraph. This can help locate optimizations that need to be made.

Class Defaults

ToolbarDefault.png

Clicking this exposes your Blueprint's variables in the Details panel, including default variables from the Blueprint class.

  • Root Motion Mode: Controls how root motion is applied within this Animation Blueprint. You can select the following options:

    • No Root Motion Extraction, which causes no root motion to be extracted or applied.

    • Ignore Root Motion, which extracts root motion, but does not apply it.

    • Root Motion from Everything, which enables root motion from all animation sources. Typically you should not enable this in multiplayer or network setups.

    • Root Motion from Montages Only, which causes root motion to only apply from Animation Montages. This is a more suitable option for multiplayer or network setups.

  • Receive Notifies from Linked Instances: Whether to process notifies from any linked anim instances.

  • Propagate Notifies to Linked Instances: Whether to propagate notifies to any linked anim instances.

  • Use Main Instance Montage Evaluation Data: Enabling this causes linked instances to use the main instances' montage data, synchronizing all instances when the main instance plays a montage.

Play / Simulate

ToolbarPlay.png

These buttons can be used as a way to start playing or simulating the Animation Blueprint, using the In-Editor Testing framework.

Debug Object

ToolbarDebug.png

This drop-down menu links the Animation Blueprint viewport to an active animation instance in a simulating or playing session. This previews the current animation from that session in the Control Rig viewport. Additionally, your graph nodes will also respond to any inputs and changes that occur in session, so that you can debug your graph and character state.

Animation Editors / Blueprint

ToolbarEditor.png

When creating an Animation Blueprint for a Skeleton, this button will appear as a selectable editor type within the Animation Editor Modes region. Clicking here opens the Animation Blueprint. You can also click the Options dropdown menu next to this button to select a specific Blueprint if more than one Animation Blueprint uses this Skeleton.

Graph

The Graph panel is where you create the logic that controls your character during gameplay. There are three main types of graphs, each with different interfaces:

  • The Event Graph, where you construct Blueprint-based logic to define node properties and variables which inform your other graph areas.

    animation blueprint event graph

  • The Anim Graph, where you construct pose-based logic which evaluates the final pose of the Skeletal Mesh for the current frame.

    animation blueprint anim graph

  • State Machines, where you construct state-based logic, typically used for locomotion.

    animation blueprint state machine

Visit the Graphing in Animation Blueprints and State Machines pages for more information about the different graph types and graphing within Animation Blueprints.

TopicIcon.png

Graphing in Animation Blueprints

Edit, blend, and manipulate poses on Skeletal Meshes using various graphs in Animation Blueprints.

Edit, blend, and manipulate poses on Skeletal Meshes using various graphs in Animation Blueprints.

TopicIcon.png

State Machines

State Machines allow Skeletal Animations to be broken up into various states, with full control over how blends occur from one state to another.

State Machines allow Skeletal Animations to be broken up into various states, with full control over how blends occur from one state to another.

Anim Preview Editor

The Anim Preview Editor is where you can make changes to your variables (including Class Defaults), which will update the Skeletal Mesh in the viewport.

anim preview editor

Clicking Edit Preview changes the behavior of this panel so that you are only making temporary edits to your variables. This can be useful if you only want to preview different variable states, without making destructive edits. When you make changes, a prompt will appear where you can choose to apply these changes to the default.

edit preview