Prototype/Equipment: Difference between revisions

Latest 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

Prototype/ActiveDefenseEquipment active-defense-equipment
Prototype/BatteryEquipment battery-equipment
Prototype/BeltImmunityEquipment belt-immunity-equipment
Prototype/EnergyShieldEquipment energy-shield-equipment
Prototype/GeneratorEquipment generator-equipment
Prototype/MovementBonusEquipment movement-bonus-equipment
Prototype/NightVisionEquipment night-vision-equipment
Prototype/RoboportEquipment roboport-equipment
Prototype/SolarPanelEquipment solar-panel-equipment

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.

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.

@@ Line 1: / Line 1: @@
-== Basics ==
+{{Prototype parent|PrototypeBase}}
-An equipment module. Extends [[Prototype]].
+Abstract base of all equipment modules. Equipment modules can be inserted into [[Prototype/EquipmentGrid]]s.
-== Mandatory properties ==
+{{Prototype TOC|''abstract''}}
-Inherits all properties from [[Prototype]].
-=== sprite ===
+== Extensions ==
-'''Type''': [[Types/Sprite]]
+* [[Prototype/ActiveDefenseEquipment]] '''active-defense-equipment'''
+* [[Prototype/BatteryEquipment]] '''battery-equipment'''
+* [[Prototype/BeltImmunityEquipment]] '''belt-immunity-equipment'''
+* [[Prototype/EnergyShieldEquipment]] '''energy-shield-equipment'''
+* [[Prototype/GeneratorEquipment]] '''generator-equipment'''
+* [[Prototype/MovementBonusEquipment]] '''movement-bonus-equipment'''
+* [[Prototype/NightVisionEquipment]] '''night-vision-equipment'''
+* [[Prototype/RoboportEquipment]] '''roboport-equipment'''
+* [[Prototype/SolarPanelEquipment]] '''solar-panel-equipment'''
-=== shape ===
+== Mandatory properties ==
-'''Type''': [[Types/EquipmentShape]]
+Inherits all properties from [[PrototypeBase]].
-=== categories ===
+{{Prototype property|sprite|[[Types/Sprite|Sprite]]}}
-'''Type''': [[Types/table]] of [[Types/string]]
+The graphics to use when this equipment is shown inside an equipment grid.
-An array of equipment-category names. Only equipment with this category can be inserted into the grid.
+{{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.
 == 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.