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_SequencePlayerBase

Sequence player node. Not instantiated directly, use [FAnimNode_SequencePlayer](API\Runtime\Engine\Animation\FAnimNode_SequencePlayer) or [FAnimNode_SequencePlayer_Standalone](API\Runtime\Engine\Animation\FAnimNode_SequencePlayer_Standal-).

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FAnimNode_Base

FAnimNode_AssetPlayerBase

FAnimNode_SequencePlayerBase

	FAnimNode_SequencePlayer
	FAnimNode_SequencePlayer_Standalone

References

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

Syntax

struct FAnimNode_SequencePlayerBase : public FAnimNode_AssetPlayerBase

Remarks

Variables

		Name	Description
	FInputScaleBias...	PlayRateScaleBiasClampState	Corresponding state for PlayRateScaleBiasClampConstants.

Functions

	Name	Description
float	GetEffectiveStartPosition ( const FAnimationBaseContext& Conte... )
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.
float	GetTimeFromEnd ( float CurrentNodeTime )
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
UAnimationAs...	GetAnimAsset()	Get the animation asset associated with the node, derived classes should implement this
float	GetCurrentAssetLength()	Functions to report data to getters, this is required for all asset players (but can't be pure abstract because of struct instantiation generated code).
float	GetCurrentAssetTime()
float	GetCurrentAssetTimePlayRateAdjusted()
void	UpdateAssetPlayer ( const FAnimationUpdateContext& Con... )	Update method for the asset player, to be implemented by derived classes

Overridden from FAnimNode_Base

	Name	Description
void	CacheBones_AnyThread ( const FAnimationCacheBonesContext&... )	Called to cache any bones that this node needs to track (e.g. in a FBoneReference).
void	Evaluate_AnyThread ( FPoseContext& Output )	Called to evaluate local-space bones transforms according to the weights set up in Update().
void	GatherDebugData ( FNodeDebugData& DebugData )	Called to gather on-screen debug data. This is called on the game thread.
void	Initialize_AnyThread ( const FAnimationInitializeContext&... )	Initialize function for setup purposes