Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

> Unreal Engine API Reference > Runtime > Engine > Animation > UAnimInstance

Light Theme

Dark Theme

UAnimInstance

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UAnimInstance

UAnimPreviewAttacheInstance

UAnimSequencerInstance

UAnimSharingAdditiveInstance

UAnimSharingStateInstance

UAnimSharingTransitionInstance

UAnimSingleNodeInstance

UAnimPreviewInstance

	UIKRetargetAnimInstance
	UIKRigAnimInstance

UControlRigAnimInstance

UControlRigLayerInstance

ULiveLinkInstance

UVehicleAnimationInstance

UVehicleAnimInstance

References

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

Syntax

class UAnimInstance : public UObject

Variables

	Name	Description
TArray< FAnimNo...	ActiveAnimNotifyEventReference
TArray< FAnimNo...	ActiveAnimNotifyState	Currently Active AnimNotifyState, stored as a copy of the event as we need to call NotifyEnd on the event after a deletion in the editor.
TMap< class UAn...	ActiveMontagesMap	Map between Active Montages and their FAnimMontageInstance
FAnimInstancePr...	AnimInstanceProxy	Proxy object, nothing should access this from an externally-callable API as it is used as a scratch area on worker threads
uint8: 1	bCreatedByLinkedAnimGraph	Flag to check if created by LinkedAnimGraph in ReinitializeLinkedAnimInstance
uint8: 1	bNeedsUpdate	Flag to check back on the game thread that indicates we need to run PostUpdateAnimation() in the post-eval call
uint8: 1	bPropagateNotifiesToLinkedInstances	Whether to propagate notifies to any linked anim instances
uint8: 1	bReceiveNotifiesFromLinkedInstances	Whether to process notifies from any linked anim instances
uint8: 1	bUseMainInstanceMontageEvaluationData	If true, linked instances will use the main instance's montage data.
uint8: 1	bUseMultiThreadedAnimationUpdate	Allows this anim instance to update its native update, blend tree, montages and asset players on a worker thread.
uint8: 1	bUsingCopyPoseFromMesh	If this AnimInstance has nodes using 'CopyPoseFromMesh' this will be true.
double	CurrentLifeTimerScrubPosition	Current scrubbing playback position (only used when debugging in Persona)
TObjectPtr< USk...	CurrentSkeleton	This is used to extract animation. If Mesh exists, this will be overwritten by Mesh->Skeleton
FGraphTraversal...	DebugDataCounter
double	LifeTimer	Maximum playback position ever reached (only used when debugging in Persona)
TArray< struct ...	MontageInstances	AnimMontage instances that are running currently
FAnimNotifyQueu...	NotifyQueue	Animation Notifies that has been triggered in the latest tick
FOnAllMontageIn...	OnAllMontageInstancesEnded	Called when all Montage instances have ended.
FOnMontageBlend...	OnMontageBlendingOut	Called when a montage starts blending out, whether interrupted or finished
FOnMontageEnded...	OnMontageEnded	Called when a montage has ended, whether interrupted or finished
FOnMontageStart...	OnMontageStarted	Called when a montage has started
FPlayMontageAni...	OnPlayMontageNotifyBegin	Called when a montage hits a 'PlayMontageNotify' or 'PlayMontageNotifyWindow' begin
FPlayMontageAni...	OnPlayMontageNotifyEnd	Called when a montage hits a 'PlayMontageNotify' or 'PlayMontageNotifyWindow' end
ETeleportType	PendingDynamicResetTeleportType	Pending teleport type, set in ResetDynamics and cleared in UpdateAnimation
FSoftClassPath	PostCompileValidationClassName	Name of Class to do Post Compile Validation.
TEnumAsByte< ER...	RootMotionMode	Sets where this blueprint pulls Root Motion from.
TMap< FName, fl...	SlotGroupInertializationRequestMap	Inertialization requests gathered this frame. Gets reset in UpdateMontageEvaluationData

Constructors

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

Destructors

	Name	Description
	~UAnimInstance()	Disable compiler-generated deprecation warnings by implementing our own destructor.

Functions

	Name	Description
void	AddCurveValue ( const FSmartNameMapping& Mapping, const FName& CurveName, float Value )	Add curve float data using a curve Uid, the name of the curve will be resolved from the skeleton.
void	AddCurveValue ( const FName& CurveName, float Value )	Add curve float data, using a curve name.
void	AddCurveValue ( const USkeleton::AnimCurveUID Uid, float Value )	Add curve float data using a curve Uid, the name of the curve will be resolved from the skeleton
void	AddExternalNotifyHandler ( UObject* ExternalHandlerObject, FName NotifyEventName )	Allows other UObjects to bind custom event notifies similarly to the AnimBP
void	AddNativeStateEntryBinding ( const FName& MachineName, const FName& StateName, const FOnGraphStateChanged& Native... )	Sets up a native state entry delegate from state with StateName, in the state machine with name MachineName.
void	AddNativeStateExitBinding ( const FName& MachineName, const FName& StateName, const FOnGraphStateChanged& Native... )	Sets up a native state exit delegate from state with StateName, in the state machine with name MachineName.
void	AddNativeTransitionBinding ( const FName& MachineName, const FName& PrevStateName, const FName& NextStateName, const FCanTakeTransition& NativeTr..., const FName& TransitionName )	Sets up a native transition delegate between states with PrevStateName and NextStateName, in the state machine with name MachineName.
FPoseSnapsho...	AddPoseSnapshot ( FName SnapshotName )	Add an empty pose snapshot to the internal snapshot cache (or recycle an existing pose snapshot if the name is already in use)
void	AddReferencedObjects ( UObject* InThis, FReferenceCollector& Collector )
void	AppendAnimationCurveList ( EAnimCurveType Type, TMap< FName, float >& InOutCurveLi... )	Append the type of curve to the OutCurveList specified by Curve Flags
void	ApplyAnimOverridesToCDO ( FCompilerResultsLog& MessageLog )	Called on the newly created CDO during anim blueprint compilation to allow subclasses a chance to replace animations (experimental)
void	BlueprintBeginPlay()	Executed when begin play is called on the owning component
void	BlueprintInitializeAnimation()	Executed when the Animation is initialized
void	BlueprintLinkedAnimationLayersInitialized()	Executed when the all Linked Animation Layers are initialized
void	BlueprintPostEvaluateAnimation()	Executed after the Animation is evaluated
void	BlueprintThreadSafeUpdateAnimation ( float DeltaTime )	Executed when the Animation Blueprint is updated on a worker thread, just prior to graph update
void	BlueprintUpdateAnimation ( float DeltaTimeX )	Executed when the Animation is updated
float	CalcSlotMontageLocalWeight ( const FName& SlotNodeName )	Get local weight of any montages this slot is playing.
bool	CanRunParallelWork()	Can this animation instance run Update or Evaluation work in parallel.
bool	CanTransitionSignature()
void	ClearMontageInstanceReferences ( FAnimMontageInstance& InMontageIns... )
void	ClearMorphTargets()	Clears the current morph targets.
FRootMotionM...	ConsumeExtractedRootMotion ( float Alpha )	Get current accumulated root motion, removing it from the AnimInstance in the process
void	CopyCurveValues ( const UAnimInstance& InSourceInsta... )	Copy curves from external source
FAnimInstanc...	CreateAnimInstanceProxy()	Override point for derived classes to create their own proxy objects (allows custom allocation)
void	DestroyAnimInstanceProxy ( FAnimInstanceProxy* InProxy )	Override point for derived classes to destroy their own proxy objects (allows custom allocation)
void	DispatchQueuedAnimEvents()	Dispatch AnimEvents (AnimNotifies, Montage Events) queued during UpdateAnimation()
void	DisplayDebug ( UCanvas* Canvas, const FDebugDisplayInfo& DebugDisp..., float& YL, float& YPos )	Debug output for this anim instance. Info for SyncGroups, Graph, Montages, etc.
void	DisplayDebugInstance ( FDisplayDebugManager& DisplayDebug..., float& Indent )	Display debug info about AnimInstance. Can be overridden to add custom info from child classes.
void	EndNotifyStates()	Triggers end on active notify states and clears the array
SubsystemTyp...	FindSubsystem()	Get a subsystem's instance-resident data. If no subsystem of the type exists this will return nullptr.
FAnimSubsyst...	FindSubsystem ( UScriptStruct* InSubsystemType )	Find a subsystem's instance-resident data.
void	GetActiveCurveNames ( EAnimCurveType CurveType, TArray< FName >& OutNames )	This returns last up-to-date list of active curve names
FAnimMontage...	GetActiveInstanceForMontage ( const UAnimMontage* Montage )	Get Active FAnimMontageInstance for given Montage asset.
FAnimMontage...	GetActiveMontageInstance()	Get Currently active montage instance.
void	GetAllCurveNames ( TArray< FName >& OutNames )	This returns all curve names
const TMap< ...	GetAnimationCurveList ( EAnimCurveType Type )	Return the list of curves that are specified by type
UAnimMontage...	GetCurrentActiveMontage()	Get a current Active Montage in this AnimInstance.
FName	GetCurrentStateName ( int32 MachineIndex )	Returns the name of a currently active state in a state machine.
bool	GetCurveValue ( FName CurveName, float& OutValue )	Returns value of named curved in OutValue, returns whether the curve was actually found or not.
float	GetCurveValue ( FName CurveName )	Returns the value of a named curve.
float	GetDeltaSeconds()	Get the current delta time
int32	GetInstanceAssetPlayerIndex ( FName MachineName, FName StateName, FName InstanceName )	Get the index of the specified instance asset player.
float	GetInstanceAssetPlayerLength ( int32 AssetPlayerIndex )	Derived anim getters
TArray< cons...	GetInstanceAssetPlayers ( const FName& GraphName )	Returns all Animation Nodes of FAnimNode_AssetPlayerBase class within the specified (named) Animation Graph
float	GetInstanceAssetPlayerTime ( int32 AssetPlayerIndex )	Get the current accumulated time in seconds for an asset player node
float	GetInstanceAssetPlayerTimeFraction ( int32 AssetPlayerIndex )	Get the current accumulated time as a fraction for an asset player node
float	GetInstanceAssetPlayerTimeFromEnd ( int32 AssetPlayerIndex )	Get the time in seconds from the end of an animation in an asset player node
float	GetInstanceAssetPlayerTimeFromEndFraction ( int32 AssetPlayerIndex )	Get the time as a fraction of the asset length of an animation in an asset player node
float	GetInstanceCurrentStateElapsedTime ( int32 MachineIndex )	Get the current elapsed time of a state within the specified state machine
float	GetInstanceMachineWeight ( int32 MachineIndex )	Get the blend weight of a specified state machine
float	GetInstanceStateWeight ( int32 MachineIndex, int32 StateIndex )	Get the blend weight of a specified state
float	GetInstanceTransitionCrossfadeDuration ( int32 MachineIndex, int32 TransitionIndex )	Get the crossfade duration of a specified transition
float	GetInstanceTransitionTimeElapsed ( int32 MachineIndex, int32 TransitionIndex )	Get the elapsed time in seconds of a specified transition
float	GetInstanceTransitionTimeElapsedFraction ( int32 MachineIndex, int32 TransitionIndex )	Get the elapsed time as a fraction of the crossfade duration of a specified transition
UAnimInstanc...	GetLinkedAnimGraphInstanceByTag ( FName InTag )	Runs through all nodes, attempting to find the first linked instance by name/tag
UAnimInstanc...	GetLinkedAnimLayerInstanceByClass ( TSubclassOf< UAnimInstance > InClas... )	Gets the first layer linked instance corresponding to the specified class
UAnimInstanc...	GetLinkedAnimLayerInstanceByGroup ( FName InGroup )	Gets the layer linked instance corresponding to the specified group
UAnimInstanc...	GetLinkedAnimLayerInstanceByGroupAndClass ( FName InGroup, TSubclassOf< UAnimInstance > InClas... )	Gets layer linked instance that matches group and class
void	GetLinkedAnimLayerInstancesByGroup ( FName InGroup, TArray< UAnimInstance* >& Out... )	Runs through all nodes, attempting to find all distinct layer linked instances in the group
FAnimNode_Li...	GetLinkedInputPoseNode ( FName InSubInput, FName InGraph )	Get a linked input pose node by name, given a named graph.
int32	GetLODLevel()	Get the 'animation' LOD level, which by default is the PredictedLODLevel of this anim instance's skeletal mesh component.
const FBaked...	GetMachineDescription ( IAnimClassInterface* AnimBluep..., FAnimNode_StateMachine* Machin... )	Get the machine description for the specified instance.
FAnimMontage...	GetMontageInstanceForID ( int32 MontageInstanceID )	Get the FAnimMontageInstance currently running that matches this ID.
TArray< FAni...	GetMutableInstanceAssetPlayers ( const FName& GraphName )	Returns all Animation Nodes of FAnimNode_AssetPlayerBase class within the specified (named) Animation Graph
AActor *	GetOwningActor()	Returns the owning actor of this AnimInstance
USkeletalMes...	GetOwningComponent()	Returns the skeletal mesh component that has created this AnimInstance.
const FPoseS...	GetPoseSnapshot ( FName SnapshotName )	Get a cached pose snapshot by name
bool	GetPropagateNotifiesToLinkedInstances()	Get whether to propagate notifies to any linked anim instances
const T &	GetProxyOnAnyThread()	Access the proxy but block if a task is currently in progress (and we are on the game thread) as it wouldn't be safe to access it
T &	GetProxyOnAnyThread()	Access the proxy but block if a task is currently in progress (and we are on the game thread) as it wouldn't be safe to access it
const T &	GetProxyOnGameThread()	Access the proxy but block if a task is currently in progress as it wouldn't be safe to access it
T &	GetProxyOnGameThread()	Access the proxy but block if a task is currently in progress as it wouldn't be safe to access it
T *	GetProxyOnGameThreadStatic ( UAnimInstance* InAnimInstance )	Access the proxy but block if a task is currently in progress as it wouldn't be safe to access it This is protected static member for allowing derived to access
bool	GetReceiveNotifiesFromLinkedInstances()	Get whether to process notifies from any linked anim instances
float	GetRelevantAnimLength ( int32 MachineIndex, int32 StateIndex )	Get the length in seconds of the most relevant animation in the source state
float	GetRelevantAnimTime ( int32 MachineIndex, int32 StateIndex )	Get the current accumulated time in seconds for the most relevant animation in the source state
float	GetRelevantAnimTimeFraction ( int32 MachineIndex, int32 StateIndex )	Get the current accumulated time as a fraction of the length of the most relevant animation in the source state
float	GetRelevantAnimTimeRemaining ( int32 MachineIndex, int32 StateIndex )	Get the time remaining in seconds for the most relevant animation in the source state
float	GetRelevantAnimTimeRemainingFraction ( int32 MachineIndex, int32 StateIndex )	Get the time remaining as a fraction of the duration for the most relevant animation in the source state
const FAnimN...	GetRelevantAssetPlayerFromState ( int32 MachineIndex, int32 StateIndex )	Gets the most relevant asset player in a specified state
const FBoneC...	GetRequiredBones()	Access the required bones array
FBoneContain...	GetRequiredBones()	Access the required bones array
const FBoneC...	GetRequiredBonesOnAnyThread()	Access the required bones array
FAnimMontage...	GetRootMotionMontageInstance()	Root Motion.
USkeletalMes...	GetSkelMeshComponent()
float	GetSlotMontageGlobalWeight ( const FName& SlotNodeName )	Get Global weight of any montages this slot node is playing.
float	GetSlotMontageLocalWeight ( const FName& SlotNodeName )	Get local weight of any montages this slot node is playing.
float	GetSlotNodeGlobalWeight ( const FName& SlotNodeName )	Get global weight in AnimGraph for this slot node.
int32	GetStateMachineIndex ( FName MachineName )	Gets the index of the state machine matching MachineName
void	GetStateMachineIndexAndDescription ( FName InMachineName, int32& OutMachineIndex, const FBakedAnimationStateMachine&... )
const FAnimN...	GetStateMachineInstance ( int32 MachineIndex )	Gets the runtime instance of the specified state machine
const FBaked...	GetStateMachineInstanceDesc ( FName MachineName )	Gets the runtime instance desc of the state machine specified by name
const FAnimN...	GetStateMachineInstanceFromName ( FName MachineName )	Gets the runtime instance of the specified state machine by Name
SubsystemTyp...	GetSubsystem()	Get a subsystem's instance-resident data. If no subsystem of the type exists this will assert.
int32	GetSyncGroupIndexFromName ( FName SyncGroupName )	Returns the baked sync group index from the compile step
FMarkerSyncA...	GetSyncGroupPosition ( FName InSyncGroupName )
bool	GetTimeToClosestMarker ( FName SyncGroup, FName MarkerName, float& OutMarkerTime )
const FGraph...	GetUpdateCounter()	Access a read only version of the Updater Counter from the AnimInstanceProxy on the GameThread.
UWorld *	GetWorld()
bool	HandleNotify ( const FAnimNotifyEvent& AnimNotify... )	Implementable custom function to handle notifies
bool	HasActiveCurves()	Check whether we have any active curves
bool	HasMarkerBeenHitThisFrame ( FName SyncGroup, FName MarkerName )
bool	HasMorphTargetCurves()	Check whether we have active morph target curves
bool	HasNativeStateEntryBinding ( const FName& MachineName, const FName& StateName, FName& OutBindingName )	Check for whether a native entry delegate is bound to the specified state.
bool	HasNativeStateExitBinding ( const FName& MachineName, const FName& StateName, FName& OutBindingName )	Check for whether a native exit delegate is bound to the specified state.
bool	HasNativeTransitionBinding ( const FName& MachineName, const FName& PrevStateName, const FName& NextStateName, FName& OutBindingName )	Check for whether a native rule is bound to the specified transition.
void	InitializeAnimation ( bool bInDeferRootNodeInitialization )	Animation phase trigger start with initialize update happens in every tick.
void	InitializeGroupedLayers ( bool bInDeferSubGraphInitialization )	Sets up initial layer groupings
bool	IsAnyMontagePlaying()	Returns true if any montage is playing currently.
bool	IsPlayingSlotAnimation ( const UAnimSequenceBase* Asset, FName SlotNodeName, UAnimMontage*& OutMontage )	Return true if this instance playing the slot animation, also returning the montage it is playing on
bool	IsPlayingSlotAnimation ( const UAnimSequenceBase* Asset, FName SlotNodeName )	Return true if it's playing the slot animation
bool	IsPostUpdatingAnimation()	Is this animation currently running post update
bool	IsRunningParallelEvaluation()	Are we being evaluated on a worker thread.
bool	IsSyncGroupBetweenMarkers ( FName InSyncGroupName, FName PreviousMarker, FName NextMarker, bool bRespectMarkerOrder )
bool	IsUsingMainInstanceMontageEvaluationData()
void	LinkAnimClassLayers ( TSubclassOf< UAnimInstance > InClas... )	Runs through all layer nodes, attempting to find layer nodes that are implemented by the specified class, then sets up a linked instance of the class for each.
void	LinkAnimGraphByTag ( FName InTag, TSubclassOf< UAnimInstance > InClas... )	Runs through all nodes, attempting to find a linked instance by name/tag, then sets the class of each node if the tag matches
void	LockAIResources ( bool bLockMovement, bool LockAILogic )	Locks indicated AI resources of animated pawn DEPRECATED. Use LockAIResourcesWithAnimation instead
void	MakeMontageTickRecord ( FAnimTickRecord& TickRecord, UAnimMontage* Montage, float MoveDelta, float Weight, TArray< FPassedMarker >& MarkersPa..., FMarkerTickRecord& MarkerTickRecor... )
void	Montage_Advance ( float DeltaSeconds )	Advance montages
FOnMontageBl...	Montage_GetBlendingOutDelegate ( UAnimMontage* Montage )	Get pointer to BlendingOutStarted delegate for Montage.
float	Montage_GetBlendTime ( const UAnimMontage* Montage )	Get the current blend time of the Montage.
FName	Montage_GetCurrentSection ( const UAnimMontage* Montage )	Returns the name of the current animation montage section.
bool	Montage_GetIsStopped ( const UAnimMontage* Montage )	Return true if Montage is not currently active. (not valid or blending out)
int32	Montage_GetNextSectionID ( const UAnimMontage* Montage, int32 const& CurrentSectionID )	Get next sectionID for given section ID
float	Montage_GetPlayRate ( const UAnimMontage* Montage )	Get PlayRate for Montage.
float	Montage_GetPosition ( const UAnimMontage* Montage )	Get Current Montage Position
bool	Montage_IsActive ( const UAnimMontage* Montage )	Returns true if the animation montage is active.
bool	Montage_IsPlaying ( const UAnimMontage* Montage )	Returns true if the animation montage is currently active and playing.
void	Montage_JumpToSection ( FName SectionName, const UAnimMontage* Montage )	Makes a montage jump to a named section.
void	Montage_JumpToSectionsEnd ( FName SectionName, const UAnimMontage* Montage )	Makes a montage jump to the end of a named section.
void	Montage_Pause ( const UAnimMontage* Montage )	Pauses the animation montage. If reference is NULL, it will pause ALL active montages.
float	Montage_Play ( UAnimMontage* MontageToPlay, float InPlayRate, EMontagePlayReturnType ReturnValueT..., float InTimeToStartMontageAt, bool bStopAllMontages )	Plays an animation montage.
float	Montage_PlayInternal ( UAnimMontage* MontageToPlay, const FMontageBlendSettings& Blend..., float InPlayRate, EMontagePlayReturnType ReturnValueT..., float InTimeToStartMontageAt, bool bStopAllMontages )
float	Montage_PlayWithBlendIn ( UAnimMontage* MontageToPlay, const FAlphaBlendArgs& BlendIn, float InPlayRate, EMontagePlayReturnType ReturnValueT..., float InTimeToStartMontageAt, bool bStopAllMontages )	Plays an animation montage.
float	Montage_PlayWithBlendSettings ( UAnimMontage* MontageToPlay, const FMontageBlendSettings& Blend..., float InPlayRate, EMontagePlayReturnType ReturnValueT..., float InTimeToStartMontageAt, bool bStopAllMontages )	Plays an animation montage.
void	Montage_Resume ( const UAnimMontage* Montage )	Resumes a paused animation montage. If reference is NULL, it will resume ALL active montages.
void	Montage_SetBlendingOutDelegate ( FOnMontageBlendingOutStarted& InOn..., UAnimMontage* Montage )
void	Montage_SetEndDelegate ( FOnMontageEnded& InOnMontageEnded, UAnimMontage* Montage )
void	Montage_SetNextSection ( FName SectionNameToChange, FName NextSection, const UAnimMontage* Montage )	Relink new next section AFTER SectionNameToChange in run-time You can link section order the way you like in editor, but in run-time if you'd like to change it dynamically, use this function to relink the next section For example, you can have Start->Loop->Loop->Loop....
void	Montage_SetPlayRate ( const UAnimMontage* Montage, float NewPlayRate )	Change AnimMontage play rate. NewPlayRate = 1.0 is the default playback rate.
void	Montage_SetPosition ( const UAnimMontage* Montage, float NewPosition )	Set position.
void	Montage_Stop ( float InBlendOutTime, const UAnimMontage* Montage )	Stops the animation montage.
void	Montage_StopGroupByName ( float InBlendOutTime, FName GroupName )	Stops all active montages belonging to a group.
void	Montage_StopInternal ( TFunctionRef< FMontageBlendSettings..., const UAnimMontage* Montage )
void	Montage_StopWithBlendOut ( const FAlphaBlendArgs& BlendOut, const UAnimMontage* Montage )	Same as Montage_Stop.
void	Montage_StopWithBlendSettings ( const FMontageBlendSettings& Blend..., const UAnimMontage* Montage )	Same as Montage_Stop, but all blend settings are provided instead of using the ones on the montage asset
void	Montage_UpdateWeight ( float DeltaSeconds )	Update weight of montages
void	MontageSync_Follow ( const UAnimMontage* MontageFol..., const UAnimInstance* OtherAnim..., const UAnimMontage* MontageLea... )	Synchronize a montage to another anim instance's montage. Both montages must be playing already
void	MontageSync_StopFollowing ( const UAnimMontage* MontageFol... )	Stop following the montage's leader in this anim instance
void	NativeBeginPlay()	Executed when begin play is called on the owning component.
void	NativeInitializeAnimation()	The below functions are the native overrides for each phase Native initialization override point
void	NativePostEvaluateAnimation()	Native Post Evaluate override point.
void	NativeUninitializeAnimation()	Native Uninitialize override point.
void	NativeUpdateAnimation ( float DeltaSeconds )	Native update override point.
bool	NeedsUpdate()	Can does this anim instance need an update (parallel or not)?
void	OnMontageInstanceStopped ( FAnimMontageInstance& StoppedMonta... )
void	OnUROPreInterpolation_AnyThread ( FAnimationEvaluationContext& InOut... )	Called before URO interpolation is performed.
void	OnUROSkipTickAnimation()	Called when skipping an animation update because of URO.
bool	ParallelCanEvaluate ( const USkeletalMesh* InSkeleta... )	Check whether evaluation can be performed on the supplied skeletal mesh.
void	ParallelEvaluateAnimation ( bool bForceRefPose, const USkeletalMesh* InSkeleta..., FParallelEvaluationData& OutAnimat... )	Perform evaluation. Can be called from worker threads.
void	ParallelUpdateAnimation()	Run update animation work on a worker thread
bool	PCV_ShouldNotifyAboutNodesNotUsingFastPath()
bool	PCV_ShouldWarnAboutNodesNotUsingFastPath()	Warn if AnimNodes are not using fast path during AnimBP compilation.
UAnimMontage...	PlaySlotAnimationAsDynamicMontage ( UAnimSequenceBase* Asset, FName SlotNodeName, float BlendInTime, float BlendOutTime, float InPlayRate, int32 LoopCount, float BlendOutTriggerTime, float InTimeToStartMontageAt )	Play normal animation asset on the slot node by creating a dynamic UAnimMontage.
UAnimMontage...	PlaySlotAnimationAsDynamicMontage_WithBlendArgs ( UAnimSequenceBase* Asset, FName SlotNodeName, const FAlphaBlendArgs& BlendIn, const FAlphaBlendArgs& BlendOut, float InPlayRate, int32 LoopCount, float BlendOutTriggerTime, float InTimeToStartMontageAt )	Play normal animation asset on the slot node by creating a dynamic UAnimMontage with blend in arguments.
UAnimMontage...	PlaySlotAnimationAsDynamicMontage_WithBlendSettings ( UAnimSequenceBase* Asset, FName SlotNodeName, const FMontageBlendSettings& Blend..., const FMontageBlendSettings& Blend..., float InPlayRate, int32 LoopCount, float BlendOutTriggerTime, float InTimeToStartMontageAt )	Play normal animation asset on the slot node by creating a dynamic UAnimMontage with blend in settings.
void	PostEvaluateAnimation()
void	PostUpdateAnimation()	Called after updates are completed, dispatches notifies etc.
void	PreEvaluateAnimation()	Called on the game thread pre-evaluation.
void	PreUpdateAnimation ( float DeltaSeconds )	Called to setup for updates
void	QueueMontageBlendingOutEvent ( const FQueuedMontageBlendingOutEven... )	Queue a Montage BlendingOut Event to be triggered.
void	QueueMontageEndedEvent ( const FQueuedMontageEndedEvent& Mo... )	Queue a Montage Ended Event to be triggered.
void	QueueRootMotionBlend ( const FTransform& RootTransform, const FName& SlotName, float Weight )	Queue blended root motion.
void	RecalcRequiredBones()	Recalculate Required Bones [RequiredBones] Is called when bRequiredBonesUpToDate = false
void	RecalcRequiredCurves ( const FCurveEvaluationOption& Curv... )	Recalculate Required Curves based on Required Bones [RequiredBones]
void	RecordMachineWeight ( const int32 InMachineClassIndex, const float InMachineWeight )	Given a machine index, record a state machine weight for this frame
void	RecordStateWeight ( const int32 InMachineClassIndex, const int32 InStateIndex, const float InStateWeight, const float InElapsedTime )	Given a machine and state index, record a state weight for this frame
void	RefreshCurves ( USkeletalMeshComponent* Compon... )	Refresh currently existing curves
void	RemoveExternalNotifyHandler ( UObject* ExternalHandlerObject, FName NotifyEventName )	Other UObjects should call this to remove themselves from the callbacks
void	RemovePoseSnapshot ( FName SnapshotName )	Remove a previously saved pose snapshot from the internal snapshot cache
void	RequestMontageInertialization ( const UAnimMontage* Montage, float Duration )	Builds an inertialization request from the montage's group and provided duration
void	RequestSlotGroupInertialization ( FName InSlotGroupName, float Duration )	Requests an inertial blend during the next anim graph update.
void	ResetDynamics ( ETeleportType InTeleportType )	Reset any dynamics running simulation-style updates (e.g. on teleport, time skip etc.)
void	SavePoseSnapshot ( FName SnapshotName )	Takes a snapshot of the current skeletal mesh component pose & saves it internally.
void	SetMorphTarget ( FName MorphTargetName, float Value )	Sets a morph target to a certain weight.
void	SetPropagateNotifiesToLinkedInstances ( bool bSet )	Set whether to propagate notifies to any linked anim instances
void	SetReceiveNotifiesFromLinkedInstances ( bool bSet )	Set whether to process notifies from any linked anim instances
void	SetRootMotionMode ( TEnumAsByte< ERootMotionMode::Type ... )	Set RootMotionMode
void	SetUseMainInstanceMontageEvaluationData ( bool bSet )
bool	ShouldExtractRootMotion()	Should Extract Root Motion or not. Return true if we do.
bool	ShouldTriggerAnimNotifyState ( const UAnimNotifyState* AnimNo... )	Return whether this AnimNotifyState should be triggered
void	SnapshotPose ( FPoseSnapshot& Snapshot )	Takes a snapshot of the current skeletal mesh component pose and saves it to the specified snapshot.
void	StopAllMontages ( float BlendOut )	Stop all montages that are active
void	StopAllMontagesByGroupName ( FName InGroupName, const FMontageBlendSettings& Blend... )	Stop all active montages belonging to 'InGroupName'
void	StopSlotAnimation ( float InBlendOutTime, FName SlotNodeName )	Stops currently playing slot animation slot or all
void	SwapCurveWithEvaluationContext ( FAnimationEvaluationContext& InOut... )	Swap curves out for evaluation
void	TriggerAnimNotifies ( float DeltaSeconds )	Trigger AnimNotifies
void	TriggerSingleAnimNotify ( FAnimNotifyEventReference& EventRe... )	Trigger an AnimNotify using an EventReference that provide context used in derived notify events
void	TriggerSingleAnimNotify ( const FAnimNotifyEvent* AnimNo... )	Trigger an AnimNotify. that this version does not provide any context for the event
APawn *	TryGetPawnOwner()
void	UninitializeAnimation()
void	UnlinkAnimClassLayers ( TSubclassOf< UAnimInstance > InClas... )	Runs through all layer nodes, attempting to find layer nodes that are currently running the specified class, then resets each to its default value.
void	UnlockAIResources ( bool bUnlockMovement, bool UnlockAILogic )	Unlocks indicated AI resources of animated pawn.
void	UpdateAnimation ( float DeltaSeconds, bool bNeedsValidRootMotion, EUpdateAnimationFlag UpdateFlag )	Update Animation code-paths, updates and advances animation state, returns whether or not the actual update should have been called immediately
void	UpdateCurves ( const FBlendedHeapCurve& InCurves )	Update all internal curves from Blended Curve
void	UpdateCurvesPostEvaluation()	Update curves once evaluation has taken place. Mostly pushes curves to materials/morphs
void	UpdateCurvesToComponents ( USkeletalMeshComponent* Compon... )	Update animation curves to component
void	UpdateCurvesToEvaluationContext ( const FAnimationEvaluationContext&... )	Pushes blended heap curve to output curves in the proxy using required bones cached data
void	UpdateMontageEvaluationData()	Updates the montage data used for evaluation based on the current playing montages.
bool	UpdateSnapshotAndSkipRemainingUpdate()	Returns true if a snapshot is being played back and the remainder of Update should be skipped.
bool	WasAnimNotifyNameTriggeredInAnyState ( FName NotifyName )	Get whether the animation notify with the specified name triggered last tick.
bool	WasAnimNotifyNameTriggeredInSourceState ( int32 MachineIndex, int32 StateIndex, FName NotifyName )	Get whether the most relevant animation triggered the animation notify with the specified name last tick..
bool	WasAnimNotifyNameTriggeredInStateMachine ( int32 MachineIndex, FName NotifyName )	Get whether the given state machine triggered the animation notify with the specified name last tick.
bool	WasAnimNotifyStateActiveInAnyState ( TSubclassOf< UAnimNotifyState > Ani... )	Get whether a particular notify state was active in any state machine last tick.
bool	WasAnimNotifyStateActiveInSourceState ( int32 MachineIndex, int32 StateIndex, TSubclassOf< UAnimNotifyState > Ani... )	Get whether a particular notify state is active in a specific state last tick.
bool	WasAnimNotifyStateActiveInStateMachine ( int32 MachineIndex, TSubclassOf< UAnimNotifyState > Ani... )	Get whether a particular notify state is active in a specific state machine last tick.
bool	WasAnimNotifyTriggeredInAnyState ( TSubclassOf< UAnimNotify > AnimNoti... )	Get whether an animation notify of a given type was triggered last tick.
bool	WasAnimNotifyTriggeredInSourceState ( int32 MachineIndex, int32 StateIndex, TSubclassOf< UAnimNotify > AnimNoti... )	Get whether the most relevant animation was in a particular notify state last tick.
bool	WasAnimNotifyTriggeredInStateMachine ( int32 MachineIndex, TSubclassOf< UAnimNotify > AnimNoti... )	Get whether a particular notify type was active in a specific state machine last tick.

Overridden from UObject

	Name	Description
void	BeginDestroy()	Called before destroying the object.
void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Enums

	Name	Description
	EUpdateAnimationFlag	Flag passed to UpdateAnimation, determines the path we follow

Typedefs

Name	Description
ProxyType

Deprecated Variables

	Name	Description
uint8: 1	bCanUseParallelUpdateAnimation_DEPRECATED	DEPRECATED: No longer used.
uint8: 1	bRunUpdatesInWorkerThreads_DEPRECATED	DEPRECATED: No longer used.
uint8: 1	bWarnAboutBlueprintUsage_DEPRECATED	This variable is no longer used. Use bWarnAboutBlueprintUsage on the UAnimBlueprint to control this.
float	DeltaTime_DEPRECATED	DeltaTime

Deprecated Functions

	Name	Description
float	CalculateDirection ( const FVector& Velocity, const FRotator& BaseRotation )	Please use UKismetAnimationLibrary::CalculateDirection instead
void	ClearLayerOverlay ( TSubclassOf< UAnimInstance > InClas... )	Function renamed, please use UnlinkAnimClassLayers
FAnimMontage...	GetActiveInstanceForMontage ( UAnimMontage const& Montage )	Please use GetActiveInstanceForMontage(const UAnimMontage* Montage)
void	GetAnimationCurveList ( EAnimCurveType Type, TMap< FName, float >& InOutCurveLi... )	This function is deprecated. Use AppendAnimationCurveList instead.
UAnimInstanc...	GetLayerSubInstanceByClass ( TSubclassOf< UAnimInstance > InClas... )	Function renamed, please use GetLinkedAnimLayerInstanceByClass
UAnimInstanc...	GetLayerSubInstanceByGroup ( FName InGroup )	Function renamed, please use GetLinkedAnimLayerInstanceByGroup
void	GetLinkedAnimGraphInstancesByTag ( FName InTag, TArray< UAnimInstance* >& Out... )	Tags are unique so this function is no longer supported. Please use GetLinkedAnimGraphInstanceByTag instead
FAnimNode_Li...	GetSubInputNode ( FName InSubInput, FName InGraph )	Function renamed, please use GetLinkedInputPoseNode
UAnimInstanc...	GetSubInstanceByTag ( FName InTag )	Function renamed, please use GetLinkedAnimGraphInstanceByTag
void	GetSubInstancesByTag ( FName InTag, TArray< UAnimInstance* >& Out... )	Function renamed, please use GetLinkedAnimGraphInstancesByTag
void	NativeUpdateAnimation_WorkerThread ( float DeltaSeconds )	This function is only called for backwards-compatibility. It is no longer called on a worker thread.
void	OnUROPreInterpolation()	This function is deprecated, please use OnUROPreInterpolation_AnyThread
void	ParallelEvaluateAnimation ( bool bForceRefPose, const USkeletalMesh* InSkeleta..., FBlendedHeapCurve& OutCurve, FCompactPose& OutPose )	Please use ParallelEvaluateAnimation with different signature.
void	ResetDynamics()	Please use ResetDynamics with a ETeleportType argument
void	SetLayerOverlay ( TSubclassOf< UAnimInstance > InClas... )	Function renamed, please use LinkAnimClassLayers
void	SetSubInstanceClassByTag ( FName InTag, TSubclassOf< UAnimInstance > InClas... )	Function renamed, please use LinkAnimGraphByTag
void	StopAllMontagesByGroupName ( FName InGroupName, const FAlphaBlend& BlendOut )	Use StopAllMontagesByGroupName with other signature.