1. Epic GamesDeveloper
  3. UBlackboardComponent

UBlackboardComponent

API > API/Runtime > API/Runtime/AIModule > API/Runtime/AIModule/BehaviorTree

Inheritance Hierarchy

References

   
Module AIModule
Header /Engine/Source/Runtime/AIModule/Classes/BehaviorTree/BlackboardComponent.h
Include #include "BehaviorTree/BlackboardComponent.h"

Syntax

class UBlackboardComponent : public UActorComponent

Variables

  Type Name Description
Protected variable TObjectPtr< UBlackboardData > BlackboardAsset Internal use, current BB asset being used. Will be made private in the future
Protected variable uint32: 1 bPausedNotifies Set when observation notifies are paused and shouldn't be passed to observers
Protected variable TObjectPtr< UBrainComponent > BrainComp Cached behavior tree component
Protected variable uint32: 1 bSynchronizedKeyPopulated Reset to false every time a new BB asset is assigned to this component
Protected variable TObjectPtr< UBlackboardData > DefaultBlackboardAsset Data asset defining entries.
Protected variable TArray< TObjectPtr< UBlackboardKeyType > > KeyInstances Instanced keys with custom data allocations
Protected variable int32 NotifyObserversRecursionCount Count of re-entrant observer notifications
Protected variable TMultiMap< const UObject *, FDelegateHandle > ObserverHandles Observers registered from owner objects
Protected variable TMultiMap< FBlackboard::FKey, FOnBlackboardChangeNotificationInfo > Observers Observers registered for blackboard keys
Protected variable int32 ObserversToRemoveCount Count of observers to remove
Protected variable TArray< FBlackboard::FKey > QueuedUpdates Queued key change notification, will be processed on ResumeUpdates call
Public variable   Tooltip  
Protected variable friend UBlackboardKeyType  
Protected variable TArray< uint8 > ValueMemory Memory block holding all values
Protected variable TArray< uint16 > ValueOffsets Offsets in ValueMemory for each key

Constructors

  Type Name Description
Public function  

UBlackboardComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void

CacheBrainComponent ( UBrainComponent& BrainComponent
)

 Caches UBrainComponent pointer to be used in communication
Public function void  
Public function void

ClearValue ( const FName& KeyName
)

  
Public function Const EBlackboardCompare::Type Compares blackboard's values under specified keys
Public function bool

CopyKeyValue ( FBlackboard::FKey SourceKeyID,
FBlackboard::FKey DestinationID
)

 Copy content from SourceKeyID to DestinationID and return true if it worked
Public function Const FString Get description of value under given key
Public function Const FString Get description of value under given key
Public function Virtual Const void Prepare blackboard snapshot for logs
Protected function void Destroy allocated values
Public function Const UBlackboardData *  
Public function Const UBrainComponent *  
Public function Const FString  
Public function Const FBlackboard::FKey

GetKeyID ( const FName& KeyName
)

  
Public function Const FName END UActorComponent overrides
Public function Const const uint8 *  
Public function Const const uint8 *

GetKeyRawData ( const FName& KeyName
)

  
Public function uint8 *  
Public function uint8 *

GetKeyRawData ( const FName& KeyName
)

 Get pointer to raw data for given key
Public function Const TSubclassOf< UBlackboardKeyType >  
Public function Const bool

GetLocationFromEntry ( const FName& KeyName,
FVector& ResultLocation
)

 Return false if call failed (most probably no such entry in BB)
Public function Const bool

GetLocationFromEntry ( FBlackboard::FKey KeyID,
FVector& ResultLocation
)

 Return false if call failed (most probably no such entry in BB)
Public function Const int32  
Public function Const bool

GetRotationFromEntry ( const FName& KeyName,
FRotator& ResultRotation
)

 Return false if call failed (most probably no such entry in BB)
Public function Const bool

GetRotationFromEntry ( FBlackboard::FKey KeyID,
FRotator& ResultRotation
)

 Return false if call failed (most probably no such entry in BB)
Public function Const TDataClass::FDataType  
Public function Const TDataClass::FDataType

GetValue ( const FName& KeyName
)

  
Public function Const bool

GetValueAsBool ( const FName& KeyName
)

  
Public function Const UClass *

GetValueAsClass ( const FName& KeyName
)

  
Public function Const uint8

GetValueAsEnum ( const FName& KeyName
)

  
Public function Const float

GetValueAsFloat ( const FName& KeyName
)

  
Public function Const int32

GetValueAsInt ( const FName& KeyName
)

  
Public function Const FName

GetValueAsName ( const FName& KeyName
)

  
Public function Const UObject *

GetValueAsObject ( const FName& KeyName
)

  
Public function Const FRotator

GetValueAsRotator ( const FName& KeyName
)

  
Public function Const FString

GetValueAsString ( const FName& KeyName
)

  
Public function Const FVector

GetValueAsVector ( const FName& KeyName
)

  
Public function Const bool  
Public function bool Setup component for using given blackboard asset, returns true if blackboard is properly initialized for specified blackboard data
Protected function void Initializes parent chain in asset
Public function Virtual Const bool

IsCompatibleWith ( const UBlackboardData* TestAsset
)

  
Public function Const bool  
Public function Const bool  
Public function Const PRAGMA_DISABLE_DEPRECATION_WARNINGSbool  
Public function Const bool  
Protected function Const void Notifies behavior tree decorators about change in blackboard
Public function void Pause observer change notifications, any new ones will be added to a queue
Protected function void Populates BB's synchronized entries
Public function FDelegateHandle

RegisterObserver ( FBlackboard::FKey KeyID,
const UObject* NotifyOwner,
FOnBlackboardChangeNotification ObserverDelegate
)

 Register observer for blackboard key
Public function void

ResumeObserverNotifications ( bool bSendQueuedObserverNotifications
)

 Resume observer change notifications and, optionally, process the queued observation list
Public function bool

SetValue ( FBlackboard::FKey KeyID,
typename TDataClass::FDataType Value
)

  
Public function bool

SetValue ( const FName& KeyName,
typename TDataClass::FDataType Value
)

  
Public function void

SetValueAsBool ( const FName& KeyName,
bool BoolValue
)

  
Public function void

SetValueAsClass ( const FName& KeyName,
UClass* ClassValue
)

  
Public function void

SetValueAsEnum ( const FName& KeyName,
uint8 EnumValue
)

  
Public function void

SetValueAsFloat ( const FName& KeyName,
float FloatValue
)

  
Public function void

SetValueAsInt ( const FName& KeyName,
int32 IntValue
)

  
Public function void

SetValueAsName ( const FName& KeyName,
FName NameValue
)

  
Public function void

SetValueAsObject ( const FName& KeyName,
UObject* ObjectValue
)

  
Public function void

SetValueAsRotator ( const FName& KeyName,
FRotator VectorValue
)

  
Public function void

SetValueAsString ( const FName& KeyName,
FString StringValue
)

  
Public function void

SetValueAsVector ( const FName& KeyName,
FVector VectorValue
)

  
Protected function Const bool

ShouldSyncWithBlackboard ( UBlackboardComponent& OtherBlackboardComponent
)

  
Public function void Unregister observer from blackboard key
Public function void

UnregisterObserversFrom ( const UObject* NotifyOwner
)

 Unregister all observers associated with given owner

Overridden from UActorComponent

  Type Name Description
Public function Virtual void BEGIN UActorComponent overrides
Public function Virtual void Handle this component being Uninitialized.

Classes

  Type Name Description
Protected struct FOnBlackboardChangeNotificationInfo    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page