RealDocs

50 results for "blackboard"

class
UBlackboardComponent AIModule

A component that stores key-value pairs for AI decision-making.

function
UBlackboardComponent::CacheBrainComponent AIModule

Stores a pointer to the given brain component so it can be retrieved later via GetBrainComponent, used for communication back to the tree that owns this blackboard.

function
UBlackboardComponent::ClearValue AIModule

Resets the value stored under the given blackboard key to its type's default/unset state, notifying any registered observers if the value changed.

function
UBlackboardComponent::CompareKeyValues AIModule

Compares the values stored under two keys using KeyType's comparison logic, returning Less, Equal, or Greater.

function
UBlackboardComponent::CopyKeyValue AIModule

Copies the raw value stored under SourceKeyID into DestinationID and returns true if the copy succeeded.

function
UBlackboardComponent::DescribeKeyValue AIModule

Returns a human-readable description of the value stored under KeyName, formatted according to Mode.

function
UBlackboardComponent::DescribeSelfToVisLog AIModule

Appends the blackboard's current key/value state to a Visual Logger snapshot, so it shows up in the Visual Logger tool alongside other AI debug data.

function
UBlackboardComponent::GetBlackboardAsset AIModule

Returns the blackboard data asset currently in use by this component, defining its available keys and their types.

function
UBlackboardComponent::GetBrainComponent AIModule

Returns the behavior tree (or other brain) component associated with this blackboard, as previously set via CacheBrainComponent.

function
UBlackboardComponent::GetDebugInfoString AIModule

Builds a multi-line debug string describing every key and its current value, formatted according to Mode.

function
UBlackboardComponent::GetKeyID AIModule

Converts a blackboard key name into its numeric FKey ID, which is the form used by the fast RegisterObserver, GetValue, and SetValue overloads.

function
UBlackboardComponent::GetKeyName AIModule

Returns the name of the blackboard key with the given ID, as defined on the blackboard data asset.

function
UBlackboardComponent::GetKeyRawData AIModule

Returns a raw pointer to the key's value bytes inside the blackboard's internal value buffer, for direct low-level access.

function
UBlackboardComponent::GetKeyType AIModule

Returns the UBlackboardKeyType subclass (Bool, Int, Float, Object, Vector, and so on) used to store the value under the given key.

function
UBlackboardComponent::GetLocationFromEntry AIModule

Resolves a world location from the given blackboard key, whether it's a Vector key or an Object/Actor key, and writes it to ResultLocation.

function
UBlackboardComponent::GetNumKeys AIModule

Returns the number of key entries defined on the blackboard's data asset, including keys inherited from parent blackboard assets.

function
UBlackboardComponent::GetRotationFromEntry AIModule

Resolves a rotation from the given blackboard key, whether it's a Rotator key or an Object/Actor key, and writes it to ResultRotation.

function
UBlackboardComponent::GetValue AIModule

Reads the value stored under the given key, decoded as the type described by the TDataClass template argument.

function
UBlackboardComponent::GetValueAsBool AIModule

Returns the boolean value stored under the given blackboard key.

function
UBlackboardComponent::GetValueAsClass AIModule

Returns the UClass value stored under the given blackboard key.

function
UBlackboardComponent::GetValueAsEnum AIModule

Returns the raw enum value stored under the given blackboard key as a uint8.

function
UBlackboardComponent::GetValueAsFloat AIModule

Returns the float value stored under the given blackboard key.

function
UBlackboardComponent::GetValueAsInt AIModule

Returns the integer value stored under the given blackboard key.

function
UBlackboardComponent::GetValueAsName AIModule

Returns the FName value stored under the given blackboard key.

function
UBlackboardComponent::GetValueAsObject AIModule

Returns the UObject stored under the given blackboard key, or null if the key doesn't exist or holds no value.

function
UBlackboardComponent::GetValueAsRotator AIModule

Returns the FRotator value stored under the given blackboard key.

function
UBlackboardComponent::GetValueAsString AIModule

Returns the string value stored under the given blackboard key.

function
UBlackboardComponent::GetValueAsVector AIModule

Returns the FVector stored under the given blackboard key.

function
UBlackboardComponent::HasValidAsset AIModule

Returns true if the component currently has a valid, initialized blackboard data asset assigned.

function
UBlackboardComponent::InitializeBlackboard AIModule

Sets up the component to use the given blackboard data asset, allocating value storage for its keys.

function
UBlackboardComponent::InitializeComponent AIModule

Overrides UActorComponent::InitializeComponent to set up the blackboard's default asset (DefaultBlackboardAsset) if one hasn't already been assigned via InitializeBlackboard.

function
UBlackboardComponent::IsCompatibleWith AIModule

Returns true if the given blackboard data asset can be used with this component, meaning it matches or derives from the currently assigned asset.

function
UBlackboardComponent::IsKeyInstanceSynced AIModule

Returns true if the key is marked as instance-synced, meaning its value is automatically mirrored across all blackboard components sharing the same asset.

function
UBlackboardComponent::IsKeyOfType AIModule

Returns true if the named key's underlying value type matches the given UBlackboardKeyType subclass, specified as the template argument.

function
UBlackboardComponent::IsValidKey AIModule

Checks whether KeyID refers to a valid entry in the component's blackboard asset.

function
UBlackboardComponent::IsVectorValueSet AIModule

Returns true if the vector value under the given key has actually been set (rather than left at its default invalid state).

function
UBlackboardComponent::PauseObserverNotifications AIModule

Suspends dispatch of blackboard change notifications; any key changes made while paused are queued rather than immediately broadcast to observers.

function
UBlackboardComponent::RegisterObserver AIModule

Registers a delegate that fires whenever the value under the given key changes, the mechanism behind behavior tree decorator observer aborts.

function
UBlackboardComponent::ResumeObserverNotifications AIModule

Resumes dispatch of blackboard change notifications after a matching call to PauseObserverNotifications, optionally flushing any queued changes.

function
UBlackboardComponent::SetValue AIModule

Sets the value under the given key using the raw templated key-type API, notifying observers if the value actually changed.

function
UBlackboardComponent::SetValueAsBool AIModule

Sets the boolean value stored under the given blackboard key, notifying any registered observers if the value changed.

function
UBlackboardComponent::SetValueAsClass AIModule

Sets the UClass value stored under the given blackboard key, notifying any registered observers if the value changed.

function
UBlackboardComponent::SetValueAsEnum AIModule

Sets the raw enum value stored under the given blackboard key, notifying any registered observers if the value changed.

function
UBlackboardComponent::SetValueAsFloat AIModule

Writes a float value to a blackboard key, which can then be read by behavior tree tasks and decorators.

function
UBlackboardComponent::SetValueAsInt AIModule

Sets the integer value stored under the given blackboard key, notifying any registered observers if the value changed.

function
UBlackboardComponent::SetValueAsName AIModule

Sets the FName value stored under the given blackboard key, notifying any registered observers if the value changed.

function
UBlackboardComponent::SetValueAsObject AIModule

Writes a UObject reference to a blackboard key.

function
UBlackboardComponent::SetValueAsRotator AIModule

Sets the FRotator value stored under the given blackboard key, notifying any registered observers if the value changed.

function
UBlackboardComponent::SetValueAsString AIModule

Sets the string value stored under the given blackboard key, notifying any registered observers if the value changed.

function
UBlackboardComponent::SetValueAsVector AIModule

Writes an FVector to a blackboard key.