Difference between revisions of "Recipe/Documentation"
Stratonian (talk | contribs) m (→Parameters: professions parameter) |
Stratonian (talk | contribs) m (→Parameters: better parameters) |
||
| Line 8: | Line 8: | ||
{{parameter|icon|The item's icon.|<nowiki>{{PAGENAME}}.png</nowiki>|Only use if the icon name differs from the name of the page.}} | {{parameter|icon|The item's icon.|<nowiki>{{PAGENAME}}.png</nowiki>|Only use if the icon name differs from the name of the page.}} | ||
{{parameter|name|The name of the item created.|<nowiki>{{PAGENAME}}</nowiki>|Only use if the item name differs from the name of the page.}} | {{parameter|name|The name of the item created.|<nowiki>{{PAGENAME}}</nowiki>|Only use if the item name differs from the name of the page.}} | ||
| − | {{parameter|crafted using|The object that the player must interact with to use the recipe.||e.g. '<code>Alchemy Workbench</code>'}} | + | {{parameter|crafted using|The object that the player must interact with to use the recipe.||e.g. '<code>Alchemy#Workbench</code>'. Automatically set to '<code>{{{professions}}}#Workbench</code>' if exactly one profession is listed in <code>professions</code>.}} |
{{parameter|learned from|The source that the recipe is learned from.||Set to '<code>automatic</code>' if learnt by default.}} | {{parameter|learned from|The source that the recipe is learned from.||Set to '<code>automatic</code>' if learnt by default.}} | ||
{{parameter|ingredients|A comma-separated list of recipe ingredients and their respective quantities.||e.g. [quantity1] [ingredient1], [quantity2] [ingredient2]}} | {{parameter|ingredients|A comma-separated list of recipe ingredients and their respective quantities.||e.g. [quantity1] [ingredient1], [quantity2] [ingredient2]}} | ||
{{parameter|quantity|The output quantity of the recipe.|1}} | {{parameter|quantity|The output quantity of the recipe.|1}} | ||
{{parameter|professions|The comma-separated professions required to craft the recipe.|}} | {{parameter|professions|The comma-separated professions required to craft the recipe.|}} | ||
Revision as of 22:41, 20 August 2023
Description
Creates a table defining a recipe or refinery. Used in the 'Acquisition' section of most items. The 'Used In' section of items will be filled in automatically by {{Recipe list}}.
Usage
{{Recipe|<name=name>|<icon=icon>|<crafted using=crafted using>|<learned from=learned from>|<ingredients=ingredients>|<quantity=quantity>|<professions=professions>}}
Parameters
icon: The item's icon.- Optional. Defaults to '
{{PAGENAME}}.png'. - Notes: Only use if the icon name differs from the name of the page.
- name: The name of the item created.
- Optional. Defaults to '
{{PAGENAME}}'. - Notes: Only use if the item name differs from the name of the page.
- crafted using: The object that the player must interact with to use the recipe.
- Optional.
- Notes: e.g. '
Alchemy#Workbench'. Automatically set to '{{{professions}}}#Workbench' if exactly one profession is listed inprofessions.
- learned from: The source that the recipe is learned from.
- Optional.
- Notes: Set to '
automatic' if learnt by default.
- ingredients: A comma-separated list of recipe ingredients and their respective quantities.
- Optional.
- Notes: e.g. [quantity1] [ingredient1], [quantity2] [ingredient2]
- quantity: The output quantity of the recipe.
- Optional. Defaults to '
1'.
- professions: The comma-separated professions required to craft the recipe.
- Optional.