1. Epic GamesDeveloper
  3. FAnimNode_StateMachine

FAnimNode_StateMachine

State machine node.

Unreal Engine C++ API Reference > Runtime > Engine > Animation

Inheritance Hierarchy

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

  Type Name Description
Protected variable TArray< FAnimationActiveTransitionEntry > ActiveTransitionArray The set of active transitions, if there are any.
Public variable bool bAllowConduitEntryStates Allows a conduit to be used as this state machine's entry state If a valid entry state cannot be found at runtime then this will generate a reference pose!
Public variable bool bCreateNotifyMetaData Tag Notifies with meta data such as the active state and mirroring state.
Public variable bool bReinitializeOnBecomingRelevant Reinitialize the state machine if we have become relevant to the graph after not being ticked on the previous frame(s)
Public variable bool bSkipFirstUpdateTransition When the state machine becomes relevant, it is initialized into the Entry state.
Protected variable int32 CurrentState The current state within the state machine.
Protected variable float ElapsedTime Elapsed time since entering the current state.
Protected variable int32 EvaluatingTransitionIndex Current Transition Index being evaluated.
Protected variable TArray< FTransitionEvent > HandledTransitionEvents The set of transition requests handled this update.
Public variable int32 MaxTransitionsPerFrame The maximum number of transitions that can be taken by this machine 'simultaneously' in a single frame.
Public variable int32 MaxTransitionsRequests The maximum number of transition requests that can be buffered at any time.
Protected variable TArray< FOnGraphStateChanged > OnGraphStatesEntered Delegates that native code can hook into to handle state entry.
Protected variable TArray< FOnGraphStateChanged > OnGraphStatesExited Delegates that native code can hook into to handle state exits.
Protected variable const FBakedAnimationStateMachine * PRIVATE_MachineDescription The state machine description this is an instance of.
Protected variable TArray< FTransitionEvent > QueuedTransitionEvents All alive transition requests that have been queued.
Public variable int32 StateMachineIndexInClass Index into the BakedStateMachines array in the owning UAnimBlueprintGeneratedClass.
Protected variable TArray< FPoseLink > StatePoseLinks The set of states in this state machine.
Protected variable TArray< int32 > StatesUpdated Used during transitions to make sure we don't double tick a state if it appears multiple times.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void Cache the internal machine description
Protected function void Removes all queued transition requests
Protected function void

ClearTransitionEvents ( const FName& EventName
)

 Removes all queued transition requests with the given event name
Public function void  
Protected function void Removes all marked events that are queued
Protected function const FPoseContext &

EvaluateState ( int32 StateIndex,
const FPoseContext& Context
)

  
Protected function void

EvaluateTransitionCustomBlend ( FPoseContext& Output,
FAnimationActiveTransitionEntry& Transition,
bool bIntermediatePoseIsValid
)

  
Protected function void

EvaluateTransitionStandardBlend ( FPoseContext& Output,
FAnimationActiveTransitionEntry& Transition,
bool bIntermediatePoseIsValid
)

 Transition type evaluation functions
Protected function void

EvaluateTransitionStandardBlendInternal ( FPoseContext& Output,
FAnimationActiveTransitionEntry& Transition,
const FPoseContext& PreviousStateResult,
const FPoseContext& NextStateResult
)

 Transition type evaluation functions
Protected function bool

FindValidTransition ( const FAnimationUpdateContext& Context,
const FBakedAnimationState& StateInfo,
FAnimationPotentialTransition& OutPotentialTransition,
TArray< int32, TInlineAllocator< 4 >>& OutVisitedStateIndices
)

 Finds the highest priority valid transition, information pass via the OutPotentialTransition variable.
Public function Const int32  
Public function Const float  
Public function Const FName  
Protected function Const const FBakedAnimationStateMachine * Tries to get the instance information for the state machine.
Protected function Const float

GetRelevantAnimTimeRemaining ( const FAnimationUpdateContext& Context,
int32 StateIndex
)

 Get the time remaining in seconds for the most relevant animation in the source state.
Protected function Const float

GetRelevantAnimTimeRemaining ( const FAnimInstanceProxy* InAnimInstanceProxy,
int32 StateIndex
)

 Get the time remaining in seconds for the most relevant animation in the source state.
Protected function Const float

GetRelevantAnimTimeRemainingFraction ( const FAnimationUpdateContext& Context,
int32 StateIndex
)

 Get the time remaining as a fraction of the duration for the most relevant animation in the source state.
Protected function Const float

GetRelevantAnimTimeRemainingFraction ( const FAnimInstanceProxy* InAnimInstanceProxy,
int32 StateIndex
)

 Get the time remaining as a fraction of the duration for the most relevant animation in the source state.
Protected function Const const FAnimNode_AssetPlayerRelevancyBase *  
Protected function Const const FAnimNode_AssetPlayerRelevancyBase *

GetRelevantAssetPlayerInterfaceFromState ( const FAnimInstanceProxy* InAnimInstanceProxy,
const FBakedAnimationState& StateInfo
)

  
Protected function Const const int32

GetStateIndex ( const FBakedAnimationState& StateInfo
)

  
Public function Const const int32

GetStateIndex ( FName StateName
)

  
Public function Const const FBakedAnimationState &

GetStateInfo ( int32 StateIndex
)

  
Protected function Const const FBakedAnimationState &  
Public function Const float

GetStateWeight ( int32 StateIndex
)

 Returns the blend weight of the specified state, as calculated by the last call to Update()
Public function Const const FAnimationTransitionBetweenStates &

GetTransitionInfo ( int32 TransIndex
)

  
Protected function Const bool

IsAConduitState ( int32 StateIndex
)

 Helper function to test if a state is a conduit
Public function Const bool

IsTransitionActive ( int32 TransIndex
)

  
Public function Const bool

IsValidTransitionIndex ( int32 TransitionIndex
)

  
Protected function void

LogInertializationRequestError ( const FAnimationUpdateContext& Context,
int32 PreviousState,
int32 NextState
)

  
Protected function bool

QueryAndMarkTransitionEvent ( const int32 TransitionIndex,
const FName& EventName
)

 Behaves like QueryTransitionEvent but additionally marks the event for consumption
Protected function Const bool

QueryTransitionEvent ( const int32 TransitionIndex,
const FName& EventName
)

 Returns whether or not the given event transition request has been queued
Protected function bool

RequestTransitionEvent ( const FTransitionEvent& InTransitionEvent
)

 Queues a new transition request, returns true if the transition request was successfully queued
Public function void

SetState ( const FAnimationBaseContext& Context,
int32 NewStateIndex
)

  
Protected function void

SetStateInternal ( int32 NewStateIndex
)

  
Public function void

TransitionToState ( const FAnimationUpdateContext& Context,
const FAnimationTransitionBetweenStates& TransitionInfo,
const FAnimationPotentialTransition* BakedTransitionInfo
)

  
Protected function void

UpdateState ( int32 StateIndex,
const FAnimationUpdateContext& Context
)

 Helper functions for calling update and evaluate on state nodes
Protected function void Helper function that will update the states associated with a transition.

Overridden from FAnimNode_Base

  Type Name Description
Public function Virtual void Called to cache any bones that this node needs to track (e.g. in a FBoneReference).
Public function Virtual void Called to evaluate local-space bones transforms according to the weights set up in Update().
Public function Virtual void Called to gather on-screen debug data. This is called on the game thread.
Public function Virtual void Called when the node first runs.
Public function Virtual void Called to update the state of the graph relative to this node.

Deprecated Functions

  Type Name Description
Protected function Const const FAnimNode_AssetPlayerBase * Please use GetRelevantAssetPlayerInterfaceFromState
Protected function Const const FAnimNode_AssetPlayerBase *

GetRelevantAssetPlayerFromState ( const FAnimInstanceProxy* InAnimInstanceProxy,
const FBakedAnimationState& StateInfo
)

 Please use GetRelevantAssetPlayerInterfaceFromState

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page