Difference between revisions of "Template:Qualityprice/doc"

Latest revision as of 23:38, 15 March 2023

Description

This template displays prices for items of specified qualities, formatted appropriately for the language where they appear. The image of the item is included (with any quality stars) instead of the gold icon. The size of the image is always 24px.

Parameters

Parameter	Notes
First (unnamed) parameter	Name of image (minus ".png")
Second (unnamed) parameter	Normal/base sell price of item (can be found in `ObjectInformation.xnb`) or Normal/base sell price of item used to make Artisan Good (see examples below) Note: also accepts non-numbers such as "3x base fruit price" without throwing an error
quality	Single quality to display. Defaults to all qualities (normal, silver, gold, iridium) if omitted. Items that exist in normal quality only do not have to specify `quality=normal` (i.e., Cave Carrot, Ginger, Green Tea, Honey, Jelly, Juice, Oil, Pickles, Qi Fruit, and Tea Leaves) Note: Other items may be added in the future. In the meantime, specifying `quality=normal` will work.
hide	Qualities to hide (e.g., `hide=silver,gold`)
pm	Profession modifier Tiller gives a 10% bonus, so specify `pm=1.1` Angler gives a 50% bonus, so specify `pm=1.5` etc.
dsv	data-sort-value Set to `false` if the quality price(s) are displayed in a non-sortable structure (like an infobox) Default value is `true` (the entire parameter can be omitted if a data-sort-value is desired).

Examples

Template Call Result

{{Qualityprice|Melon|250}}

	250g
	312g
	375g
	500g

{{Qualityprice|Parsnip|35|pm=1.1}}

	38g
	47g
	57g
	77g

{{Qualityprice|Ginger|60}}

60g

{{Qualityprice|Goat Cheese|400|hide=normal,silver}}

	600g
	800g

{{Qualityprice|Large Goat Milk FR|345}}

	345g
	431g
	517g
	690g

{{Qualityprice|Juice|260}}
(The base sell price of Red Cabbage is 260,
and the base sell price of Red Cabbage Juice is 585)

585g

{{Qualityprice|Wine|750|pm=1.4}}
(The base sell price of Starfruit is 750,
and the Artisan base sell price of Starfruit Wine is 3,150)

	3,150g
	3,936g
	4,725g
	6,300g

{{Qualityprice|Honey|30}}
(The base sell price of a Tulip is 30,
and the base sell price of Tulip Honey is 160)

160g

@@ Line 1: / Line 1: @@
-{{Construction}}
+==Description==
-[[Template:Qualityprice|Qualityprice]] displays a table of the sell prices for a requested item for all item qualities.  Each sell price is shown with the image icon and a superimposed quality star (see [[Template:Quality]]).  It intentionally does not show the money icon so as to not clutter the page with multiple icons.
+This template displays prices for items of specified qualities, formatted appropriately for the language where they appear. The image of the item is included (with any quality stars) instead of the gold icon. The size of the image is always 24px.
-In order for the values to be calculated correctly, the input value should always be the item base cost.  If other factors should be included (''e.g.,'' professions that increase the price), those factors should be specified using the <samp>pm</samp> parameter.
+==Parameters==
+{|class="wikitable sortable"
+|-
+!Parameter
+!Notes
+|-
+|First (unnamed) parameter
+|Name of image (minus ".png")
+|-
+|Second (unnamed) parameter
+|Normal/base sell price of item (can be found in <samp>ObjectInformation.xnb</samp>)<br />''or''<br />Normal/base sell price of item used to make [[Artisan Goods|Artisan Good]] (see examples below)<br />Note: also accepts non-numbers such as "3x base fruit price" without throwing an error
+|-
+|quality
+|Single quality to display.<br />Defaults to all qualities (normal, silver, gold, iridium) if omitted.<br />Items that exist in normal quality only do not have to specify <samp>quality=normal</samp> (''i.e.,'' [[Cave Carrot]], [[Ginger]], [[Green Tea]], [[Honey]], [[Jellies and Pickles|Jelly]], [[Juice]], [[Oil]], [[Jellies and Pickles|Pickles]], [[Qi Fruit]], and [[Tea Leaves]])<div style="font-size: smaller;">''Note: Other items may be added in the future. In the meantime, specifying <samp>quality=normal</samp> will work.''</div>
+|-
+|hide
+|Qualities to hide<br />(''e.g.,'' <samp>hide=silver,gold</samp>)
+|-
+|pm
+|Profession modifier<br />[[Skills#Farming|Tiller]] gives a 10% bonus, so specify <samp>pm=1.1</samp><br />[[Skills#Fishing|Angler]] gives a 50% bonus, so specify <samp>pm=1.5</samp><br />etc.
+|-
+|dsv
+|data-sort-value<br />Set to <samp>false</samp> if the quality price(s) are displayed in a non-sortable structure (like an infobox)<br />Default value is <samp>true</samp> (the entire parameter can be omitted if a data-sort-value is desired).
+|-
+|}
-For variable price items (Wine, Juice, Pickles, Jelly, Honey), this template also allows the item base price to be automatically calculated from the source item price.
+==Examples==
+{|class="wikitable sortable"
-Additionally, a sortkey is provided allowing correct sorting in tables where a column contains multiple instances of this template.
+|-
+!Template Call
-==Use==
+!Result
-===Syntax===
+|-
-Basic usage:
+|<code><nowiki>{{Qualityprice|Melon|250}}</nowiki></code>
- <nowiki>{{</nowiki>[[Template:Qualityprice|Qualityprice]] |''item_name''| ''base_cost'' <nowiki>}}</nowiki>
+|{{Qualityprice|Melon|250}}
+|-
-Complete argument list:
+|<code><nowiki>{{Qualityprice|Parsnip|35|pm=1.1}}</nowiki></code>
+|{{Qualityprice|Parsnip|35|pm=1.1}}
- <nowiki>{{</nowiki>[[Template:Qualityprice|Qualityprice]] |''item_name''| ''base_cost'' | prof_mult=''mult'' | quality=''values''
+|-
-                | hide=''values'' | sortkey=''value'' <nowiki>}}</nowiki>
+|<code><nowiki>{{Qualityprice|Ginger|60}}</nowiki></code>
+|{{Qualityprice|Ginger|60}}
-===Parameters===
+|-
-There are two unnamed, required parameters, ''item_name'' and ''base_cost''.  All other parameters are named and optional.  Default value for all arguments is empty, unless specified otherwise.
+|<code><nowiki>{{Qualityprice|Goat Cheese|400|hide=normal,silver}}</nowiki></code>
+|{{Qualityprice|Goat Cheese|400|hide=normal,silver}}
-* '''''item_name'''''
+|-
-** First unnamed parameter, required.
+|<code><nowiki>{{Qualityprice|Large Goat Milk FR|345}}</nowiki></code>
-** Name of item being displayed. There should be a corresponding image named <samp>File:item name.png</samp>.
+|{{Qualityprice|Large Goat Milk FR|345}}
-** On non-english wikis this should be the '''English''' item name.
+|-
+|<code><nowiki>{{Qualityprice|Juice|260}}</nowiki></code><br />(The base sell price of [[Red Cabbage]] is 260,<br />and the base sell price of Red Cabbage Juice is 585)
-* '''''base_cost'''''
+|{{Qualityprice|Juice|260}}
-** Second unnamed parameter.
+|-
-** Required unless <samp>srcprice</samp> and <samp>auto</samp> are specified AND the item is one whose price can be auto-calculated.
+|<code><nowiki>{{Qualityprice|Wine|750|pm=1.4}}</nowiki></code><br />(The base sell price of [[Starfruit]] is 750,<br />and the Artisan base sell price of Starfruit Wine is 3,150)
-** The base cost of the displayed item.
+|{{Qualityprice|Wine|750|pm=1.4}}
-** Normally the base cost should be a numeric value (or valid numeric expression).  If a non-numeric cost is provided, it will be printed as-is for all requested qualities (and the sortkey is set to "0" to hide the non-numeric data from any table-sorting).
+|-
+|<code><nowiki>{{Qualityprice|Honey|30}}</nowiki></code><br />(The base sell price of a [[Tulip]] is 30,<br />and the base sell price of Tulip Honey is 160)
-* '''prof_mult=''mult'''''
+|{{Qualityprice|Honey|30}}
-** Any other multipliers (''e.g.,'' profession price bonuses) that should be included in the calculated price.  Default value is 1.
+|-
-** This value is always ignored (<samp>prof_mult</samp> is forced to be 1) for Oil and Coffee, to ensure that the Artisan Profession bonus is not accidentally displayed for these items. This allows oil to be shown in multi-item infobox displays alongside other artisan goods without any special handling elsewhere.
+|}<includeonly>[[Category:Templates]]{{Addlanglinks}}</includeonly><noinclude>[[Category:Template documentation]]</noinclude>
-* '''quality=''value'''''
-** Quality value to display. Default value is all 4 qualities
-* '''srcprice=''price'''''
-** The base price of the source item (''e.g.,'' vegetable, fruit, flower, or fish) used to create the displayed item.
-* '''hide=''values'''''
-** List of quality values to hide, as a comma-separated list of individual values.
-===Examples===
-<pre>
-{{Qualityprice|Pumpkin|100}}
-</pre>
-{{Qualityprice|Pumpkin|100}}
-<pre>
-{{Qualityprice|Pumpkin|100|prof_mult=1.1}}
-</pre>
-{{Qualityprice|Pumpkin|100|prof_mult=1.1}}
-<pre>
-{{Qualityprice|Leek|60|iridium}}
-</pre>
-{{Qualityprice|Leek|60|iridium}}
-<pre>
-{{Qualityprice|Apple|42|iridium|hide=gold,silver}}
-</pre>
-{{Qualityprice|Apple|42|iridium|hide=gold,silver}}
-<pre>
-{{Qualityprice|Apple|42|iridium|hide=silver,iridium}}
-</pre>
-{{Qualityprice|Apple|42|iridium|hide=silver,iridium}}
-<pre>
-{{Qualityprice|Wine|auto=true|srcprice=42|prof_mult=1.4}}
-</pre>
-{{Qualityprice|Wine|auto=true|srcprice=42|prof_mult=1.4}}
-<includeonly>{{Addlanglinks}}[[Category:Templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>

Difference between revisions of "Template:Qualityprice/doc"

Latest revision as of 23:38, 15 March 2023

Description

Parameters

Examples

Navigation menu

Search