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_RunBehavior

Light Theme

Dark Theme

UBTTask_RunBehavior

RunBehavior task allows pushing subtrees on execution stack.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UBTNode

UBTTaskNode

UBTTask_RunBehavior

References

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

Syntax

class UBTTask_RunBehavior : public UBTTaskNode

Remarks

RunBehavior task allows pushing subtrees on execution stack. Subtree asset can't be changed in runtime!

This limitation is caused by support for subtree's root level decorators, which are injected into parent tree, and structure of running tree cannot be modified in runtime (see: BTNode: ExecutionIndex, MemoryOffset)

Use RunBehaviorDynamic task for subtrees that need to be changed in runtime.

Variables

		Name	Description
	UBehaviorTree &...	BehaviorAsset	Behavior to run

Constructors

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

Functions

	Name	Description
int32	GetInjectedNodesCount()
UBehaviorTre...	GetSubtreeAsset()
void	OnSubtreeDeactivated ( UBehaviorTreeComponent& OwnerComp, EBTNodeResult::Type NodeResult )	Called when subtree is removed from active stack

Overridden from UBTTaskNode

		Name	Description
	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