Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

> Unreal Engine API Reference > Runtime > Engine > Animation > FAnimNode_AssetPlayerBase

Light Theme

Dark Theme

FAnimNode_AssetPlayerBase

Base class for any asset playing anim node

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

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

Syntax

struct FAnimNode_AssetPlayerBase : public FAnimNode_Base

Remarks

Base class for any asset playing anim node

Variables

		Name	Description
	bool	bHasBeenFullWeight	Track whether we have been full weight previously. Reset when we reach 0 weight
	float	BlendWeight	Last encountered blendweight for this node
	FDeltaTimeRecor...	DeltaTimeRecord	Previous frame InternalTimeAccumulator value and effective delta time leading into the current frame
	float	InternalTimeAccumulator	Accumulated time used to reference the asset in this node
	FMarkerTickReco...	MarkerTickRecord	Store data about current marker position when using marker based syncing

Constructors

	Name	Description
	FAnimNode_AssetPlayerBase()

Functions

		Name	Description
	void	ClearCachedBlendWeight()	Set the cached blendweight to zero
	void	CreateTickRecordForNode ( const FAnimationUpdateContext& Con..., UAnimSequenceBase* Sequence, bool bLooping, float PlayRate )	Create a tick record for this node.
	float	GetAccumulatedTime()	Get the currently referenced time within the asset player node
	UAnimationAs...	GetAnimAsset()	Get the animation asset associated with the node, derived classes should implement this
	float	GetCachedBlendWeight()	Get the last encountered blend weight for this node
	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()
	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.
	void	SetAccumulatedTime ( float NewTime )	Override the currently accumulated time
	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.
	void	UpdateAssetPlayer ( const FAnimationUpdateContext& Con... )	Update method for the asset player, to be implemented by derived classes

Overridden from FAnimNode_Base

		Name	Description
	void	Initialize_AnyThread ( const FAnimationInitializeContext&... )	Initialize function for setup purposes
	void	Update_AnyThread ( const FAnimationUpdateContext& Con... )	Update the node, marked final so we can always handle blendweight caching.