RealDocs

UBlackboardComponent::GetDebugInfoString

function AIModule Since 4.0
#include "BehaviorTree/BlackboardComponent.h"
Access: public Specifiers: const

Description

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

Caveats & Gotchas

  • Intended for the gameplay debugger and logging — it walks every key in the blackboard asset, so it isn't cheap to call every frame.
  • Full mode additionally reports data size and any per-key debug details the key type exposes, making it noticeably slower than OnlyValue.

Signature

FString GetDebugInfoString(EBlackboardDescription::Type Mode) const

Parameters

Name Type Description Default
Mode EBlackboardDescription::Type Level of detail to include: OnlyValue, KeyWithValue, DetailedKeyWithValue, or Full.

Return Type

FString

Example

Dumping blackboard state to log C++
UE_LOG(LogTemp, Log, TEXT("%s"), *BlackboardComp->GetDebugInfoString(EBlackboardDescription::KeyWithValue));

Version History

Introduced in: 4.0

Version Status Notes
5.6 stable

Feedback

Was this helpful?

Suggest an edit

Select a field above to begin editing.