Factorio: fill in some missing doc strings
This commit is contained in:
parent
97d6e80556
commit
52e01c0925
|
@ -131,6 +131,8 @@ class RecipeTime(Choice):
|
||||||
|
|
||||||
|
|
||||||
class Progressive(Choice):
|
class Progressive(Choice):
|
||||||
|
"""Merges together Technologies like "automation-1" to "automation-3" into 3 copies of "Progressive Automation",
|
||||||
|
which awards them in order."""
|
||||||
displayname = "Progressive Technologies"
|
displayname = "Progressive Technologies"
|
||||||
option_off = 0
|
option_off = 0
|
||||||
option_grouped_random = 1
|
option_grouped_random = 1
|
||||||
|
@ -151,17 +153,19 @@ class RecipeIngredients(Choice):
|
||||||
|
|
||||||
|
|
||||||
class FactorioStartItems(ItemDict):
|
class FactorioStartItems(ItemDict):
|
||||||
|
"""Mapping of Factorio internal item-name to amount granted on start."""
|
||||||
displayname = "Starting Items"
|
displayname = "Starting Items"
|
||||||
verify_item_name = False
|
verify_item_name = False
|
||||||
default = {"burner-mining-drill": 19, "stone-furnace": 19}
|
default = {"burner-mining-drill": 19, "stone-furnace": 19}
|
||||||
|
|
||||||
|
|
||||||
class FactorioFreeSampleBlacklist(OptionSet):
|
class FactorioFreeSampleBlacklist(OptionSet):
|
||||||
|
"""Set of items that should never be granted from Free Samples"""
|
||||||
displayname = "Free Sample Blacklist"
|
displayname = "Free Sample Blacklist"
|
||||||
|
|
||||||
|
|
||||||
class FactorioFreeSampleWhitelist(OptionSet):
|
class FactorioFreeSampleWhitelist(OptionSet):
|
||||||
"""overrides any free sample blacklist present. This may ruin the balance of the mod, be forewarned."""
|
"""Overrides any free sample blacklist present. This may ruin the balance of the mod, be warned."""
|
||||||
displayname = "Free Sample Whitelist"
|
displayname = "Free Sample Whitelist"
|
||||||
|
|
||||||
|
|
||||||
|
@ -180,6 +184,7 @@ class EvolutionTrapCount(TrapCount):
|
||||||
|
|
||||||
|
|
||||||
class EvolutionTrapIncrease(Range):
|
class EvolutionTrapIncrease(Range):
|
||||||
|
"""How much an Evolution Trap increases the enemy evolution"""
|
||||||
displayname = "Evolution Trap % Effect"
|
displayname = "Evolution Trap % Effect"
|
||||||
range_start = 1
|
range_start = 1
|
||||||
default = 10
|
default = 10
|
||||||
|
@ -187,6 +192,8 @@ class EvolutionTrapIncrease(Range):
|
||||||
|
|
||||||
|
|
||||||
class FactorioWorldGen(OptionDict):
|
class FactorioWorldGen(OptionDict):
|
||||||
|
"""World Generation settings. Overview of options at https://wiki.factorio.com/Map_generator,
|
||||||
|
with in-depth documentation at https://lua-api.factorio.com/latest/Concepts.html#MapGenSettings"""
|
||||||
displayname = "World Generation"
|
displayname = "World Generation"
|
||||||
# FIXME: do we want default be a rando-optimized default or in-game DS?
|
# FIXME: do we want default be a rando-optimized default or in-game DS?
|
||||||
value: typing.Dict[str, typing.Dict[str, typing.Any]]
|
value: typing.Dict[str, typing.Dict[str, typing.Any]]
|
||||||
|
@ -320,6 +327,7 @@ class FactorioWorldGen(OptionDict):
|
||||||
|
|
||||||
|
|
||||||
class ImportedBlueprint(DefaultOnToggle):
|
class ImportedBlueprint(DefaultOnToggle):
|
||||||
|
"""Allow or Disallow Blueprints from outside the current savegame."""
|
||||||
displayname = "Blueprints"
|
displayname = "Blueprints"
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue