1. Epic GamesDeveloper
  3. UBlackboardComponent

UBlackboardComponent

API > API/Runtime > API/Runtime/AIModule

   
Name UBlackboardComponent
Type class
Header File /Engine/Source/Runtime/AIModule/Classes/BehaviorTree/BlackboardComponent.h
Include Path #include "BehaviorTree/BlackboardComponent.h"

Syntax

UCLASS (ClassGroup=AI, Meta=(BlueprintSpawnableComponent), HideCategories=(Sockets, Collision),  
       MinimalAPI)  
class UBlackboardComponent : public UActorComponent

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UBlackboardComponent ( const FObjectInitializer& ObjectInitializer
)

   BehaviorTree/BlackboardComponent.h  

Structs

Name Remarks
FOnBlackboardChangeNotificationInfo  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Tooltip     BehaviorTree/BlackboardComponent.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void CacheBrainComponent ( UBrainComponent& BrainComponent
)

 Caches UBrainComponent pointer to be used in communication BehaviorTree/BlackboardComponent.h  

void ClearValue ( FBlackboard::FKey KeyID
)

   BehaviorTree/BlackboardComponent.h
  • BlueprintCallable
  • Category="AI|Components|Blackboard"

void ClearValue ( const FName& KeyName
)

   BehaviorTree/BlackboardComponent.h
  • BlueprintCallable
  • Category="AI|Components|Blackboard"
Compares blackboard's values under specified keys BehaviorTree/BlackboardComponent.h  

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

 Copy content from SourceKeyID to DestinationID and return true if it worked BehaviorTree/BlackboardComponent.h  

FString DescribeKeyValue ( const FName& KeyName,
EBlackboardDescription::Type Mode
) const

 Get description of value under given key BehaviorTree/BlackboardComponent.h  
  BehaviorTree/BlackboardComponent.h  

virtual void DescribeSelfToVisLog ( FVisualLogEntry* Snapshot
) const

 Prepare blackboard snapshot for logs BehaviorTree/BlackboardComponent.h  

UBlackboardData * GetBlackboardAsset()

   BehaviorTree/BlackboardComponent.h  

UBrainComponent * GetBrainComponent()

   BehaviorTree/BlackboardComponent.h  

FString GetDebugInfoString ( EBlackboardDescription::Type Mode
) const

   BehaviorTree/BlackboardComponent.h  

FBlackboard::FKey GetKeyID ( const FName& KeyName
) const

   BehaviorTree/BlackboardComponent.h  

FName GetKeyName ( FBlackboard::FKey KeyID
) const

 END UActorComponent overrides BehaviorTree/BlackboardComponent.h  

const uint8 * GetKeyRawData ( FBlackboard::FKey KeyID
) const

   BehaviorTree/BlackboardComponent.h  

const uint8 * GetKeyRawData ( const FName& KeyName
) const

   BehaviorTree/BlackboardComponent.h  

uint8 * GetKeyRawData ( FBlackboard::FKey KeyID
)

   BehaviorTree/BlackboardComponent.h  

uint8 * GetKeyRawData ( const FName& KeyName
)

 Get pointer to raw data for given key BehaviorTree/BlackboardComponent.h  

TSubclassOf< UBlackboardKeyType > GetKeyType ( FBlackboard::FKey KeyID
) const

   BehaviorTree/BlackboardComponent.h  

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

   BehaviorTree/BlackboardComponent.h
  • BlueprintCallable
  • Category="AI|Components|Blackboard"

bool GetLocationFromEntry ( const FName& KeyName,
FVector& ResultLocation
) const

 Return false if call failed (most probably no such entry in BB) BehaviorTree/BlackboardComponent.h
  • BlueprintCallable
  • Category="AI|Components|Blackboard"

int32 GetNumKeys()

   BehaviorTree/BlackboardComponent.h  

bool GetRotationFromEntry ( const FName& KeyName,
FRotator& ResultRotation
) const

 Return false if call failed (most probably no such entry in BB) BehaviorTree/BlackboardComponent.h
  • BlueprintCallable
  • Category="AI|Components|Blackboard"

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

   BehaviorTree/BlackboardComponent.h
  • BlueprintCallable
  • Category="AI|Components|Blackboard"

TDataClass::FDataType GetValue ( const FName& KeyName
) const

   BehaviorTree/BlackboardComponent.h  

TDataClass::FDataType GetValue ( FBlackboard::FKey KeyID
) const

   BehaviorTree/BlackboardComponent.h  

bool GetValueAsBool ( const FName& KeyName
) const

   BehaviorTree/BlackboardComponent.h
  • BlueprintCallable
  • Category="AI|Components|Blackboard"

UClass * GetValueAsClass ( const FName& KeyName
) const

   BehaviorTree/BlackboardComponent.h
  • BlueprintCallable
  • Category="AI|Components|Blackboard"

uint8 GetValueAsEnum ( const FName& KeyName
) const

   BehaviorTree/BlackboardComponent.h
  • BlueprintCallable
  • Category="AI|Components|Blackboard"

float GetValueAsFloat ( const FName& KeyName
) const

   BehaviorTree/BlackboardComponent.h
  • BlueprintCallable
  • Category="AI|Components|Blackboard"

int32 GetValueAsInt ( const FName& KeyName
) const

   BehaviorTree/BlackboardComponent.h
  • BlueprintCallable
  • Category="AI|Components|Blackboard"

FName GetValueAsName ( const FName& KeyName
) const

   BehaviorTree/BlackboardComponent.h
  • BlueprintCallable
  • Category="AI|Components|Blackboard"

UObject * GetValueAsObject ( const FName& KeyName
) const

   BehaviorTree/BlackboardComponent.h
  • BlueprintCallable
  • Category="AI|Components|Blackboard"

FRotator GetValueAsRotator ( const FName& KeyName
) const

   BehaviorTree/BlackboardComponent.h
  • BlueprintCallable
  • Category="AI|Components|Blackboard"

FString GetValueAsString ( const FName& KeyName
) const

   BehaviorTree/BlackboardComponent.h
  • BlueprintCallable
  • Category="AI|Components|Blackboard"

FVector GetValueAsVector ( const FName& KeyName
) const

   BehaviorTree/BlackboardComponent.h
  • BlueprintCallable
  • Category="AI|Components|Blackboard"

bool HasValidAsset()

   BehaviorTree/BlackboardComponent.h  

bool InitializeBlackboard ( UBlackboardData& NewAsset
)

 Setup component for using given blackboard asset, returns true if blackboard is properly initialized for specified blackboard data BehaviorTree/BlackboardComponent.h  

virtual bool IsCompatibleWith ( const UBlackboardData* TestAsset
) const

   BehaviorTree/BlackboardComponent.h  

bool IsKeyInstanceSynced ( FBlackboard::FKey KeyID
) const

   BehaviorTree/BlackboardComponent.h  

bool IsKeyOfType ( FBlackboard::FKey KeyID
) const

   BehaviorTree/BlackboardComponent.h  

bool IsKeyOfType ( const FName& KeyName
) const

   BehaviorTree/BlackboardComponent.h  

PRAGMA_DISABLE_DEPRECATION_WARNINGS bool IsValidKey ( FBlackboard::FKey KeyID
) const

   BehaviorTree/BlackboardComponent.h  

bool IsVectorValueSet ( FBlackboard::FKey KeyID
) const

   BehaviorTree/BlackboardComponent.h
  • BlueprintCallable
  • Category="AI|Components|Blackboard"
  • Meta=(ToolTip="If the vector value has been set (and not cleared), this function returns true (indicating that the value should be valid). If it's not set, the vector value is invalid and this function will return false. (Also returns false if the key specified does not hold a vector.)")

void PauseObserverNotifications()

 Pause observer change notifications, any new ones will be added to a queue BehaviorTree/BlackboardComponent.h  

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

 Register observer for blackboard key BehaviorTree/BlackboardComponent.h  

void ResumeObserverNotifications ( bool bSendQueuedObserverNotifications
)

 Resume observer change notifications and, optionally, process the queued observation list BehaviorTree/BlackboardComponent.h  

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

   BehaviorTree/BlackboardComponent.h  

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

   BehaviorTree/BlackboardComponent.h  

void SetValueAsBool ( const FName& KeyName,
bool BoolValue
)

   BehaviorTree/BlackboardComponent.h
  • BlueprintCallable
  • Category="AI|Components|Blackboard"

void SetValueAsClass ( const FName& KeyName,
UClass* ClassValue
)

   BehaviorTree/BlackboardComponent.h
  • BlueprintCallable
  • Category="AI|Components|Blackboard"

void SetValueAsEnum ( const FName& KeyName,
uint8 EnumValue
)

   BehaviorTree/BlackboardComponent.h
  • BlueprintCallable
  • Category="AI|Components|Blackboard"

void SetValueAsFloat ( const FName& KeyName,
float FloatValue
)

   BehaviorTree/BlackboardComponent.h
  • BlueprintCallable
  • Category="AI|Components|Blackboard"

void SetValueAsInt ( const FName& KeyName,
int32 IntValue
)

   BehaviorTree/BlackboardComponent.h
  • BlueprintCallable
  • Category="AI|Components|Blackboard"

void SetValueAsName ( const FName& KeyName,
FName NameValue
)

   BehaviorTree/BlackboardComponent.h
  • BlueprintCallable
  • Category="AI|Components|Blackboard"

void SetValueAsObject ( const FName& KeyName,
UObject* ObjectValue
)

   BehaviorTree/BlackboardComponent.h
  • BlueprintCallable
  • Category="AI|Components|Blackboard"

void SetValueAsRotator ( const FName& KeyName,
FRotator VectorValue
)

   BehaviorTree/BlackboardComponent.h
  • BlueprintCallable
  • Category="AI|Components|Blackboard"

void SetValueAsString ( const FName& KeyName,
FString StringValue
)

   BehaviorTree/BlackboardComponent.h
  • BlueprintCallable
  • Category="AI|Components|Blackboard"

void SetValueAsVector ( const FName& KeyName,
FVector VectorValue
)

   BehaviorTree/BlackboardComponent.h
  • BlueprintCallable
  • Category="AI|Components|Blackboard"

void UnregisterObserver ( FBlackboard::FKey KeyID,
FDelegateHandle ObserverHandle
)

 Unregister observer from blackboard key BehaviorTree/BlackboardComponent.h  

void UnregisterObserversFrom ( const UObject* NotifyOwner
)

 Unregister all observers associated with given owner BehaviorTree/BlackboardComponent.h  

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual void InitializeComponent()

 BEGIN UActorComponent overrides BehaviorTree/BlackboardComponent.h  

virtual void UninitializeComponent()

   BehaviorTree/BlackboardComponent.h  

Protected

Name Remarks Include Path Unreal Specifiers

void DestroyValues()

 Destroy allocated values BehaviorTree/BlackboardComponent.h  

void InitializeParentChain ( UBlackboardData* NewAsset
)

 Initializes parent chain in asset BehaviorTree/BlackboardComponent.h  

void NotifyObservers ( FBlackboard::FKey KeyID
) const

 Notifies behavior tree decorators about change in blackboard BehaviorTree/BlackboardComponent.h  

void PopulateSynchronizedKeys()

 Populates BB's synchronized entries BehaviorTree/BlackboardComponent.h  

bool ShouldSyncWithBlackboard ( UBlackboardComponent& OtherBlackboardComponent
) const

   BehaviorTree/BlackboardComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page