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 <samp>ObjectInformation.xnb</samp>. 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|image 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]]) |
| + | |- |
| + | |} |
| | | |
− | ===Examples===
| + | ==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=true}}</pre> | + | |- |
− | {{EdibilityGrid|Morel|8|iridium=true}} | + | |<code><nowiki>{{EdibilityGrid|Melon|45}}</nowiki></code> |
− | <pre>{{EdibilityGrid|Milk|15|hide=normal,gold}}</pre> | + | |{{EdibilityGrid|Melon|45}} |
− | {{EdibilityGrid|Milk|15|hide=normal,gold}} | + | |- |
− | <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}} | + | |- |
− | ==Non-English Images==
| + | |<code><nowiki>{{EdibilityGrid|Ginger|10}}</nowiki></code> |
− | For languages other than English, there may be a language-specific image that can be used.
| + | |{{EdibilityGrid|Ginger|10}} |
− | <pre>{{EdibilityGrid|Milk ES|15|iridium=true}}</pre> | + | |- |
− | {{EdibilityGrid|Milk ES|15|iridium=true}} | + | |<code><nowiki>{{EdibilityGrid|Goat Cheese|50|hide=normal,silver}}</nowiki></code> |
− | <pre>{{EdibilityGrid|Large Milk FR|20|iridium=true}}</pre> | + | |{{EdibilityGrid|Goat Cheese|50|hide=normal,silver}} |
− | {{EdibilityGrid|Large Milk FR|20|iridium=true}} | + | |- |
− | <pre>{{EdibilityGrid|Large Goat Milk JA|35|iridium=true}}</pre> | + | |<code><nowiki>{{EdibilityGrid|Large Goat Milk JA|35|showitem=true}}</nowiki></code> |
− | {{EdibilityGrid|Large Goat Milk JA|35|iridium=true}} | + | |{{EdibilityGrid|Large Goat Milk JA|35|showitem=true}} |
− | <includeonly>{{Addlanglinks}}[[Category:Templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude> | + | |- |
| + | |<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> |