LuaSettings - Runtime Docs

Version 1.1.80 / Runtime Docs / Classes / LuaSettings <>

Class LuaSettings

Object containing mod settings of three distinct types: startup, global, and player. An instance of LuaSettings is available through the global object named settings.

Members

get_player_settings(player)	→ LuaCustomTable[string → ModSetting]	Gets the current per-player settings for the given player, indexed by prototype name.
Gets the current per-player settings for the given player, indexed by prototype name.
startup [R]	:: LuaCustomTable[string → ModSetting]	The startup mod settings, indexed by prototype name.
The startup mod settings, indexed by prototype name.
global [R]	:: LuaCustomTable[string → ModSetting]	The current global mod settings, indexed by prototype name.
The current global mod settings, indexed by prototype name.
player [R]	:: LuaCustomTable[string → ModSetting]	The default player mod settings for this map, indexed by prototype name.
The default player mod settings for this map, indexed by prototype name.
object_name [R]	:: string	This object's name.
This object's name.

Methods

get_player_settings(player) → LuaCustomTable[string → ModSetting]

Gets the current per-player settings for the given player, indexed by prototype name. Returns the same structure as LuaPlayer::mod_settings. This table becomes invalid if its associated player does.

Even though this attribute is marked as read-only, individual settings can be changed by overwriting their ModSetting table. Mods can only change their own settings. Using the in-game console, all player settings can be changed.

Parameters

player

:: PlayerIdentification

Example

-- Change the value of the "active_lifestyle" setting
settings.get_player_settings(player_index)["active_lifestyle"] = {value = true}

Attributes

startup :: LuaCustomTable[string → ModSetting] Read

The startup mod settings, indexed by prototype name.

global :: LuaCustomTable[string → ModSetting] Read

The current global mod settings, indexed by prototype name.

player :: LuaCustomTable[string → ModSetting] Read

The default player mod settings for this map, indexed by prototype name.

object_name :: string Read

This object's name.

Classes - Events - Concepts - Defines

Factorio Runtime Docs

Class LuaSettings

Members

Methods

get_player_settings(player) → LuaCustomTable[string → ModSetting]

Parameters

Example

Attributes

startup :: LuaCustomTable[string → ModSetting] Read

global :: LuaCustomTable[string → ModSetting] Read

player :: LuaCustomTable[string → ModSetting] Read

object_name :: string Read

Classes

Events

Concepts

Defines

Builtin types