Storage
Persistent key-value storage scoped to your mod. Data persists across game sessions.
No permission required.
Methods
get<T>(key)
Get a stored value.
typescript
const score = Storage.get<number>("highScore");set(key, value)
Store a value.
typescript
Storage.set("highScore", 9999);getAll()
Get all stored key-value pairs.
typescript
const data = Storage.getAll();remove(key)
Remove a stored value.
typescript
Storage.remove("highScore");clear()
Remove all stored values for this mod.
typescript
Storage.clear();Related APIs
| API | Scope | Persistence |
|---|---|---|
Storage | Per mod | Persistent |
Variables | Per mod | Session only |
SharedStorage | Shared between mods | Persistent |
SharedVariables | Shared between mods | Session only |
ModSettings | Per mod (player config) | Persistent |