UBlackboardComponent::DescribeSelfToVisLog

function AIModule Since 4.0

#include "BehaviorTree/BlackboardComponent.h"

Access: public Specifiers: virtualconst

Description

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.

Caveats & Gotchas

• Only compiled in when ENABLE_VISUAL_LOG is set (editor and development builds) — the whole function is stripped from shipping builds.
• Called automatically by the owning behavior tree component's visual logging; you rarely need to invoke it directly.

Signature

virtual void DescribeSelfToVisLog(struct FVisualLogEntry* Snapshot) const

Parameters

Name	Type	Description	Default
Snapshot	FVisualLogEntry*	Visual Logger entry to append the blackboard's current state to.	—

Return Type

void

Example

Overriding to add custom logging context C++

#if ENABLE_VISUAL_LOG
void UMyBlackboardComponent::DescribeSelfToVisLog(FVisualLogEntry* Snapshot) const
{
    Super::DescribeSelfToVisLog(Snapshot);
    // Add custom entries to Snapshot here
}
#endif

Version History

Introduced in: 4.0

Version	Status	Notes
5.6	stable	—

Feedback

Was this helpful?