Prototype/Equipment

From Official Factorio Wiki
Revision as of 15:30, 11 March 2020 by Bilka (talk | contribs) (background_color default is now defined in utility constants (0.18.12))
Jump to navigation Jump to search

Prototype definitions » PrototypeBase » Prototype/Equipment


Abstract base of all equipment modules. Equipment modules can be inserted into Prototype/EquipmentGrids.


Prototype/Equipment — abstract
categories::table of string
energy_source::EnergySource
shape::EquipmentShape
sprite::Sprite
background_border_color::Color (optional)
background_color::Color (optional)
grabbed_background_color::Color (optional)
take_result::string (optional)
Inherited from PrototypeBase
name::string
type::string
localised_description::LocalisedString (optional)
localised_name::LocalisedString (optional)
order::Order (optional)

Extensions

Mandatory properties

Inherits all properties from PrototypeBase.

sprite

Type: Sprite
The graphics to use when this equipment is shown inside an equipment grid.

shape

Type: EquipmentShape
How big this equipment should be in the grid and whether it should be one solid rectangle or of a custom shape.

categories

Type: table of string
An array of Prototype/EquipmentCategory names. Sets the categories of the equipment. It can only be inserted into grids with at least one matching category.

energy_source

Type: EnergySource
Must be an electric energy source.

Optional properties

ability_icon

Type: Sprite

take_result

Type: string
Default: name of this prototype
Name of the item prototype that should be returned to the player when they remove this equipment from an equipment grid.

background_color

Type: Color
Default: value of equipment_default_background_color in the utility constants
The color that the background of this equipment should have when shown inside an equipment grid.