Prototype/AutoplaceControl: Difference between revisions

From Official Factorio Wiki
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:
== 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]].


== Properties ==
{{Prototype TOC|autoplace-control}}
=== type ===
Type: [[Types/string]]


Must be "autoplace-control".
== Mandatory properties ==
Inherits all properties from [[PrototypeBase]].


=== name ===
{{Prototype property|category|[[Types/string|string]]}}
Type: [[Types/string]]
Either "resource", "terrain" or "enemy". Controls in what tab the autoplace is shown in the map generator GUI.


The unique name of this autoplace control.
== Optional properties ==


=== order ===
{{Prototype property|richness|[[Types/bool|bool]]|false|optional=true}}
Type: [[Types/Order]]
Sets whether this control's richness can be set by the player or not.


Controls are sorted in the map creation GUI according to their order field. A control with order="a" will always come before a control with order="b".
If your autoplace control is used to generate ores, you probably want this to be true.


=== richness ===
== Differing defaults ==
Type: [[Types/bool]]
=== order ===
:''See [[PrototypeBase#order]]''


Optional. Sets whether this control's richness can be set by the player or not. Default is false.
'''Default''': ""


If your autoplace control is used to generate ores, you probably want this to be true.
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

See PrototypeBase#order

Default: ""

Controls are sorted in the map creation GUI according to this property.