BTTask_BlueprintBase.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "BehaviorTree/BTTaskNode.h"
#include "BTTask_BlueprintBase.generated.h"
 
class AActor;
class AAIController;
class APawn;
class UBehaviorTree;
 
UCLASS(Abstract, Blueprintable, MinimalAPI)
class UBTTask_BlueprintBase : public UBTTaskNode
{
    GENERATED_UCLASS_BODY()
    
    AIMODULE_API virtual EBTNodeResult::Type ExecuteTask(UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory) override;
    AIMODULE_API virtual EBTNodeResult::Type AbortTask(UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory) override;
 
    AIMODULE_API virtual FString GetStaticDescription() const override;
    AIMODULE_API virtual void DescribeRuntimeValues(const UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory, EBTDescriptionVerbosity::Type Verbosity, TArray<FString>& Values) const override;
    AIMODULE_API virtual void OnInstanceDestroyed(UBehaviorTreeComponent& OwnerComp) override;
    AIMODULE_API virtual void OnTaskFinished(UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory, EBTNodeResult::Type TaskResult) override;
    AIMODULE_API virtual void InitializeFromAsset(UBehaviorTree& Asset) override;
 
    AIMODULE_API virtual void SetOwner(AActor* ActorOwner) override;
 
#if WITH_EDITOR
    AIMODULE_API virtual bool UsesBlueprint() const override;
#endif
 
protected:
    UPROPERTY(Transient)
    TObjectPtr<AAIController> AIOwner;
 
    UPROPERTY(Transient)
    TObjectPtr<AActor> ActorOwner;
 
    UPROPERTY(EditAnywhere, Category = Task)
    FIntervalCountdown TickInterval;
    
    mutable TEnumAsByte<EBTNodeResult::Type> CurrentCallResult;
 
    TArray<FProperty*> PropertyData;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY(EditDefaultsOnly, BlueprintReadWrite, Category = Description)
    FString CustomDescription;
#endif // WITH_EDITORONLY_DATA
 
    UPROPERTY(EditInstanceOnly, Category=Description)
    uint32 bShowPropertyDetails : 1;
 
    uint32 ReceiveTickImplementations : 2;
 
    uint32 ReceiveExecuteImplementations : 2;
 
    uint32 ReceiveAbortImplementations : 2;
 
    uint32 bIsAborting : 1;
 
    mutable uint32 bStoreFinishResult : 1;
 
    UFUNCTION(BlueprintImplementableEvent)
    AIMODULE_API void ReceiveExecute(AActor* OwnerActor);
 
    UFUNCTION(BlueprintImplementableEvent)
    AIMODULE_API void ReceiveAbort(AActor* OwnerActor);
 
    UFUNCTION(BlueprintImplementableEvent)
    AIMODULE_API void ReceiveTick(AActor* OwnerActor, float DeltaSeconds);
 
    UFUNCTION(BlueprintImplementableEvent, Category = AI)
    AIMODULE_API void ReceiveExecuteAI(AAIController* OwnerController, APawn* ControlledPawn);
 
    UFUNCTION(BlueprintImplementableEvent, Category = AI)
    AIMODULE_API void ReceiveAbortAI(AAIController* OwnerController, APawn* ControlledPawn);
 
    UFUNCTION(BlueprintImplementableEvent, Category = AI)
    AIMODULE_API void ReceiveTickAI(AAIController* OwnerController, APawn* ControlledPawn, float DeltaSeconds);
 
    UFUNCTION(BlueprintCallable, Category="AI|BehaviorTree")
    AIMODULE_API void FinishExecute(bool bSuccess);
 
    UFUNCTION(BlueprintCallable, Category="AI|BehaviorTree")
    AIMODULE_API void FinishAbort();
 
    UFUNCTION(BlueprintCallable, Category="AI|BehaviorTree")
    AIMODULE_API void SetFinishOnMessage(FName MessageName);
 
    UFUNCTION(BlueprintCallable, Category="AI|BehaviorTree")
    AIMODULE_API void SetFinishOnMessageWithId(FName MessageName, int32 RequestID = -1);
 
    UFUNCTION(BlueprintCallable, Category="AI|BehaviorTree")
    AIMODULE_API bool IsTaskExecuting() const;
    
    UFUNCTION(BlueprintCallable, Category = "AI|BehaviorTree")
    AIMODULE_API bool IsTaskAborting() const;
 
    AIMODULE_API virtual void TickTask(UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory, float DeltaSeconds) override;
};