Module:Infobox Recipe/doc: Difference between revisions

From Brighter Shores Wiki
Jump to navigation Jump to search
Content added Content deleted
(add in the duration and kp parameters)
(show function of stopping recipe tree at buyable items)
Line 103:
| <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
|-
Line 133:
|exp = 63
|kp = 1.5%
|duration = 28
|rawmat1 = 10% Preparation Healing
|rawmat2 = Bottle
Line 142 ⟶ 143:
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.
<pre>
{{Infobox Recipe
Line 155 ⟶ 156:
|output1 = 10% Potion Healing
|output1qty = 1
|showFull = true
}}
 
</pre>
{{Infobox Recipe
Line 169 ⟶ 170:
|output1 = 10% Potion Healing
|output1qty = 1
}}
 
===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
|level = 0
|exp = 250
|kp = 3
|rawmat1 = Coarse Flint (Etched)
|rawmat1qty = 2
|rawmat2 = Coarse Hickory Pole
|output1 = Hammerfist (Basic)
|showFull = true
}}
 
 
==Blank infobox==

Revision as of 20:21, 6 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 loads data from Module:Experience/data.

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

Parameter Format Usage Mandatory?
facility Link to facility The name of the facility that is required to create the item; e.g. facility = Standard Potion Station will display

Standard Potion Station

Yes
duration duration in seconds The amount of time that the recipe takes to complete Yes
profession profession name The profession in which experience is gained, or which has a level requirement, for creating the item Yes
level Integer The level required in the profession to create the item. Yes
exp number The amount of experience gained for performing the action. Yes
kp number The amount of knowledge points gained for performing the action. Yes
rawmat1 Exact name of the item The primary item used for performing the craft. e.g. Brown Kelp for Brown Kelp Yes
rawmat1qty Integer The amount of the material used in the process.

This parameter can be removed if it would be 1

No
rawmat2 Exact name of the item The secondary item used for performing the craft. e.g. Brown Kelp for Brown Kelp No
rawmat2qty Integer The amount of the material used in the process.

This parameter can be removed if it would be 1

No
rawmat3 Exact name of the item The tertiary item used for performing the craft. e.g. Brown Kelp for Brown Kelp No
rawmat3qty Integer The amount of the material used in the process.

This parameter can be removed if it would be 1

No
rawmat4 Exact name of the item The fourth item used for performing the craft. e.g. Brown Kelp for Brown Kelp No
rawmat4qty Integer The amount of the material used in the process.

This parameter can be removed if it would be 1

No
output1 Exact name of the item The item created by performing the craft. e.g. Brown Kelp for Brown Kelp Yes
output1qty Integer The amount of the output created in the process.

This parameter can be removed if it would be 1

No
showFull 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

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 showFull parameter can be omitted entirely if this is the desired outcome as the default value is false

{{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
}}
Requirements
Facility Standard Potion Station
Experience63
Duration28 seconds
ProfessionLevelKPAlbum XP
Alchemist01.5%%250 xp
Raw IngredientQuantityCost
10% Preparation Healing10Copper
Bottle120Copper
Total Raw cost20Copper
OutputQuantityValue
10% Potion Healing1450Copper
Profit430Copper

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 showFull parameter has been set to true. 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.

{{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
}}

Requirements
Facility Standard Potion Station
Experience63
Duration7.5 seconds
ProfessionLevelKPAlbum XP
Alchemist01.5%%250 xp
Raw IngredientQuantityCost
10% Preparation Healing10Copper
Bottle120Copper
Total Raw cost20Copper
OutputQuantityValue
10% Potion Healing1450Copper
Profit430Copper

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 showFull 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 showFull to be used for recipes that would otherwise span multiple professions, since in this example only the Stonemason steps are shown.

{{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
}}

Requirements
Facility One Handed Melee Workbench (stonemason)
Experience250 (324 total)
Duration? (edit) (? total)
ProfessionLevelKPAlbum XP
Stonemason03%250 xp
Raw IngredientQuantityCost
Coarse Hickory Pole1742Copper
Coarse Flint2750Copper
Total Raw cost1Silver492Copper
Intermediate IngredientQuantityFaciltity
Coarse Flint (Etched)2 T.E.A. Machine
OutputQuantityValue
File:Hammerfist (Basic).pngHammerfist (Basic)10Copper
Profit-1Silver492Copper


Blank infobox

{{Infobox Recipe
|facility = 
|duration = 
|profession = 
|level = 
|exp = 
|kp = 
|rawmat1 = 
|rawmat1qty = 
|rawmat2 = 
|rawmat2qty = 
|rawmat3 = 
|rawmat3qty = 
|output1 = 
|output1qty =