1. Epic GamesDeveloper
  3. UAnimationStateMachineLibrary

UAnimationStateMachineLibrary

Exposes operations to be performed on anim state machine node contexts.

API > API/Runtime > API/Runtime/AnimGraphRuntime

Exposes operations to be performed on anim state machine node contexts.

   
Name UAnimationStateMachineLibrary
Type class
Header File /Engine/Source/Runtime/AnimGraphRuntime/Public/AnimationStateMachineLibrary.h
Include Path #include "AnimationStateMachineLibrary.h"

Syntax

UCLASS (Experimental, MinimalAPI)  
class UAnimationStateMachineLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Functions

Static

Name Remarks Include Path Unreal Specifiers

static void ConvertToAnimationStateMachine ( const FAnimNodeReference& Node,
FAnimationStateMachineReference& AnimationState,
EAnimNodeReferenceConversionResult& Result
)

 Get an anim state machine from an anim node reference AnimationStateMachineLibrary.h
  • BlueprintCallable
  • Category="State Machine"
  • Meta=(BlueprintThreadSafe, DisplayName="Convert to Animation State Machine", ExpandEnumAsExecs="Result")

static void ConvertToAnimationStateMachinePure ( const FAnimNodeReference& Node,
FAnimationStateMachineReference& AnimationState,
bool& Result
)

 Get an anim state machine from an anim node reference (pure) AnimationStateMachineLibrary.h
  • BlueprintPure
  • Category="State Machine"
  • Meta=(BlueprintThreadSafe, DisplayName="Convert to Animation State Machine")

static void ConvertToAnimationStateResult ( const FAnimNodeReference& Node,
FAnimationStateResultReference& AnimationState,
EAnimNodeReferenceConversionResult& Result
)

 Get an anim state reference from an anim node reference AnimationStateMachineLibrary.h
  • BlueprintCallable
  • Category="State Machine"
  • Meta=(BlueprintThreadSafe, DisplayName="Convert to Animation State", ExpandEnumAsExecs="Result")

static void ConvertToAnimationStateResultPure ( const FAnimNodeReference& Node,
FAnimationStateResultReference& AnimationState,
bool& Result
)

 Get an anim state reference from an anim node reference (pure) AnimationStateMachineLibrary.h
  • BlueprintPure
  • Category="State Machine"
  • Meta=(BlueprintThreadSafe, DisplayName="Convert to Animation State")

static float GetRelevantAnimTimeRemaining ( const FAnimUpdateContext& UpdateContext,
const FAnimationStateResultReference& Node
)

 Returns the remaining animation time of the state's most relevant asset player AnimationStateMachineLibrary.h
  • BlueprintPure
  • Category="State Machine"
  • Meta=(BlueprintThreadSafe)

static float GetRelevantAnimTimeRemainingFraction ( const FAnimUpdateContext& UpdateContext,
const FAnimationStateResultReference& Node
)

 Returns the remaining animation time as a fraction of the duration for the state's most relevant asset player AnimationStateMachineLibrary.h
  • BlueprintPure
  • Category="State Machine"
  • Meta=(BlueprintThreadSafe)

static FName GetState ( const FAnimUpdateContext& UpdateContext,
const FAnimationStateMachineReference& Node
)

 Returns the name of the current state of this state machine AnimationStateMachineLibrary.h
  • BlueprintPure
  • Category="State Machine"
  • Meta=(BlueprintThreadSafe)

static bool IsStateBlendingIn ( const FAnimUpdateContext& UpdateContext,
const FAnimationStateResultReference& Node
)

 Returns whether the state the node belongs to is blending in AnimationStateMachineLibrary.h
  • BlueprintPure
  • Category="State Machine"
  • Meta=(BlueprintThreadSafe)

static bool IsStateBlendingOut ( const FAnimUpdateContext& UpdateContext,
const FAnimationStateResultReference& Node
)

 Returns whether the state the node belongs to is blending out AnimationStateMachineLibrary.h
  • BlueprintPure
  • Category="State Machine"
  • Meta=(BlueprintThreadSafe)

static void SetState ( const FAnimUpdateContext& UpdateContext,
const FAnimationStateMachineReference& Node,
FName TargetState,
float Duration,
TEnumAsByte< ETransitionLogicType::Type > BlendType,
UBlendProfile* BlendProfile,
EAlphaBlendOption AlphaBlendOption,
UCurveFloat* CustomBlendCurve
)

 Manually set the current state of the state machine NOTE: Custom blend type is not supported AnimationStateMachineLibrary.h
  • BlueprintCallable
  • Category="State Machine"
  • Meta=(BlueprintThreadSafe, AdvancedDisplay="4")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page