Prototype/MapGenPresets: Difference between revisions
Muppet9010 (talk | contribs) (clarify presets as a special thing as they are defined so differently to all other prototype properties.) |
(Updated styling of prototype doc migration note) |
||
(7 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
= | <div class="stub"><p>'''The prototype docs have moved to a new website with an improved format.''' This documentation page can now be found here: [https://lua-api.factorio.com/latest/prototypes/MapGenPresets.html https://lua-api.factorio.com/latest/prototypes/MapGenPresets.html] | ||
The available map gen presets. | </p><p>This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div> | ||
{{Prototype parent}} | |||
The available map gen presets. Only 1 instance of this prototype can exist. | |||
{{Prototype TOC|map-gen-presets}} | |||
== Mandatory properties == | == Mandatory properties == | ||
{{Prototype property|type|[[Types/string|string]]}} | |||
Must be "map-gen-presets". | Must be "map-gen-presets". | ||
{{Prototype property|name|[[Types/string|string]]}} | |||
Name of the map-gen-presets. Must be "default" since only one instances of this prototype can be defined. | Name of the map-gen-presets. Must be "default" since only one instances of this prototype can be defined. | ||
== Presets == | == Presets == | ||
Presets are defined as uniquely named properties of the prototype with a value of [[Types/MapGenPreset]]. | Presets are defined as uniquely named properties of the prototype with a value of [[Types/MapGenPreset|MapGenPreset]]. 0 or more named presets can be specified within the prototype. | ||
== Example == | |||
Example full prototype. | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
{ | { | ||
type = "map-gen-presets", | type = "map-gen-presets", | ||
name = "default", | name = "default", | ||
[" | ["marathon"] = | ||
order = " | { | ||
order = "c", | |||
basic_settings = | |||
{ | |||
property_expression_names = {}, | |||
}, | |||
advanced_settings = | |||
{ | |||
difficulty_settings = | |||
{ | |||
recipe_difficulty = defines.difficulty_settings.recipe_difficulty.expensive, | |||
technology_difficulty = defines.difficulty_settings.technology_difficulty.expensive, | |||
technology_price_multiplier = 4 | |||
} | |||
} | |||
}, | }, | ||
[" | ["island"] = | ||
order = " | { | ||
order = "g", | |||
basic_settings = | |||
{ | |||
property_expression_names = | |||
{ | |||
elevation = "0_17-island", | |||
}, | |||
autoplace_controls = {}, | |||
terrain_segmentation = 1, | |||
} | |||
} | } | ||
}</syntaxhighlight> | }</syntaxhighlight> |
Latest revision as of 10:43, 21 September 2023
The prototype docs have moved to a new website with an improved format. This documentation page can now be found here: https://lua-api.factorio.com/latest/prototypes/MapGenPresets.html
This wiki page is no longer updated and will be removed at some point in the future, so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback on the forums.
Prototype definitions » Prototype/MapGenPresets
The available map gen presets. Only 1 instance of this prototype can exist.
Prototype/MapGenPresets — map-gen-presets | ||
name | :: | string |
type | :: | string |
Mandatory properties
type
Type: string
Must be "map-gen-presets".
name
Type: string
Name of the map-gen-presets. Must be "default" since only one instances of this prototype can be defined.
Presets
Presets are defined as uniquely named properties of the prototype with a value of MapGenPreset. 0 or more named presets can be specified within the prototype.
Example
Example full prototype.
{
type = "map-gen-presets",
name = "default",
["marathon"] =
{
order = "c",
basic_settings =
{
property_expression_names = {},
},
advanced_settings =
{
difficulty_settings =
{
recipe_difficulty = defines.difficulty_settings.recipe_difficulty.expensive,
technology_difficulty = defines.difficulty_settings.technology_difficulty.expensive,
technology_price_multiplier = 4
}
}
},
["island"] =
{
order = "g",
basic_settings =
{
property_expression_names =
{
elevation = "0_17-island",
},
autoplace_controls = {},
terrain_segmentation = 1,
}
}
}