UBlackboardComponent::IsKeyInstanceSynced

function AIModule Since 4.0

#include "BehaviorTree/BlackboardComponent.h"

Access: public Specifiers: const

Description

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

Caveats & Gotchas

• Instance syncing is configured per-key on the BlackboardData asset (bInstanceSynced), not something toggled from code.
• Only relevant when multiple AI controllers share the same UBlackboardData — synced keys let one agent's SetValue call propagate to others, used for squad-shared knowledge.

Signature

bool IsKeyInstanceSynced(FBlackboard::FKey KeyID) const

Parameters

Name	Type	Description	Default
KeyID	FBlackboard::FKey	The key ID to check.	—

Return Type

bool

Example

Check whether a key propagates across agents C++

if (BlackboardComp->IsKeyInstanceSynced(KeyID))
{
    UE_LOG(LogTemp, Log, TEXT("This key is shared across squad members"));
}

Version History

Introduced in: 4.0

Version	Status	Notes
5.6	stable	—

Feedback

Was this helpful?