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_GameplayTaskBase

Light Theme

Dark Theme

UBTTask_GameplayTaskBase

Base class for managing gameplay tasks Since AITask doesn't have any kind of success/failed results, default implemenation will only return EBTNode::Succeeded

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UBTNode

UBTTaskNode

UBTTask_GameplayTaskBase

References

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

Syntax

class UBTTask_GameplayTaskBase : public UBTTaskNode

Remarks

Base class for managing gameplay tasks Since AITask doesn't have any kind of success/failed results, default implemenation will only return EBTNode::Succeeded

In your ExecuteTask:

use NewBTAITask() helper to create task
initialize task with values if needed
use StartGameplayTask() helper to execute and get node result

Variables

		Name	Description
	uint32: 1	bWaitForGameplayTask	If set, behavior tree task will wait until gameplay tasks finishes

Constructors

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

Functions

		Name	Description
	EBTNodeResul...	DetermineGameplayTaskResult ( UAITask& Task )	Get finish result from task
	EBTNodeResul...	StartGameplayTask ( UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory, UAITask& Task )	Start task and initialize FBTGameplayTaskMemory memory block

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!
	void	OnTaskFinished ( UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory, EBTNodeResult::Type TaskResult )	Called when task execution is finished this function should be considered as const (don't modify state of object) if node is not instanced!

Overridden from UBTNode

		Name	Description
	uint16	GetInstanceMemorySize()	Size of instance memory

Overridden from IGameplayTaskOwnerInterface

		Name	Description
	void	OnGameplayTaskDeactivated ( UGameplayTask& Task )	Notify called after GameplayTask changes state from Active (finishing or pausing)

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

Take our survey

Dismiss