BlackboardData.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 "InputCoreTypes.h"
#include "Templates/SubclassOf.h"
#include "BehaviorTree/Blackboard/BlackboardKeyType.h"
#include "Engine/DataAsset.h"
#include "BlackboardData.generated.h"
 
USTRUCT()
struct FBlackboardEntry
{
    GENERATED_USTRUCT_BODY()
 
    UPROPERTY(EditAnywhere, Category=Blackboard)
    FName EntryName;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY(EditAnywhere, Category=Blackboard, Meta=(ToolTip="Optional description to explain what this blackboard entry does."))
    FString EntryDescription;
 
    UPROPERTY(EditAnywhere, Category=Blackboard)
    FName EntryCategory;
#endif // WITH_EDITORONLY_DATA
 
    UPROPERTY(EditAnywhere, Instanced, Category = Blackboard, meta = (AllowEditInlineCustomization))
    TObjectPtr<UBlackboardKeyType> KeyType;
 
    UPROPERTY(EditAnywhere, Category=Blackboard)
    uint32 bInstanceSynced : 1;
 
    FBlackboardEntry()
        : KeyType(nullptr), bInstanceSynced(0)
    {}
 
    AIMODULE_API bool operator==(const FBlackboardEntry& Other) const;
};
 
UCLASS(BlueprintType, AutoExpandCategories=(Blackboard), MinimalAPI)
class UBlackboardData : public UDataAsset
{
    GENERATED_UCLASS_BODY()
    DECLARE_MULTICAST_DELEGATE_OneParam(FKeyUpdate, UBlackboardData* /*asset*/);
 
    UPROPERTY(EditAnywhere, Category=Parent)
    TObjectPtr<UBlackboardData> Parent;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY(VisibleDefaultsOnly, Transient, Category=Parent)
    TArray<FBlackboardEntry> ParentKeys;
#endif
 
    UPROPERTY(EditAnywhere, Category=Blackboard)
    TArray<FBlackboardEntry> Keys;
 
private:
    UPROPERTY()
    uint32 bHasSynchronizedKeys : 1;
 
public:
 
    inline bool HasSynchronizedKeys() const { return bHasSynchronizedKeys; }
 
    AIMODULE_API bool IsKeyInstanceSynced(FBlackboard::FKey KeyID) const;
    
    AIMODULE_API FBlackboard::FKey GetKeyID(const FName& KeyName) const;
 
    AIMODULE_API FName GetKeyName(FBlackboard::FKey KeyID) const;
 
    AIMODULE_API TSubclassOf<UBlackboardKeyType> GetKeyType(FBlackboard::FKey KeyID) const;
 
    AIMODULE_API int32 GetNumKeys() const;
 
    inline FBlackboard::FKey GetFirstKeyID() const { return FirstKeyID; }
 
    bool IsValidKey(FBlackboard::FKey KeyID) const { return KeyID != FBlackboard::InvalidKey && (int32)KeyID < GetNumKeys(); }
 
    AIMODULE_API const FBlackboardEntry* GetKey(FBlackboard::FKey KeyID) const;
 
    const TArray<FBlackboardEntry>& GetKeys() const { return Keys; }
 
    AIMODULE_API virtual void PostInitProperties() override;
    AIMODULE_API virtual void PostLoad() override;
#if WITH_EDITOR
    AIMODULE_API virtual void PostEditChangeProperty(struct FPropertyChangedEvent& PropertyChangedEvent) override;
#endif
    AIMODULE_API void PropagateKeyChangesToDerivedBlackboardAssets();
 
    AIMODULE_API bool IsValid() const;
 
    template<class T>
    T* UpdatePersistentKey(const FName& KeyName)
    {
        T* CreatedKeyType = NULL;
 
        const FBlackboard::FKey KeyID = InternalGetKeyID(KeyName, DontCheckParentKeys);
        if (KeyID == FBlackboard::InvalidKey && Parent == NULL)
        {
            FBlackboardEntry Entry;
            Entry.EntryName = KeyName;
 
            CreatedKeyType = NewObject<T>(this);
            Entry.KeyType = CreatedKeyType;     
 
            Keys.Add(Entry);
            MarkPackageDirty();
            PropagateKeyChangesToDerivedBlackboardAssets();
        }
        else if (KeyID != FBlackboard::InvalidKey && Parent != NULL)
        {
            const FBlackboard::FKey KeyIndex = (int32)KeyID - (int32)FirstKeyID;
            Keys.RemoveAt(KeyIndex);
            MarkPackageDirty();
            PropagateKeyChangesToDerivedBlackboardAssets();
        }
 
        return CreatedKeyType;
    }
 
#if WITH_EDITOR
    DECLARE_MULTICAST_DELEGATE_OneParam(FBlackboardDataChanged, UBlackboardData* /*Asset*/);
    static AIMODULE_API FBlackboardDataChanged OnBlackboardDataChanged;
#endif
 
    static AIMODULE_API FKeyUpdate OnUpdateKeys;
 
    AIMODULE_API void UpdateParentKeys();
 
    AIMODULE_API void UpdateKeyIDs();
 
    AIMODULE_API void UpdateIfHasSynchronizedKeys();
 
    AIMODULE_API void UpdateDeprecatedKeys();
 
    AIMODULE_API bool IsChildOf(const UBlackboardData& OtherAsset) const;
 
    bool IsRelatedTo(const UBlackboardData& OtherAsset) const
    {
        return this == &OtherAsset || IsChildOf(OtherAsset) || OtherAsset.IsChildOf(*this)
            || (Parent && OtherAsset.Parent && Parent->IsRelatedTo(*OtherAsset.Parent));
    }
 
protected:
 
    enum EKeyLookupMode
    {
        CheckParentKeys,
        DontCheckParentKeys,
    };
 
    FBlackboard::FKey FirstKeyID;
 
    AIMODULE_API FBlackboard::FKey InternalGetKeyID(const FName& KeyName, EKeyLookupMode LookupMode) const;
};