BTAuxiliaryNode.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "BehaviorTree/BTNode.h"
#include "BTAuxiliaryNode.generated.h"
 
struct FBTAuxiliaryMemory : public FBTInstancedNodeMemory
{
    float NextTickRemainingTime;
    float AccumulatedDeltaTime;
};
 
UCLASS(Abstract, MinimalAPI)
class UBTAuxiliaryNode : public UBTNode
{
    GENERATED_UCLASS_BODY()
 
    
    AIMODULE_API void WrappedOnBecomeRelevant(UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory) const;
 
    AIMODULE_API void WrappedOnCeaseRelevant(UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory) const;
 
    AIMODULE_API bool WrappedTickNode(UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory, float DeltaSeconds, float& NextNeededDeltaTime) const;
 
    AIMODULE_API virtual void DescribeRuntimeValues(const UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory, EBTDescriptionVerbosity::Type Verbosity, TArray<FString>& Values) const override;
    AIMODULE_API virtual uint16 GetSpecialMemorySize() const override;
 
    AIMODULE_API void InitializeParentLink(uint8 InChildIndex);
 
    AIMODULE_API const UBTNode* GetMyNode() const;
 
    uint8 GetChildIndex() const;
 
    AIMODULE_API float GetNextNeededDeltaTime(UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory) const;
 
protected:
 
    uint8 bNotifyBecomeRelevant:1;
 
    uint8 bNotifyCeaseRelevant:1;
 
    uint8 bNotifyTick : 1;
 
    uint8 bTickIntervals : 1;
 
    uint8 ChildIndex;
 
    AIMODULE_API virtual void OnBecomeRelevant(UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory);
 
    AIMODULE_API virtual void OnCeaseRelevant(UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory);
 
    AIMODULE_API virtual void TickNode(UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory, float DeltaSeconds);
 
    AIMODULE_API void SetNextTickTime(uint8* NodeMemory, float RemainingTime) const;
 
    AIMODULE_API float GetNextTickRemainingTime(uint8* NodeMemory) const;
    
    template<typename TickNode, typename OnBecomeRelevant, typename OnCeaseRelevant>
    void InitNotifyFlags(TickNode, OnBecomeRelevant, OnCeaseRelevant)
    {
        bNotifyTick = !std::is_same_v<decltype(&UBTAuxiliaryNode::TickNode), TickNode>;
        bNotifyBecomeRelevant = !std::is_same_v<decltype(&UBTAuxiliaryNode::OnBecomeRelevant), OnBecomeRelevant>;
        bNotifyCeaseRelevant = !std::is_same_v<decltype(&UBTAuxiliaryNode::OnCeaseRelevant), OnCeaseRelevant>;
    }
};
 
#define INIT_AUXILIARY_NODE_NOTIFY_FLAGS() \
    do { \
    using NodeType = TRemovePointer<decltype(this)>::Type; \
    InitNotifyFlags(&NodeType::TickNode, &NodeType::OnBecomeRelevant, &NodeType::OnCeaseRelevant); \
    } while (false)
 
inline uint8 UBTAuxiliaryNode::GetChildIndex() const
{
    return ChildIndex;
}