EquipmentPrototype - Prototype Docs

Home / Prototypes / EquipmentPrototype><

EquipmentPrototype - abstract

Abstract base of all equipment modules. Equipment modules can be inserted into equipment grids.

Inherits from PrototypeBase

Children

ActiveDefenseEquipmentPrototype - 'active-defense-equipment'
BatteryEquipmentPrototype - 'battery-equipment'
BeltImmunityEquipmentPrototype - 'belt-immunity-equipment'
EnergyShieldEquipmentPrototype - 'energy-shield-equipment'
GeneratorEquipmentPrototype - 'generator-equipment'
MovementBonusEquipmentPrototype - 'movement-bonus-equipment'
NightVisionEquipmentPrototype - 'night-vision-equipment'
RoboportEquipmentPrototype - 'roboport-equipment'
SolarPanelEquipmentPrototype - 'solar-panel-equipment'

Properties

default

sorted

sprite	:: Sprite	The graphics to use when this equipment is shown inside an equipment grid.
The graphics to use when this equipment is shown inside an equipment grid.
shape	:: EquipmentShape	How big this equipment should be in the grid and whether it should be one solid rectangle or of a custom shape.
How big this equipment should be in the grid and whether it should be one solid rectangle or of a custom shape.
categories	:: array[EquipmentCategoryID]	Sets the categories of the equipment. [...]
Sets the categories of the equipment. [...]
energy_source	:: ElectricEnergySource
take_result optional	:: ItemID	Name of the item prototype that should be returned to the player when they remove this equipment from an equipment grid.
Name of the item prototype that should be returned to the player when they remove this equipment from an equipment grid.
background_color optional	:: Color	The color that the background of this equipment should have when shown inside an equipment grid.
The color that the background of this equipment should have when shown inside an equipment grid.
background_border_color optional	:: Color	The color that the border of the background of this equipment should have when shown inside an equipment grid.
The color that the border of the background of this equipment should have when shown inside an equipment grid.
grabbed_background_color optional	:: Color	The color that the background of this equipment should have when held in the players hand and hovering over an equipment grid.
The color that the background of this equipment should have when held in the players hand and hovering over an equipment grid.

Inherited from PrototypeBase

type	:: string	Specifies the kind of prototype this is. [...]
Specifies the kind of prototype this is. [...]
name	:: string	Unique textual identification of the prototype. [...]
Unique textual identification of the prototype. [...]
order optional	:: Order	Used to order prototypes in inventory, recipes and GUIs. [...]
Used to order prototypes in inventory, recipes and GUIs. [...]
localised_name optional	:: LocalisedString	Overwrites the name set in the locale file. [...]
Overwrites the name set in the locale file. [...]
localised_description optional	:: LocalisedString	Overwrites the description set in the locale file. [...]
Overwrites the description set in the locale file. [...]

categories	:: array[EquipmentCategoryID]	Sets the categories of the equipment. [...]
Sets the categories of the equipment. [...]
energy_source	:: ElectricEnergySource
shape	:: EquipmentShape	How big this equipment should be in the grid and whether it should be one solid rectangle or of a custom shape.
How big this equipment should be in the grid and whether it should be one solid rectangle or of a custom shape.
sprite	:: Sprite	The graphics to use when this equipment is shown inside an equipment grid.
The graphics to use when this equipment is shown inside an equipment grid.
background_border_color optional	:: Color	The color that the border of the background of this equipment should have when shown inside an equipment grid.
The color that the border of the background of this equipment should have when shown inside an equipment grid.
background_color optional	:: Color	The color that the background of this equipment should have when shown inside an equipment grid.
The color that the background of this equipment should have when shown inside an equipment grid.
grabbed_background_color optional	:: Color	The color that the background of this equipment should have when held in the players hand and hovering over an equipment grid.
The color that the background of this equipment should have when held in the players hand and hovering over an equipment grid.
take_result optional	:: ItemID	Name of the item prototype that should be returned to the player when they remove this equipment from an equipment grid.
Name of the item prototype that should be returned to the player when they remove this equipment from an equipment grid.

Inherited from PrototypeBase

name	:: string	Unique textual identification of the prototype. [...]
Unique textual identification of the prototype. [...]
type	:: string	Specifies the kind of prototype this is. [...]
Specifies the kind of prototype this is. [...]
localised_description optional	:: LocalisedString	Overwrites the description set in the locale file. [...]
Overwrites the description set in the locale file. [...]
localised_name optional	:: LocalisedString	Overwrites the name set in the locale file. [...]
Overwrites the name set in the locale file. [...]
order optional	:: Order	Used to order prototypes in inventory, recipes and GUIs. [...]
Used to order prototypes in inventory, recipes and GUIs. [...]

Properties

sprite :: Sprite

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

shape :: EquipmentShape

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

categories :: array[EquipmentCategoryID]

Sets the categories of the equipment. It can only be inserted into grids with at least one matching category.

energy_source :: ElectricEnergySource

take_result :: ItemID optional

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 :: Color optional

Default: equipment_default_background_color in utility constants

The color that the background of this equipment should have when shown inside an equipment grid.

background_border_color :: Color optional

Default: equipment_default_background_border_color in utility constants

The color that the border of the background of this equipment should have when shown inside an equipment grid.

grabbed_background_color :: Color optional

Default: equipment_default_grabbed_background_color in utility constants

The color that the background of this equipment should have when held in the players hand and hovering over an equipment grid.

Factorio Prototype Docs Version 1.1.107

EquipmentPrototype - abstract

Properties

Properties

sprite :: Sprite

shape :: EquipmentShape

categories :: array[EquipmentCategoryID]

energy_source :: ElectricEnergySource

take_result :: ItemID optional

background_color :: Color optional

background_border_color :: Color optional

grabbed_background_color :: Color optional

Prototypes

Types

Factorio Prototype DocsVersion 1.1.107

EquipmentPrototype - abstract

Properties

Properties

sprite :: Sprite

shape :: EquipmentShape

categories :: array[EquipmentCategoryID]

energy_source :: ElectricEnergySource

take_result :: ItemID optional

background_color :: Color optional

background_border_color :: Color optional

grabbed_background_color :: Color optional

Prototypes

Types

Factorio Prototype Docs Version 1.1.107