Difference between revisions of "Template:Qualityprice/doc"

From Stardew Valley Wiki
Jump to navigation Jump to search
 
(32 intermediate revisions by 7 users not shown)
Line 1: Line 1:
 
==Description==
 
==Description==
This template is used to provide a template that takes the base cost of each item, calculates the silver and gold quality costs, and displays it in a table. The cost calculation is silver=(basecost)*1.25 and gold=(basecost)*1.50. It always rounds down to the nearest whole number.
+
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.
  
Note that this intentionally doesn't show the gold icon to not clutter the page with multiple icons.
+
==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).
 +
|-
 +
|}
  
==Usage==
+
==Examples==
This template can be used by entering the following onto a relevant page.
+
{|class="wikitable sortable"
 
+
|-
<pre>{{Qualityprice|item name|item base cost}}</pre>
+
!Template Call
 
+
!Result
===parameters===
+
|-
====item name====
+
|<code><nowiki>{{Qualityprice|Melon|250}}</nowiki></code>
This parameter accepts an item name.
+
|{{Qualityprice|Melon|250}}
 
+
|-
====item base cost====
+
|<code><nowiki>{{Qualityprice|Parsnip|35|pm=1.1}}</nowiki></code>
This parameter accepts the item's base cost.
+
|{{Qualityprice|Parsnip|35|pm=1.1}}
 
+
|-
===Example===
+
|<code><nowiki>{{Qualityprice|Ginger|60}}</nowiki></code>
<pre>
+
|{{Qualityprice|Ginger|60}}
{{Qualityprice|Pumpkin|100}}
+
|-
</pre>
+
|<code><nowiki>{{Qualityprice|Goat Cheese|400|hide=normal,silver}}</nowiki></code>
 
+
|{{Qualityprice|Goat Cheese|400|hide=normal,silver}}
{{Qualityprice|Pumpkin|100}}
+
|-
<includeonly>[[Category:Transclusion templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>
+
|<code><nowiki>{{Qualityprice|Large Goat Milk FR|345}}</nowiki></code>
 +
|{{Qualityprice|Large Goat Milk FR|345}}
 +
|-
 +
|<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)
 +
|{{Qualityprice|Juice|260}}
 +
|-
 +
|<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)
 +
|{{Qualityprice|Wine|750|pm=1.4}}
 +
|-
 +
|<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)
 +
|{{Qualityprice|Honey|30}}
 +
|-
 +
|}<includeonly>[[Category:Templates]]{{Addlanglinks}}</includeonly><noinclude>[[Category:Template documentation]]</noinclude>

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}} data-sort-value="250"
Melon.png
250g
Melon.png
Silver Quality Icon.png
312g
Melon.png
Gold Quality Icon.png
375g
Melon.png
Iridium Quality Icon.png
500g
{{Qualityprice|Parsnip|35|pm=1.1}} data-sort-value="38"
Parsnip.png
38g
Parsnip.png
Silver Quality Icon.png
47g
Parsnip.png
Gold Quality Icon.png
57g
Parsnip.png
Iridium Quality Icon.png
77g
{{Qualityprice|Ginger|60}} data-sort-value="60"
Ginger.png
60g
{{Qualityprice|Goat Cheese|400|hide=normal,silver}} data-sort-value="400"
Goat Cheese.png
Gold Quality Icon.png
600g
Goat Cheese.png
Iridium Quality Icon.png
800g
{{Qualityprice|Large Goat Milk FR|345}} data-sort-value="345"
Large Goat Milk FR.png
345g
Large Goat Milk FR.png
Silver Quality Icon.png
431g
Large Goat Milk FR.png
Gold Quality Icon.png
517g
Large Goat Milk FR.png
Iridium Quality Icon.png
690g
{{Qualityprice|Juice|260}}
(The base sell price of Red Cabbage is 260,
and the base sell price of Red Cabbage Juice is 585)
data-sort-value="585"
Juice.png
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)
data-sort-value="3150"
Wine.png
3,150g
Wine.png
Silver Quality Icon.png
3,936g
Wine.png
Gold Quality Icon.png
4,725g
Wine.png
Iridium Quality Icon.png
6,300g
{{Qualityprice|Honey|30}}
(The base sell price of a Tulip is 30,
and the base sell price of Tulip Honey is 160)
data-sort-value="160"
Honey.png
160g