UBlackboardData

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

AIModule

Header

/Engine/Source/Runtime/AIModule/Classes/BehaviorTree/BlackboardData.h

Include

#include "BehaviorTree/BlackboardData.h"

Syntax

class UBlackboardData : public UDataAsset

Variables

Name Description

Protected variable

FBlackboard::FK...

 

FirstKeyID

Public variable

TArray< FBlackb...

 

Keys

Blackboard keys

Public variable

TObjectPtr< UBl...

 

Parent

Parent blackboard (keys can be overridden)

Public variable

TArray< FBlackb...

 

ParentKeys

All keys inherited from parent chain

Constructors

Name Description

Public function

UBlackboardData

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Const

FBlackboard:...

 

GetFirstKeyID()

Public function Const

const FBlack...

 

GetKey

(
    FBlackboard::FKey KeyID
)

Public function Const

FBlackboard:...

 

GetKeyID

(
    const FName& KeyName
)

Public function Const

FName

 

GetKeyName

(
    FBlackboard::FKey KeyID
)

Public function Const

const TArray...

 

GetKeys()

Public function Const

TSubclassOf<...

 

GetKeyType

(
    FBlackboard::FKey KeyID
)

Public function Const

int32

 

GetNumKeys()

Public function Const

bool

 

HasSynchronizedKeys()

Protected function Const

FBlackboard:...

 

InternalGetKeyID

(
    const FName& KeyName,
    EKeyLookupMode LookupMode
)

Public function Const

bool

 

IsChildOf

(
    const UBlackboardData& OtherAsset
)

Returns true if OtherAsset is somewhere up the parent chain of this asset.

Public function Const

bool

 

IsKeyInstanceSynced

(
    FBlackboard::FKey KeyID
)

Public function Const

bool

 

IsRelatedTo

(
    const UBlackboardData& OtherAsset
)

Returns true if OtherAsset is equal to *this, or is it's parent, or *this is OtherAsset's parent

Public function Const

bool

 

IsValid()

Public function

void

 

PropagateKeyChangesToDerivedBlackboardAssets()

Public function

void

 

UpdateDeprecatedKeys()

Fix entries with deprecated key types

Public function

void

 

UpdateIfHasSynchronizedKeys()

Public function

void

 

UpdateKeyIDs()

Forces update of FirstKeyID, which depends on parent chain

Public function

void

 

UpdateParentKeys()

Updates parent key cache for editor

Public function

T *

 

UpdatePersistentKey

(
    const FName& KeyName
)

Updates persistent key with given name, depending on currently defined entries and parent chain

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PostInitProperties()

Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Enums

Name

Description

Protected enum

EKeyLookupMode

Typedefs

Name

Description

FBlackboardDataChanged

A delegate called on PostEditChangeProperty. Can be used in editor to react to asset changes.

FKeyUpdate

Constants

Name

Description

OnBlackboardDataChanged

OnUpdateKeys

Delegate called for every loaded blackboard asset meant for adding game specific persistent keys

Deprecated Functions

Name Description

Protected function Const

bool

 

HasParent

(
    const UBlackboardData* TestPar...
)

This function is deprecated, please use IsChildOf instead.