Prototype/AutoplaceControl: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Changed links going to the redirect Prototype to go to PrototypeBase.)
(order already defaults to empty string in PrototypeBase)
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Basics ==
{{Prototype parent|PrototypeBase}}
Prototype type: '''autoplace-control'''
A setting in the map creation GUI. Used by the [[Types/AutoplaceSpecification#control|autoplace system]]. Only 255 instances of this prototype may be defined.


A setting in the map creation GUI. Used by the [[Types/AutoplaceSpecification#control|autoplace system]].
{{Prototype TOC|autoplace-control}}


== Mandatory properties ==
== Mandatory properties ==
Inherits all properties from [[PrototypeBase]].
Inherits all properties from [[PrototypeBase]].


=== category ===
{{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.
Either "resource", "terrain" or "enemy". Controls in what tab the autoplace is shown in the map generator GUI.


== Optional properties ==
== Optional properties ==


=== richness ===
{{Prototype property|richness|[[Types/bool|bool]]|false|optional=true}}
'''Type''': [[Types/bool]]
 
'''Default''': false
 
Sets whether this control's richness can be set by the player or not.
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.
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 12:48, 29 July 2021

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 set by the player or not.

If your autoplace control is used to generate ores, you probably want this to be true.