Prototype/Equipment: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Migrated prototype doc to separate website)
(Removed old prototype docs)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
'''The prototype docs have moved to a new website with an improved format.''' This documentation page can now be found here: [https://lua-api.factorio.com/latest/prototypes/EquipmentPrototype.html https://lua-api.factorio.com/latest/prototypes/EquipmentPrototype.html]
<div class="stub"><p>'''The prototype docs have moved to a new website with an improved format.''' This documentation page can now be found here: [https://lua-api.factorio.com/latest/prototypes/EquipmentPrototype.html https://lua-api.factorio.com/latest/prototypes/EquipmentPrototype.html]


This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].
</p><p>This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div>
 
 
 
{{Prototype parent|PrototypeBase}}
Abstract base of all equipment modules. Equipment modules can be inserted into [[Prototype/EquipmentGrid]]s.
 
{{Prototype TOC|''abstract''}}
 
== 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]].
 
{{Prototype property|sprite|[[Types/Sprite|Sprite]]}}
The graphics to use when this equipment is shown inside an equipment 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.
 
{{Prototype property|categories|[[Types/table|table]] of [[Types/string|string]]}}
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 ==
 
{{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.
 
{{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.
 
{{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 14:32, 25 October 2024

The prototype docs have moved to a new website with an improved format. This documentation page can now be found here: https://lua-api.factorio.com/latest/prototypes/EquipmentPrototype.html

This wiki page is no longer updated and will be removed at some point in the future, so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback on the forums.

Retrieved from "https://wiki.factorio.com/index.php?title=Prototype/Equipment&oldid=202889"