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

Preference allows you to control some game behaviors, such as auto-forward mode.

For a list of preference keys, see GamePreference.

Public Methods

constructor

setPreference<K extends Extract<keyof T, string>>

Set a preference.

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

getPreference<K extends Extract<keyof T, string>>

Get a preference.

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

getPreferences

Get all preferences.

onPreferenceChange<U extends Extract<keyof T, string>>

Listen to preference changes.

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

importPreferences

Import preferences

Note: this will override the existing preferences and trigger the change event

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

exportPreferences

Export preferences

const preferences = game.preference.exportPreferences();

togglePreference<K extends BooleanValueKeyOf<T>>

Toggle a boolean preference.

game.preference.togglePreference("autoForward");