1. Epic GamesDeveloper
  3. FCachedAnimStateData

FCachedAnimStateData

This file contains a number of helper structures that can be used to process state-machine- related data in C++.

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

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Public/Animation/CachedAnimData.h
Include #include "Animation/CachedAnimData.h"

Syntax

struct FCachedAnimStateData

Remarks

This file contains a number of helper structures that can be used to process state-machine- related data in C++. This includes relevancy, state weights, animation time etc.

Variables

  Type Name Description
Public variable FName StateMachineName Name of StateMachine State is in
Public variable FName StateName Name of State to Cache

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Const float

GetGlobalWeight ( UAnimInstance& InAnimInstance
)

 Global weight of state in AnimGraph
Public function Const float

GetWeight ( UAnimInstance& InAnimInstance
)

 Local weight of state inside of state machine.
Public function Const bool

IsActiveState ( UAnimInstance& InAnimInstance
)

 Is State active?
Public function Const bool

IsFullWeight ( UAnimInstance& InAnimInstance
)

 Is State Full Weight?
Public function Const float

IsMachineRelevant ( UAnimInstance& InAnimInstance
)

 Is the State Machine relevant? (Has any weight)
Public function Const bool

IsRelevant ( UAnimInstance& InAnimInstance
)

 Is State relevant?
Public function Const bool

IsValid ( UAnimInstance& InAnimInstance
)

 Did it find a matching StateMachine and State in the AnimGraph?
Public function Const bool

WasAnimNotifyStateActive ( UAnimInstance& InAnimInstance,
TSubclassOf< UAnimNotifyState > AnimNotifyStateType
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page