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_LinkedAnimGraph

Windows

MacOS

Linux

Inheritance Hierarchy

FAnimNode_Base

FAnimNode_CustomProperty

FAnimNode_LinkedAnimGraph

FAnimNode_LinkedAnimLayer

References

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

Syntax

struct FAnimNode_LinkedAnimGraph : public FAnimNode_CustomProperty

Variables

	Name	Description
uint8: 1	bPropagateNotifiesToLinkedInstances	Whether named notifies will be propagated from this linked instance to other instances (outer or other linked instances)
uint8: 1	bReceiveNotifiesFromLinkedInstances	Whether named notifies will be received by this linked instance from other instances (outer or other linked instances)
int32	CachedLinkedNodeIndex	Cached node index for our linked function.
TArray< FName >	InputPoseNames	List of input pose names, 1-1 with pose links about, built by the compiler
TArray< FPoseLi...	InputPoses	Input poses for the node, intentionally not accessible because if there's no input nodes in the target class we don't want to show these as pins
TSubclassOf< UA...	InstanceClass	The class spawned for this linked instance
FAnimNode_Base ...	LinkedRoot	The root node of the dynamically-linked graph.
int32	NodeIndex	Our node index.
float	PendingBlendDuration	Inertial blending duration to request next update.
FName	Tag	Optional tag used to identify this linked instance

Constructors

	Name	Description
	FAnimNode_LinkedAnimGraph()

Functions

	Name	Description
void	CacheBonesSubGraph_AnyThread ( const FAnimationCacheBonesContext&... )	Caches bones only for the sub graph that this node is linked to.
void	DynamicLink ( UAnimInstance* InOwningAnimIns... )	Link up pose links dynamically with linked instance
void	DynamicUnlink ( UAnimInstance* InOwningAnimIns... )	Break any pose links dynamically with linked instance
int32	FindFunctionInputIndex ( const FAnimBlueprintFunction& Anim..., const FName& InInputName )	Helper function for finding function inputs when linking/unlinking
FName	GetDynamicLinkFunctionName()	Get the function name we should be linking with when we call DynamicLink/Unlink
UAnimInstanc...	GetDynamicLinkTarget ( UAnimInstance* InOwningAnimIns... )	Get the dynamic link target
void	InitializeSubGraph_AnyThread ( const FAnimationInitializeContext&... )	Initializes only the sub-graph that this node is linked to.
void	ReinitializeLinkedAnimInstance ( const UAnimInstance* InOwningA..., UAnimInstance* InNewAnimInstan... )	Re-create the linked instances for this node.
void	RequestBlend ( const IAnimClassInterface* Pri..., const IAnimClassInterface* New... )	Request a blend when the active instance changes
void	SetAnimClass ( TSubclassOf< UAnimInstance > InClas..., const UAnimInstance* InOwningA... )	Dynamically set the anim class of this linked instance
void	TeardownInstance()	Shutdown the currently running instance.

Overridden from FAnimNode_CustomProperty

		Name	Description
	UClass *	GetTargetClass()	Get Target Class.

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&... )	Called when the node first runs.
bool	NeedsOnInitializeAnimInstance()	For nodes that need some kind of initialization that is not dependent on node relevancy (i.e. it is insufficent or inefficent to use Initialize_AnyThread), return true here.
void	OnInitializeAnimInstance ( const FAnimInstanceProxy* InPr..., const UAnimInstance* InAnimIns... )	Called once, from game thread as the parent anim instance is created
void	Update_AnyThread ( const FAnimationUpdateContext& Con... )	Called to update the state of the graph relative to this node.

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

Take our survey

Dismiss