クック時にデコレーターのエラーに遭遇した話

忙しさにかまけて放置してしまっていたが、久々に更新。

デコレーターでクックエラー
どういうことなの・・・
作り直すのはいいんだけどさ
どのアセットが問題か探す
- 1. デコレーターアセットを別プロジェクトに Migrate して該当するアセットが含まれているか確認
- 2. 各デコレーターアセットの Observer Abouts を1つずつ None にしてクックエラーが出ないか確認
該当アセットの修正

デコレーターでクックエラー

突然だが、UE4 のビヘイビアツリーには、デコレーター(Decorator)というものがある。

このデコレーターのアセットを作った上で、パッケージングをするためにクックを走らせると、
以下のようなエラーが出て止まるということがあった。

LogOutputDevice: Error: === Handled ensure: ===
LogOutputDevice: Error: Ensure condition failed: ObservedKeyNames.Num() > 0 
[File:D:\Build\++UE4+Release-4.19+Compile\Sync\Engine\Source\Runtime\AIModule\Private\BehaviorTree\Decorators\BTDecorator_BlueprintBase.cpp] [Line: 67]

UE4 の ensure アサーションに捕まっている。
とりあえず、上記に書かれているソースコードを読んで見る。

void UBTDecorator_BlueprintBase::PostLoad()
{
  Super::PostLoad();

  if (GetFlowAbortMode() != EBTFlowAbortMode::None && bIsObservingBB)
  {
    ObservedKeyNames.Reset();
    UClass* StopAtClass = UBTDecorator_BlueprintBase::StaticClass();
    BlueprintNodeHelpers::CollectBlackboardSelectors(this, StopAtClass, ObservedKeyNames);
    ensure(ObservedKeyNames.Num() > 0);
  }
}

BTDecorator_BlueprintBase はブループリントでデコレーターを作る際には必ず継承する必要があるクラス。

このクラスの PostLoad つまりロード直後のイベント内でアサートしている。
具体的には、GetFlowAbortMode() != EBTFlowAbortMode::None かつ bIsObservingBB のとき、
自分のクラスに、 FBlackboardKeySelector のメンバ変数があるかどうか探して、なければアサーション。

(BlueprintNodeHelpers::CollectBlackboardSelectors は FBlackboardKeySelector のプロパティを検索してその名前をリスト化して返す)

EBTFlowAbortMode はデコレーターが元々持っているもので、ビヘイビアツリーの中断発生時の振る舞いを決めるものだけど、
一般的に考えて EBTFlowAbortMode::None にする運用はあまりないといっていい。

なので、bIsObservingBB が true になっていることが問題？と一瞬思うのだが、

void UBTDecorator_BlueprintBase::InitializeProperties()
{ 
  if (HasAnyFlags(RF_ClassDefaultObject)) 
  { 
    UClass* StopAtClass = UBTDecorator_BlueprintBase::StaticClass(); 
    BlueprintNodeHelpers::CollectPropertyData(this, StopAtClass, PropertyData);
    bIsObservingBB = BlueprintNodeHelpers::HasAnyBlackboardSelectors(this, StopAtClass);
  }
} 

void UBTDecorator_BlueprintBase::PostInitProperties()
{
  Super::PostInitProperties();
  
  InitializeProperties();
  if (PerformConditionCheckImplementations || bIsObservingBB)
  { 
    bNotifyBecomeRelevant = true; 
    bNotifyCeaseRelevant = true;
  }
}

とあるように、PostInitProperties 時に、
BlueprintNodeHelpers::HasAnyBlackboardSelectors で ‘FBlackboardKeySelector’ を事前検索しているだけだった。