PrototypeBase: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(→‎Optional properties: Added descriptions)
(Removed old prototype docs)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Prototype parent}}
<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/PrototypeBase.html https://lua-api.factorio.com/latest/prototypes/PrototypeBase.html]
The abstract base for all prototypes. All prototypes inherit from this prototype.


{{Prototype TOC|''abstract''}}
</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 ==
 
{{Prototype_property|type|[[Types/string|string]]}}
Specification of the type of the prototype.
 
For a list of all available types and their properties, see [[prototype definitions]]. For a list of all types used in vanilla, see [[data.raw]].
 
{{Prototype_property|name|[[Types/string|string]]}}
Unique textual identification of the prototype.
 
For a list of all names used in vanilla, see [[data.raw]].
 
May not contain <code>.</code>, may not exceed a length of 200 characters.
 
== Optional properties ==
 
{{Prototype_property|order|[[Types/Order|Order]]|optional=true}}
Used to order items in inventory, recipes and GUI's.
 
May not exceed a length of 200 characters.
 
{{Prototype_property|localised_name|[[Types/LocalisedString|LocalisedString]]|optional=true}}
Overwrites the name set in the [[Tutorial:Localisation#Localising_simple_strings|locale file]]. Can be used to easily set a procedurally-generated name because the LocalisedString format allows to insert parameters into the name directly from the Lua script.
 
{{Prototype_property|localised_description|[[Types/LocalisedString|LocalisedString]]|optional=true}}
Overwrites the description set in the [[Tutorial:Localisation#Localising_simple_strings|locale file]]. The description is usually shown in the tooltip of the prototype.

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/PrototypeBase.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=PrototypeBase&oldid=202823"