UBTDecorator_TagCooldown

Cooldown decorator node.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

AIModule

Header

/Engine/Source/Runtime/AIModule/Classes/BehaviorTree/Decorators/BTDecorator_TagCooldown.h

Include

#include "BehaviorTree/Decorators/BTDecorator_TagCooldown.h"

Syntax

class UBTDecorator_TagCooldown : public UBTDecorator

Remarks

Cooldown decorator node. A decorator node that bases its condition on whether a cooldown timer based on a gameplay tag has expired.

Variables

Name Description

Public variable

bool

 

bActivatesCooldown

Whether or not we are adding/setting to the cooldown tag's value when the decorator deactivates.

Public variable

bool

 

bAddToExistingDuration

True if we are adding to any existing duration, false if we are setting the duration (potentially invalidating an existing end time).

Public variable

float

 

CooldownDuration

Value we will add or set to the Cooldown tag when this node is deactivated.

Public variable

FGameplayTag

 

CooldownTag

Gameplay tag that will be used for the cooldown.

Constructors

Name Description

Public function

UBTDecorator_TagCooldown

(
    const FObjectInitializer& ObjectIn...
)

Overridden from UBTDecorator

Name Description

Public function Virtual Const

bool

 

CalculateRawConditionValue

(
    UBehaviorTreeComponent& OwnerComp,
    uint8* NodeMemory
)

Calculates raw, core value of decorator's condition. Should not include calling IsInversed

Protected function Virtual

void

 

OnNodeDeactivation

(
    FBehaviorTreeSearchData& SearchDat...,
    EBTNodeResult::Type NodeResult
)

Called when underlying node has finished this function should be considered as const (don't modify state of object) if node is not instanced! bNotifyDeactivation must be set to true for this function to be called Calling INIT_DECORATOR_NODE_NOTIFY_FLAGS in the constructor of the decorator will set this flag automatically

Overridden from UBTAuxiliaryNode

Name Description

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

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

 

GetInstanceMemorySize()

Size of instance memory

Public function Virtual Const

FName

 

GetNodeIconName()

Get the name of the icon used to display this node in the editor

Public function Virtual Const

FString

 

GetStaticDescription()

Public function Virtual Const

void

 

InitializeMemory

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

Initialize memory block

Overridden from UObject

Name Description

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.