BTDecorator_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 "UObject/UObjectGlobals.h"
#include "InputCoreTypes.h"
#include "BehaviorTree/BTDecorator.h"
#include "BTDecorator_BlueprintBase.generated.h"
 
class AActor;
class AAIController;
class APawn;
class UBehaviorTree;
class UBlackboardComponent;
 
UCLASS(Abstract, Blueprintable, MinimalAPI)
class UBTDecorator_BlueprintBase : public UBTDecorator
{
    GENERATED_BODY()
 
public:
    AIMODULE_API UBTDecorator_BlueprintBase(const FObjectInitializer& ObjectInitializer = FObjectInitializer::Get());
 
    AIMODULE_API void InitializeProperties();
 
    AIMODULE_API virtual void PostInitProperties() override;
    AIMODULE_API virtual void PostLoad() override;
 
    AIMODULE_API EBlackboardNotificationResult OnBlackboardKeyValueChange(const UBlackboardComponent& Blackboard, FBlackboard::FKey ChangedKeyID);
 
    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 bool CalculateRawConditionValue(UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory) const override;
    AIMODULE_API virtual void OnInstanceDestroyed(UBehaviorTreeComponent& OwnerComp) override;
    AIMODULE_API virtual void InitializeFromAsset(UBehaviorTree& Asset) override;
 
    enum class EAbortType : uint8
    {
        NoAbort,
        ActivateBranch,
        DeactivateBranch,
        Unknown,
    };
 
    AIMODULE_API EAbortType EvaluateAbortType(UBehaviorTreeComponent& OwnerComp) const;
 
    UE_DEPRECATED(5.2, "Use GetShouldAbortType instead")
    bool GetShouldAbort(UBehaviorTreeComponent& OwnerComp) const
    {
        return  EvaluateAbortType(OwnerComp) != EAbortType::NoAbort;
    }
 
    AIMODULE_API virtual void SetOwner(AActor* ActorOwner) override;
 
#if WITH_EDITOR
    AIMODULE_API virtual FName GetNodeIconName() const override;
    AIMODULE_API virtual bool UsesBlueprint() const override;
#endif
 
protected:
    UPROPERTY(Transient)
    TObjectPtr<AAIController> AIOwner;
 
    UPROPERTY(Transient)
    TObjectPtr<AActor> ActorOwner;
 
    UPROPERTY()
    TArray<FName> ObservedKeyNames;
 
    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;
 
    UPROPERTY(EditDefaultsOnly, Category = "FlowControl", AdvancedDisplay)
    uint32 bCheckConditionOnlyBlackBoardChanges : 1;
 
    uint32 bIsObservingBB : 1;
    
    uint32 ReceiveTickImplementations : 2;
 
    uint32 ReceiveExecutionStartImplementations : 2;
 
    uint32 ReceiveExecutionFinishImplementations : 2;
 
    uint32 ReceiveObserverActivatedImplementations : 2;
 
    uint32 ReceiveObserverDeactivatedImplementations : 2;
 
    uint32 PerformConditionCheckImplementations : 2;
 
    AIMODULE_API virtual void OnBecomeRelevant(UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory) override;
    AIMODULE_API virtual void OnCeaseRelevant(UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory) override;
    AIMODULE_API virtual void OnNodeActivation(FBehaviorTreeSearchData& SearchData) override;
    AIMODULE_API virtual void OnNodeDeactivation(FBehaviorTreeSearchData& SearchData, EBTNodeResult::Type NodeResult) override;
    AIMODULE_API virtual void TickNode(UBehaviorTreeComponent& OwnerComp, uint8* NodeMemory, float DeltaSeconds) override;
 
    UFUNCTION(BlueprintImplementableEvent)
    AIMODULE_API void ReceiveTick(AActor* OwnerActor, float DeltaSeconds);
 
    UFUNCTION(BlueprintImplementableEvent)
    AIMODULE_API void ReceiveExecutionStart(AActor* OwnerActor);
 
    UFUNCTION(BlueprintImplementableEvent)
    AIMODULE_API void ReceiveExecutionFinish(AActor* OwnerActor, enum EBTNodeResult::Type NodeResult);
 
    UFUNCTION(BlueprintImplementableEvent)
    AIMODULE_API void ReceiveObserverActivated(AActor* OwnerActor);
 
    UFUNCTION(BlueprintImplementableEvent)
    AIMODULE_API void ReceiveObserverDeactivated(AActor* OwnerActor);
 
    UFUNCTION(BlueprintImplementableEvent)
    AIMODULE_API bool PerformConditionCheck(AActor* OwnerActor);
 
    UFUNCTION(BlueprintImplementableEvent, Category = AI)
    AIMODULE_API void ReceiveTickAI(AAIController* OwnerController, APawn* ControlledPawn, float DeltaSeconds);
 
    UFUNCTION(BlueprintImplementableEvent, Category = AI)
    AIMODULE_API void ReceiveExecutionStartAI(AAIController* OwnerController, APawn* ControlledPawn);
 
    UFUNCTION(BlueprintImplementableEvent, Category = AI)
    AIMODULE_API void ReceiveExecutionFinishAI(AAIController* OwnerController, APawn* ControlledPawn, enum EBTNodeResult::Type NodeResult);
 
    UFUNCTION(BlueprintImplementableEvent, Category = AI)
    AIMODULE_API void ReceiveObserverActivatedAI(AAIController* OwnerController, APawn* ControlledPawn);
 
    UFUNCTION(BlueprintImplementableEvent, Category = AI)
    AIMODULE_API void ReceiveObserverDeactivatedAI(AAIController* OwnerController, APawn* ControlledPawn);
 
    UFUNCTION(BlueprintImplementableEvent, Category = AI)
    AIMODULE_API bool PerformConditionCheckAI(AAIController* OwnerController, APawn* ControlledPawn);
        
    UFUNCTION(BlueprintCallable, Category="AI|BehaviorTree")
    AIMODULE_API bool IsDecoratorExecutionActive() const;
 
    UFUNCTION(BlueprintCallable, Category="AI|BehaviorTree")
    AIMODULE_API bool IsDecoratorObserverActive() const;
 
    inline bool GetNeedsTickForConditionChecking() const { return PerformConditionCheckImplementations != 0 && (bIsObservingBB == false || bCheckConditionOnlyBlackBoardChanges == false); }
 
    AIMODULE_API void RequestAbort(UBehaviorTreeComponent& OwnerComp, const EAbortType Type);
};