UBlackboardKeyType

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

AIModule

Header

/Engine/Source/Runtime/AIModule/Classes/BehaviorTree/Blackboard/BlackboardKeyType.h

Include

#include "BehaviorTree/Blackboard/BlackboardKeyType.h"

Syntax

class UBlackboardKeyType : public UObject

Variables

Name Description

Protected variable

uint8: 1

 

bCreateKeyInstance

If set, key will be instanced instead of using memory block

Protected variable

uint8: 1

 

bIsInstanced

Set automatically for node instances

Protected variable

TEnumAsByte< EB...

 

SupportedOp

Decorator operation supported with this type

Protected variable

friend

 

UBlackboardComponent

Protected variable

uint16

 

ValueSize

Size of value for this type

Constructors

Name Description

Public function

UBlackboardKeyType

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Protected function Virtual

void

 

Clear

(
    UBlackboardComponent& OwnerComp,
    uint8* MemoryBlock
)

Sets value to the default, works directly on provided memory/properties

Public function Virtual Const

EBlackboardC...

 

CompareValues

(
    const UBlackboardComponent& OwnerC...,
    const uint8* MemoryBlock,
    const UBlackboardKeyType* Othe...,
    const uint8* OtherMemoryBlock
)

Compares two values

Protected function Virtual

void

 

CopyValues

(
    UBlackboardComponent& OwnerComp,
    uint8* MemoryBlock,
    const UBlackboardKeyType* Sour...,
    const uint8* SourceBlock
)

Copy value from other key, works directly on provided memory/properties

Public function Virtual Const

FString

 

DescribeArithmeticParam

(
    int32 IntValue,
    float FloatValue
)

Describe params of arithmetic test

Public function Virtual Const

FString

 

DescribeSelf()

Description of params for property view

Protected function Virtual Const

FString

 

DescribeValue

(
    const UBlackboardComponent& OwnerC...,
    const uint8* MemoryBlock
)

Convert value to text, works directly on provided memory/properties

Protected function Virtual

void

 

FreeMemory

(
    UBlackboardComponent& OwnerComp,
    uint8* MemoryBlock
)

Free value before removing from blackboard, works directly on provided memory/properties

Public function Const

const UBlack...

 

GetKeyInstance

(
    const UBlackboardComponent& OwnerC...,
    const uint8* MemoryBlock
)

Public function Const

UBlackboardK...

 

GetKeyInstance

(
    UBlackboardComponent& OwnerComp,
    const uint8* MemoryBlock
)

Protected function Virtual Const

bool

 

GetLocation

(
    const UBlackboardComponent& OwnerC...,
    const uint8* MemoryBlock,
    FVector& Location
)

Extract location from entry, works directly on provided memory/properties

Protected function Virtual Const

bool

 

GetRotation

(
    const UBlackboardComponent& OwnerC...,
    const uint8* MemoryBlock,
    FRotator& Rotation
)

Extract rotation from entry, works directly on provided memory/properties

Public function Const

EBlackboardK...

 

GetTestOperation()

Get test supported by this type

Protected function Static

T

 

GetValueFromMemory

(
    const uint8* MemoryBlock
)

Helper function for reading typed data from memory block

Public function Const

uint16

 

GetValueSize()

Get ValueSize

Public function Const

bool

 

HasInstance()

Public function

void

 

InitializeKey

(
    UBlackboardComponent& OwnerComp,
    FBlackboard::FKey KeyID
)

Handle instancing if needed

Protected function Virtual

void

 

InitializeMemory

(
    UBlackboardComponent& OwnerComp,
    uint8* MemoryBlock
)

Initialize memory, works directly on provided memory/properties

Public function Virtual Const

bool

 

IsAllowedByFilter

(
    UBlackboardKeyType* FilterOb
)

Does it match settings in filter?

Protected function Virtual Const

bool

 

IsEmpty

(
    const UBlackboardComponent& OwnerC...,
    const uint8* MemoryBlock
)

Check if key has stored value, works directly on provided memory/properties

Public function Const

bool

 

IsInstanced()

Public function Virtual

void

 

PreInitialize

(
    UBlackboardComponent& OwnerComp
)

Handle dynamic data size

Protected function Static

bool

 

SetValueInMemory

(
    uint8* MemoryBlock,
    const T& Value
)

Helper function for writing typed data to memory block, returns true if value has changed

Protected function 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

Protected function Virtual Const

bool

 

TestArithmeticOperation

(
    const UBlackboardComponent& OwnerC...,
    const uint8* MemoryBlock,
    EArithmeticKeyOperation::Type Op,
    int32 OtherIntValue,
    float OtherFloatValue
)

Protected function Virtual Const

bool

 

TestBasicOperation

(
    const UBlackboardComponent& OwnerC...,
    const uint8* MemoryBlock,
    EBasicKeyOperation::Type Op
)

Various value testing, works directly on provided memory/properties

Protected function Virtual Const

bool

 

TestTextOperation

(
    const UBlackboardComponent& OwnerC...,
    const uint8* MemoryBlock,
    ETextKeyOperation::Type Op,
    const FString& OtherString
)

Public function Virtual

UBlackboardK...

 

UpdateDeprecatedKey()

Create replacement key for deprecated data

Public function Const

void

 

WrappedClear

(
    const UBlackboardComponent& OwnerC...,
    uint8* MemoryBlock
)

Sets value to the default, supports instanced keys

Public function Const

FString

 

WrappedDescribeValue

(
    const UBlackboardComponent& OwnerC...,
    const uint8* MemoryBlock
)

Convert value to text, supports instanced keys

Public function

void

 

WrappedFree

(
    UBlackboardComponent& OwnerComp,
    uint8* MemoryBlock
)

Free value before removing from blackboard, supports instanced keys

Public function Const

bool

 

WrappedGetLocation

(
    const UBlackboardComponent& OwnerC...,
    const uint8* MemoryBlock,
    FVector& Location
)

Extract location from entry, supports instanced keys

Public function Const

bool

 

WrappedGetRotation

(
    const UBlackboardComponent& OwnerC...,
    const uint8* MemoryBlock,
    FRotator& Rotation
)

Extract rotation from entry, supports instanced keys

Public function Const

bool

 

WrappedIsEmpty

(
    const UBlackboardComponent& OwnerC...,
    const uint8* MemoryBlock
)

Check if key has stored value, supports instanced keys

Public function Const

bool

 

WrappedTestArithmeticOperation

(
    const UBlackboardComponent& OwnerC...,
    const uint8* MemoryBlock,
    EArithmeticKeyOperation::Type Op,
    int32 OtherIntValue,
    float OtherFloatValue
)

Public function Const

bool

 

WrappedTestBasicOperation

(
    const UBlackboardComponent& OwnerC...,
    const uint8* MemoryBlock,
    EBasicKeyOperation::Type Op
)

Various value testing, used by decorators, supports instanced keys

Public function Const

bool

 

WrappedTestTextOperation

(
    const UBlackboardComponent& OwnerC...,
    const uint8* MemoryBlock,
    ETextKeyOperation::Type Op,
    const FString& OtherString
)