UBTAuxiliaryNode | Unreal Engine 5.6 Documentation

API > API/Runtime > API/Runtime/AIModule

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() )


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

Syntax

UCLASS (Abstract, MinimalAPI)  
class UBTAuxiliaryNode : public UBTNode

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UBTNode → UBTAuxiliaryNode

Implements Interfaces

IGameplayTaskOwnerInterface

Derived Classes

Constructors

Name	Remarks	Include Path	Unreal Specifiers
UBTAuxiliaryNode ( const FObjectInitializer& ObjectInitializer )		BehaviorTree/BTAuxiliaryNode.h

Functions

Public

Name	Remarks	Include Path
uint8 GetChildIndex()		BehaviorTree/BTAuxiliaryNode.h
const UBTNode * GetMyNode()		BehaviorTree/BTAuxiliaryNode.h
float GetNextNeededDeltaTime ( UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory ) const	Get The next needed deltatime for this node	BehaviorTree/BTAuxiliaryNode.h
void InitializeParentLink ( uint8 InChildIndex )	Fill in data about tree structure	BehaviorTree/BTAuxiliaryNode.h
void WrappedOnBecomeRelevant ( UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory ) const	Wrapper for node instancing: OnBecomeRelevant	BehaviorTree/BTAuxiliaryNode.h
void WrappedOnCeaseRelevant ( UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory ) const	Wrapper for node instancing: OnCeaseRelevant	BehaviorTree/BTAuxiliaryNode.h
bool WrappedTickNode ( UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory, float DeltaSeconds, float& NextNeededDeltaTime ) const	Wrapper for node instancing: TickNode	BehaviorTree/BTAuxiliaryNode.h

Overridden from UBTNode

Name	Remarks	Include Path	Unreal Specifiers
virtual void DescribeRuntimeValues ( const UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory, EBTDescriptionVerbosity::Type Verbosity, TArray< FString >& Values ) const	Gathers description of all runtime parameters	BehaviorTree/BTAuxiliaryNode.h
virtual uint16 GetSpecialMemorySize()	Size of special, hidden memory block for internal mechanics	BehaviorTree/BTAuxiliaryNode.h

Protected

Name	Remarks	Include Path
float GetNextTickRemainingTime ( uint8* NodeMemory ) const	Gets remaining time for next tick	BehaviorTree/BTAuxiliaryNode.h
void InitNotifyFlags ( TickNode, OnBecomeRelevant, OnCeaseRelevant )		BehaviorTree/BTAuxiliaryNode.h
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!	BehaviorTree/BTAuxiliaryNode.h
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!	BehaviorTree/BTAuxiliaryNode.h
void SetNextTickTime ( uint8* NodeMemory, float RemainingTime ) const	Sets next tick time	BehaviorTree/BTAuxiliaryNode.h
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!	BehaviorTree/BTAuxiliaryNode.h

Navigation