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_AssetPlayerBase

Base class for any asset playing anim node

Windows

MacOS

Linux

Inheritance Hierarchy

FAnimNode_Base

FAnimNode_AssetPlayerBase

FAnimNode_BlendSpacePlayer

	FAnimNode_AimOffsetLookAt
	FAnimNode_BlendSpaceEvaluator
	FAnimNode_RotationOffsetBlendSpace

FAnimNode_PoseHandler

FAnimNode_SequenceEvaluator

FAnimNode_SequencePlayer

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
bool	bIgnoreForRelevancyTest	If true, "Relevant anim" nodes that look for the highest weighted animation in a state will ignore this node
float	BlendWeight	Last encountered blendweight for this node
int32	GroupIndex	The group index, assigned at compile time based on the editoronly GroupName (or INDEX_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)
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()
void	SetAccumulatedTime ( const float& NewTime )	Override the currently accumulated time
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.

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

Take our survey

Dismiss