ldoc

• Index

Contents

• Concepts
• Setting

Modules

• Core
• Types
• Concepts
• Cache
• Data
• Entity
• EventManagerLite
• Force
• Gui
• Locale
• Player
• PluginManagerLite
• Prototype
• Remote
• Setting
• Stacktrace
• Surface
• Train
• Wube
• Array
• Class
• Coding
• Color
• Compare
• Debug
• Error
• Filter
• Iter
• Lambda
• LocalisedString
• Lock
• Log
• Logic
• Math
• Meta
• Polygon
• Replicate
• Set
• String
• Table
• Time
• Tool
• Vector
• Verificate
• Version
• remotes
• snippet
• Babelfish

Source

• Introduction

Module Setting

Methods for Mod Settings.

Module Status: Work in progress.

Usage:

local Setting = require('__eradicators-library__/erlib/factorio/Setting')()

Concepts

setting_type

Factorio uses several different names for the setting_type of a setting.

Setting

get_value(setting_type, name)	Retrieve the current value of a ModSetting.
set_value(setting_type, name)	Set a new value for a ModSetting.
make(prototype)	Syntactic sugar for making settings.

Concepts

setting_type

Factorio uses several different names for the setting_type of a setting.

In-Game Menu | Erlib     | settings.lua      | data.lua  | LuaSettings
---------------------------------------------------------------------
Startup      | 'startup' | 'startup'         | 'startup' | 'startup'
Map          | 'map'     | 'runtime-global'  |  -        | 'global'
Per Player   | 'player'  | 'runtime-per-user'|  -       '| 'player'

Setting

get_value(setting_type, name)

Retrieve the current value of a ModSetting.

Works in: data stage, control stage.

Parameters:

• setting_type string, player_index or LuaPlayer The string can be either 'startup' or 'map'. Only 'startup' is valid in data stage.
• name string Name of the setting.

Returns:

NotNil Value of the setting.

set_value(setting_type, name)

Set a new value for a ModSetting. Works only when called from the same mod that created the setting.

Works in: control stage.

See also LuaSetting

Parameters:

• setting_type string, player_index or LuaPlayer The string can be either 'startup' or 'map'. Only 'startup' is valid in data stage.
• name string Name of the setting.

make(prototype)

Syntactic sugar for making settings.

Parameters:

• prototype (table)
  • 1 string name
  • 2 string setting_type
  • 3 string type 'bool', 'int', 'string' or 'double'
  • 4 boolean, number, string or table default_value
    Can also be a table {minimum_value, default_value, maximum_value}
  • 5 string order
  • ... AnyValue Everything else is copied unchanged.

Returns:

table A reference to the new prototype at data.raw[type][name].

Usage:

Setting.make {
  'mymod-my-setting-name',
  'player', 'string', 'default_value',
  'order-string-[foo]-[bar]',
  allow_blank    = false,
  allowed_values = {'default_value', 'other_value'},
  }