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 > UAnimationAsset

Light Theme

Dark Theme

UAnimationAsset

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UAnimationAsset

UAnimSequenceBase

UAnimCompositeBase

	UAnimComposite
	UAnimMontage

UAnimSequence

UAnimStreamable

UBlendSpace

UAimOffsetBlendSpace

UBlendSpace1D

UAimOffsetBlendSpace1D

UPoseAsset

References

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

Syntax

class UAnimationAsset :
    public UObject,
    public IInterface_AssetUserData,
    public IInterface_PreviewMeshProvider

Variables

	Name	Description
TObjectPtr< cla...	AssetMappingTable	Asset mapping table when ParentAsset is set
TArray< TObject...	AssetUserData	Array of user data stored with the asset
TArray< TObject...	ChildrenAssets	Note this is transient as they're added as they're loaded
TObjectPtr< cla...	ParentAsset	Parent asset is used for AnimMontage when it derives all settings but remap animation asset.
TObjectPtr< cla...	PreviewPoseAsset	The default skeletal mesh to use when previewing this asset - this only applies when you open Persona using this asset
TObjectPtr< cla...	ThumbnailInfo	Information for thumbnail rendering

Functions

	Name	Description
void	AddMetaData ( UAnimMetaData* MetaDataInstanc... )
void	EmptyMetaData()
UAnimMetaDat...	FindMetaDataByClass ( const TSubclassOf< UAnimMetaData > ... )	Returns the first metadata of the specified class
T *	FindMetaDataByClass()	Templatized version of FindMetaDataByClass that handles casting for you
bool	GetAllAnimationSequencesReferred ( TArray< class UAnimationAsset*..., bool bRecursive )	Retrieve all animations that are used by this asset
const UAsset...	GetAssetMappingTable()
int32	GetMarkerUpdateCounter()
const TArray...	GetMetaData()	Get available Metadata within the animation asset
float	GetPlayLength()
USkeleton &#...	GetSkeleton()
FGuid	GetSkeletonVirtualBoneGuid()
TArray< FNam...	GetUniqueMarkerNames()	Return a list of unique marker names for blending compatibility
void	HandleAnimReferenceCollection ( TArray< UAnimationAsset* >& A..., bool bRecursive )	Helper function for GetAllAnimationSequencesReferred, it adds itself first and call GetAllAnimationSEquencesReferred.
bool	HasParentAsset()
bool	IsValidAdditive()	Return true if this is valid additive animation false otherwise
void	OnSetSkeleton ( USkeleton* NewSkeleton )
void	RefreshParentAssetData()
bool	RemapAsset ( UAnimationAsset* SourceAsset, UAnimationAsset* TargetAsset )
void	RemapTracksToNewSkeleton ( USkeleton* NewSkeleton, bool bConvertSpaces )
void	RemoveMetaData ( TArrayView< UAnimMetaData* > M... )
void	RemoveMetaData ( UAnimMetaData* MetaDataInstanc... )
void	ReplaceReferredAnimations ( const TMap< UAnimationAsset*, ... )	Replace this assets references to other animations based on ReplacementMap
bool	ReplaceSkeleton ( USkeleton* NewSkeleton, bool bConvertSpaces )	Replace Skeleton
void	SetParentAsset ( UAnimationAsset* InParentAsset )	Parent Asset related function. Used by editor
void	SetPreviewSkeletalMesh ( USkeletalMesh* PreviewMesh )	Sets or updates the preview skeletal mesh
void	SetSkeleton ( USkeleton* NewSkeleton )
void	SetSkeletonVirtualBoneGuid ( FGuid Guid )
void	TickAssetPlayer ( FAnimTickRecord& Instance, FAnimNotifyQueue& NotifyQueue, FAnimAssetTickContext& Context )	Advances the asset player instance
void	UpdateParentAsset()	We have to update whenever we have anything loaded
void	ValidateParentAsset()
void	ValidateSkeleton()	Validate our stored data against our skeleton and update accordingly

Overridden from UObject

	Name	Description
void	GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTa... )	Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects
EDataValidat...	IsDataValid ( TArray< FText >& ValidationErrors )	Generic function to validate objects during changelist validations, etc.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
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_AssetUserData

		Name	Description
	void	AddAssetUserData ( UAssetUserData* InUserData )
	const TArray...	GetAssetUserDataArray()
	UAssetUserDa...	GetAssetUserDataOfClass ( TSubclassOf< UAssetUserData > InUse... )
	void	RemoveUserDataOfClass ( TSubclassOf< UAssetUserData > InUse... )

Overridden from IInterface_PreviewMeshProvider

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

Deprecated Functions

		Name	Description
	float	GetMaxCurrentTime()	Use GetPlayLength instead
	void	ResetSkeleton ( USkeleton* NewSkeleton )	ResetSkeleton has been deprecated, use ReplaceSkeleton or SetSkeleton instead

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

Take our survey

Cancel