1. Epic GamesDeveloper
  3. UBTCompositeNode

UBTCompositeNode

API > API/Runtime > API/Runtime/AIModule

   
Name UBTCompositeNode
Type class
Header File /Engine/Source/Runtime/AIModule/Classes/BehaviorTree/BTCompositeNode.h
Include Path #include "BehaviorTree/BTCompositeNode.h"

Syntax

UCLASS (Abstract, MinimalAPI)  
class UBTCompositeNode : public UBTNode

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UBTCompositeNode ( const FObjectInitializer& ObjectInitializer
)

   BehaviorTree/BTCompositeNode.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~UBTCompositeNode()

   BehaviorTree/BTCompositeNode.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Children TArray< FBTCompositeChild > Child nodes BehaviorTree/BTCompositeNode.h  
Services TArray< TObjectPtr< UBTService > > Service nodes BehaviorTree/BTCompositeNode.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual bool CanAbortLowerPriority()

   BehaviorTree/BTCompositeNode.h  

virtual bool CanAbortSelf()

   BehaviorTree/BTCompositeNode.h  

virtual bool CanPushSubtree ( UBehaviorTreeComponent& OwnerComp,
uint8* NodeMemory,
int32 ChildIdx
) const

 Check if child node can execute new subtree BehaviorTree/BTCompositeNode.h  

void ConditionalNotifyChildExecution ( UBehaviorTreeComponent& OwnerComp,
uint8* NodeMemory,
const UBTNode& ChildNode,
EBTNodeResult::Type& NodeResult
) const

 Notify about task execution start BehaviorTree/BTCompositeNode.h  

bool DoDecoratorsAllowExecution ( UBehaviorTreeComponent& OwnerComp,
const int32 InstanceIdx,
const int32 ChildIdx
) const

 Is child execution allowed by decorators? BehaviorTree/BTCompositeNode.h  

int32 FindChildToExecute ( FBehaviorTreeSearchData& SearchData,
EBTNodeResult::Type& LastResult
) const

 Find next child branch to execute BehaviorTree/BTCompositeNode.h  

uint16 GetBranchExecutionIndex ( uint16 NodeInBranchIdx
) const

 Get first execution index of given branch BehaviorTree/BTCompositeNode.h  

uint16 GetChildExecutionIndex ( int32 Index,
EBTChildIndex ChildMode
) const

   BehaviorTree/BTCompositeNode.h  

int32 GetChildIndex ( FBehaviorTreeSearchData& SearchData,
const UBTNode& ChildNode
) const

 Get index of child node (handle subtrees) BehaviorTree/BTCompositeNode.h  

int32 GetChildIndex ( const UBTNode& ChildNode
) const

 Get index of child node BehaviorTree/BTCompositeNode.h  

UBTNode * GetChildNode ( int32 Index
) const

   BehaviorTree/BTCompositeNode.h  

int32 GetChildrenNum()

   BehaviorTree/BTCompositeNode.h  

uint16 GetLastExecutionIndex()

   BehaviorTree/BTCompositeNode.h  

int32 GetMatchingChildIndex ( int32 ActiveInstanceIdx,
FBTNodeIndex& NodeIdx
) const

 Find branch containing specified node index BehaviorTree/BTCompositeNode.h  

void InitializeComposite ( uint16 InLastExecutionIndex
)

 Fill in data about tree structure BehaviorTree/BTCompositeNode.h  

bool IsApplyingDecoratorScope()

   BehaviorTree/BTCompositeNode.h  

void OnChildActivation ( FBehaviorTreeSearchData& SearchData,
int32 ChildIndex
) const

   BehaviorTree/BTCompositeNode.h  

void OnChildActivation ( FBehaviorTreeSearchData& SearchData,
const UBTNode& ChildNode
) const

 Called before passing search to child node BehaviorTree/BTCompositeNode.h  

void OnChildDeactivation ( FBehaviorTreeSearchData& SearchData,
int32 ChildIndex,
EBTNodeResult::Type& NodeResult
) const

   BehaviorTree/BTCompositeNode.h  

void OnChildDeactivation ( FBehaviorTreeSearchData& SearchData,
const UBTNode& ChildNode,
EBTNodeResult::Type& NodeResult
) const

 Deprecated methods BehaviorTree/BTCompositeNode.h  

void OnChildDeactivation ( FBehaviorTreeSearchData& SearchData,
const UBTNode& ChildNode,
EBTNodeResult::Type& NodeResult,
const bool bRequestedFromValidInstance
) const

 Notification called after child has finished search BehaviorTree/BTCompositeNode.h  

void OnChildDeactivation ( FBehaviorTreeSearchData& SearchData,
int32 ChildIndex,
EBTNodeResult::Type& NodeResult,
const bool bRequestedFromValidInstance
) const

 Notification called after child has finished search BehaviorTree/BTCompositeNode.h  

void OnNodeActivation ( FBehaviorTreeSearchData& SearchData
) const

 Called when start enters this node BehaviorTree/BTCompositeNode.h  

void OnNodeDeactivation ( FBehaviorTreeSearchData& SearchData,
EBTNodeResult::Type& NodeResult
) const

 Called when search leaves this node BehaviorTree/BTCompositeNode.h  

void OnNodeRestart ( FBehaviorTreeSearchData& SearchData
) const

 Called when search needs to reactivate this node BehaviorTree/BTCompositeNode.h  

virtual void SetChildOverride ( FBehaviorTreeSearchData& SearchData,
int8 Index
) const

 Set override for next child index BehaviorTree/BTCompositeNode.h  

Overridden from UBTNode

Name Remarks Include Path Unreal Specifiers

virtual void CleanupMemory ( UBehaviorTreeComponent& OwnerComp,
uint8* NodeMemory,
EBTMemoryClear::Type CleanupType
) const

 Cleanup memory block. CleanupNodeMemory template function is provided to help cleanup the memory. BehaviorTree/BTCompositeNode.h  

virtual void DescribeRuntimeValues ( const UBehaviorTreeComponent& OwnerComp,
uint8* NodeMemory,
EBTDescriptionVerbosity::Type Verbosity,
TArray< FString >& Values
) const

 Gathers description of all runtime parameters BehaviorTree/BTCompositeNode.h  

virtual uint16 GetInstanceMemorySize()

 Size of instance memory BehaviorTree/BTCompositeNode.h  

virtual void InitializeMemory ( UBehaviorTreeComponent& OwnerComp,
uint8* NodeMemory,
EBTMemoryInit::Type InitType
) const

 Initialize memory block. BehaviorTree/BTCompositeNode.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual bool CanNotifyDecoratorsOnActivation ( FBehaviorTreeSearchData& SearchData,
int32 ChildIdx
) const

 Check if NotifyDecoratorsOnActivation is allowed, requires bUseDecoratorsActivationCheck flag bUseDecoratorsActivationCheck must be set to true for this function to be called BehaviorTree/BTCompositeNode.h  

virtual bool CanNotifyDecoratorsOnDeactivation ( FBehaviorTreeSearchData& SearchData,
int32 ChildIdx,
EBTNodeResult::Type& NodeResult
) const

 Check if NotifyDecoratorsOnDeactivation is allowed, requires bUseDecoratorsDeactivationCheck flag BehaviorTree/BTCompositeNode.h  

virtual bool CanNotifyDecoratorsOnFailedActivation ( FBehaviorTreeSearchData& SearchData,
int32 ChildIdx,
EBTNodeResult::Type& NodeResult
) const

 Check if NotifyDecoratorsOnFailedActivation is allowed, requires bUseDecoratorsActivationCheck flag BehaviorTree/BTCompositeNode.h  

int32 GetNextChild ( FBehaviorTreeSearchData& SearchData,
int32 LastChildIdx,
EBTNodeResult::Type LastResult
) const

 Get next child to process and store it in CurrentChild BehaviorTree/BTCompositeNode.h  

virtual int32 GetNextChildHandler ( FBehaviorTreeSearchData& SearchData,
int32 PrevChild,
EBTNodeResult::Type LastResult
) const

   BehaviorTree/BTCompositeNode.h  
  BehaviorTree/BTCompositeNode.h  

virtual void NotifyChildExecution ( UBehaviorTreeComponent& OwnerComp,
uint8* NodeMemory,
int32 ChildIdx,
EBTNodeResult::Type& NodeResult
) const

 Called just after child execution, allows to modify result BehaviorTree/BTCompositeNode.h  

void NotifyDecoratorsOnActivation ( FBehaviorTreeSearchData& SearchData,
int32 ChildIdx
) const

 Runs through decorators on given child node and notify them about activation BehaviorTree/BTCompositeNode.h  

void NotifyDecoratorsOnDeactivation ( FBehaviorTreeSearchData& SearchData,
int32 ChildIdx,
EBTNodeResult::Type& NodeResult,
const bool bIsInSameActiveInstance
) const

 Runs through decorators on given child node and notify them about deactivation BehaviorTree/BTCompositeNode.h  

void NotifyDecoratorsOnFailedActivation ( FBehaviorTreeSearchData& SearchData,
int32 ChildIdx,
EBTNodeResult::Type& NodeResult
) const

 Runs through decorators on given child node and notify them about failed activation BehaviorTree/BTCompositeNode.h  

virtual void NotifyNodeActivation ( FBehaviorTreeSearchData& SearchData
) const

 Called when start enters this node BehaviorTree/BTCompositeNode.h  

virtual void NotifyNodeDeactivation ( FBehaviorTreeSearchData& SearchData,
EBTNodeResult::Type& NodeResult
) const

 Called when start leaves this node bUseNodeDeactivationNotify must be set to true for this function to be called BehaviorTree/BTCompositeNode.h  

void RequestDelayedExecution ( UBehaviorTreeComponent& OwnerComp,
EBTNodeResult::Type LastResult
) const

 Store delayed execution request BehaviorTree/BTCompositeNode.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page