BTService.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "BehaviorTree/BTAuxiliaryNode.h"
#include "BTService.generated.h"
 
UCLASS(Abstract, MinimalAPI)
class UBTService : public UBTAuxiliaryNode
{
    GENERATED_UCLASS_BODY()
 
    AIMODULE_API virtual FString GetStaticDescription() const override;
 
    AIMODULE_API void NotifyParentActivation(FBehaviorTreeSearchData& SearchData);
 
protected:
 
    // Gets the description of our tick interval
    AIMODULE_API FString GetStaticTickIntervalDescription() const;
 
    // Gets the description for our service
    AIMODULE_API virtual FString GetStaticServiceDescription() const;
 
    UPROPERTY(Category=Service, EditAnywhere, meta=(ClampMin="0.001"))
    float Interval;
 
    UPROPERTY(Category=Service, EditAnywhere, meta=(ClampMin="0.0"))
    float RandomDeviation;
 
    UPROPERTY(Category = Service, EditAnywhere, AdvancedDisplay, meta=(EditCondition = bCanTickOnSearchStartBeExposed, EditConditionHides))
    uint32 bCallTickOnSearchStart : 1;
 
    UPROPERTY(Category = Service, EditAnywhere, AdvancedDisplay)
    uint32 bRestartTimerOnEachActivation : 1;
 
    uint32 bNotifyOnSearch : 1;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY(transient)
    uint32 bCanTickOnSearchStartBeExposed : 1;
#endif // WITH_EDITORONLY_DATA
 
    AIMODULE_API virtual void TickNode(UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory, float DeltaSeconds) override;
 
    AIMODULE_API virtual void OnSearchStart(FBehaviorTreeSearchData& SearchData);
 
#if WITH_EDITOR
    AIMODULE_API virtual FName GetNodeIconName() const override;
#endif // WITH_EDITOR
 
    AIMODULE_API virtual void ScheduleNextTick(UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory);
 
    template<typename TickNode, typename OnBecomeRelevant, typename OnCeaseRelevant, typename OnSearchStart>
    void InitNotifyFlags(TickNode, OnBecomeRelevant, OnCeaseRelevant, OnSearchStart)
    {
        bNotifyTick = !std::is_same_v<decltype(&UBTService::TickNode), TickNode>;
        bNotifyBecomeRelevant = !std::is_same_v<decltype(&UBTService::OnBecomeRelevant), OnBecomeRelevant>;
        bNotifyCeaseRelevant = !std::is_same_v<decltype(&UBTService::OnCeaseRelevant), OnCeaseRelevant>;
        bNotifyOnSearch = !std::is_same_v<decltype(&UBTService::OnSearchStart), OnSearchStart>;
    }
};
 
#define INIT_SERVICE_NODE_NOTIFY_FLAGS() \
    do { \
    using NodeType = TRemovePointer<decltype(this)>::Type; \
    InitNotifyFlags(&NodeType::TickNode, \
                    &NodeType::OnBecomeRelevant, \
                    &NodeType::OnCeaseRelevant, \
                    &NodeType::OnSearchStart); \
    } while (false)