Prototype/Equipment: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Set prototype parent)
(1.1.36: ability_icon removed)
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Prototype parent|PrototypeBase}}
{{Prototype parent|PrototypeBase}}
Abstract base of all equipment modules. Equipment modules can be inserted into [[Prototype/EquipmentGrid]]s.


== Basics ==
{{Prototype TOC|''abstract''}}
This type is abstract and cannot be created directly.
 
An equipment module. Extends [[PrototypeBase]].


== Extensions ==
== Extensions ==
Line 20: Line 18:
Inherits all properties from [[PrototypeBase]].
Inherits all properties from [[PrototypeBase]].


=== sprite ===
{{Prototype property|sprite|[[Types/Sprite|Sprite]]}}
'''Type''': [[Types/Sprite]]
The graphics to use when this equipment is shown inside an equipment grid.
 
=== shape ===
'''Type''': [[Types/EquipmentShape]]
 
=== categories ===
'''Type''': [[Types/table]] of [[Types/string]]


An array of equipment-category names. Sets the category of the quipment. It can only be inserted into grids with the same category.
{{Prototype property|shape|[[Types/EquipmentShape|EquipmentShape]]}}
How big this equipment should be in the grid and whether it should be one solid rectangle or of a custom shape.


=== energy_source ===
{{Prototype property|categories|[[Types/table|table]] of [[Types/string|string]]}}
'''Type''': [[Types/EnergySource]]
An array of [[Prototype/EquipmentCategory]] names. Sets the categories of the equipment. It can only be inserted into [[Prototype/EquipmentGrid#equipment_categories|grids]] with at least one matching category.


{{Prototype property|energy_source|[[Types/EnergySource|EnergySource]]}}
Must be an electric energy source.
Must be an electric energy source.


== Optional properties ==
== Optional properties ==


=== ability_icon ===
{{Prototype property|take_result|[[Types/string|string]]|<code>name</code> of this prototype|optional=true}}
'''Type''': [[Types/Sprite]]
Name of the item prototype that should be returned to the player when they remove this equipment from an equipment grid.


=== take_result ===
{{Prototype property|background_color|[[Types/Color|Color]]|value of equipment_default_background_color in the utility constants|optional=true}}
'''Type''': [[Types/string]]
The color that the background of this equipment should have when shown inside an equipment grid.


'''Default''': <code>name</code> of the prototype
{{Prototype property|background_border_color|[[Types/Color|Color]]|value of equipment_default_background_border_color in the utility constants|optional=true}}
The color that the border of the background of this equipment should have when shown inside an equipment grid.


=== background_color ===
{{Prototype property|grabbed_background_color|[[Types/Color|Color]]|value of equipment_default_grabbed_background_color in the utility constants|optional=true}}
'''Type''': [[Types/Color]]
The color that the background of this equipment should have when held in the players hand and hovering over an equipment grid.

Revision as of 17:38, 30 July 2021

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

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.

background_border_color

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

grabbed_background_color

Type: Color
Default: value of equipment_default_grabbed_background_color in the utility constants
The color that the background of this equipment should have when held in the players hand and hovering over an equipment grid.