BTTaskNode.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 "BTTaskNode.generated.h"
 
class UBTService;
 
struct FBTTaskMemory : public FBTInstancedNodeMemory
{
    float NextTickRemainingTime = 0.f;
    float AccumulatedDeltaTime = 0.f;
};
 
UCLASS(Abstract, MinimalAPI)
class UBTTaskNode : public UBTNode
{
    GENERATED_UCLASS_BODY()
 
    
    AIMODULE_API virtual EBTNodeResult::Type ExecuteTask(UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory);
 
    AIMODULE_API virtual uint16 GetSpecialMemorySize() const override;
 
protected:
    AIMODULE_API virtual EBTNodeResult::Type AbortTask(UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory);
 
    AIMODULE_API void SetNextTickTime(uint8* NodeMemory, float RemainingTime) const;
 
public:
#if WITH_EDITOR
    AIMODULE_API virtual FName GetNodeIconName() const override;
#endif // WITH_EDITOR
    AIMODULE_API virtual void OnGameplayTaskDeactivated(UGameplayTask& Task) override;
 
    AIMODULE_API void ReceivedMessage(UBrainComponent* BrainComp, const FAIMessage& Message);
 
    AIMODULE_API EBTNodeResult::Type WrappedExecuteTask(UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory) const;
 
    AIMODULE_API EBTNodeResult::Type WrappedAbortTask(UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory) const;
 
    AIMODULE_API bool WrappedTickTask(UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory, float DeltaSeconds, float& NextNeededDeltaTime) const;
 
    AIMODULE_API void WrappedOnTaskFinished(UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory, EBTNodeResult::Type TaskResult) const;
 
    AIMODULE_API void FinishLatentTask(UBehaviorTreeComponent& OwnerComp, EBTNodeResult::Type TaskResult) const;
 
    AIMODULE_API void FinishLatentAbort(UBehaviorTreeComponent& OwnerComp) const;
 
    bool ShouldIgnoreRestartSelf() const;
 
    UPROPERTY()
    TArray<TObjectPtr<UBTService>> Services;
 
protected:
 
    UPROPERTY(EditAnywhere, Category=Task)
    uint32 bIgnoreRestartSelf : 1;
 
    uint32 bNotifyTick : 1;
 
    uint32 bNotifyTaskFinished : 1;
 
    AIMODULE_API virtual void TickTask(UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory, float DeltaSeconds);
 
    AIMODULE_API virtual void OnMessage(UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory, FName Message, int32 RequestID, bool bSuccess);
 
    AIMODULE_API virtual void OnTaskFinished(UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory, EBTNodeResult::Type TaskResult);
 
    AIMODULE_API void WaitForMessage(UBehaviorTreeComponent& OwnerComp, FName MessageType) const;
    AIMODULE_API void WaitForMessage(UBehaviorTreeComponent& OwnerComp, FName MessageType, int32 RequestID) const;
    
    AIMODULE_API void StopWaitingForMessages(UBehaviorTreeComponent& OwnerComp) const;
    
    template<typename TickTask, typename OnTaskFinished>
    void InitNotifyFlags(TickTask, OnTaskFinished)
    {
        bNotifyTick = !std::is_same_v<decltype(&UBTTaskNode::TickTask), TickTask>;
        bNotifyTaskFinished = !std::is_same_v<decltype(&UBTTaskNode::OnTaskFinished), OnTaskFinished>;
    }
 
    uint8 bTickIntervals : 1;
};
 
#define INIT_TASK_NODE_NOTIFY_FLAGS() \
    do { \
    using NodeType = TRemovePointer<decltype(this)>::Type; \
    InitNotifyFlags(&NodeType::TickTask, &NodeType::OnTaskFinished); \
    } while (false)
 
inline bool UBTTaskNode::ShouldIgnoreRestartSelf() const
{
    return bIgnoreRestartSelf;
}