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

Light Theme

Dark Theme

FBehaviorTreeInstance

Data required for instance of single subtree

Windows

MacOS

Linux

References

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

Syntax

struct FBehaviorTreeInstance

Remarks

Data required for instance of single subtree

Variables

	Name	Description
TArray< UBTAuxi...	ActiveAuxNodes	Active auxiliary nodes
UBTNode *	ActiveNode	Active node in template
TEnumAsByte< EB...	ActiveNodeType	Active node type
FBTInstanceDeac...	DeactivationNotify	Delegate sending a notify when tree instance is removed from active stack
uint8	InstanceIdIndex	Index of identifier (BehaviorTreeComponent.KnownInstances)
TArray< uint8 >	InstanceMemory	Memory: instance
TArray< FBehavi...	ParallelTasks	Active parallel tasks
UBTCompositeNod...	RootNode	Root node in template

Constructors

	Name	Description
	FBehaviorTreeInstance()
	FBehaviorTreeInstance ( const FBehaviorTreeInstance& Other )
	FBehaviorTreeInstance ( int32 MemorySize )

Destructors

	Name	Description
	~FBehaviorTreeInstance()

Functions

	Name	Description
void	AddToActiveAuxNodes ( UBTAuxiliaryNode* AuxNode )	Add specified node to the active nodes list
void	AddToParallelTasks ( FBehaviorTreeParallelTask&& Parall... )	Add new parallel task
void	Cleanup ( UBehaviorTreeComponent& OwnerComp, EBTMemoryClear::Type CleanupType )	Cleanup node instances
void	CleanupNodes ( UBehaviorTreeComponent& OwnerComp, UBTCompositeNode& Node, EBTMemoryClear::Type CleanupType )	Worker for updating all nodes
void	DeactivateNodes ( FBehaviorTreeSearchData& SearchDat..., uint16 InstanceIndex )	Deactivate all active aux nodes and remove their requests from SearchData
void	DecMemoryStats()
void	ExecuteOnEachAuxNode ( TFunctionRef< void... )	Iterate on auxiliary nodes and call ExecFunc on each of them.
void	ExecuteOnEachParallelTask ( TFunctionRef< void... )	Iterate on parallel tasks and call ExecFunc on each of them.
TArrayView< ...	GetActiveAuxNodes()	Get list of all active auxiliary nodes
uint32	GetAllocatedSize()
TArrayView< ...	GetInstanceMemory()	Get instance memory
TArrayView< ...	GetParallelTasks()	Get list of all active parallel tasks
bool	HasActiveNode ( uint16 TestExecutionIndex )	Check if instance has active node with given execution index
void	IncMemoryStats()
void	Initialize ( UBehaviorTreeComponent& OwnerComp, UBTCompositeNode& Node, int32& InstancedIndex, EBTMemoryInit::Type InitType )	Initialize memory and create node instances
bool	IsValidParallelTaskIndex ( const int32 Index )	Indicates if the provided index is a valid parallel task index
void	MarkParallelTaskAsAbortingAt ( int32 TaskIndex )	Mark parallel task at given index as pending abort
void	RemoveFromActiveAuxNodes ( UBTAuxiliaryNode* AuxNode )	Remove specified node from the active nodes list
void	RemoveParallelTaskAt ( int32 TaskIndex )	Remove parallel task at given index
void	ResetActiveAuxNodes()	Remove all auxiliary nodes from active nodes list
void	SetInstanceMemory ( const TArray< uint8 >& Memory )	Set instance memory

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

Take our survey

Dismiss