ModSettings

Read and write mod settings configured by the player in the Mods menu. This API is completely separate from the Storage API.

No permission required.

Methods

get<T>(key)

Get a setting value by key. Returns the player's override or the default value. Returns undefined if the key doesn't exist in the settings definition.

Returns: T | undefined

const difficulty = ModSettings.get<string>("difficulty"); // "normal"
const hints = ModSettings.get<boolean>("showHints");      // true
const missing = ModSettings.get("nonexistent");           // undefined

getAll()

Get all setting values as a key-value map (defaults merged with player overrides).

const settings = ModSettings.getAll();
// { difficulty: "normal", showHints: true, maxEnemies: 5 }

set(key, value)

Programmatically set a setting value.

ModSettings.set("difficulty", "hard");

reset(key)

Reset a single setting to its default value.

ModSettings.reset("difficulty");

resetAll()

Reset all settings to their defaults.

ModSettings.resetAll();

Defining Settings

Settings are defined in your Bootstrap class. See the Mod Settings guide for details.

ModSettings vs Storage

ModSettings is for player-facing configuration defined via Bootstrap.Settings. Use Storage for internal mod data (save state, cache, etc.). They use separate storage and do not interfere with each other.