UBTAuxiliaryNode

Auxiliary nodes are supporting nodes, that receive notification about execution flow and can be ticked

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

AIModule

Header

/Engine/Source/Runtime/AIModule/Classes/BehaviorTree/BTAuxiliaryNode.h

Include

#include "BehaviorTree/BTAuxiliaryNode.h"

Syntax

class UBTAuxiliaryNode : public UBTNode

Remarks

Auxiliary nodes are supporting nodes, that receive notification about execution flow and can be ticked

Because some of them can be instanced for specific AI, following virtual functions are not marked as const:

  • OnBecomeRelevant

  • OnCeaseRelevant

  • TickNode

If your node is not being instanced (default behavior), DO NOT change any properties of object within those functions! Template nodes are shared across all behavior tree components using the same tree asset and must store their runtime properties in provided NodeMemory block (allocation size determined by GetInstanceMemorySize() )

Variables

Name Description

Protected variable

uint8: 1

 

bNotifyBecomeRelevant

If set, OnBecomeRelevant will be used

Protected variable

uint8: 1

 

bNotifyCeaseRelevant

If set, OnCeaseRelevant will be used

Protected variable

uint8: 1

 

bNotifyTick

If set, OnTick will be used

Protected variable

uint8: 1

 

bTickIntervals

If set, conditional tick will use remaining time from node's memory

Protected variable

uint8

 

ChildIndex

Child index in parent node

Constructors

Name Description

Public function

UBTAuxiliaryNode

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Const

uint8

 

GetChildIndex()

Public function Const

const UBTNod...

 

GetMyNode()

Public function Const

float

 

GetNextNeededDeltaTime

(
    UBehaviorTreeComponent& OwnerComp,
    uint8* NodeMemory
)

Get The next needed deltatime for this node

Protected function Const

float

 

GetNextTickRemainingTime

(
    uint8* NodeMemory
)

Gets remaining time for next tick

Public function

void

 

InitializeParentLink

(
    uint8 InChildIndex
)

Fill in data about tree structure

Protected function

void

 

InitNotifyFlags

(
    TickNode,
    OnBecomeRelevant,
    OnCeaseRelevant
)

Protected function Virtual

void

 

OnBecomeRelevant

(
    UBehaviorTreeComponent& OwnerComp,
    uint8* NodeMemory
)

Called when auxiliary node becomes active this function should be considered as const (don't modify state of object) if node is not instanced! bNotifyBecomeRelevant must be set to true for this function to be called Calling INIT_AUXILIARY_NODE_NOTIFY_FLAGS in the constructor of the node will set this flag automatically

Protected function Virtual

void

 

OnCeaseRelevant

(
    UBehaviorTreeComponent& OwnerComp,
    uint8* NodeMemory
)

Called when auxiliary node becomes inactive this function should be considered as const (don't modify state of object) if node is not instanced! bNotifyCeaseRelevant must be set to true for this function to be called Calling INIT_AUXILIARY_NODE_NOTIFY_FLAGS in the constructor of the node will set this flag automatically

Protected function Const

void

 

SetNextTickTime

(
    uint8* NodeMemory,
    float RemainingTime
)

Sets next tick time

Protected function Virtual

void

 

TickNode

(
    UBehaviorTreeComponent& OwnerComp,
    uint8* NodeMemory,
    float DeltaSeconds
)

Tick function this function should be considered as const (don't modify state of object) if node is not instanced! bNotifyTick must be set to true for this function to be called Calling INIT_AUXILIARY_NODE_NOTIFY_FLAGS in the constructor of the node will set this flag automatically

Public function Const

void

 

WrappedOnBecomeRelevant

(
    UBehaviorTreeComponent& OwnerComp,
    uint8* NodeMemory
)

Wrapper for node instancing: OnBecomeRelevant

Public function Const

void

 

WrappedOnCeaseRelevant

(
    UBehaviorTreeComponent& OwnerComp,
    uint8* NodeMemory
)

Wrapper for node instancing: OnCeaseRelevant

Public function Const

bool

 

WrappedTickNode

(
    UBehaviorTreeComponent& OwnerComp,
    uint8* NodeMemory,
    float DeltaSeconds,
    float& NextNeededDeltaTime
)

Wrapper for node instancing: TickNode

Overridden from UBTNode

Name Description

Public function Virtual Const

void

 

DescribeRuntimeValues

(
    const UBehaviorTreeComponent& Owne...,
    uint8* NodeMemory,
    EBTDescriptionVerbosity::Type Verbo...,
    TArray< FString >& Values
)

Gathers description of all runtime parameters

Public function Virtual Const

uint16

 

GetSpecialMemorySize()

Size of special, hidden memory block for internal mechanics