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

Light Theme

Dark Theme

FCachedAnimStateData

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

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
	FName	StateMachineName	Name of StateMachine State is in
	FName	StateName	Name of State to Cache

Constructors

	Name	Description
	FCachedAnimStateData()

Functions

	Name	Description
float	GetGlobalWeight ( UAnimInstance& InAnimInstance )	Global weight of state in AnimGraph
float	GetWeight ( UAnimInstance& InAnimInstance )	Local weight of state inside of state machine.
bool	IsActiveState ( UAnimInstance& InAnimInstance )	Is State active?
bool	IsFullWeight ( UAnimInstance& InAnimInstance )	Is State Full Weight?
float	IsMachineRelevant ( UAnimInstance& InAnimInstance )	Is the State Machine relevant? (Has any weight)
bool	IsRelevant ( UAnimInstance& InAnimInstance )	Is State relevant?
bool	IsValid ( UAnimInstance& InAnimInstance )	Did it find a matching StateMachine and State in the AnimGraph?

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

Take our survey

Dismiss