Storable

Storable を使うと、ゲームの状態にデータを保存できます。Storable に保存されたデータは、現在のゲーム 状態と一緒に保存・読み込みされます。

データを操作するアクションを作りたい場合は、Persistent という抽象を使えます。

Storable に保存されるデータは名前空間ごとに分かれています。異なる名前空間であれば、同じキーを 使うことができます。 例えば、プレイヤー1 の名前を player1 名前空間に、プレイヤー2 の名前を player2 名前空間に それぞれ保存できます。

名前空間 game はすでに定義済みでデータを保存できます。新しい Namespace をインスタンス化することで、自分の名前空間を追加できます。

例えば、新しい player1 名前空間を作り、そこにプレイヤー1 の名前を保存してみます。

type Player1Content = {
    name: string;
};

const storable = game.getLiveGame().getStorable();

// 名前空間を初期化して登録する
const player1namespace = Storable.createNamespace<Player1Content>("player1", {
    name: "default name",
});

storable.addNamespace(player1namespace);

// 名前空間にデータを設定する
const namespace = storable.getNamespace<Player1Content>('player1');
namespace.set('name', 'John Doe');

// 名前空間からデータを取得する
const name = namespace.get('name');
console.log(name); // John Doe

静的メソッド

createNamespace<T extends NameSpaceContent<keyof T>>

公開プロパティ

events

• EventDispatcher<StorableEvents> - すべてのストアイベントが経由するディスパッチャー。 event:storable.change は StorableChange を 携え、event:storable.restore は StorableRestore を携えます。名前空間とキーでフィルタリングしてくれる onChange の使用を優先してください。 参照: 保存された値を監視する。

公開メソッド

addNamespace<T extends NameSpaceContent<keyof T>>

getNamespace<T extends NameSpaceContent<keyof T> = any>

setNamespace<T extends NameSpaceContent<keyof T> = any>

getNamespaces

hasNamespace

removeNamespace

keys

values

entries

onChange

保存された値の変化を監視します。

リスナーは新しい値が読み取れるようになった後、かつ値が実際に動いたときにのみ実行されます。すでに そこにある値と等しい値を書き込んでも何も報告されません。等価性の判定は構造的なものなので、同じ内容の オブジェクトを作り直すことも何もしないのと同じです。セーブの読み込みは変化を報告しません。 参照: onRestore。

購読は、それが監視している名前空間よりも長生きします。newGame() とセーブの読み込みはどちらも すべての名前空間をゼロから再構築しますが、ここに登録したリスナーはそれを生き延びます。全体の説明は 保存された値を監視するを参照してください。

storable.onChange(({namespace, key, previous, next}) => {
    console.log(`${namespace}.${key}: ${previous} -> ${next}`);
});

storable.onChange("persistent:player", ({key, next}) => {...});

const token = storable.onChange("persistent:player", "gold", ({next}) => {
    if (next === 100) achievements.unlock("rich");
});

token.cancel();

onRestore

ストアが丸ごと置き換えられること —— セーブの読み込み、または名前空間をスナップショットへ巻き戻す こと —— を監視します。一括適用ごとに一度だけ発火し、それが暗に示す変化ではなく、関係する名前空間を 列挙します。

これが発火したら、ストアから導出しているものは何であれ読み直してください。

storable.onRestore(({namespaces}) => {
    if (namespaces.includes("persistent:player")) rereadPlayerView();
});