Prototype/Module - Revision history

BilkaBot: Removed old prototype docs

2024-10-25T14:32:56Z

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\|Prototype/Item}}~~
	~~A [[module]].~~

	~~{{Prototype TOC\|module}}~~

	~~== Mandatory properties ==~~
	~~This prototype inherits all the properties from [[Prototype/Item]].~~

	~~{{Prototype property\|category\|[[Types/string\|string]]}}~~
	~~The name of a [[Prototype/ModuleCategory]]. Used when upgrading modules: Ctrl + click modules into an entity and it will replace lower tier modules of the same category with higher tier modules.~~

	~~{{Prototype property\|tier\|[[Types/uint32\|uint32]]}}~~
	~~Tier of the module inside its category. Used when upgrading modules: Ctrl + click modules into an entity and it will replace lower tier modules with higher tier modules if they have the same category.~~

	~~{{Prototype property\|effect\|[[Types/Effect\|Effect]]}}~~

	~~== Optional properties ==~~

	~~{{Prototype property\|requires_beacon_alt_mode\|[[Types/bool\|bool]]\|true\|optional=true}}~~

	~~{{Prototype property\|limitation\|[[Types/table\|table]] of [[Types/string\|string]]\|optional=true}}~~
	~~Array of recipe names this module can be used on. If empty, the module can be used on all recipes.~~

	~~{{Prototype property\|limitation_blacklist\|[[Types/table\|table]] of [[Types/string\|string]]\|optional=true}}~~
	~~Array of recipe names this module can '''not''' be used on, implicitly allowing its use on all other recipes. This property has no effect if set to an empty table.~~

	Note that the game converts this into a normal list of limitations internally, so reading [https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.limitations LuaItemPrototype.limitations] at runtime will be the product of both ways of defining limitations.

	~~{{Prototype property\|limitation_message_key\|[[Types/string\|string]]\|optional=true}}~~
	Mandatory when <code>limitation</code> is present. The locale key of the message that is shown when the player attempts to use the module on a recipe it can't be used on. The locale key will be prefixed with <code>item-limitation.</code> (the "category" of the locale) by the game.

	~~{{Prototype property\|art_style\|[[Types/string\|string]]\|optional=true}}~~
	~~Chooses with what art style the module is shown inside beacons. See [[Types/BeaconModuleVisualizations#art_style]]. Vanilla uses "vanilla" here.~~

	~~{{Prototype property\|beacon_tint\|[[Types/table\|table]] of [[Types/Color\|Color]]\|optional=true}}~~
	~~Format:~~
	~~<syntaxhighlight lang="lua">beacon_tint = { primary = {r=1,g=1,b=1,a=1}, secondary = {r=1,g=1,b=1,a=1}, tertiary = {r=1,g=1,b=1,a=1}, quaternary = {r=1,g=1,b=1,a=1}}</syntaxhighlight>~~
	~~Each key/value pair is optional and defaults to no color.~~

BilkaBot: Updated styling of prototype doc migration note

2023-09-21T10:43:16Z

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/ModulePrototype.html https://lua-api.factorio.com/latest/prototypes/ModulePrototype.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/ModulePrototype.html https://lua-api.factorio.com/latest/prototypes/ModulePrototype.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/Module": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2023-08-16T17:52:51Z

Protected "Prototype/Module": 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:51Z

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/ModulePrototype.html https://lua-api.factorio.com/latest/prototypes/ModulePrototype.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\|Prototype/Item}}		{{Prototype parent\|Prototype/Item}}
	A [[module]].		A [[module]].

Therenas: Add limitation_blacklist property

2020-12-27T15:16:46Z

Add limitation_blacklist property

← Older revision		Revision as of 15:16, 27 December 2020
Line 21:		Line 21:
	{{Prototype property\|limitation\|[[Types/table\|table]] of [[Types/string\|string]]\|optional=true}}		{{Prototype property\|limitation\|[[Types/table\|table]] of [[Types/string\|string]]\|optional=true}}
	Array of recipe names this module can be used on. If empty, the module can be used on all recipes.		Array of recipe names this module can be used on. If empty, the module can be used on all recipes.

			{{Prototype property\|limitation_blacklist\|[[Types/table\|table]] of [[Types/string\|string]]\|optional=true}}
			Array of recipe names this module can '''not''' be used on, implicitly allowing its use on all other recipes. This property has no effect if set to an empty table.

			Note that the game converts this into a normal list of limitations internally, so reading [https://lua-api.factorio.com/latest/LuaItemPrototype.html#LuaItemPrototype.limitations LuaItemPrototype.limitations] at runtime will be the product of both ways of defining limitations.

	{{Prototype property\|limitation_message_key\|[[Types/string\|string]]\|optional=true}}		{{Prototype property\|limitation_message_key\|[[Types/string\|string]]\|optional=true}}

Bilka: 0.18.32: hr beacon

2020-07-23T11:01:18Z

0.18.32: hr beacon

@@ Line 16: / Line 16: @@
 == Optional properties ==
 {{Prototype property|limitation|[[Types/table|table]] of [[Types/string|string]]|optional=true}}
@@ Line 22: / Line 24: @@
 {{Prototype property|limitation_message_key|[[Types/string|string]]|optional=true}}
 Mandatory when <code>limitation</code> is present. The locale key of the message that is shown when the player attempts to use the module on a recipe it can't be used on. The locale key will be prefixed with <code>item-limitation.</code> (the "category" of the locale) by the game.

Bilka: /* Mandatory properties */ expanded descriptions

2019-08-05T14:09:25Z

Mandatory properties: expanded descriptions

← Older revision		Revision as of 14:09, 5 August 2019
Line 8:		Line 8:

	{{Prototype property\|category\|[[Types/string\|string]]}}		{{Prototype property\|category\|[[Types/string\|string]]}}
	The name of a ~~module category. Used when upgrading modules. Must match the name of a registered~~ [[Prototype/ModuleCategory]].		The name of a [[Prototype/ModuleCategory]]. Used when upgrading modules: Ctrl + click modules into an entity and it will replace lower tier modules of the same category with higher tier modules.

	{{Prototype property\|tier\|[[Types/uint32\|uint32]]}}		{{Prototype property\|tier\|[[Types/uint32\|uint32]]}}
			Tier of the module inside its category. Used when upgrading modules: Ctrl + click modules into an entity and it will replace lower tier modules with higher tier modules if they have the same category.

	{{Prototype property\|effect\|[[Types/Effect\|Effect]]}}		{{Prototype property\|effect\|[[Types/Effect\|Effect]]}}

Deadlock989: /* Mandatory properties */

2019-08-05T10:47:35Z

Mandatory properties

← Older revision		Revision as of 10:47, 5 August 2019
Line 8:		Line 8:

	{{Prototype property\|category\|[[Types/string\|string]]}}		{{Prototype property\|category\|[[Types/string\|string]]}}
	The name of a module category.		The name of a module category. Used when upgrading modules. Must match the name of a registered [[Prototype/ModuleCategory]].

	{{Prototype property\|tier\|[[Types/uint32\|uint32]]}}		{{Prototype property\|tier\|[[Types/uint32\|uint32]]}}

Bilka: Converted to SMW format

2019-07-26T16:01:58Z

Converted to SMW format

← Older revision		Revision as of 16:01, 26 July 2019
Line 1:		Line 1:
	{{Prototype parent\|Prototype/Item}}		{{Prototype parent\|Prototype/Item}}
			A [[module]].

	~~== Basics ==~~		{{Prototype TOC\|module}}
	Prototype ~~type: '''~~module~~'''~~

	~~A [[module]]. Extends [[Prototype/Item]].~~

	== Mandatory properties ==		== Mandatory properties ==
	This prototype inherits all the properties from [[Prototype/Item]].		This prototype inherits all the properties from [[Prototype/Item]].

	~~===~~ category ~~===~~		{{Prototype property\|category\|[[Types/string\|string]]}}
	~~'''Type''':~~ [[Types/string]]

	The name of a module category.		The name of a module category.

	~~===~~ tier ~~===~~		{{Prototype property\|tier\|[[Types/uint32\|uint32]]}}
	~~'''Type''':~~ [[Types/uint32]]

	~~===~~ effect ~~===~~		{{Prototype property\|effect\|[[Types/Effect\|Effect]]}}
	~~'''Type''':~~ [[Types/Effect]]

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

	~~===~~ limitation ~~===~~		{{Prototype property\|limitation\|[[Types/table\|table]] of [[Types/string\|string]]\|optional=true}}
	~~'''Type''':~~ [[Types/table]] of [[Types/string]]

	Array of recipe names this module can be used on. If empty, the module can be used on all recipes.		Array of recipe names this module can be used on. If empty, the module can be used on all recipes.

	~~===~~ limitation_message_key ~~===~~		{{Prototype property\|limitation_message_key\|[[Types/string\|string]]\|optional=true}}
	~~'''Type''':~~ [[Types/string]]

	Mandatory when <code>limitation</code> is present. The locale key of the message that is shown when the player attempts to use the module on a recipe it can't be used on. The locale key will be prefixed with <code>item-limitation.</code> (the "category" of the locale) by the game.		Mandatory when <code>limitation</code> is present. The locale key of the message that is shown when the player attempts to use the module on a recipe it can't be used on. The locale key will be prefixed with <code>item-limitation.</code> (the "category" of the locale) by the game.

Bilka: Set prototype parent

2019-07-24T15:26:22Z

Set prototype parent

← Older revision		Revision as of 15:26, 24 July 2019
Line 1:		Line 1:
			{{Prototype parent\|Prototype/Item}}

	== Basics ==		== Basics ==
	Prototype type: '''module'''		Prototype type: '''module'''