Module:Infobox Recipe/doc: Difference between revisions

From Brighter Shores Wiki
Jump to navigation Jump to search
Browse history interactively
Content added Content deleted
VisualWikitext
(update parameter list to include hideAlbum)
(remove the documentation that belonged to the Template, replaced with documentation that belongs to the module)
Tag: Replaced
 
Line 1:
{{Documentation}}
This module invoked using the command
The '''Infobox Recipe''' template is used to show the details of a recipe step in item articles, such as a potion mixture or adding a cooking ingredient. It can also be used to display the experience gained for item creation.
 
==Parameters==
{| class="wikitable"
! Parameter
! Format
! Usage
! Mandatory?
|-
| <code>facility</code>
| ''Link to facility''
| The name of the facility that is required to create the item; e.g. <code><nowiki>facility = Standard Potion Station</nowiki></code> will display
 
[[Standard Potion Station]]
| Yes
|-
| <code>duration</code>
| ''duration in seconds''
| The amount of time that the recipe takes to complete
| Yes
|-
| <code>profession</code>
| ''profession name''
| The profession in which experience is gained, or which has a level requirement, for creating the item
| Yes
|-
| <code>level</code>
| ''Integer''
| The level required in the profession to create the item.
| Yes
|-
| <code>exp</code>
| ''number''
| The amount of experience gained for performing the action.
| Yes
|-
| <code>kp</code>
| ''number''
| The amount of knowledge points gained for performing the action.
| Yes
|-
| <code>rawmat1</code>
| ''Exact name of the item''
| The primary item used for performing the craft. e.g. <code>Brown Kelp</code> for [[Brown Kelp]]
| Yes
|-
| <code>rawmat1qty</code>
| ''Integer''
| The amount of the material used in the process.
 
This parameter can be removed if it would be '''1'''
| No
|-
| <code>rawmat2</code>
| ''Exact name of the item''
| The secondary item used for performing the craft. e.g. <code>Brown Kelp</code> for [[Brown Kelp]]
| No
|-
| <code>rawmat2qty</code>
| ''Integer''
| The amount of the material used in the process.
 
This parameter can be removed if it would be '''1'''
| No
|-
| <code>rawmat3</code>
| ''Exact name of the item''
| The tertiary item used for performing the craft. e.g. <code>Brown Kelp</code> for [[Brown Kelp]]
| No
|-
| <code>rawmat3qty</code>
| ''Integer''
| The amount of the material used in the process.
 
This parameter can be removed if it would be '''1'''
| No
|-
| <code>rawmat4</code>
| ''Exact name of the item''
| The fourth item used for performing the craft. e.g. <code>Brown Kelp</code> for [[Brown Kelp]]
| No
|-
| <code>rawmat4qty</code>
| ''Integer''
| The amount of the material used in the process.
 
This parameter can be removed if it would be '''1'''
| No
|-
| <code>output1</code>
| ''Exact name of the item''
| The item created by performing the craft. e.g. <code>Brown Kelp</code> for [[Brown Kelp]]
| Yes
|-
| <code>output1qty</code>
| ''Integer''
| The amount of the output created in the process.
 
This parameter can be removed if it would be '''1'''
| No
|-
| <code>showFull</code>
| ''boolean''
| Flag to display all steps of a recipe or only the step specified in the params. Will show all steps back to buyable materials.
| No
|-
| <code>hideAlbum</code>
| ''boolean''
| Flag to hide the Album XP from the display, for items that do not award album xp. Defaults to false.
| No
|-
|}
 
==Examples==
===Show Single Step Recipe===
This is an example that uses values from the 10% Potion Healing recipe. Notice that this only shows information of the steps for which the information has been provided.
The <code>showFull</code> parameter can be omitted entirely if this is the desired outcome as the default value is <code>false</code>
<pre>
{{#invoke:Infobox Recipe|_main}}
|facility = Standard Potion Station
|duration = 7.5
|profession = Alchemist
|level = 0
|exp = 63
|kp = 1.5%
|rawmat1 = 10% Preparation Healing
|rawmat2 = Bottle
|output1 = 10% Potion Healing
|output1qty = 1
}}
</pre>
{{It provides this functionality to [[Template:Infobox Recipe]]
|facility = Standard Potion Station
|duration = 7.5
|profession = Alchemist
|level = 0
|exp = 63
|kp = 1.5%
|rawmat1 = 10% Preparation Healing
|rawmat2 = Bottle
|output1 = 10% Potion Healing
|output1qty = 1
}}
 
<includeonly>[[Category:Infobox templates]]</includeonly>
===Show Full Recipe===
This is an example that uses values from the 10% Potion Healing recipe. Notice that the parameters that have been passed to this example do not include 'Brown Kelp'
This is displayed because the <code>showFull</code> parameter has been set to <code>true</code>. This causes the Infobox Module to query smw data for each of the provided
raw materials to check if they have raw materials of their own. If they do, but cannot be bought from a shop, they are brought in to the recipe. The total xp and duration are also shown in brackets.
<pre>
{{Infobox Recipe
|facility = Standard Potion Station
|duration = 7.5
|profession = Alchemist
|level = 0
|exp = 63
|kp = 1.5
|rawmat1 = 10% Preparation Healing
|rawmat2 = Bottle
|output1 = 10% Potion Healing
|output1qty = 1
|showFull = true
}}
 
</pre>
{{Infobox Recipe
|facility = Standard Potion Station
|duration = 7.5
|profession = Alchemist
|level = 0
|exp = 63
|kp = 1.5
|rawmat1 = 10% Preparation Healing
|rawmat2 = Bottle
|output1 = 10% Potion Healing
|output1qty = 1
|showFull = true
}}
 
===Show Full Recipe with buyable items===
This is an example that uses values from the Hammerfist (Basic). As before, the parameters passed to this example are only the materials used in the final step, and the <code>showFull</code> parameter caused the full recipe tree to be displayed. The 'Coarse Hickory Pole' can be bought, so even though it can be crafted from Coarse Hickory Logs, it was not replaced with its own recipe tree. This allows <code>showFull</code> to be used for recipes that would otherwise span multiple professions, since in this example only the Stonemason steps are shown.
<pre>
{{Infobox Recipe
|facility = One Handed Melee Workbench (stonemason)
|profession = Stonemason
|level = 0
|exp = 250
|kp = 3
|rawmat1 = Coarse Flint (Etched)
|rawmat1qty = 2
|rawmat2 = Coarse Hickory Pole
|output1 = Hammerfist (basic)
|showFull = true
}}
 
</pre>
{{Infobox Recipe
|facility = One Handed Melee Workbench (stonemason)
|profession = Stonemason
|duration = 28
|level = 0
|exp = 250
|kp = 3
|rawmat1 = Coarse Flint (Etched)
|rawmat1qty = 2
|rawmat2 = Coarse Hickory Pole
|output1 = Hammerfist (basic)
|showFull = true
}}
 
 
==Blank infobox==
<pre>
{{Infobox Recipe
|facility =
|duration =
|profession =
|level =
|exp =
|kp =
|rawmat1 =
|rawmat1qty =
|rawmat2 =
|rawmat2qty =
|rawmat3 =
|rawmat3qty =
|output1 =
|output1qty =
|showFull =
|hideAlbum =
</pre><includeonly>[[Category:Infobox templates]]</includeonly>

Latest revision as of 12:56, 10 December 2024

This is a documentation subpage for Module:Infobox Recipe.
It contains usage information, categories, and other content that is not part of the original module page.
Module:Infobox Recipe's function _main is invoked by Template:Infobox Recipe.
Module:Infobox Recipe requires .
Module:Infobox Recipe loads data from Module:Experience/data.

This module invoked using the command 

{{#invoke:Infobox Recipe|_main}}

It provides this functionality to Template:Infobox Recipe


Retrieved from ‘https://brightershoreswiki.org/w/Module:Infobox_Recipe/doc?oldid=65748’