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 > UBTNode

Light Theme

Dark Theme

UBTNode

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UBTNode

UBTAuxiliaryNode

UBTCompositeNode

	UBTComposite_Selector
	UBTComposite_Sequence
	UBTComposite_SimpleParallel

UBTTaskNode

References

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

Syntax

class UBTNode :
public UObject,
public IGameplayTaskOwnerInterface

Variables

	Name	Description
uint8: 1	bCreateNodeInstance	If set, node will be instanced instead of using memory block and template shared with all other BT components
uint8: 1	bOwnsGameplayTasks	Set to true if task owns any GameplayTasks.
FString	NodeName	Node name

Constructors

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

Functions

	Name	Description
T *	CastInstanceNodeMemory ( uint8* NodeMemory )
void	CleanupInSubtree ( UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory, EBTMemoryClear::Type CleanupType )	Called on removing subtree to cleanup memory
void	CleanupMemory ( UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory, EBTMemoryClear::Type CleanupType )	Cleanup memory block
void	DescribeRuntimeValues ( const UBehaviorTreeComponent& Owne..., uint8* NodeMemory, EBTDescriptionVerbosity::Type Verbo..., TArray< FString >& Values )	Gathers description of all runtime parameters
void	ForceInstancing ( bool bEnable )	Sets bCreateNodeInstance flag, do NOT call this function on already pushed tree instance!
UBlackboardD...	GetBlackboardAsset()
UBehaviorTre...	GetBTComponentForTask ( UGameplayTask& Task )
uint16	GetExecutionIndex()
uint16	GetInstanceMemorySize()	Size of instance memory
uint16	GetMemoryOffset()
UBTNode *...	GetNextNode()
FName	GetNodeIconName()	Get the name of the icon used to display this node in the editor
UBTNode *...	GetNodeInstance ( const UBehaviorTreeComponent& Owne..., uint8* NodeMemory )
UBTNode *...	GetNodeInstance ( FBehaviorTreeSearchData& SearchDat... )
const T *...	GetNodeMemory ( const FBehaviorTreeInstance& BTIns... )
T *	GetNodeMemory ( FBehaviorTreeInstance& BTInstance )
const T *...	GetNodeMemory ( const FBehaviorTreeSearchData& Sea... )
T *	GetNodeMemory ( FBehaviorTreeSearchData& SearchDat... )
FString	GetNodeName()
UBTComposite...	GetParentNode()
FString	GetRuntimeDescription ( const UBehaviorTreeComponent& Owne..., uint8* NodeMemory, EBTDescriptionVerbosity::Type Verbo... )
uint16	GetSpecialMemorySize()	Size of special, hidden memory block for internal mechanics
T *	GetSpecialNodeMemory ( uint8* NodeMemory )	Get special memory block used for hidden shared data (e.g. node instancing)
FString	GetStaticDescription()
UBehaviorTre...	GetTreeAsset()
uint8	GetTreeDepth()
UWorld *	GetWorld()
bool	HasInstance()
void	InitializeExecutionOrder ( UBTNode* NextNode )	Fill in data about execution order
void	InitializeFromAsset ( UBehaviorTree& Asset )	Initialize any asset related data
void	InitializeInSubtree ( UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory, int32& NextInstancedIndex, EBTMemoryInit::Type InitType )	Called on creating subtree to set up memory and instancing
void	InitializeMemory ( UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory, EBTMemoryInit::Type InitType )	Initialize memory block
void	InitializeNode ( UBTCompositeNode* InParentNode, uint16 InExecutionIndex, uint16 InMemoryOffset, uint8 InTreeDepth )	Fill in data about tree structure
bool	IsInjected()
bool	IsInstanced()
void	MarkInjectedNode()	Sets bIsInjected flag, do NOT call this function unless you really know what you are doing!
T *	NewBTAITask ( UBehaviorTreeComponent& BTComponen... )
T *	NewBTAITask ( const UClass& Class, UBehaviorTreeComponent& BTComponen... )
void	OnInstanceCreated ( UBehaviorTreeComponent& OwnerComp )	Called when node instance is added to tree
void	OnInstanceDestroyed ( UBehaviorTreeComponent& OwnerComp )	Called when node instance is removed from tree
void	OnNodeCreated()	Called after creating new node in behavior tree editor, use for versioning
void	SetOwner ( AActor* ActorOwner )	Gets called only for instanced nodes(bCreateNodeInstance == true).
bool	UsesBlueprint()	Get whether this node is using a blueprint for its logic

Overridden from IGameplayTaskOwnerInterface

	Name	Description
AActor *	GetGameplayTaskAvatar ( const UGameplayTask* Task )	Get "body" of task's owner / default, having location in world (e.g. Owner = AIController, Avatar = Pawn)
uint8	GetGameplayTaskDefaultPriority()	Get default priority for running a task
AActor *	GetGameplayTaskOwner ( const UGameplayTask* Task )	Get owner of a task or default one when task is null
UGameplayTas...	GetGameplayTasksComponent ( const UGameplayTask& Task )	Finds tasks component for given GameplayTask, Task.GetGameplayTasksComponent() may not be initialized at this point!
void	OnGameplayTaskInitialized ( UGameplayTask& Task )	Notify called after GameplayTask finishes initialization (not active yet)

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

Take our survey

Cancel