ビュー

実験的機能 - Viewsはv2.2.0（未リリース）で利用可能です。APIは将来のバージョンで変更される可能性があります。本番環境での使用は自己責任で行ってください。

目的

このページでは、ReactiveView<TData>を使ってエンティティのサブセットを動的に管理する方法を説明します。データ条件だけのView、Traits条件を含むView、メンバーシップイベント、ライフサイクルの各トピックを扱います。

ビューとは

Viewはセット内のエンティティのうち、指定した条件を満たすものだけを追跡するオブジェクトです。エンティティのデータやTraitsが変わると、Viewは自動的にメンバーシップを再評価します。条件を満たすようになったエンティティにはOnEnter、満たさなくなったエンティティにはOnExitが発火します。

毎フレームForEachでセット全体を走査して絞り込む代わりに、Viewを使うと変更があったエンティティだけを再評価するため効率的です。

データのみのViewを作成する

HPが0より大きいエンティティだけを追跡するViewを作ります。

public class EnemyAIManager : MonoBehaviour
{
    [SerializeField] private EnemyEntitySetSO enemySet;

    private ReactiveView<EnemyState> aliveEnemies;

    private void OnEnable()
    {
        aliveEnemies = enemySet.CreateView(
            state => state.Health > 0
        );

        aliveEnemies.OnEnter += id => Debug.Log($"Enemy {id} is now alive in view");
        aliveEnemies.OnExit  += id => Debug.Log($"Enemy {id} left the alive view");
    }

    private void OnDisable()
    {
        aliveEnemies?.Dispose();
        aliveEnemies = null;
    }
}

CreateViewを呼んだ時点で、既存の全エンティティに対して条件が評価され、初期メンバーが決まります。

Traits対応Viewを作成する

Traitsとデータの両方を条件に使う場合、Func<TData, ulong, bool>のオーバーロードを使います。

// IsAggroが立っていて、かつHPが50%以上の敵
var aggroAlive = enemySet.CreateView(
    (state, traitMask) =>
    {
        ulong aggroFlag = TraitMaskUtility.ToUInt64(EnemyTraits.IsAggro);
        return (traitMask & aggroFlag) != 0 && state.Health > state.MaxHealth / 2;
    },
    ViewTrigger.All,
    TraitMaskUtility.ToUInt64(EnemyTraits.IsAggro)
);

第3引数observedTraitMaskには、このViewが反応するTraitsフラグを渡します。IsAggroの変化に限定することで、無関係なTraits変更での不要な再評価を防ぎます。

ViewTriggerモード

ViewTriggerは、Viewがどのタイミングで再評価するかを制御します。

値 説明
None 再評価しない（登録・登録解除のみ追跡）
DataOnly データ変更時に再評価
TraitsOnly Traits変更時に再評価
All データ変更とTraits変更の両方で再評価

データのみのViewにはViewTrigger.DataOnly（デフォルト）を使います。Traitsに反応させたい場合はTraitsOnlyかAllを指定します。

// データが変わったときだけ再評価（Traits変更は無視）
var dataView = enemySet.CreateView(
    state => state.Health > 0,
    ViewTrigger.DataOnly
);

// Traitsが変わったときだけ再評価（データ変更は無視）
var traitView = enemySet.CreateView(
    (state, mask) => (mask & TraitMaskUtility.ToUInt64(EnemyTraits.IsDead)) == 0,
    ViewTrigger.TraitsOnly,
    TraitMaskUtility.ToUInt64(EnemyTraits.IsDead)
);

メンバーシップイベント

エンティティがViewに入るときと出るときにイベントが発火します。

private ReactiveView<EnemyState> stunView;

private void OnEnable()
{
    stunView = enemySet.CreateView(
        (state, mask) =>
        {
            ulong stunFlag = TraitMaskUtility.ToUInt64(EnemyTraits.IsStunned);
            return (mask & stunFlag) != 0;
        },
        ViewTrigger.TraitsOnly,
        TraitMaskUtility.ToUInt64(EnemyTraits.IsStunned)
    );

    stunView.OnEnter += OnEnemyStunned;
    stunView.OnExit  += OnEnemyRecovered;
}

private void OnEnemyStunned(int entityId)
{
    // スタン演出を開始
    PlayStunEffect(entityId);
}

private void OnEnemyRecovered(int entityId)
{
    // スタン演出を停止
    StopStunEffect(entityId);
}

private void OnDisable()
{
    stunView?.Dispose();
}

Viewメンバーをイテレートする

Viewのメンバーをforeachで走査します。

private void Update()
{
    // Viewに所属するエンティティだけ処理
    foreach (int id in aliveEnemies)
    {
        if (enemySet.TryGetData(id, out var state))
        {
            UpdateEnemyAI(id, state);
        }
    }
}

特定のエンティティがViewに含まれているかどうかはO(1)で確認できます。

if (aliveEnemies.Contains(targetId))
{
    // ターゲットが生存中
}

Debug.Log($"生存中の敵: {aliveEnemies.Count}");

ライフサイクルと破棄

ViewはNativeメモリを保持するため、使い終わったら必ずDisposeを呼びます。Disposeを呼ぶとViewはセットから登録解除され、OnEnter/OnExitのイベントも解放されます。

private ReactiveView<EnemyState> view;

private void OnEnable()
{
    view = enemySet.CreateView(state => state.Health > 0);
    view.OnEnter += HandleEnter;
}

private void OnDisable()
{
    // Disposeを忘れるとメモリリーク
    view?.Dispose();
    view = null;
}

バルク操作時の挙動

Clear()やRestoreSnapshot()を実行すると、Viewのメンバーシップはサイレントに再構築されます。この場合、OnEnterとOnExitは発火しません。UI要素のリフレッシュなど、バルク操作後に一括更新が必要な場合はCountやContainsで状態を確認してください。

// バルク操作後に手動でUIを同期
enemySet.Clear();
RefreshAllUIFromScratch();  // OnExit/OnEnterを待たず即時同期

APIサマリー

Viewの作成

メソッド 説明
CreateView(Func<TData, bool> predicate, ViewTrigger triggerOn) データのみのViewを作成
CreateView(Func<TData, ulong, bool> predicate, ViewTrigger triggerOn, ulong observedTraitMask) Traits対応Viewを作成

ReactiveView

メンバー 説明
bool Contains(int id) メンバーかどうかをO(1)で確認
int Count 現在のメンバー数
GetEnumerator() NativeHashSet<int>のEnumeratorを取得
event Action<int> OnEnter エンティティがViewに入ったとき発火
event Action<int> OnExit エンティティがViewから出たとき発火
void Dispose() Viewを破棄してリソースを解放

パフォーマンス特性

操作 時間計算量
Contains O(1)
メンバーシップ再評価（1エンティティ） O(1)
初期化時の全評価 O(n)
バルク操作後の再構築 O(n)

ViewのメンバーシップはNativeHashSetで管理されます。登録済みのViews数が増えるほど、データ変更やTraits変更時のオーバーヘッドも増えます。不要になったViewはすぐにDisposeしてください。

次のステップ

This site uses Just the Docs, a documentation theme for Jekyll.