1. Epic GamesDeveloper
  3. UBTNode

UBTNode

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

Inheritance Hierarchy

References

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

Syntax

UCLASS (Abstract, Config=Game, MinimalAPI)  
class UBTNode :  
    public UObject,  
    public IGameplayTaskOwnerInterface

Variables

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

Constructors

  Type Name Description
Public function  

UBTNode ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const T *

CastInstanceNodeMemory ( uint8* NodeMemory
)

  
Public function Const void

CleanupInSubtree ( UBehaviorTreeComponent& OwnerComp,
uint8* NodeMemory,
EBTMemoryClear::Type CleanupType
)

 Called on removing subtree to cleanup memory
Public function Virtual Const void

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

 Cleanup memory block. CleanupNodeMemory template function is provided to help cleanup the memory.
Public function Const void

CleanupNodeMemory ( uint8* NodeMemory,
EBTMemoryClear::Type CleanupType
)

  
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 void

ForceInstancing ( bool bEnable
)

 Sets bCreateNodeInstance flag, do NOT call this function on already pushed tree instance!
Public function Const UBlackboardData *  
Public function Const UBehaviorTreeComponent *

GetBTComponentForTask ( UGameplayTask& Task
)

  
Public function Virtual Const FString Validates this node and returns the resulting error message. Empty means no error.
Public function Const uint16  
Public function Virtual Const AActor *

GetGameplayTaskAvatar ( const UGameplayTask* Task
)

  
Public function Virtual Const uint8  
Public function Virtual Const AActor *

GetGameplayTaskOwner ( const UGameplayTask* Task
)

  
Public function Virtual Const UGameplayTasksComponent *

GetGameplayTasksComponent ( const UGameplayTask& Task
)

  
Public function Virtual Const uint16 Size of instance memory
Public function Const uint16  
Public function Const UBTNode *  
Public function Virtual Const FName Get the name of the icon used to display this node in the editor
Public function Virtual Const const ISlateStyle & Get the style set from which GetNodeIconName is queried
Public function Const UBTNode *

GetNodeInstance ( const UBehaviorTreeComponent& OwnerComp,
uint8* NodeMemory
)

  
Public function Const UBTNode *  
Public function Const const T *

GetNodeMemory ( const FBehaviorTreeInstance& BTInstance
)

  
Public function Const T *  
Public function Const const T *

GetNodeMemory ( const FBehaviorTreeSearchData& SearchData
)

  
Public function Const T *  
Public function Const FString  
Public function Const UBTCompositeNode *  
Public function Const FString  
Public function Virtual Const uint16 Size of special, hidden memory block for internal mechanics
Public function Const T *

GetSpecialNodeMemory ( uint8* NodeMemory
)

 Get special memory block used for hidden shared data (e.g. node instancing)
Public function Virtual Const FString  
Public function Const UBehaviorTree *  
Public function Const uint8  
Public function Virtual Const UWorld *  
Public function Const bool  
Public function void Fill in data about execution order
Public function Virtual void Initialize any asset related data
Public function Const void

InitializeInSubtree ( UBehaviorTreeComponent& OwnerComp,
uint8* NodeMemory,
int32& NextInstancedIndex,
EBTMemoryInit::Type InitType
)

 Called on creating subtree to set up memory and instancing
Public function Virtual Const void

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

 Initialize memory block.
Public function void

InitializeNode ( UBTCompositeNode* InParentNode,
uint16 InExecutionIndex,
uint16 InMemoryOffset,
uint8 InTreeDepth
)

 Fill in data about tree structure
Public function Const T *

InitializeNodeMemory ( uint8* NodeMemory,
EBTMemoryInit::Type InitType
)

  
Public function Const bool  
Public function Const bool  
Public function void Sets bIsInjected flag, do NOT call this function unless you really know what you are doing!
Public function T *  
Public function T *

NewBTAITask ( const UClass& Class,
UBehaviorTreeComponent& BTComponent
)

  
Public function Virtual void

OnGameplayTaskInitialized ( UGameplayTask& Task
)

  
Public function Virtual void Called when node instance is added to tree
Public function Virtual void Called when node instance is removed from tree
Public function Virtual void Called after creating new node in behavior tree editor, use for versioning
Public function Virtual void

SetOwner ( AActor* ActorOwner
)

 Gets called only for instanced nodes(bCreateNodeInstance == true).
Public function Virtual Const bool Get whether this node is using a blueprint for its logic

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page