Prototype/Equipment - Revision history

BilkaBot: Removed old prototype docs

2024-10-25T14:32:49Z

Removed old prototype docs

← Older revision		Revision as of 14:32, 25 October 2024
Line 2:		Line 2:

	</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>		</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.~~

BilkaBot: Updated styling of prototype doc migration note

2023-09-21T10:43:02Z

Updated styling of prototype doc migration note

← Older revision		Revision as of 10:43, 21 September 2023
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>

BilkaBot: Protected "Prototype/Equipment": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2023-08-16T17:52:26Z

Protected "Prototype/Equipment": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

← Older revision		Revision as of 17:52, 16 August 2023
(No difference)

BilkaBot: Migrated prototype doc to separate website

2023-08-16T17:52:25Z

Migrated prototype doc to separate website

← Older revision		Revision as of 17:52, 16 August 2023
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]

			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].



	{{Prototype parent\|PrototypeBase}}		{{Prototype parent\|PrototypeBase}}
	Abstract base of all equipment modules. Equipment modules can be inserted into [[Prototype/EquipmentGrid]]s.		Abstract base of all equipment modules. Equipment modules can be inserted into [[Prototype/EquipmentGrid]]s.

Bilka: 1.1.36: ability_icon removed

2021-07-30T17:38:30Z

1.1.36: ability_icon removed

← Older revision		Revision as of 17:38, 30 July 2021
Line 31:		Line 31:

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

	~~{{Prototype property\|ability_icon\|[[Types/Sprite\|Sprite]]\|optional=true}}~~

	{{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}}

Bilka: 0.18.35

2020-07-08T08:32:30Z

0.18.35

← Older revision		Revision as of 08:32, 8 July 2020
Line 39:		Line 39:
	{{Prototype property\|background_color\|[[Types/Color\|Color]]\|value of equipment_default_background_color in the utility constants\|optional=true}}		{{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.

Bilka: background_color default is now defined in utility constants (0.18.12)

2020-03-11T15:30:00Z

background_color default is now defined in utility constants (0.18.12)

← Older revision		Revision as of 15:30, 11 March 2020
Line 37:		Line 37:
	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]]\|~~<nowiki>{r = 65, g = 76, b = 193}</nowiki>~~\|optional=true}}		{{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.

Bilka: included abstract in description

2019-08-08T19:16:26Z

included abstract in description

← Older revision		Revision as of 19:16, 8 August 2019
Line 1:		Line 1:
	{{Prototype parent\|PrototypeBase}}		{{Prototype parent\|PrototypeBase}}
	An equipment ~~module~~. ~~Can~~ be inserted into [[Prototype/EquipmentGrid]].		Abstract base of all equipment modules. Equipment modules can be inserted into [[Prototype/EquipmentGrid]]s.

	{{Prototype TOC\|''abstract''}}		{{Prototype TOC\|''abstract''}}

Bilka: words

2019-07-27T20:45:33Z

words

← Older revision		Revision as of 20:45, 27 July 2019
Line 25:		Line 25:

	{{Prototype property\|categories\|[[Types/table\|table]] of [[Types/string\|string]]}}		{{Prototype property\|categories\|[[Types/table\|table]] of [[Types/string\|string]]}}
	An array of ~~equipment-category~~ names. Sets the ~~category~~ of the equipment. It can only be inserted into ~~grids with that~~ [[Prototype/EquipmentGrid#equipment_categories\|~~category~~]].		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]]}}		{{Prototype property\|energy_source\|[[Types/EnergySource\|EnergySource]]}}
Line 37:		Line 37:
	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]]\|optional=true}}		{{Prototype property\|background_color\|[[Types/Color\|Color]]\|<nowiki>{r = 65, g = 76, b = 193}</nowiki>\|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.

Bilka: Converted to SMW format, added descriptions

2019-07-27T20:40:32Z

Converted to SMW format, added descriptions

← Older revision		Revision as of 20:40, 27 July 2019
Line 1:		Line 1:
	{{Prototype parent\|PrototypeBase}}		{{Prototype parent\|PrototypeBase}}
			An equipment module. Can be inserted into [[Prototype/EquipmentGrid]].

	~~== 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 equipment-category names. Sets the category of the equipment. It can only be inserted into grids with that [[Prototype/EquipmentGrid#equipment_categories\|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\|ability_icon\|[[Types/Sprite\|Sprite]]\|optional=true}}
	~~'''Type''':~~ [[Types/Sprite]]

	~~=== take_result~~ ===
	~~'''Type''': [[Types/string]]~~

	~~'''Default''':~~ <code>name</code> of the prototype		{{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.

	~~===~~ background_color ~~===~~		{{Prototype property\|background_color\|[[Types/Color\|Color]]\|optional=true}}
	~~'''Type''':~~ [[Types/Color]]		The color that the background of this equipment should have when shown inside an equipment grid.