1. Epic GamesDeveloper
  3. FBehaviorTreeInstance

FBehaviorTreeInstance

Data required for instance of single subtree

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

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

  Type Name Description
Public variable TArray< UBTAuxiliaryNode * > ActiveAuxNodes Active auxiliary nodes
Public variable UBTNode * ActiveNode Active node in template
Public variable TEnumAsByte< EBTActiveNode::Type > ActiveNodeType Active node type
Public variable FBTInstanceDeactivation DeactivationNotify Delegate sending a notify when tree instance is removed from active stack
Public variable uint8 InstanceIdIndex Index of identifier (BehaviorTreeComponent.KnownInstances)
Public variable TArray< uint8 > InstanceMemory Memory: instance
Public variable TArray< FBehaviorTreeParallelTask > ParallelTasks Active parallel tasks
Public variable UBTCompositeNode * RootNode Root node in template

Constructors

  Type Name Description
Public function    
Public function   Copying FBehaviorTreeInstance constructor has been deprecated in favor of move-constructor
Public function    
Public function  

FBehaviorTreeInstance ( int32 MemorySize
)

  

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void Add specified node to the active nodes list
Public function void Add new parallel task
Public function void Cleanup node instances
Protected function void Worker for updating all nodes
Public function void

DeactivateNodes ( FBehaviorTreeSearchData& SearchData,
uint16 InstanceIndex
)

 Deactivate all active aux nodes and remove their requests from SearchData
Public function Const void  
Public function void

ExecuteOnEachAuxNode ( TFunctionRef< void(const UBTAuxiliaryNode&)> ExecFunc
)

 Iterate on auxiliary nodes and call ExecFunc on each of them.
Public function void

ExecuteOnEachParallelTask ( TFunctionRef< void(const FBehaviorTreeParallelTask&, const int32)> ExecFunc
)

 Iterate on parallel tasks and call ExecFunc on each of them.
Public function Const TArrayView< UBTAuxiliaryNode *const > Get list of all active auxiliary nodes
Public function Const uint32  
Public function Const TArrayView< const uint8 > Get instance memory
Public function Const TArrayView< const FBehaviorTreeParallelTask > Get list of all active parallel tasks
Public function Const bool

HasActiveNode ( uint16 TestExecutionIndex
)

 Check if instance has active node with given execution index
Public function Const void  
Public function void

Initialize ( UBehaviorTreeComponent& OwnerComp,
UBTCompositeNode& Node,
int32& InstancedIndex,
EBTMemoryInit::Type InitType
)

 Initialize memory and create node instances
Public function Const bool

IsValidParallelTaskIndex ( const int32 Index
)

 Indicates if the provided index is a valid parallel task index
Public function void

MarkParallelTaskAsAbortingAt ( int32 TaskIndex
)

 Mark parallel task at given index as pending abort
Public function void Remove specified node from the active nodes list
Public function void

RemoveParallelTaskAt ( int32 TaskIndex
)

 Remove parallel task at given index
Public function void Remove all auxiliary nodes from active nodes list
Public function void

SetInstanceMemory ( const TArray< uint8 >& Memory
)

 Set instance memory

Operators

  Type Name Description
Public function FBehaviorTreeInstance &  

Deprecated Functions

  Type Name Description
Public function   Copying FBehaviorTreeInstance constructor has been deprecated in favor of move-constructor
Public function FBehaviorTreeInstance &

operator= ( const FBehaviorTreeInstance& Other
)

 Copying FBehaviorTreeInstance assignement operator has been deprecated in favor of move assignement operator

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page