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

Light Theme

Dark Theme

FAnimNode_StateMachine

State machine node.

Windows

MacOS

Linux

Inheritance Hierarchy

FAnimNode_Base

FAnimNode_StateMachine

References

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

Syntax

struct FAnimNode_StateMachine : public FAnimNode_Base

Remarks

State machine node.

Variables

	Name	Description
TArray< FAnimat...	ActiveTransitionArray	The set of active transitions, if there are any.
bool	bReinitializeOnBecomingRelevant	Reinitialize the state machine if we have become relevant to the graph after not being ticked on the previous frame(s)
bool	bSkipFirstUpdateTransition	When the state machine becomes relevant, it is initialized into the Entry state.
int32	CurrentState	The current state within the state machine.
float	ElapsedTime	Elapsed time since entering the current state.
int32	EvaluatingTransitionIndex	Current Transition Index being evaluated.
int32	MaxTransitionsPerFrame	The maximum number of transitions that can be taken by this machine 'simultaneously' in a single frame.
TArray< FOnGrap...	OnGraphStatesEntered	Delegates that native code can hook into to handle state entry.
TArray< FOnGrap...	OnGraphStatesExited	Delegates that native code can hook into to handle state exits.
const FBakedAni...	PRIVATE_MachineDescription	The state machine description this is an instance of.
int32	StateMachineIndexInClass	Index into the BakedStateMachines array in the owning UAnimBlueprintGeneratedClass.
TArray< FPoseLi...	StatePoseLinks	The set of states in this state machine.
TArray< int32 >	StatesUpdated	Used during transitions to make sure we don't double tick a state if it appears multiple times.

Constructors

	Name	Description
	FAnimNode_StateMachine()

Functions

	Name	Description
void	CacheMachineDescription ( IAnimClassInterface* AnimBluep... )	Cache the internal machine description
void	ConditionallyCacheBonesForState ( int32 StateIndex, FAnimationBaseContext Context )
const FPoseC...	EvaluateState ( int32 StateIndex, const FPoseContext& Context )
void	EvaluateTransitionCustomBlend ( FPoseContext& Output, FAnimationActiveTransitionEntry& T..., bool bIntermediatePoseIsValid )
void	EvaluateTransitionStandardBlend ( FPoseContext& Output, FAnimationActiveTransitionEntry& T..., bool bIntermediatePoseIsValid )	Transition type evaluation functions
void	EvaluateTransitionStandardBlendInternal ( FPoseContext& Output, FAnimationActiveTransitionEntry& T..., const FPoseContext& PreviousStateR..., const FPoseContext& NextStateResul... )	Transition type evaluation functions
bool	FindValidTransition ( const FAnimationUpdateContext& Con..., const FBakedAnimationState& StateI..., FAnimationPotentialTransition& Out..., TArray< int32, TInlineAllocator< 4 ... )	Finds the highest priority valid transition, information pass via the OutPotentialTransition variable.
int32	GetCurrentState()
float	GetCurrentStateElapsedTime()
FName	GetCurrentStateName()
const FBaked...	GetMachineDescription()	Tries to get the instance information for the state machine.
FAnimNode_As...	GetRelevantAssetPlayerFromState ( const FAnimationUpdateContext& Con..., const FBakedAnimationState& StateI... )
const int32	GetStateIndex ( const FBakedAnimationState& StateI... )
const FBaked...	GetStateInfo()
const FBaked...	GetStateInfo ( int32 StateIndex )
float	GetStateWeight ( int32 StateIndex )	Returns the blend weight of the specified state, as calculated by the last call to Update()
const FAnima...	GetTransitionInfo ( int32 TransIndex )
bool	IsAConduitState ( int32 StateIndex )	Helper function to test if a state is a conduit
bool	IsTransitionActive ( int32 TransIndex )
bool	IsValidTransitionIndex ( int32 TransitionIndex )
void	LogInertializationRequestError ( const FAnimationUpdateContext& Con..., int32 PreviousState, int32 NextState )
void	SetState ( const FAnimationBaseContext& Conte..., int32 NewStateIndex )
void	SetStateInternal ( int32 NewStateIndex )
void	UpdateState ( int32 StateIndex, const FAnimationUpdateContext& Con... )	Helper functions for calling update and evaluate on state nodes
void	UpdateTransitionStates ( const FAnimationUpdateContext& Con..., FAnimationActiveTransitionEntry& T... )	Helper function that will update the states associated with a transition.

Overridden from FAnimNode_Base

	Name	Description
void	CacheBones_AnyThread ( const FAnimationCacheBonesContext&... )	Called to cache any bones that this node needs to track (e.g. in a FBoneReference).
void	Evaluate_AnyThread ( FPoseContext& Output )	Called to evaluate local-space bones transforms according to the weights set up in Update().
void	GatherDebugData ( FNodeDebugData& DebugData )	Called to gather on-screen debug data. This is called on the game thread.
void	Initialize_AnyThread ( const FAnimationInitializeContext&... )	Called when the node first runs.
void	Update_AnyThread ( const FAnimationUpdateContext& Con... )	Called to update the state of the graph relative to this node.

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

Take our survey

Dismiss