Prototype/AutoplaceControl: Difference between revisions
Jump to navigation
Jump to search
m (→order: fixed type) |
m (fixed link) |
||
(7 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
{{Prototype parent|PrototypeBase}} | |||
A setting in the map creation GUI. Used by the [[Types/AutoplaceSpecification#control|autoplace system]]. | A setting in the map creation GUI. Used by the [[Types/AutoplaceSpecification#control|autoplace system]]. | ||
{{Prototype TOC|autoplace-control}} | |||
== Mandatory properties == | |||
Inherits all properties from [[PrototypeBase]]. | |||
{{Prototype property|category|[[Types/string|string]]}} | |||
Either "resource", "terrain" or "enemy". Controls in what tab the autoplace is shown in the map generator GUI. | |||
== Optional properties == | |||
{{Prototype property|richness|[[Types/bool|bool]]|false|optional=true}} | |||
Sets whether this control's richness can be set by the player or not. | |||
If your autoplace control is used to generate ores, you probably want this to be true. | |||
=== | == Differing defaults == | ||
=== order === | |||
:''See [[PrototypeBase#order]]'' | |||
'''Default''': "" | |||
Controls are sorted in the map creation GUI according to this property. |
Revision as of 17:34, 21 November 2019
Prototype definitions » PrototypeBase » Prototype/AutoplaceControl
A setting in the map creation GUI. Used by the autoplace system.
Prototype/AutoplaceControl — autoplace-control | ||
category | :: | string |
can_be_disabled | :: | bool (optional) |
richness | :: | bool (optional) |
Inherited from PrototypeBase | ||
name | :: | string |
type | :: | string |
localised_description | :: | LocalisedString (optional) |
localised_name | :: | LocalisedString (optional) |
order | :: | Order (optional) |
Mandatory properties
Inherits all properties from PrototypeBase.
category
Type: string
Either "resource", "terrain" or "enemy". Controls in what tab the autoplace is shown in the map generator GUI.
Optional properties
richness
Type: bool
Default: false
Sets whether this control's richness can be set by the player or not.
If your autoplace control is used to generate ores, you probably want this to be true.
Differing defaults
order
Default: ""
Controls are sorted in the map creation GUI according to this property.