Prototype/Equipment: Difference between revisions
m (words) |
(1.1.36: ability_icon removed) |
||
| (3 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. | |||
{{Prototype TOC|''abstract''}} | {{Prototype TOC|''abstract''}} | ||
| Line 31: | Line 31: | ||
== Optional properties == | == Optional properties == | ||
{{Prototype property|take_result|[[Types/string|string]]|<code>name</code> of this prototype|optional=true}} | {{Prototype property|take_result|[[Types/string|string]]|<code>name</code> of this prototype|optional=true}} | ||
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. | ||
{{Prototype property|background_color|[[Types/Color|Color]]| | {{Prototype property|background_color|[[Types/Color|Color]]|value of equipment_default_background_color in the utility constants|optional=true}} | ||
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. | ||
{{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. | |||
{{Prototype property|grabbed_background_color|[[Types/Color|Color]]|value of equipment_default_grabbed_background_color in the utility constants|optional=true}} | |||
The color that the background of this equipment should have when held in the players hand and hovering over an equipment grid. | |||
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.
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.