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

> Unreal Engine API Reference > Runtime > AIModule > BehaviorTree > Tasks > UBTTask_PlayAnimation

Light Theme

Dark Theme

UBTTask_PlayAnimation

Play indicated AnimationAsset on Pawn controlled by BT Note that this node is generic and is handing multiple special cases, If you want a more efficient solution you'll need to implement it yourself (or wait for our BTTask_PlayCharacterAnimation)

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UBTNode

UBTTaskNode

UBTTask_PlayAnimation

References

Module	AIModule
Header	/Engine/Source/Runtime/AIModule/Classes/BehaviorTree/Tasks/BTTask_PlayAnimation.h
Include	#include "BehaviorTree/Tasks/BTTask_PlayAnimation.h"

Syntax

class UBTTask_PlayAnimation : public UBTTaskNode

Remarks

Play indicated AnimationAsset on Pawn controlled by BT Note that this node is generic and is handing multiple special cases, If you want a more efficient solution you'll need to implement it yourself (or wait for our BTTask_PlayCharacterAnimation)

Variables

	Name	Description
UAnimationAsset...	AnimationToPlay	Animation asset to play. Note that it needs to match the skeleton of pawn this BT is controlling
uint32: 1	bLooping
uint32: 1	bNonBlocking	If true the task will just trigger the animation and instantly finish. Fire and Forget.
USkeletalMeshCo...	CachedSkelMesh
UBehaviorTreeCo...	MyOwnerComp
EAnimationMode:...	PreviousAnimationMode
FTimerDelegate	TimerDelegate
FTimerHandle	TimerHandle

Constructors

	Name	Description
	UBTTask_PlayAnimation ( const FObjectInitializer& ObjectIn... )

Functions

		Name	Description
	void	CleanUp ( UBehaviorTreeComponent& OwnerComp )
	void	OnAnimationTimerDone()

Overridden from UBTTaskNode

		Name	Description
	EBTNodeResul...	AbortTask ( UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory )	Aborts this task, should return Aborted or InProgress (use FinishLatentAbort() when returning InProgress) this function should be considered as const (don't modify state of object) if node is not instanced!
	EBTNodeResul...	ExecuteTask ( UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory )	Starts this task, should return Succeeded, Failed or InProgress (use FinishLatentTask() when returning InProgress) this function should be considered as const (don't modify state of object) if node is not instanced!

Overridden from UBTNode

		Name	Description
	FName	GetNodeIconName()	Get the name of the icon used to display this node in the editor
	FString	GetStaticDescription()

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

Take our survey

Dismiss