BlackboardKeyType.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/Object.h"
#include "InputCoreTypes.h"
#include "BehaviorTree/BehaviorTreeTypes.h"
#include "BlackboardKeyEnums.h"
#include "BlackboardKeyType.generated.h"
 
DECLARE_LOG_CATEGORY_EXTERN(LogBlackboard, Log, All);
 
class UBlackboardComponent;
 
struct FBlackboardInstancedKeyMemory
{
    int32 KeyIdx;
};
 
UCLASS(EditInlineNew, Abstract, CollapseCategories, AutoExpandCategories=(Blackboard), MinimalAPI)
class UBlackboardKeyType : public UObject
{
    GENERATED_UCLASS_BODY()
 
    
    AIMODULE_API virtual void PreInitialize(UBlackboardComponent& OwnerComp);
 
    AIMODULE_API void InitializeKey(UBlackboardComponent& OwnerComp, FBlackboard::FKey KeyID);
 
    AIMODULE_API virtual bool IsAllowedByFilter(UBlackboardKeyType* FilterOb) const;
 
    AIMODULE_API bool WrappedGetLocation(const UBlackboardComponent& OwnerComp, const uint8* MemoryBlock, FVector& Location) const;
 
    AIMODULE_API bool WrappedGetRotation(const UBlackboardComponent& OwnerComp, const uint8* MemoryBlock, FRotator& Rotation) const;
 
    AIMODULE_API void WrappedFree(UBlackboardComponent& OwnerComp, uint8* MemoryBlock);
 
    AIMODULE_API void WrappedClear(const UBlackboardComponent& OwnerComp, uint8* MemoryBlock) const;
 
    AIMODULE_API bool WrappedIsEmpty(const UBlackboardComponent& OwnerComp, const uint8* MemoryBlock) const;
 
    AIMODULE_API bool WrappedTestBasicOperation(const UBlackboardComponent& OwnerComp, const uint8* MemoryBlock, EBasicKeyOperation::Type Op) const;
    AIMODULE_API bool WrappedTestArithmeticOperation(const UBlackboardComponent& OwnerComp, const uint8* MemoryBlock, EArithmeticKeyOperation::Type Op, int32 OtherIntValue, float OtherFloatValue) const;
    AIMODULE_API bool WrappedTestTextOperation(const UBlackboardComponent& OwnerComp, const uint8* MemoryBlock, ETextKeyOperation::Type Op, const FString& OtherString) const;
 
    AIMODULE_API virtual FString DescribeArithmeticParam(int32 IntValue, float FloatValue) const;
 
    AIMODULE_API FString WrappedDescribeValue(const UBlackboardComponent& OwnerComp, const uint8* MemoryBlock) const;
 
    AIMODULE_API virtual FString DescribeSelf() const;
 
    AIMODULE_API virtual UBlackboardKeyType* UpdateDeprecatedKey();
 
    AIMODULE_API const UBlackboardKeyType* GetKeyInstance(const UBlackboardComponent& OwnerComp, const uint8* MemoryBlock) const;
    AIMODULE_API UBlackboardKeyType* GetKeyInstance(UBlackboardComponent& OwnerComp, const uint8* MemoryBlock) const;
 
    AIMODULE_API virtual EBlackboardCompare::Type CompareValues(const UBlackboardComponent& OwnerComp, const uint8* MemoryBlock,
        const UBlackboardKeyType* OtherKeyOb, const uint8* OtherMemoryBlock) const;
 
    bool HasInstance() const;
 
    bool IsInstanced() const;
 
    uint16 GetValueSize() const;
 
    EBlackboardKeyOperation::Type GetTestOperation() const;
 
protected:
 
    uint16 ValueSize;
 
    TEnumAsByte<EBlackboardKeyOperation::Type> SupportedOp;
 
    uint8 bIsInstanced : 1;
 
    uint8 bCreateKeyInstance : 1;
 
    template<typename T>
    static T GetValueFromMemory(const uint8* MemoryBlock)
    {
        return *((T*)MemoryBlock);
    }
 
    template<typename T>
    static bool SetValueInMemory(uint8* MemoryBlock, const T& Value)
    {
        const bool bChanged = *((T*)MemoryBlock) != Value;
        *((T*)MemoryBlock) = Value;
        
        return bChanged;
    }
 
    template<typename T>
    static bool SetWeakObjectInMemory(uint8* MemoryBlock, const TWeakObjectPtr<T>& Value)
    {
        TWeakObjectPtr<T>* PrevValue = (TWeakObjectPtr<T>*)MemoryBlock;
        const bool bChanged =
            (Value.IsValid(false, true) != PrevValue->IsValid(false, true)) ||
            (Value.IsStale(false, true) != PrevValue->IsStale(false, true)) ||
            (*PrevValue) != Value;
 
        *((TWeakObjectPtr<T>*)MemoryBlock) = Value;
 
        return bChanged;
    }
 
    friend UBlackboardComponent;
    
    AIMODULE_API virtual void CopyValues(UBlackboardComponent& OwnerComp, uint8* MemoryBlock, const UBlackboardKeyType* SourceKeyOb, const uint8* SourceBlock);
 
    AIMODULE_API virtual void InitializeMemory(UBlackboardComponent& OwnerComp, uint8* MemoryBlock);
 
    AIMODULE_API virtual void FreeMemory(UBlackboardComponent& OwnerComp, uint8* MemoryBlock);
 
    AIMODULE_API virtual bool GetLocation(const UBlackboardComponent& OwnerComp, const uint8* MemoryBlock, FVector& Location) const;
    
    AIMODULE_API virtual bool GetRotation(const UBlackboardComponent& OwnerComp, const uint8* MemoryBlock, FRotator& Rotation) const;
 
    AIMODULE_API virtual void Clear(UBlackboardComponent& OwnerComp, uint8* MemoryBlock);
 
    AIMODULE_API virtual bool IsEmpty(const UBlackboardComponent& OwnerComp, const uint8* MemoryBlock) const;
 
    AIMODULE_API virtual bool TestBasicOperation(const UBlackboardComponent& OwnerComp, const uint8* MemoryBlock, EBasicKeyOperation::Type Op) const;
    AIMODULE_API virtual bool TestArithmeticOperation(const UBlackboardComponent& OwnerComp, const uint8* MemoryBlock, EArithmeticKeyOperation::Type Op, int32 OtherIntValue, float OtherFloatValue) const;
    AIMODULE_API virtual bool TestTextOperation(const UBlackboardComponent& OwnerComp, const uint8* MemoryBlock, ETextKeyOperation::Type Op, const FString& OtherString) const;
 
    AIMODULE_API virtual FString DescribeValue(const UBlackboardComponent& OwnerComp, const uint8* MemoryBlock) const;
};
 
// Inlines
 
inline uint16 UBlackboardKeyType::GetValueSize() const
{
    return ValueSize;
}
 
inline EBlackboardKeyOperation::Type UBlackboardKeyType::GetTestOperation() const
{
    return SupportedOp; 
}
 
inline bool UBlackboardKeyType::HasInstance() const
{
    return bCreateKeyInstance;
}
 
inline bool UBlackboardKeyType::IsInstanced() const
{
    return bIsInstanced;
}