PrototypeBase: Difference between revisions
(Set prototype parent) |
(→Optional properties: order default) |
||
(6 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
{{Prototype parent}} | {{Prototype parent}} | ||
The abstract base for prototypes. PrototypeBase defines the common features of prototypes, such as localization and order. | |||
{{Prototype TOC|''abstract''}} | |||
== Mandatory properties == | == Mandatory properties == | ||
{{Prototype_property|type|[[Types/string|string]]}} | |||
Specification of the type of the prototype. | Specification of the type of the prototype. | ||
For a list of all available types and their properties, see [[prototype definitions]]. For a list of all types used in vanilla, see [[data.raw]]. | For a list of all available types and their properties, see [[prototype definitions]]. For a list of all types used in vanilla, see [[data.raw]]. | ||
{{Prototype_property|name|[[Types/string|string]]}} | |||
Unique textual identification of the prototype. | Unique textual identification of the prototype. | ||
Line 24: | Line 19: | ||
== Optional properties == | == Optional properties == | ||
Used to order | {{Prototype_property|order|[[Types/Order|Order]]|""|optional=true}} | ||
Used to order prototypes in inventory, recipes and GUI's. | |||
May not exceed a length of 200 characters. | May not exceed a length of 200 characters. | ||
{{Prototype_property|localised_name|[[Types/LocalisedString|LocalisedString]]|optional=true}} | |||
Overwrites the name set in the [[Tutorial:Localisation#Localising_simple_strings|locale file]]. Can be used to easily set a procedurally-generated name because the LocalisedString format allows to insert parameters into the name directly from the Lua script. | |||
{{Prototype_property|localised_description|[[Types/LocalisedString|LocalisedString]]|optional=true}} | |||
Overwrites the description set in the [[Tutorial:Localisation#Localising_simple_strings|locale file]]. The description is usually shown in the tooltip of the prototype. |
Revision as of 12:47, 29 July 2021
Prototype definitions » PrototypeBase
The abstract base for prototypes. PrototypeBase defines the common features of prototypes, such as localization and order.
PrototypeBase — abstract | ||
name | :: | string |
type | :: | string |
localised_description | :: | LocalisedString (optional) |
localised_name | :: | LocalisedString (optional) |
order | :: | Order (optional) |
Mandatory properties
type
Type: string
Specification of the type of the prototype.
For a list of all available types and their properties, see prototype definitions. For a list of all types used in vanilla, see data.raw.
name
Type: string
Unique textual identification of the prototype.
For a list of all names used in vanilla, see data.raw.
May not contain .
, may not exceed a length of 200 characters.
Optional properties
order
Type: Order
Default: ""
Used to order prototypes in inventory, recipes and GUI's.
May not exceed a length of 200 characters.
localised_name
Type: LocalisedString
Overwrites the name set in the locale file. Can be used to easily set a procedurally-generated name because the LocalisedString format allows to insert parameters into the name directly from the Lua script.
localised_description
Type: LocalisedString
Overwrites the description set in the locale file. The description is usually shown in the tooltip of the prototype.