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

Light Theme

Dark Theme

FAnimNode_SequencePlayer

Sequence player node that can be used with constant folding.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FAnimNode_Base

FAnimNode_AssetPlayerBase

FAnimNode_SequencePlayerBase

FAnimNode_SequencePlayer

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Animation/AnimNode_SequencePlayer.h
Include	#include "Animation/AnimNode_SequencePlayer.h"

Syntax

struct FAnimNode_SequencePlayer : public FAnimNode_SequencePlayerBase

Remarks

Sequence player node that can be used with constant folding.

Variables

	Name	Description
bool	bIgnoreForRelevancyTest	If true, "Relevant anim" nodes that look for the highest weighted animation in a state will ignore this node.
bool	bLoopAnimation	Should the animation loop back to the start when it reaches the end?
bool	bStartFromMatchingPose	Use pose matching to choose the start position. Requires experimental PoseSearch plugin.
FName	GroupName	The group name (NAME_None if it is not part of any group)
TEnumAsByte< EA...	GroupRole	The role this player can assume within the group (ignored if GroupIndex is INDEX_NONE)
EAnimSyncMethod	Method	How synchronization is determined.
float	PlayRate	The play rate multiplier. Can be negative, which will cause the animation to play in reverse.
float	PlayRateBasis	The Basis in which the PlayRate is expressed in.
FInputScaleBias...	PlayRateScaleBiasClampConstants	Additional scaling, offsetting and clamping of PlayRate input. Performed after PlayRateBasis.
TObjectPtr< UAn...	Sequence	The animation sequence asset to play.
float	StartPosition	The start position in [0, 1] to use when initializing. When looping, play will still jump back to the beginning when reaching the end.

Overridden from FAnimNode_SequencePlayerBase

	Name	Description
bool	GetLoopAnimation()	Should the animation loop back to the start when it reaches the end?
float	GetPlayRate()	The play rate multiplier. Can be negative, which will cause the animation to play in reverse.
float	GetPlayRateBasis()	The Basis in which the PlayRate is expressed in.
const FInput...	GetPlayRateScaleBiasClampConstants()	Additional scaling, offsetting and clamping of PlayRate input. Performed after PlayRateBasis.
UAnimSequenc...	GetSequence()	The animation sequence asset to play.
bool	GetStartFromMatchingPose()	Use pose matching to choose the start position. Requires experimental PoseSearch plugin.
float	GetStartPosition()	The start position in [0, 1] to use when initializing. When looping, play will still jump back to the beginning when reaching the end.
bool	SetLoopAnimation ( bool bInLoopAnimation )	Set the animation to continue looping when it reaches the end.
bool	SetPlayRate ( float InPlayRate )	Set the play rate of this node.
bool	SetSequence ( UAnimSequenceBase* InSequence )	Set the animation sequence asset to play.
bool	SetStartPosition ( float InStartPosition )	Set the start time of this node.

Overridden from FAnimNode_AssetPlayerBase

	Name	Description
EAnimSyncMet...	GetGroupMethod()	Get the sync group method we are using.
FName	GetGroupName()	Get the sync group name we are using.
EAnimGroupRo...	GetGroupRole()	Get the sync group role we are using.
bool	GetIgnoreForRelevancyTest()	Check whether this node should be ignored when testing for relevancy in state machines.
bool	SetGroupMethod ( EAnimSyncMethod InMethod )	Set the sync group method we are using.
bool	SetGroupName ( FName InGroupName )	Set the sync group name we are using.
bool	SetGroupRole ( EAnimGroupRole::Type InRole )	Set the sync group role we are using.
bool	SetIgnoreForRelevancyTest ( bool bInIgnoreForRelevancyTest )	Set whether this node should be ignored when testing for relevancy in state machines.

Deprecated Variables

		Name	Description
	FInputScaleBias...	PlayRateScaleBiasClamp_DEPRECATED