Module · Scripting core
mod.settings
The settings declared in mod.json, with their defaults. "user" settings belong to each player and are changed from client scripts; "server" settings are changed from the server script and reach every player. Both sides read every setting.
mod.settings.all(): any
Every declared setting with its current value.
Returns A table keyed by setting key.
mod.settings.get(key: string): any
The current value of a declared setting.
local volume = mod.settings.get("volume")mod.settings.onChanged(handler: function): Subscription
Calls handler(key, value) after any of this mod's settings changes.
mod.settings.onChanged(function(key, value) log.info(key, "is now", value) end)mod.settings.set(key: string, value: any)
Changes a setting. User settings can be changed from client scripts; server settings from server scripts.