Preference\<T extends Record\<string, string | boolean | number | null | undefined\>\>

プレイヤーのプリファレンス値を読み取り、設定し、インポート・エクスポートし、切り替える Preference のメソッド

Preference を使うと、自動送りモードのような一部のゲームの挙動を制御できます。

プリファレンスキーの一覧は GamePreference を参照してください。

公開メソッド

プリファレンスを設定します。

game.preference.setPreference("autoForward", true);

プリファレンスを取得します。

const autoForward = game.preference.getPreference("autoForward");

すべてのプリファレンスを取得します。

プリファレンスの変化を監視します。

game.preference.onPreferenceChange("autoForward", value => {
    console.log(`Auto-forward mode is ${value ? "enabled" : "disabled"}`);
});

listener: (key: Extract<keyof T, string>, value: T[Extract<keyof T, string>]) => void

プリファレンスをインポートします。

注意: これは既存のプリファレンスを上書きし、変更イベントを発火させます。

game.preference.importPreferences({
    autoForward: true,
});

プリファレンスをエクスポートします。

const preferences = game.preference.exportPreferences();

真偽値のプリファレンスを切り替えます。

game.preference.togglePreference("autoForward");