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

Light Theme

Dark Theme

FAnimationBaseContext

Base class for update/evaluate contexts

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FAnimationBaseContext

	FAnimationCacheBonesContext
	FAnimationInitializeContext
	FAnimationUpdateContext
	FComponentSpacePoseContext
	FPoseContext

References

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

Syntax

struct FAnimationBaseContext

Remarks

Base class for update/evaluate contexts

Variables

	Name	Description
FAnimInstancePr...	AnimInstanceProxy
int32	CurrentNodeId	The current node ID, set when we recurse into graph traversal functions from pose links.
int32	PreviousNodeId	The previous node ID, set when we recurse into graph traversal functions from pose links.
FAnimationUpdat...	SharedContext

Constructors

	Name	Description
	FAnimationBaseContext()
	FAnimationBaseContext ( const FAnimationBaseContext& InCon... )	We define a copy constructor here simply to avoid deprecation warnings with clang
	FAnimationBaseContext ( UAnimInstance* InAnimInstance )	DEPRECATED - Please use constructor that uses an FAnimInstanceProxy*.
	FAnimationBaseContext ( FAnimInstanceProxy* InAnimInst..., FAnimationUpdateSharedContext*... )

Functions

	Name	Description
UAnimBluepri...	GetAnimBlueprint()	Get the AnimBlueprint associated with this context, if there is one.
IAnimClassIn...	GetAnimClass()	Get the Blueprint IAnimClassInterface associated with this context, if there is one.
UObject *...	GetAnimInstanceObject()	Get the anim instance associated with the current proxy.
int32	GetCurrentNodeId()	Get the current node Id, set when we recurse into graph traversal functions from pose links.
TGraphMessag...	GetMessage()	Get the innermost scoped message of the specified type.
TGraphMessag...	GetMessageChecked()	Get the innermost scoped message of the specified type.
int32	GetPreviousNodeId()	Get the previous node Id, set when we recurse into graph traversal functions from pose links.
void	LogMessageInternal ( FName InLogType, EMessageSeverity::Type InSeverity, FText InMessage )	Interface for node contexts to register log messages with the proxy
void	SetNodeId ( int32 InNodeId )
void	SetNodeIds ( const FAnimationBaseContext& InCon... )

Deprecated Functions

		Name	Description
	NodeType ...	GetAncestor()	Please use the message & tagging system in UE::Anim::FMessageStack
	FScopedAnimN...	TrackAncestor ( NodeType* Node )	Please use the message & tagging system in UE::Anim::FMessageStack