1. Epic GamesDeveloper
  3. UBlackboardKeyType

UBlackboardKeyType

API > API/Runtime > API/Runtime/AIModule

   
Name UBlackboardKeyType
Type class
Header File /Engine/Source/Runtime/AIModule/Classes/BehaviorTree/Blackboard/BlackboardKeyType.h
Include Path #include "BehaviorTree/Blackboard/BlackboardKeyType.h"

Syntax

UCLASS (EditInlineNew, Abstract, CollapseCategories, AutoExpandCategories=(Blackboard), MinimalAPI)  
class UBlackboardKeyType : public UObject

Inheritance Hierarchy

Derived Classes

UBlackboardKeyType derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UBlackboardKeyType ( const FObjectInitializer& ObjectInitializer
)

   BehaviorTree/Blackboard/BlackboardKeyType.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual EBlackboardCompare::Type CompareValues ( const UBlackboardComponent& OwnerComp,
const uint8* MemoryBlock,
const UBlackboardKeyType* OtherKeyOb,
const uint8* OtherMemoryBlock
) const

 Compares two values BehaviorTree/Blackboard/BlackboardKeyType.h  

virtual FString DescribeArithmeticParam ( int32 IntValue,
float FloatValue
) const

 Describe params of arithmetic test BehaviorTree/Blackboard/BlackboardKeyType.h  

virtual FString DescribeSelf()

 Description of params for property view BehaviorTree/Blackboard/BlackboardKeyType.h  

const UBlackboardKeyType * GetKeyInstance ( const UBlackboardComponent& OwnerComp,
const uint8* MemoryBlock
) const

   BehaviorTree/Blackboard/BlackboardKeyType.h  

UBlackboardKeyType * GetKeyInstance ( UBlackboardComponent& OwnerComp,
const uint8* MemoryBlock
) const

   BehaviorTree/Blackboard/BlackboardKeyType.h  

EBlackboardKeyOperation::Type GetTestOperation()

 Get test supported by this type BehaviorTree/Blackboard/BlackboardKeyType.h  

uint16 GetValueSize()

 Get ValueSize BehaviorTree/Blackboard/BlackboardKeyType.h  

bool HasInstance()

   BehaviorTree/Blackboard/BlackboardKeyType.h  

void InitializeKey ( UBlackboardComponent& OwnerComp,
FBlackboard::FKey KeyID
)

 Handle instancing if needed BehaviorTree/Blackboard/BlackboardKeyType.h  

virtual bool IsAllowedByFilter ( UBlackboardKeyType* FilterOb
) const

 Does it match settings in filter? BehaviorTree/Blackboard/BlackboardKeyType.h  

bool IsInstanced()

   BehaviorTree/Blackboard/BlackboardKeyType.h  

virtual void PreInitialize ( UBlackboardComponent& OwnerComp
)

 Handle dynamic data size BehaviorTree/Blackboard/BlackboardKeyType.h  

virtual UBlackboardKeyType * UpdateDeprecatedKey()

 Create replacement key for deprecated data BehaviorTree/Blackboard/BlackboardKeyType.h  

void WrappedClear ( const UBlackboardComponent& OwnerComp,
uint8* MemoryBlock
) const

 Sets value to the default, supports instanced keys BehaviorTree/Blackboard/BlackboardKeyType.h  

FString WrappedDescribeValue ( const UBlackboardComponent& OwnerComp,
const uint8* MemoryBlock
) const

 Convert value to text, supports instanced keys BehaviorTree/Blackboard/BlackboardKeyType.h  

void WrappedFree ( UBlackboardComponent& OwnerComp,
uint8* MemoryBlock
)

 Free value before removing from blackboard, supports instanced keys BehaviorTree/Blackboard/BlackboardKeyType.h  

bool WrappedGetLocation ( const UBlackboardComponent& OwnerComp,
const uint8* MemoryBlock,
FVector& Location
) const

 Extract location from entry, supports instanced keys BehaviorTree/Blackboard/BlackboardKeyType.h  

bool WrappedGetRotation ( const UBlackboardComponent& OwnerComp,
const uint8* MemoryBlock,
FRotator& Rotation
) const

 Extract rotation from entry, supports instanced keys BehaviorTree/Blackboard/BlackboardKeyType.h  

bool WrappedIsEmpty ( const UBlackboardComponent& OwnerComp,
const uint8* MemoryBlock
) const

 Check if key has stored value, supports instanced keys BehaviorTree/Blackboard/BlackboardKeyType.h  

bool WrappedTestArithmeticOperation ( const UBlackboardComponent& OwnerComp,
const uint8* MemoryBlock,
EArithmeticKeyOperation::Type Op,
int32 OtherIntValue,
float OtherFloatValue
) const

   BehaviorTree/Blackboard/BlackboardKeyType.h  

bool WrappedTestBasicOperation ( const UBlackboardComponent& OwnerComp,
const uint8* MemoryBlock,
EBasicKeyOperation::Type Op
) const

 Various value testing, used by decorators, supports instanced keys BehaviorTree/Blackboard/BlackboardKeyType.h  

bool WrappedTestTextOperation ( const UBlackboardComponent& OwnerComp,
const uint8* MemoryBlock,
ETextKeyOperation::Type Op,
const FString& OtherString
) const

   BehaviorTree/Blackboard/BlackboardKeyType.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void Clear ( UBlackboardComponent& OwnerComp,
uint8* MemoryBlock
)

 Sets value to the default, works directly on provided memory/properties BehaviorTree/Blackboard/BlackboardKeyType.h  

virtual void CopyValues ( UBlackboardComponent& OwnerComp,
uint8* MemoryBlock,
const UBlackboardKeyType* SourceKeyOb,
const uint8* SourceBlock
)

 Copy value from other key, works directly on provided memory/properties BehaviorTree/Blackboard/BlackboardKeyType.h  

virtual FString DescribeValue ( const UBlackboardComponent& OwnerComp,
const uint8* MemoryBlock
) const

 Convert value to text, works directly on provided memory/properties BehaviorTree/Blackboard/BlackboardKeyType.h  

virtual void FreeMemory ( UBlackboardComponent& OwnerComp,
uint8* MemoryBlock
)

 Free value before removing from blackboard, works directly on provided memory/properties BehaviorTree/Blackboard/BlackboardKeyType.h  

virtual bool GetLocation ( const UBlackboardComponent& OwnerComp,
const uint8* MemoryBlock,
FVector& Location
) const

 Extract location from entry, works directly on provided memory/properties BehaviorTree/Blackboard/BlackboardKeyType.h  

virtual bool GetRotation ( const UBlackboardComponent& OwnerComp,
const uint8* MemoryBlock,
FRotator& Rotation
) const

 Extract rotation from entry, works directly on provided memory/properties BehaviorTree/Blackboard/BlackboardKeyType.h  

virtual void InitializeMemory ( UBlackboardComponent& OwnerComp,
uint8* MemoryBlock
)

 Initialize memory, works directly on provided memory/properties BehaviorTree/Blackboard/BlackboardKeyType.h  

virtual bool IsEmpty ( const UBlackboardComponent& OwnerComp,
const uint8* MemoryBlock
) const

 Check if key has stored value, works directly on provided memory/properties BehaviorTree/Blackboard/BlackboardKeyType.h  

virtual bool TestArithmeticOperation ( const UBlackboardComponent& OwnerComp,
const uint8* MemoryBlock,
EArithmeticKeyOperation::Type Op,
int32 OtherIntValue,
float OtherFloatValue
) const

   BehaviorTree/Blackboard/BlackboardKeyType.h  

virtual bool TestBasicOperation ( const UBlackboardComponent& OwnerComp,
const uint8* MemoryBlock,
EBasicKeyOperation::Type Op
) const

 Various value testing, works directly on provided memory/properties BehaviorTree/Blackboard/BlackboardKeyType.h  

virtual bool TestTextOperation ( const UBlackboardComponent& OwnerComp,
const uint8* MemoryBlock,
ETextKeyOperation::Type Op,
const FString& OtherString
) const

   BehaviorTree/Blackboard/BlackboardKeyType.h  

Static

Name Remarks Include Path Unreal Specifiers

static T GetValueFromMemory ( const uint8* MemoryBlock
)

 Helper function for reading typed data from memory block BehaviorTree/Blackboard/BlackboardKeyType.h  

static bool SetValueInMemory ( uint8* MemoryBlock,
const T& Value
)

 Helper function for writing typed data to memory block, returns true if value has changed BehaviorTree/Blackboard/BlackboardKeyType.h  

static bool SetWeakObjectInMemory ( uint8* MemoryBlock,
const TWeakObjectPtr< T >& Value
)

 Helper function for witting weak object data to memory block, returns true if value has changed BehaviorTree/Blackboard/BlackboardKeyType.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page