Object containing mod settings of three distinct types: startup
, global
, and player
.
An instance of LuaSettings is available through the global object named settings
.
get_player_settings(player) → LuaCustomTable[string → ModSetting] | Gets the current per-player settings for the given player, indexed by prototype name. |
startup :: LuaCustomTable[string → ModSetting] [R] | The startup mod settings, indexed by prototype name. |
global :: LuaCustomTable[string → ModSetting] [R] | The current global mod settings, indexed by prototype name. |
player :: LuaCustomTable[string → ModSetting] [R] | The default player mod settings for this map, indexed by prototype name. |
object_name :: string [R] | This object's name. |
Gets the current per-player settings for the given player, indexed by prototype name. Returns the same structure as LuaPlayer::mod_settings.
The startup mod settings, indexed by prototype name.
The current global mod settings, indexed by prototype name.
Even though these are marked as read-only, they can be changed by overwriting individual ModSetting tables in the custom table. Mods can only change their own settings. Using the in-game console, all global settings can be changed.
The default player mod settings for this map, indexed by prototype name.
Even though these are marked as read-only, they can be changed by overwriting individual ModSetting tables in the custom table. Mods can only change their own settings. Using the in-game console, all player settings can be changed.
This object's name.