Jump to content

Template:EdibilityGrid/doc: Difference between revisions

From Stardew Valley Wiki
← Older edit
imported>Margotbean
No edit summary
imported>Margotbean
No edit summary
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
==Description==
==Description==
Displays a horizontal grid of health and energy values for a consumable item, using the edibility value found in <tt>ObjectInformation.xnb</tt>.  Can display or hide any quality (normal, sliver, gold, iridium).
This template displays a grid of energy and health values for an edible item.


==Use==
==Parameters==
<pre>{{EdibilityGrid|item name|item edibility|iridium quality|hide qualities}}</pre>
{|class="wikitable sortable"
|-
!Parameter
!Notes
|-
|First (unnamed) parameter
|Name of image (minus ".png")
|-
|Second (unnamed) parameter
|Edibility of item (can be found in <samp>ObjectInformation.xnb</samp>)<br />Items with a negative edibility will display the poison icon instead of the energy icon.
|-
|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 Algae]], [[Green Tea]], [[Juice]], [[Oil]], [[Qi Fruit]], [[Sap]], and [[White Algae]])<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>)
|-
|showitem
|Set to <samp>true</samp> to display the image of the edible item
|-
|dsv
|data-sort-value<br />Set to <samp>false</samp> if the energy & health values 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).
|-
|health
|Use to override the normal calculation for health, when the normal formula does not apply (''e.g.,'' for [[Bug Steak]] and [[Oil of Garlic]])
|-
|}


===Example===
==Examples==
<pre>{{EdibilityGrid|Blackberry|10}}</pre>
{|class="wikitable sortable"
{{EdibilityGrid|Blackberry|10}}
|-
<pre>{{EdibilityGrid|Red Mushroom|-20}}</pre>
!Template Call
{{EdibilityGrid|Red Mushroom|-20}}
!Result
<pre>{{EdibilityGrid|Morel|8|iridium=y}}</pre>
|-
{{EdibilityGrid|Morel|8|iridium=y}}
|<code><nowiki>{{EdibilityGrid|Melon|45}}</nowiki></code>
<pre>{{EdibilityGrid|Milk|15|iridium=true}}</pre>
|{{EdibilityGrid|Melon|45}}
{{EdibilityGrid|Milk|15|iridium=true}}
|-
<pre>{{EdibilityGrid|Milk|15|iridium=true|hide=silver,gold}}</pre>
|<code><nowiki>{{EdibilityGrid|Melon|45|showitem=true}}</nowiki></code>
{{EdibilityGrid|Milk|15|iridium=true|hide=silver,gold}}
|{{EdibilityGrid|Melon|45|showitem=true}}
<pre>{{EdibilityGrid|Daffodil|0|iridium=true}}</pre>
|-
{{EdibilityGrid|Daffodil|0|iridium=true}}
|<code><nowiki>{{EdibilityGrid|Parsnip|10}}</nowiki></code>
<pre>{{EdibilityGrid|Cauliflower|30}}</pre>
|{{EdibilityGrid|Parsnip|10}}
{{EdibilityGrid|Cauliflower|30}}
|-
<includeonly>[[Category:Formatting templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>
|<code><nowiki>{{EdibilityGrid|Ginger|10}}</nowiki></code>
<includeonly>{{Addlanglinks}}</includeonly>
|{{EdibilityGrid|Ginger|10}}
|-
|<code><nowiki>{{EdibilityGrid|Goat Cheese|50|hide=normal,silver}}</nowiki></code>
|{{EdibilityGrid|Goat Cheese|50|hide=normal,silver}}
|-
|<code><nowiki>{{EdibilityGrid|Large Goat Milk JA|35|showitem=true}}</nowiki></code>
|{{EdibilityGrid|Large Goat Milk JA|35|showitem=true}}
|-
|<code><nowiki>{{EdibilityGrid|Juice|30}}</nowiki></code>
|{{EdibilityGrid|Juice|30}}
|-
|<code><nowiki>{{EdibilityGrid|Wine|20}}</nowiki></code>
|{{EdibilityGrid|Wine|20}}
|-
|<code><nowiki>{{EdibilityGrid|Holly|-15}}</nowiki></code>
|{{EdibilityGrid|Holly|-15}}
|-
|<code><nowiki>{{EdibilityGrid|Bug Steak|18|quality=0}}</nowiki></code>
Missing <samp>health</samp> parameter; Shows incorrect health value
|{{EdibilityGrid|Bug Steak|18|quality=0}}
|-
|<code><nowiki>{{EdibilityGrid|Bug Steak|18|health=30|quality=0}}</nowiki></code>
|{{EdibilityGrid|Bug Steak|18|health=30|quality=0}}
|-
|}<includeonly>{{Addlanglinks}}[[Category:Templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>

Latest revision as of 23:37, 15 March 2023

Description

This template displays a grid of energy and health values for an edible item.

Parameters

Parameter Notes
First (unnamed) parameter Name of image (minus ".png")
Second (unnamed) parameter Edibility of item (can be found in ObjectInformation.xnb)
Items with a negative edibility will display the poison icon instead of the energy icon.
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 Algae, Green Tea, Juice, Oil, Qi Fruit, Sap, and White Algae)
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)
showitem Set to true to display the image of the edible item
dsv data-sort-value
Set to false if the energy & health values 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).
health Use to override the normal calculation for health, when the normal formula does not apply (e.g., for Bug Steak and Oil of Garlic)

Examples

Template Call Result
{{EdibilityGrid|Melon|45}} data-sort-value="45"
 113
50
158
71
203
91
293
131
{{EdibilityGrid|Melon|45|showitem=true}} data-sort-value="45"
113
50
158
71
203
91
293
131
{{EdibilityGrid|Parsnip|10}} data-sort-value="10"
 25
11
35
15
45
20
65
29
{{EdibilityGrid|Ginger|10}} data-sort-value="10"
 25
11
{{EdibilityGrid|Goat Cheese|50|hide=normal,silver}} data-sort-value="50"
 225
101
325
146
{{EdibilityGrid|Large Goat Milk JA|35|showitem=true}} data-sort-value="35"
88
39
123
55
158
71
228
102
{{EdibilityGrid|Juice|30}} data-sort-value="30"
 75
33
{{EdibilityGrid|Wine|20}} data-sort-value="20"
 50
22
70
31
90
40
130
58
{{EdibilityGrid|Holly|-15}} data-sort-value="-15"
 −37
0
−52
0
−67
0
−97
0
{{EdibilityGrid|Bug Steak|18|quality=0}}

Missing health parameter; Shows incorrect health value

data-sort-value="18"
 45
20
{{EdibilityGrid|Bug Steak|18|health=30|quality=0}} data-sort-value="18"
 45
30
Retrieved from "https://stardew.fastobject.net/index.php?title=Template:EdibilityGrid/doc&oldid=128035"