PrototypeBase

The abstract base for prototypes. PrototypeBase defines the common features of prototypes, such as localization and order.

Properties

type

• Type: string
• Optional: false
• Override: false

Specifies the kind of prototype this is.

For a list of all possible types, see the prototype overview.

name

• Type: string
• Optional: false
• Override: false

Unique textual identification of the prototype. May only contain alphanumeric characters, dashes and underscores. May not exceed a length of 200 characters.

For a list of all names used in vanilla, see data.raw.

order

• Type: Order
• Optional: true
• Override: false

Used to order prototypes in inventory, recipes and GUIs. May not exceed a length of 200 characters.

localised_name

• Type: LocalisedString
• Optional: true
• Override: false

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
• Optional: true
• Override: false

Overwrites the description set in the locale file. The description is usually shown in the tooltip of the prototype.

factoriopedia_description

• Type: LocalisedString
• Optional: true
• Override: false

Provides additional description used in factoriopedia.

subgroup

• Type: ItemSubGroupID
• Optional: true
• Override: false

The name of an ItemSubGroup.

hidden

• Type: boolean
• Optional: true
• Override: false

hidden_in_factoriopedia

• Type: boolean
• Optional: true
• Override: false

parameter

• Type: boolean
• Optional: true
• Override: false

Whether the prototype is a special type which can be used to parametrize blueprints and doesn't have other function.

factoriopedia_simulation

• Type: SimulationDefinition
• Optional: true
• Override: false

The simulation shown when looking at this prototype in the Factoriopedia GUI.