Variables

Session-only key-value storage scoped to your mod. Data is lost when the game closes.

No permission required.

Methods

get<T>(key)

Get a variable value.

const count = Variables.get<number>("sessionCount");

set(key, value)

Set a variable.

Variables.set("sessionCount", 42);

getAll()

Get all variables.

const vars = Variables.getAll();

remove(key)

Remove a variable.

Variables.remove("sessionCount");

clear()

Remove all variables for this mod.

Variables.clear();

Related APIs

For persistent storage, use Storage. For shared data between mods, use SharedStorage or SharedVariables.