PrototypeBase: Difference between revisions

Revision as of 20:26, 27 July 2019

The abstract base for all prototypes. All prototypes inherit from this prototype.

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
Used to order items 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.

@@ Line 26: / Line 26: @@
 {{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.