Prototype/AutoplaceControl: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(overhaul to include Prototype)
m (formatting)
 
(12 intermediate revisions by 3 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]]. 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 changed. The map generator GUI will only show the richness slider when the <code>category</code> is "resource".


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