1. Epic GamesDeveloper
  3. UBTCompositeNode

UBTCompositeNode

API > API/Runtime > API/Runtime/AIModule > API/Runtime/AIModule/BehaviorTree

Inheritance Hierarchy

References

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

Syntax

class UBTCompositeNode : public UBTNode

Variables

  Type Name Description
Protected variable uint32: 1 bApplyDecoratorScope If set, all decorators in branch below will be removed when execution flow leaves (decorators on this node are not affected)
Protected variable uint32: 1 bUseChildExecutionNotify If set, NotifyChildExecution will be called
Protected variable uint32: 1 bUseDecoratorsActivationCheck If set, CanNotifyDecoratorsOnActivation will be called
Protected variable uint32: 1 bUseDecoratorsDeactivationCheck If set, CanNotifyDecoratorsOnDeactivation will be called
Protected variable uint32: 1 bUseDecoratorsFailedActivationCheck If set, CanNotifyDecoratorsOnFailedActivation will be called
Protected variable uint32: 1 bUseNodeActivationNotify If set, NotifyNodeActivation will be called
Protected variable uint32: 1 bUseNodeDeactivationNotify If set, NotifyNodeDeactivation will be called
Public variable TArray< FBTCompositeChild > Children Child nodes
Protected variable uint16 LastExecutionIndex Execution index of last node in child branches
Public variable TArray< TObjectPtr< UBTService > > Services Service nodes

Constructors

  Type Name Description
Public function  

UBTCompositeNode ( const FObjectInitializer& ObjectInitializer
)

  

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Virtual Const bool  
Public function Virtual Const bool  
Protected function Virtual Const bool Check if NotifyDecoratorsOnActivation is allowed, requires bUseDecoratorsActivationCheck flag bUseDecoratorsActivationCheck must be set to true for this function to be called Calling INIT_COMPOSITE_NODE_NOTIFY_FLAGS in the constructor of the node will set this flag automatically
Protected function Virtual Const bool Check if NotifyDecoratorsOnDeactivation is allowed, requires bUseDecoratorsDeactivationCheck flag bUseDecoratorsDeactivationCheck must be set to true for this function to be called Calling INIT_COMPOSITE_NODE_NOTIFY_FLAGS in the constructor of the node will set this flag automatically
Protected function Virtual Const bool Check if NotifyDecoratorsOnFailedActivation is allowed, requires bUseDecoratorsActivationCheck flag bUseDecoratorsFailedActivationCheck must be set to true for this function to be called Calling INIT_COMPOSITE_NODE_NOTIFY_FLAGS in the constructor of the node will set this flag automatically
Public function Virtual Const bool

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

 Check if child node can execute new subtree
Public function Const void

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

 Notify about task execution start
Public function Const bool

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

 Is child execution allowed by decorators?
Public function Const int32 Find next child branch to execute
Public function Const uint16

GetBranchExecutionIndex ( uint16 NodeInBranchIdx
)

 Get first execution index of given branch
Public function Const uint16

GetChildExecutionIndex ( int32 Index,
EBTChildIndex ChildMode
)

  
Public function Const int32

GetChildIndex ( FBehaviorTreeSearchData& SearchData,
const UBTNode& ChildNode
)

 Get index of child node (handle subtrees)
Public function Const int32

GetChildIndex ( const UBTNode& ChildNode
)

 Get index of child node
Public function Const UBTNode *

GetChildNode ( int32 Index
)

  
Public function Const int32  
Public function Const uint16  
Public function Const int32

GetMatchingChildIndex ( int32 ActiveInstanceIdx,
FBTNodeIndex& NodeIdx
)

 Find branch containing specified node index
Protected function Const int32

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

 Get next child to process and store it in CurrentChild
Protected function Virtual Const int32

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

  
Public function void

InitializeComposite ( uint16 InLastExecutionIndex
)

 Fill in data about tree structure
Protected function void  
Public function Const bool  
Protected function Virtual Const void

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

 Called just after child execution, allows to modify result bUseChildExecutionNotify must be set to true for this function to be called Calling INIT_COMPOSITE_NODE_NOTIFY_FLAGS in the constructor of the node will set this flag automatically
Protected function Const void

NotifyDecoratorsOnActivation ( FBehaviorTreeSearchData& SearchData,
int32 ChildIdx
)

 Runs through decorators on given child node and notify them about activation
Protected function Const void

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

 Runs through decorators on given child node and notify them about deactivation
Protected function Const void Runs through decorators on given child node and notify them about failed activation
Protected function Virtual Const void Called when start enters this node bUseNodeActivationNotify must be set to true for this function to be called Calling INIT_COMPOSITE_NODE_NOTIFY_FLAGS in the constructor of the node will set this flag automatically
Protected function Virtual Const void Called when start leaves this node bUseNodeDeactivationNotify must be set to true for this function to be called Calling INIT_COMPOSITE_NODE_NOTIFY_FLAGS in the constructor of the node will set this flag automatically
Public function Const void

OnChildActivation ( FBehaviorTreeSearchData& SearchData,
int32 ChildIndex
)

 Called before passing search to child node
Public function Const void

OnChildActivation ( FBehaviorTreeSearchData& SearchData,
const UBTNode& ChildNode
)

 Called before passing search to child node
Public function Const void

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

 Notification called after child has finished search
Public function Const void

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

 Notification called after child has finished search
Public function Const void Called when start enters this node
Public function Const void Called when search leaves this node
Public function Const void Called when search needs to reactivate this node
Protected function Const void Store delayed execution request
Public function Virtual Const void

SetChildOverride ( FBehaviorTreeSearchData& SearchData,
int8 Index
)

 Set override for next child index

Overridden from UBTNode

  Type Name Description
Public function Virtual Const void

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

 Gathers description of all runtime parameters
Public function Virtual Const uint16 Size of instance memory

Deprecated Functions

  Type Name Description
Public function Const void

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

 This function is deprecated. Please use RequestBranchDeactivation instead.
Public function Const void

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

 This function is deprecated. Please use RequestBranchDeactivation instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page