UBlackboardComponent::DescribeKeyValue
#include "BehaviorTree/BlackboardComponent.h"
Access: public
Specifiers: const
Description
Returns a human-readable description of the value stored under KeyName, formatted according to Mode.
Caveats & Gotchas
- • Returns an empty string if KeyName doesn't resolve to a valid key.
- • There's also an FBlackboard::FKey overload — prefer it in hot paths like per-frame debug drawing since it skips the name lookup.
Signature
FString DescribeKeyValue(const FName& KeyName, EBlackboardDescription::Type Mode) constParameters
| Name | Type | Description | Default |
|---|---|---|---|
| KeyName | const FName& | Name of the key to describe. | — |
| Mode | EBlackboardDescription::Type | Level of detail to include in the description. | — |
Return Type
FString Example
Describing a single key for on-screen debug C++
const FString Desc = BlackboardComp->DescribeKeyValue(TEXT("TargetActor"), EBlackboardDescription::OnlyValue);
GEngine->AddOnScreenDebugMessage(-1, 0.f, FColor::Yellow, Desc);Version History
Introduced in: 4.0
| Version | Status | Notes |
|---|---|---|
| 5.6 | stable | — |
Feedback
Was this helpful?