1. Epic GamesDeveloper
  3. UAnimBlueprint

UAnimBlueprint

An Anim Blueprint is essentially a specialized Blueprint whose graphs control the animation of a Skeletal Mesh.

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Animation

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Animation/AnimBlueprint.h
Include #include "Animation/AnimBlueprint.h"

Syntax

UCLASS (BlueprintType, MinimalAPI)  
class UAnimBlueprint :  
    public UBlueprint ,  
    public IInterface_PreviewMeshProvider

Remarks

An Anim Blueprint is essentially a specialized Blueprint whose graphs control the animation of a Skeletal Mesh. It can perform blending of animations, directly control the bones of the skeleton, and output a final pose for a Skeletal Mesh each frame.

Variables

  Type Name Description
Public variable UProperty Category, EditDefaultsOnly uint8: 1 bEnableLinkedAnimLayerInstanceSharing If true, linked animation layers will be instantiated only once per AnimClass instead of once per AnimInstance, AnimClass and AnimGroup.
Public variable UProperty assetregistrysearchable bool bIsTemplate This is an anim blueprint that acts as a set of template functionality without being tied to a specific skeleton.
Public variable UProperty Category, EditAnywhere bool bUseMultiThreadedAnimationUpdate Allows this anim Blueprint to update its native update, blend tree, montages and asset players on a worker thread.
Public variable UProperty Category, EditAnywhere bool bWarnAboutBlueprintUsage Selecting this option will cause the compiler to emit warnings whenever a call into Blueprint is made from the animation graph.
Public variable UProperty TArray< FAnimGroupInfo > Groups List of animation sync groups.
Protected variable FOnOverrideChangedMulticaster OnOverrideChanged Broadcast when an override is changed, allowing derived blueprints to be updated.
Public variable UProperty TArray< FAnimParentNodeAssetOverride > ParentAssetOverrides Array of overrides to asset containing nodes in the parent that have been overridden.
Public variable UProperty TArray< TObjectPtr< UPoseWatch > > PoseWatches  
Public variable UProperty TArray< TObjectPtr< UPoseWatchFolder > > PoseWatchFolders Array of active pose watches (pose watches allows us to see the bone pose at a particular point of the anim graph and control debug draw for unselected anim nodes).
Public variable UProperty Category, EditAnywhere, AdvancedDisplay assetregistrysearchable TObjectPtr< USkeleton > TargetSkeleton This is the target skeleton asset for anim instances created from this blueprint; all animations referenced by the BP should be compatible with this skeleton.

Constructors

  Type Name Description
Public function  

UAnimBlueprint ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function int32

FindOrAddGroup ( FName GroupName
)

 Finds the index of the specified group, or creates a new entry for it (unless the name is NAME_None, which will return INDEX_NONE)
Public function Static UAnimBlueprint *

FindRootAnimBlueprint ( const UAnimBlueprint* DerivedBlueprint
)

 Returns the most base anim blueprint for a given blueprint (if it is inherited from another anim blueprint, returning null if only native / non-anim BP classes are it's parent)
Public function Const UAnimBlueprintGeneratedClass *  
Public function Const UAnimBlueprintGeneratedClass *  
Public function Const FAnimParentNodeAssetOverride *

GetAssetOverrideForNode ( FGuid NodeGuid,
bool bIgnoreSelf
)

 Inspects the hierarchy and looks for an override for the requested node GUID
Public function bool Inspects the hierarchy and builds a list of all asset overrides for this blueprint.
Public function Const FAnimBlueprintDebugData * Get the debug data for this anim BP
Public function Const UClass * Get the default binding type that any new nodes will use when created.
Public function Static UAnimBlueprint *

GetParentAnimBlueprint ( const UAnimBlueprint* DerivedBlueprint
)

 Returns the parent anim blueprint for a given blueprint (if it is inherited from another anim blueprint, returning null if only native / non-anim BP classes are it's parent)
Public function Const UAnimBlueprint *  
Public function Const EPreviewAnimationBlueprintApplicationMethod  
Public function Const FName  
Public function Const bool

IsCompatible ( const UAnimBlueprint* InAnimBlueprint
)

 Check if the anim BP is compatible with this one (for linked instancing).
Public function Const bool

IsCompatibleByAssetString ( const FString& InSkeletonAsset,
bool bInIsTemplate,
bool bInIsInterface
)

 Check if the asset path of a skeleton, template and interface flags are compatible with this anim blueprint (for linked instancing)
Public function Const bool

IsObjectBeingDebugged ( const UObject* AnimInstance
)

 Check if the anim instance is the active debug object for this anim BP
Public function void  
Public function FOnGraphRenamedEvent &  
Public function void  
Public function void Queue a refresh of the set of anim blueprint extensions that this anim blueprint hosts.
Public function void

SetPreviewAnimationBlueprint ( UAnimBlueprint* InPreviewAnimationBlueprint
)

 Preview anim blueprint support
Public function void  
Public function void  
Public function void

UnregisterOnOverrideChanged ( SWidget* Widget
)

  

Overridden from UBlueprint

  Type Name Description
Public function Virtual Const bool

AllowFunctionOverride ( const UFunction*const InFunction
)

 Returns true if this blueprints allows the given function to be overridden
Public function Virtual Const bool Some Blueprints (and classes) can recompile while we are debugging a live session (play in editor).
Public function Virtual Const bool

FindDiffs ( const UBlueprint* OtherBlueprint,
FDiffResults& Results
)

 Fills in a list of differences between this blueprint and another blueprint.
Public function Virtual Const UClass * Gets the class generated when this blueprint is compiled.
Public function Virtual Const void Allow each blueprint instance to add specific UBlueprintNodeSpawners pertaining to the sub-class type.
Public function Virtual Const void Allow each blueprint type (AnimBlueprint or ControlRigBlueprint) to add specific UBlueprintNodeSpawners pertaining to the sub-class type.
Public function Virtual Const bool Whether or not this blueprint can be considered for a bytecode only compile
Public function Virtual void

NotifyGraphRenamed ( UEdGraph* Graph,
FName OldName,
FName NewName
)

 Notify the blueprint when a graph is renamed to allow for additional fixups.
Public function Virtual void Sets the current object being debugged
Public function Virtual Const bool Should the generic blueprint factory work for this blueprint?
Public function Virtual Const bool Returns true if this blueprint supports animation layers
Public function Virtual Const bool Returns true if this blueprint supports delegates
Public function Virtual Const bool Returns true if this blueprint supports event graphs
Public function Virtual Const bool  
Public function Virtual Const bool Returns true if this blueprint supports macros

Overridden from UObject

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Overridden from IInterface_PreviewMeshProvider

  Type Name Description
Public function Virtual Const USkeletalMesh * Get the preview mesh for this asset
Public function Virtual USkeletalMesh *

GetPreviewMesh ( bool bFindIfNotSet
)

 Get the preview mesh for this asset, non const.
Public function Virtual void

SetPreviewMesh ( USkeletalMesh* PreviewMesh,
bool bMarkAsDirty
)

 IInterface_PreviewMeshProvider interface

Classes

  Type Name Description
Public class FOnGraphRenamedEvent Event that is broadcast to inform observers that the node title has changed The default SAnimationGraphNode uses this to invalidate cached node title text  

Typedefs

Name Description
FOnOverrideChanged  
FOnOverrideChangedMulticaster  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page