FCachedAnimStateData

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

Choose your operating system:

Windows

macOS

Linux

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

Name Description

Public variable

FName

 

StateMachineName

Name of StateMachine State is in

Public variable

FName

 

StateName

Name of State to Cache

Constructors

Name Description

Public function

FCachedAnimStateData()

Functions

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?