Template:EdibilityGrid/doc: Difference between revisions

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}}

	113		50
	158		71
	203		91
	293		131

{{EdibilityGrid|Melon|45|showitem=true}}

		113		50
		158		71
		203		91
		293		131

{{EdibilityGrid|Parsnip|10}}

	25		11
	35		15
	45		20
	65		29

{{EdibilityGrid|Ginger|10}}

25

11

{{EdibilityGrid|Goat Cheese|50|hide=normal,silver}}

	225		101
	325		146

{{EdibilityGrid|Large Goat Milk JA|35|showitem=true}}

		88		39
		123		55
		158		71
		228		102

{{EdibilityGrid|Juice|30}}

75

33

{{EdibilityGrid|Wine|20}}

	50		22
	70		31
	90		40
	130		58

{{EdibilityGrid|Holly|-15}}

	−37		0
	−52		0
	−67		0
	−97		0

{{EdibilityGrid|Bug Steak|18|quality=0}}

Missing health parameter; Shows incorrect health value

45

20

{{EdibilityGrid|Bug Steak|18|health=30|quality=0}}

45

30

@@ Line 15: / Line 15: @@
 |-
 |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 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>
+|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
@@ Line 25: / Line 25: @@
 |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]])
 |-
 |}
@@ Line 57: / Line 60: @@
 |<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>