Prototype/Module: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(→‎Mandatory properties: expanded descriptions)
(Removed old prototype docs)
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Prototype parent|Prototype/Item}}
<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]
A [[module]].


{{Prototype TOC|module}}
</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>
 
== 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|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_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.

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/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 on the forums.

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