Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > AIModule > BehaviorTree > UBlackboardComponent

Light Theme

Dark Theme

UBlackboardComponent

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

UBlackboardComponent

References

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

Syntax

class UBlackboardComponent : public UActorComponent

Variables

	Name	Description
UBlackboardData...	BlackboardAsset
uint32: 1	bPausedNotifies	Set when observation notifies are paused and shouldn't be passed to observers
UBrainComponent...	BrainComp	Cached behavior tree component
uint32: 1	bSynchronizedKeyPopulated	Reset to false every time a new BB asset is assigned to this component
UBlackboardData...	DefaultBlackboardAsset	Data asset defining entries
TArray< UBlackb...	KeyInstances	Instanced keys with custom data allocations
TMultiMap< UObj...	ObserverHandles	Observers registered from owner objects
TMultiMap< uint...	Observers	Observers registered for blackboard keys
TArray< uint8 >	QueuedUpdates	Queued key change notification, will be processed on ResumeUpdates call
	Tooltip
friend	UBlackboardKeyType
TArray< uint8 >	ValueMemory	Memory block holding all values
TArray< uint16 ...	ValueOffsets	Offsets in ValueMemory for each key

Constructors

	Name	Description
	UBlackboardComponent ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	CacheBrainComponent ( UBrainComponent& BrainComponent )	Caches UBrainComponent pointer to be used in communication
void	ClearValue ( FBlackboard::FKey KeyID )
void	ClearValue ( const FName& KeyName )
EBlackboardC...	CompareKeyValues ( TSubclassOf< UBlackboardKeyType > K..., FBlackboard::FKey KeyA, FBlackboard::FKey KeyB )	Compares blackboard's values under specified keys
bool	CopyKeyValue ( FBlackboard::FKey SourceKeyID, FBlackboard::FKey DestinationID )	Copy content from SourceKeyID to DestinationID and return true if it worked
FString	DescribeKeyValue ( FBlackboard::FKey KeyID, EBlackboardDescription::Type Mode )	Get description of value under given key
FString	DescribeKeyValue ( const FName& KeyName, EBlackboardDescription::Type Mode )	Get description of value under given key
void	DescribeSelfToVisLog ( FVisualLogEntry* Snapshot )	Prepare blackboard snapshot for logs
void	DestroyValues()	Destroy allocated values
UBlackboardD...	GetBlackboardAsset()
UBrainCompon...	GetBrainComponent()
FString	GetDebugInfoString ( EBlackboardDescription::Type Mode )
FBlackboard:...	GetKeyID ( const FName& KeyName )
FName	GetKeyName ( FBlackboard::FKey KeyID )	END UActorComponent overrides
const uint8 ...	GetKeyRawData ( FBlackboard::FKey KeyID )
const uint8 ...	GetKeyRawData ( const FName& KeyName )
uint8 *	GetKeyRawData ( FBlackboard::FKey KeyID )
uint8 *	GetKeyRawData ( const FName& KeyName )	Get pointer to raw data for given key
TSubclassOf<...	GetKeyType ( FBlackboard::FKey KeyID )
bool	GetLocationFromEntry ( FBlackboard::FKey KeyID, FVector& ResultLocation )	Return false if call failed (most probably no such entry in BB)
bool	GetLocationFromEntry ( const FName& KeyName, FVector& ResultLocation )	Return false if call failed (most probably no such entry in BB)
int32	GetNumKeys()
bool	GetRotationFromEntry ( const FName& KeyName, FRotator& ResultRotation )	Return false if call failed (most probably no such entry in BB)
bool	GetRotationFromEntry ( FBlackboard::FKey KeyID, FRotator& ResultRotation )	Return false if call failed (most probably no such entry in BB)
TDataClass::...	GetValue ( const FName& KeyName )
TDataClass::...	GetValue ( FBlackboard::FKey KeyID )
bool	GetValueAsBool ( const FName& KeyName )
UClass *	GetValueAsClass ( const FName& KeyName )
uint8	GetValueAsEnum ( const FName& KeyName )
float	GetValueAsFloat ( const FName& KeyName )
int32	GetValueAsInt ( const FName& KeyName )
FName	GetValueAsName ( const FName& KeyName )
UObject *...	GetValueAsObject ( const FName& KeyName )
FRotator	GetValueAsRotator ( const FName& KeyName )
FString	GetValueAsString ( const FName& KeyName )
FVector	GetValueAsVector ( const FName& KeyName )
bool	HasValidAsset()
bool	InitializeBlackboard ( UBlackboardData& NewAsset )	Setup component for using given blackboard asset, returns true if blackboard is properly initialized for specified blackboard data
void	InitializeParentChain ( UBlackboardData* NewAsset )	Initializes parent chain in asset
bool	IsCompatibleWith ( UBlackboardData* TestAsset )
bool	IsKeyInstanceSynced ( FBlackboard::FKey KeyID )
bool	IsKeyOfType ( FBlackboard::FKey KeyID )
bool	IsValidKey ( FBlackboard::FKey KeyID )
bool	IsVectorValueSet ( FBlackboard::FKey KeyID )
void	NotifyObservers ( FBlackboard::FKey KeyID )	Notifies behavior tree decorators about change in blackboard
void	PauseObserverNotifications()	Pause observer change notifications, any new ones will be added to a queue
void	PopulateSynchronizedKeys()	Populates BB's synchronized entries
FDelegateHan...	RegisterObserver ( FBlackboard::FKey KeyID, UObject* NotifyOwner, FOnBlackboardChangeNotification Obs... )	Register observer for blackboard key
void	ResumeObserverNotifications ( bool bSendQueuedObserverNotificatio... )	Resume observer change notifications and, optionally, process the queued observation list
bool	SetValue ( FBlackboard::FKey KeyID, typename TDataClass::FDataType Valu... )
bool	SetValue ( const FName& KeyName, typename TDataClass::FDataType Valu... )
void	SetValueAsBool ( const FName& KeyName, bool BoolValue )
void	SetValueAsClass ( const FName& KeyName, UClass* ClassValue )
void	SetValueAsEnum ( const FName& KeyName, uint8 EnumValue )
void	SetValueAsFloat ( const FName& KeyName, float FloatValue )
void	SetValueAsInt ( const FName& KeyName, int32 IntValue )
void	SetValueAsName ( const FName& KeyName, FName NameValue )
void	SetValueAsObject ( const FName& KeyName, UObject* ObjectValue )
void	SetValueAsRotator ( const FName& KeyName, FRotator VectorValue )
void	SetValueAsString ( const FName& KeyName, FString StringValue )
void	SetValueAsVector ( const FName& KeyName, FVector VectorValue )
bool	ShouldSyncWithBlackboard ( UBlackboardComponent& OtherBlackbo... )
void	UnregisterObserver ( FBlackboard::FKey KeyID, FDelegateHandle ObserverHandle )	Unregister observer from blackboard key
void	UnregisterObserversFrom ( UObject* NotifyOwner )	Unregister all observers associated with given owner

Overridden from UActorComponent

		Name	Description
	void	InitializeComponent()	BEGIN UActorComponent overrides
	void	UninitializeComponent()	Handle this component being Uninitialized.

Deprecated Functions

		Name	Description
	void	PauseUpdates()	Please call PauseObserverUpdates.
	void	ResumeUpdates()	Please call ResumeObserverNotifications.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss