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 > Plugins > AnimationSharing > FPerStateData

Light Theme

Dark Theme

FPerStateData

Structure which holds data about a unique state which is linked to an enumeration value defined by the user.

Windows

MacOS

Linux

References

Module	AnimationSharing
Header	/Engine/Plugins/Developer/AnimationSharing/Source/AnimationSharing/Public/AnimationSharingManager.h
Include	#include "AnimationSharingManager.h"

Syntax

struct FPerStateData

Remarks

Structure which holds data about a unique state which is linked to an enumeration value defined by the user. The data is populated from the user exposed FAnimationStateEntry

Variables

	Name	Description
UAnimSequence &...	AdditiveAnimationSequence	Animation Sequence that is used for Additive States
FInstanceStack<...	AdditiveInstanceStack	Additive actors data structure
TArray< float >	AnimationLengths	Length of the animations used for an on-demand state, array as it could contain different animation permutations
bool	bIsAdditive	Flag whether or not this state is an additive state
bool	bIsOnDemand	Flag whether or not this state is an on-demand state, this means that we kick off a unique animation when needed
float	BlendTime	Duration of blending when blending to this state
bool	bReturnToPreviousState	Flag whether or not we should return to the previous state, only used when this state is an on-demand one
bool	bShouldForwardToState	Flag whether or not ForwardStateValue should be used hwen the animation has finished
TArray< USkelet...	Components	Components setup to play animations for this state
uint32	CurrentFrameOnDemandIndex	This is (re-)set every frame, and allows for quickly finding an on-demand instance which was setup this frame
uint8	ForwardStateValue	State value to which the actors part of an FOnDemandInstance should be set to when its animation has finished
TBitArray	InUseComponentFrameBits	Bits keeping track which of the components are in-use, in case of On Demand state this is managed by FOnDemandInstance, otherwise we clear and populate the flags each frame
TBitArray	PreviousInUseComponentFrameBits
TBitArray	SlaveTickRequiredFrameBits	Bits keeping track whether or not any of the slave components requires the master component to tick
uint8	StateEnumValue	Enum value linked to this state
float	WiggleTime	Number of 'wiggle' frames, this is used when we run out of available entries in Components, if one of the FOnDemandInstance has started NumWiggleFrames ago or earlier, it is used instead of a brand new one

Constructors

	Name	Description
	FPerStateData()

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

Take our survey

Dismiss