Prototype/AutoplaceControl: Difference between revisions

Revision as of 12:48, 29 July 2021

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)

Inherits all properties from PrototypeBase.

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.

@@ Line 1: / Line 1: @@
-== Basics ==
+{{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]]. Only 255 instances of this prototype may be defined.
-== Properties ==
+{{Prototype TOC|autoplace-control}}
-Inherits all properties from [[Prototype]].
-Controls are sorted in the map creation GUI according to their order field.
+== Mandatory properties ==
+Inherits all properties from [[PrototypeBase]].
-=== richness ===
+{{Prototype property|category|[[Types/string|string]]}}
-'''Type''': [[Types/bool]]
+Either "resource", "terrain" or "enemy". Controls in what tab the autoplace is shown in the map generator GUI.
-'''Default''': false
+== Optional properties ==
-Optional. Sets whether this control's richness can be set by the player or not.
+{{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.