Template:Qualityprice/doc - Revision history

imported>Margotbean: update

2024-07-06T19:07:14Z

update

← Older revision		Revision as of 19:07, 6 July 2024
Line 15:		Line 15:
	\|-		\|-
	\|quality		\|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>		\|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> or <samp>quality=0</samp> will work.''</div>
	\|-		\|-
	\|hide		\|hide
Line 51:		Line 51:
	\|<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)		\|<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}}		\|{{Qualityprice\|Juice\|260}}
			\|-
			\|<code><nowiki>{{Qualityprice\|Purple Juice\|260\|quality=0}}</nowiki></code><br />(Must specify <samp>quality=normal</samp> or<br /><samp>quality=0</samp> if using a colored sprite)
			\|{{Qualityprice\|Purple Juice\|260\|quality=0}}
	\|-		\|-
	\|<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)		\|<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)

imported>Margotbean at 23:38, 15 March 2023

2023-03-15T23:38:40Z

← Older revision		Revision as of 23:38, 15 March 2023
Line 15:		Line 15:
	\|-		\|-
	\|quality		\|quality
	\|Single quality to display.<br />Defaults to all qualities (normal, silver, gold, iridium) if omitted~~.<br />'''Note:''' Instead of specifying 3 qualities to show, use the "hide" parameter with one quality instead~~.<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>		\|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		\|hide

imported>Sizau: samp

2023-03-06T12:44:26Z

samp

← Older revision		Revision as of 12:44, 6 March 2023
Line 24:		Line 24:
	\|-		\|-
	\|dsv		\|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 true (the entire parameter can be omitted if a data-sort-value is desired).		\|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).
	\|-		\|-
	\|}		\|}

imported>Margotbean at 20:24, 5 March 2023

2023-03-05T20:24:22Z

← Older revision		Revision as of 20:24, 5 March 2023
Line 15:		Line 15:
	\|-		\|-
	\|quality		\|quality
	\|Single quality ~~to display, or list of qualities~~ to display.<br />Defaults to all qualities (normal, silver, gold, iridium) if omitted.<br />'''Note:''' Instead of specifying 3 qualities to show, use the "hide" parameter with one quality instead.<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>		\|Single quality to display.<br />Defaults to all qualities (normal, silver, gold, iridium) if omitted.<br />'''Note:''' Instead of specifying 3 qualities to show, use the "hide" parameter with one quality instead.<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		\|hide

imported>Margotbean at 16:03, 28 February 2023

2023-02-28T16:03:24Z

← Older revision		Revision as of 16:03, 28 February 2023
Line 15:		Line 15:
	\|-		\|-
	\|quality		\|quality
	\|Single quality to display, or list of qualities to display.<br />Defaults to all qualities (normal, silver, gold, iridium) if omitted.<br />'''Note:''' Instead of specifying 3 qualities to show, use the "hide" parameter with one quality instead.<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]], 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>		\|Single quality to display, or list of qualities to display.<br />Defaults to all qualities (normal, silver, gold, iridium) if omitted.<br />'''Note:''' Instead of specifying 3 qualities to show, use the "hide" parameter with one quality instead.<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		\|hide

imported>Margotbean: fix category

2023-02-26T00:05:43Z

fix category

← Older revision		Revision as of 00:05, 26 February 2023
Line 58:		Line 58:
	\|{{Qualityprice\|Honey\|30}}		\|{{Qualityprice\|Honey\|30}}
	\|-		\|-
	\|}<includeonly>[[Category:~~Infobox templates~~]]{{Addlanglinks}}</includeonly><noinclude>[[Category:Template documentation]]</noinclude>		\|}<includeonly>[[Category:Templates]]{{Addlanglinks}}</includeonly><noinclude>[[Category:Template documentation]]</noinclude>

imported>Margotbean at 23:31, 25 February 2023

2023-02-25T23:31:20Z

← Older revision		Revision as of 23:31, 25 February 2023
Line 12:		Line 12:
	\|-		\|-
	\|Second (unnamed) parameter		\|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)		\|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		\|quality

imported>Margotbean: /* Parameters */

2023-02-25T22:50:24Z

Parameters

← Older revision		Revision as of 22:50, 25 February 2023
Line 15:		Line 15:
	\|-		\|-
	\|quality		\|quality
	\|Single quality to display, or list of qualities to display.<br />Defaults to all qualities (normal, silver, gold, iridium) if omitted.<br />'''Note:''' Instead of specifying 3 qualities to show, use the "hide" parameter with one quality instead.<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]], and [[Tea Leaves]])		\|Single quality to display, or list of qualities to display.<br />Defaults to all qualities (normal, silver, gold, iridium) if omitted.<br />'''Note:''' Instead of specifying 3 qualities to show, use the "hide" parameter with one quality instead.<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]], 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		\|hide

imported>Margotbean: Update

2023-02-25T20:32:37Z

Update

Show changes

imported>Margotbean at 03:23, 20 February 2023

2023-02-20T03:23:56Z

← Older revision		Revision as of 03:23, 20 February 2023
Line 1:		Line 1:
			{{Construction}}
	[[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.		[[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.

	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>~~prof_mult~~</samp> parameter.		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.

	For variable price items (Wine, Juice, Pickles, Jelly~~, Roe, Aged Roe~~, Honey~~, etc.~~)~~<ref name="items"/>~~, this template also allows the item base price to be automatically calculated from the source item price.		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.

	Additionally, a sortkey is provided allowing correct sorting in tables where a column contains multiple instances of this template.		Additionally, a sortkey is provided allowing correct sorting in tables where a column contains multiple instances of this template.

	~~==Notes==~~
	~~The sell price is calculated by:~~
	* Rounding down (truncating any fraction) on the input base cost (for the sake of derived base costs such as fruit-specific wine)
	* 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
	* Applying any profession-related bonuses (from the <samp>prof_mult</samp> parameter)
	* 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 <samp>Object::sellToStorePrice</samp>. 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.

	==Use==		==Use==
Line 24:		Line 16:

	<nowiki>{{</nowiki>[[Template:Qualityprice\|Qualityprice]] \|''item_name''\| ''base_cost'' \| prof_mult=''mult'' \| quality=''values''		<nowiki>{{</nowiki>[[Template:Qualityprice\|Qualityprice]] \|''item_name''\| ''base_cost'' \| prof_mult=''mult'' \| quality=''values''
	~~\| srcprice=''price'' \| auto=true~~		\| hide=''values'' \| sortkey=''value'' <nowiki>}}</nowiki>
	~~\| iridium=true~~ \| hide=''values~~'' \| size=''px~~'' \| sortkey=''value'' <nowiki>}}</nowiki>

	===Parameters===		===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.		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.

	~~See [[Template:ParseInputQuality]] for more information on quality-related parameters.~~

	* '''''item_name'''''		* '''''item_name'''''
	** First unnamed parameter, required.		** First unnamed parameter, required.
	** Name of item being displayed. There should be a corresponding image named <samp>File:~~item_name~~.png</samp>.		** Name of item being displayed. There should be a corresponding image named <samp>File:item name.png</samp>.
	** On non-english wikis this should ~~normally~~ be the '''~~english~~''' ~~item_name. Even if there is a language-specific~~ item ~~image (''e.g.,'' [[:File:Large Milk FR.png]] in French), it should not be necessary to alter the image~~ name ~~([[Template:Quality]] automatically handles all variants of milk image names)~~.		** On non-english wikis this should be the '''English''' item name.
	** 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)

	* '''''base_cost'''''		* '''''base_cost'''''
	** Second unnamed parameter.		** 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.~~<ref name="items"/>~~		** Required unless <samp>srcprice</samp> and <samp>auto</samp> are specified AND the item is one whose price can be auto-calculated.
	** The base cost of the displayed item.		** The base cost of the displayed item.
	** 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).		** 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).
Line 48:		Line 36:
	** 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.		** 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.

	* '''quality=''~~values~~'''''		* '''quality=''value'''''
	** ~~List of quality values~~ to display. Default value is ~~<samp>Normal, Silver, Gold</samp>~~		** Quality value to display. Default value is all 4 qualities
	** Set quality to true to get <samp>Normal, Silver, Gold</samp>, or
	** Set quality to false or Normal to get <samp>Normal</samp>, 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 <samp>iridium=true</samp>
	** If <samp>auto</samp> is set and the displayed item is recognized, any input quality value will be ignored and instead the quality will be automatically set based on the item's default allowed qualities.

	* '''srcprice=''price'''''		* '''srcprice=''price'''''
	** The base price of the source item (''e.g.,'' vegetable, fruit, flower, or fish) used to create the displayed item.		** The base price of the source item (''e.g.,'' vegetable, fruit, flower, or fish) used to create the displayed item.
	** Only relevant if <samp>auto</samp> is set, and the displayed item is one whose price depends upon the source item (Wine, Juice, Pickles, Jelly, Roe, Aged Roe, Honey, etc.)<ref name="items"/>. In which case, the item base price will be automatically derived from <samp>srcrprice</samp>.
	** For example, to display the price of Salmonberry Wine, set <samp>srcrprice=5</samp>.

	* '''auto=true'''
	** Set auto to true in order to allow quality and base_cost to be automatically set for recognized items.<ref name="items"/>

	* '''iridium=true'''
	** Set iridium to true to display iridium values.
	** Also recognizes <samp>iridium=false</samp> as equivalent to <samp>hide=iridium</samp> (although it's easier to just omit the entire iridium parameter)

	* '''hide=''values'''''		* '''hide=''values'''''
	** List of quality values to hide, as a comma-separated list of individual 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 <samp>hide=base</samp> 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").

	* '''sortkey=''value'''''
	** Override the value used for the sortkey. Default value is <samp>true</samp>, in which case the sortkey is set to the normal quality value (or to 0 for non-numeric data)
	** This parameter should not normally be necessary. One known use case, however, is when one table cell makes multiple calls to Qualityprice, in which case only one of the calls should be allowed to set a sortkey. Therefore, the sortkey should be set to an empty value on all but the first template call in a single cell.

	===Examples===		===Examples===
Line 98:		Line 62:

	<pre>		<pre>
	{{Qualityprice\|Apple\|42\|iridium\|hide=gold,silver~~\|size=48~~}}		{{Qualityprice\|Apple\|42\|iridium\|hide=gold,silver}}
	</pre>		</pre>
	{{Qualityprice\|Apple\|42\|iridium\|hide=gold,silver~~\|size=48~~}}		{{Qualityprice\|Apple\|42\|iridium\|hide=gold,silver}}

	<pre>		<pre>
Line 111:		Line 75:
	</pre>		</pre>
	{{Qualityprice\|Wine\|auto=true\|srcprice=42\|prof_mult=1.4}}		{{Qualityprice\|Wine\|auto=true\|srcprice=42\|prof_mult=1.4}}

	~~==References==~~
	~~<references>~~
	<ref name="items">The full list of items for which the quality and base price can be automatically set is: Wine, Juice, Jelly, Pickles, Honey, Roe, Caviar, Aged Roe, Pale Ale, Beer, and Mead. A few fixed-price items are included in this list so multiple-item infobox displays can be handled more easily.</ref>
	~~</references>~~

	<includeonly>{{Addlanglinks}}[[Category:Templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>		<includeonly>{{Addlanglinks}}[[Category:Templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>