Factorio Forums

Rseding91 wrote:"double-player-health" is a way to identify this setting. This is required to be unique per-mod.

sparr wrote:

Rseding91 wrote:"double-player-health" is a way to identify this setting. This is required to be unique per-mod.

I know that info is outdated, but I wanted to point out that it seems like settings require globally unique names now? When I query a setting I don't have to specify which mod it belongs to. This seems like a bad idea that's going to cause problems with conflicting names. Maybe settings should be segregated per mod and queryable that way?

Rseding91 wrote:It's a core part of how the entire prototype system works in Factorio. If you don't know that it exists then you probably haven't been doing anything with modding in Factorio

Supercheese wrote:

Rseding91 wrote:It's a core part of how the entire prototype system works in Factorio. If you don't know that it exists then you probably haven't been doing anything with modding in Factorio

The only "documentation" that exists for Factorio prototypes is "copy the base game definitions". Since the test mod that contains the only base example of mod-settings does not contain an instance of the "order" property, you'll have to excuse me for not immediately assuming its existence as a valid property.

swni wrote:So that leaves me with two main questions: How do you access runtime-global settings, and what does the per_user option do?

settings.global['name_of_setting'].value

swni wrote:By the way, where did you find the test mod? The only example I've been working off of is folk's.

swni wrote:Lack of documentation has been a problem but thankfully folk's work was enough to get me started, although I still have some questions. So far this is what I've figured out (partially from what other people have said and partially from experimentation):

Settings are created by extending data.raw. Use data:extend{<Setting1>, <Setting2>, ..., <SettingN>} where each <Setting> is a lua table with some of the following keys: type, name, setting_type, default_value, minimum_value, maximum_value, order, allowed_values, per_user.

"type" should be one of "int-setting", "bool-setting", "double-setting", or "string-setting".

"name" should be a string unique across all mods. This name is used in the locale configuration, and to retrieve the setting's value as described below.

"setting_type" should be "startup", "runtime-global", or "runtime-per-user".

"allowed_values" a list of values, and can be used with string and int types to make a drop down menu

"per_user" is a bool; best guess is it doesn't do anything (i.e., don't use it)


"startup" settings are accessible only in data.lua, and not in control.lua. They are accessed with settings.startup[<SettingName>].value. (Of course, one can use data.lua to copy the startup settings into a dummy entity to make the startup settings visible from control.lua, using the same trick as sparr's "Expose data.raw" mod that makes data.raw visible within control.lua.) startup has nothing to do with a new game starting as I had assumed at first, but refers to the Factorio binary starting. Changing startup settings causes Factorio to restart.

"runtime-per-user" and "runtime-global" settings are accessible only in control.lua and not in data.lua. The former are accessed with settings.global[<SettingName>].value, and the latter with settings.get_player_settings(<LuaPlayer>)[<SettingName>].value.

Locale configuration for "[mod-setting-name]" controls the label for the gui element visible to the user when choosing the value for the setting, and "[mod-setting-description]" controls the tooltip.

I'm fairly sure that if you load a saved game with different settings than it was saved with, the new settings are used and old ones forgotten, although I haven't tested this carefully. This makes it a bit tricky to have different saves going with different settings, but not any trickier than it was before. I haven't had a chance to see what happens if you try to join a multiplayer game with different settings; I assume local settings are changed to agree with the server and, if that includes startup settings, a restart is triggered.

So that leaves me with two main questions: How do you access runtime-global settings, and what does the per_user option do?

Nexela wrote:I think per_user means any user can change their user_runtime setting. Whereas if it is false only admin can change??? Haven't tested these with MP yet but I may soon

swni wrote: "startup" settings are accessible only in data.lua, and not in control.lua. They are accessed with settings.startup[<SettingName>].value. (Of course, one can use data.lua to copy the startup settings into a dummy entity to make the startup settings visible from control.lua, using the same trick as sparr's "Expose data.raw" mod that makes data.raw visible within control.lua.) startup has nothing to do with a new game starting as I had assumed at first, but refers to the Factorio binary starting. Changing startup settings causes Factorio to restart.

Nexela wrote:runtime-per-user can be changed by users
runtime-global by admins
startup by anyone before world loads, if your startup doesn't you will be prompted to restart with those settings

So back to not having any clue what the per_user variable does

Rseding91 wrote:Where did "per_user" come from? It's not used in any context when it comes to mod settings.