Prototype/AutoplaceControl: Difference between revisions
(Set prototype parent) |
m (formatting) |
||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Prototype parent|PrototypeBase}} | {{Prototype parent|PrototypeBase}} | ||
A setting in the map creation GUI. Used by the [[Types/AutoplaceSpecification#control|autoplace system]]. Only 255 instances of this prototype may be defined. | |||
{{Prototype TOC|autoplace-control}} | |||
Prototype | |||
== Mandatory properties == | == Mandatory properties == | ||
Inherits all properties from [[PrototypeBase]]. | 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. | Either "resource", "terrain" or "enemy". Controls in what tab the autoplace is shown in the map generator GUI. | ||
== Optional properties == | == Optional properties == | ||
{{Prototype property|richness|[[Types/bool|bool]]|false|optional=true}} | |||
Sets whether this control's richness can be changed. The map generator GUI will only show the richness slider when the <code>category</code> is "resource". | |||
Sets whether this control's richness can be | |||
If the autoplace control is used to generate ores, you probably want this to be true. | |||
{{Prototype property|can_be_disabled|[[Types/bool|bool]]|true|optional=true}} | |||
Whether there is an "enable" checkbox for the autoplace control in the map generator GUI. If this is false, the autoplace control cannot be disabled from the GUI. | |||
Latest revision as of 14:39, 25 February 2022
Prototype definitions » PrototypeBase » Prototype/AutoplaceControl
A setting in the map creation GUI. Used by the autoplace system. Only 255 instances of this prototype may be defined.
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 changed. The map generator GUI will only show the richness slider when the category is "resource".
If the autoplace control is used to generate ores, you probably want this to be true.
can_be_disabled
Type: bool
Default: true
Whether there is an "enable" checkbox for the autoplace control in the map generator GUI. If this is false, the autoplace control cannot be disabled from the GUI.