Difference between revisions of "Template:Qualityprice/doc"

From Stardew Valley Wiki
Jump to navigation Jump to search
(Complete params, formatting)
 
(17 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
This template displays a table of the sell prices of an item for each requested item.  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 as to not clutter the page with multiple icons.
+
==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.
  
−
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 <tt>prof_mult</tt> 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).
 +
|-
 +
|}
  
−
Additionally, a sortkey is provided allowing correct sorting in tables where a column contains multiple instances of this template.
+
==Examples==
−
 
+
{|class="wikitable sortable"
−
==Notes==
+
|-
−
The sell price is calculated by:
+
!Template Call
−
* Rounding down (truncating any fraction) on the input base cost (for the sake of derived base costs such as fruit-specific wine)
+
!Result
−
* Applying the quality adjustment to the price: multiplying by 1.25 for Silver, 1.5 for Gold, or 2 for Iridium
+
|-
−
* Rounding down the quality-adjusted price
+
|<code><nowiki>{{Qualityprice|Melon|250}}</nowiki></code>
−
* Applying any profession-related bonuses (from the <tt>prof_mult</tt> parameter)
+
|{{Qualityprice|Melon|250}}
−
* Rounding down to yield the final displayed sell price.
+
|-
−
This sequence of operations (and the specific order in which they are done) replicates the calculations done by the game code in <tt>Object::sellToStorePrice</tt>. Changing the order of operations and/or omitting any of the rounding-down steps will cause changes in the calculated values for some items and result in discrepancies between the wiki's displayed values and the actual in-game values.
+
|<code><nowiki>{{Qualityprice|Parsnip|35|pm=1.1}}</nowiki></code>
−
 
+
|{{Qualityprice|Parsnip|35|pm=1.1}}
−
==Usage==
+
|-
−
===Syntax===
+
|<code><nowiki>{{Qualityprice|Ginger|60}}</nowiki></code>
−
Basic usage:
+
|{{Qualityprice|Ginger|60}}
−
<nowiki>{{</nowiki>[[Template:Qualityprice|Qualityprice]] |''item_name''| ''base_cost'' <nowiki>}}</nowiki>
+
|-
−
 
+
|<code><nowiki>{{Qualityprice|Goat Cheese|400|hide=normal,silver}}</nowiki></code>
−
Complete argument list:
+
|{{Qualityprice|Goat Cheese|400|hide=normal,silver}}
−
 
+
|-
−
<nowiki>{{</nowiki>[[Template:Qualityprice|Qualityprice]] |''item_name''| ''base_cost'' | prof_mult=''mult'' | quality=''values''
+
|<code><nowiki>{{Qualityprice|Large Goat Milk FR|345}}</nowiki></code>
−
                | iridium=true | hide=''values'' | size=''px'' | link=''link''| alt=''alt'' <nowiki>}}</nowiki>
+
|{{Qualityprice|Large Goat Milk FR|345}}
−
 
+
|-
−
===Parameters===
+
|<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)
−
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.
+
|{{Qualityprice|Juice|260}}
−
 
+
|-
−
See [[Template:ParseInputQuality]] for more information on quality-related parameters.
+
|<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}}
−
* '''''item_name'''''
+
|-
−
** First unnamed parameter, required
+
|<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)
−
** Name of item being displayed. There should be a corresponding image named <tt>File:item_name.png</tt>.
+
|{{Qualityprice|Honey|30}}
−
** On non-english wikis this should normally be the '''english''' item_name, unless there's a language-specific image of the item, e.g., <tt>Large_Milk_FR</tt> should be used in French instead of <tt>Large_Milk</tt>.  To provide the translated item name, see <tt>alt</tt>
+
|-
−
** Note that there must be no spaces following the item_name -- the "|" symbol must come immediately afterwards, or the template will fail (due to quirks of how mediawiki templates process arguments)
+
|}<includeonly>[[Category:Templates]]{{Addlanglinks}}</includeonly><noinclude>[[Category:Template documentation]]</noinclude>
−
 
 
−
* '''''base_cost'''''
 
−
** Second unnamed parameter, rquired
 
−
** The base cost of the item
 
−
 
 
−
* '''prof_mult=''mult'''''
 
−
** Any other multipliers (e.g., profession price bonuses) that should be included in the calculated price. Default value is 1
 
−
 
 
−
* '''quality=''values'''''
 
−
** List of quality values to display. Default value is <tt>Normal, Silver, Gold</tt>
 
−
** Set quality to true to get <tt>Normal, Silver, Gold</tt>, or
 
−
** Set quality to false or Normal to get <tt>Normal</tt>, or
 
−
** Set quality to one or more specific quality values
 
−
** iridium is disabled by default. Enable by explicitly adding iridium to the listed quality values or by setting <tt>iridium=true</tt>
 
−
 
 
−
* '''iridium=true'''
 
−
** Set iridium to true to display iridium values.
 
−
** Also recognizes <tt>iridium=false</tt> as equivalent to <tt>hide=iridium</tt> (although it's easier to just omit the entire iridium parameter)
 
−
 
 
−
* '''hide=''values'''''
 
−
** List of quality values to hide, as a comma-separated list of individual values.
 
−
** In case of conflict, hide overrides any other input.
 
−
** For backwards compatibility <tt>hide=base</tt> is recognized as equivalent to <nowiki>hide=normal</nowiki>, but this is deprecated.
 
−
 
 
−
* '''size=''px'''''
 
−
** Size of icons in pixels.  Default value is 24
 
−
** Only the number should be provided (do not append "px").
 
−
 
 
−
* '''link=''link'''''
 
−
** Name of page (without square brackets) that item icon should link to.  By default empty, meaning clicking on the icon does nothing.
 
−
 
 
−
* '''alt=''alt'''''
 
−
** Alt text for item icon. Default value is ''link'' (if non-empty) or ''item_name''.
 
−
** This is not normally directly displayed on the page, but may be used by screen readers or accessibility-aware browsers.
 
−
 
 
−
===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|size=48}}
 
−
</pre>
 
−
{{Qualityprice|Apple|42|iridium|hide=gold,silver|size=48}}
 
−
 
 
−
<pre>
 
−
{{Qualityprice|Apple|42|iridium|hide=silver,iridium}}
 
−
</pre>
 
−
{{Qualityprice|Apple|42|iridium|hide=silver,iridium}}
 
−
 
 
−
<includeonly>[[Category:Formatting templates]]</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
Retrieved from "https://stardewvalleywiki.com/mediawiki/index.php?title=Template:Qualityprice/doc&oldid=146731"