Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > Animation > UAnimBlueprint

Light Theme

Dark Theme

UAnimBlueprint

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

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UBlueprintCore

UBlueprint

UAnimBlueprint

References

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

Syntax

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

	Name	Description
bool	bUseMultiThreadedAnimationUpdate	Allows this anim Blueprint to update its native update, blend tree, montages and asset players on a worker thread.
bool	bWarnAboutBlueprintUsage	Selecting this option will cause the compiler to emit warnings whenever a call into Blueprint is made from the animation graph.
TArray< FAnimGr...	Groups	List of animation sync groups.
FOnOverrideChan...	OnOverrideChanged	Broadcast when an override is changed, allowing derived blueprints to be updated.
TArray< FAnimPa...	ParentAssetOverrides	Array of overrides to asset containing nodes in the parent that have been overridden.
TArray< class U...	PoseWatches	Array of active pose watches (pose watch allows us to see the bone pose at a particular point of the anim graph)
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

	Name	Description
	UAnimBlueprint ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
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)
UAnimBluepri...	FindRootAnimBlueprint ( const UAnimBlueprint* DerivedB... )	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)
UAnimBluepri...	GetAnimBlueprintGeneratedClass()
UAnimBluepri...	GetAnimBlueprintSkeletonClass()
FAnimParentN...	GetAssetOverrideForNode ( FGuid NodeGuid, bool bIgnoreSelf )	Inspects the hierarchy and looks for an override for the requested node GUID
bool	GetAssetOverrides ( TArray< FAnimParentNodeAssetOverrid... )	Inspects the hierarchy and builds a list of all asset overrides for this blueprint.
FAnimBluepri...	GetDebugData()	Get the debug data for this anim BP
UAnimBluepri...	GetPreviewAnimationBlueprint()
EPreviewAnim...	GetPreviewAnimationBlueprintApplicationMethod()
FName	GetPreviewAnimationBlueprintTag()
bool	IsObjectBeingDebugged ( const UObject* AnimInstance )	Check if the anim instance is the active debug object for this anim BP
void	NotifyOverrideChange ( FAnimParentNodeAssetOverride& Over... )
void	RegisterOnOverrideChanged ( const FOnOverrideChanged& Delegate )
void	SetPreviewAnimationBlueprint ( UAnimBlueprint* InPreviewAnima... )	Preview anim blueprint support
void	SetPreviewAnimationBlueprintApplicationMethod ( EPreviewAnimationBlueprintApplicati... )
void	SetPreviewAnimationBlueprintTag ( FName InTag )
void	UnregisterOnOverrideChanged ( SWidget* Widget )

Overridden from UBlueprint

	Name	Description
bool	CanRecompileWhilePlayingInEditor()	Some Blueprints (and classes) can recompile while we are debugging a live session.
bool	FindDiffs ( const UBlueprint* OtherBluepri..., FDiffResults& Results )	Fills in a list of differences between this blueprint and another blueprint.
UClass *	GetBlueprintClass()	Gets the class generated when this blueprint is compiled.
bool	IsValidForBytecodeOnlyRecompile()	Whether or not this blueprint can be considered for a bytecode only compile
bool	SupportedByDefaultBlueprintFactory()	Should the generic blueprint factory work for this blueprint?

Overridden from UObject

		Name	Description
	void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
	void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Overridden from IInterface_PreviewMeshProvider

	Name	Description
USkeletalMes...	GetPreviewMesh ( bool bFindIfNotSet )	Get the preview mesh for this asset, non const.
USkeletalMes...	GetPreviewMesh()	Get the preview mesh for this asset
void	SetPreviewMesh ( USkeletalMesh* PreviewMesh, bool bMarkAsDirty )	IInterface_PreviewMeshProvider interface

Typedefs

Name	Description
FOnOverrideChanged
FOnOverrideChangedMulticaster

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss