Difference between revisions of "Template:Infobox fish/doc"

From Stardew Valley Wiki
Jump to navigation Jump to search
(documentation of nopricebonus)
(At least make the parameter list complete)
Line 1: Line 1:
==Description==
 
 
This template is used to provide a template that displays an infobox for fishpages
 
This template is used to provide a template that displays an infobox for fishpages
  
Line 6: Line 5:
  
 
<pre>{{Infobox fish
 
<pre>{{Infobox fish
 +
|name        =
 +
|eng        =
 +
|image      =
 
|description =  
 
|description =  
 
|location    =  
 
|location    =  
Line 13: Line 15:
 
|difficulty  =
 
|difficulty  =
 
|behavior    =  
 
|behavior    =  
 +
|fl          =
 
|size        =  
 
|size        =  
 
|price      =
 
|price      =
 
|edibility  =
 
|edibility  =
|hideprice  =
+
|quality    =
|healq      =
 
 
|iridium    =
 
|iridium    =
 +
|custom_price=
 
|roe        =
 
|roe        =
|nopricebonus=
 
 
}}</pre>
 
}}</pre>
  
 
===Parameters===
 
===Parameters===
<pre>{{Infobox fish
+
<nowiki>{{</nowiki>[[Template:Infobox fish|Infobox fish]]
|description = In-game item description (optional -- populated by Template:Description if omitted)
+
|name        = Fish name (optional - set to <nowiki>{{PAGENAME}}</nowiki> if omitted)
|location    = Where the Fish is found
+
|eng        = English fish name - only necessary on non-english wikis
|time        = What time range the fish is found in
+
|image      = Fish image (optional - set to name or eng if omitted)
|season      = What season(s) the fish can be found (e.g., Summer / Winter)
+
|description = In-game item description (optional -- populated by [[Template:Description]] if omitted)
|weather    = What weather the fish can be found (e.g., Rainy)
+
|location    = Where the Fish is found
|difficulty  = Difficulty level of the fish
+
|time        = What time range the fish is found in
|behavior    = Behavior type of the fish (described on Fish page)
+
|season      = What season(s) the fish can be found (e.g., Summer / Winter)
|size        = Size range of the fish
+
|weather    = What weather the fish can be found (e.g., Rainy)
|price      = Base price of the fish, no star
+
|difficulty  = Difficulty level of the fish
|edibility  = Base edibility of the fish, no star
+
|behavior    = Behavior type of the fish (described on [[Fish]] page)
|hideprice  = Qualities (normal,silver,gold) to hide from sell price section (Optional)
+
|fl          = Required fishing level
|healq      = Energy/Health qualities to show (normal,silver,gold) (Optional)
+
|size        = Size range of the fish in INCHES (even on non-english wikis; autoconverts to cm as necessary)
              Use this parameter to suppress qualities that are not specified
+
|price      = Base price of the fish, no star
|iridium    = Set this to 'true' to add iridium sell prices, health, and energy
+
|edibility  = Base edibility of the fish, no star
|roe        = Set this to the color of the Roe (matching the filenames in [[:Category:Roe images]]) to add  
+
|quality    = Qualities (normal,silver,gold,iridium) of fish to show in health/price displays (Optional)
              a section showing roe, aged roe, and prices
+
  |iridium    = Set this to 'true' to add iridium sell prices, health, and energy
|nopricebonus= Set this to 'true' to show sell prices without bonuses from Fisher/Angler professions
+
|custom_price= Set with a template call to [[Template:Infosection price|Infosection price]] to overwrite standard price section.
              (if template is being used for non-fish such as Sea Urchins)
+
                See [[Salmonberry]] for an example.
}}</pre>
+
|roe        = Set this to the color of the Roe (matching the filenames in [[:Category:Roe images]]) to add  
 +
                a section showing roe, aged roe, and prices
 +
|hideprice  = Qualities (normal,silver,gold) to hide from sell price section (DEPRECATED) - use quality
 +
|healq      = Energy/Health qualities to show (normal,silver,gold)  (DEPRECATED) - use quality
 +
                Use this parameter to suppress qualities that are not specified
 +
<nowiki>}}</nowiki>
 
<includeonly>[[Category:Infobox templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>
 
<includeonly>[[Category:Infobox templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>
<includeonly>{{Addlanglinks}}</includeonly>
 

Revision as of 18:25, 24 September 2020

This template is used to provide a template that displays an infobox for fishpages

Usage

This template can be used by entering the following onto a relevant page.

{{Infobox fish
|name        =
|eng         =
|image       =
|description = 
|location    = 
|time        = 
|season      = 
|weather     = 
|difficulty  =
|behavior    = 
|fl          =
|size        = 
|price       =
|edibility   =
|quality     =
|iridium     =
|custom_price=
|roe         =
}}

Parameters

{{Infobox fish
|name        = Fish name (optional - set to {{PAGENAME}} if omitted)
|eng         = English fish name - only necessary on non-english wikis
|image       = Fish image (optional - set to name or eng if omitted)
|description = In-game item description (optional -- populated by Template:Description if omitted)
|location    = Where the Fish is found
|time        = What time range the fish is found in
|season      = What season(s) the fish can be found (e.g., Summer / Winter)
|weather     = What weather the fish can be found (e.g., Rainy)
|difficulty  = Difficulty level of the fish
|behavior    = Behavior type of the fish (described on Fish page)
|fl          = Required fishing level
|size        = Size range of the fish in INCHES (even on non-english wikis; autoconverts to cm as necessary)
|price       = Base price of the fish, no star
|edibility   = Base edibility of the fish, no star
|quality     = Qualities (normal,silver,gold,iridium) of fish to show in health/price displays (Optional)
|iridium     = Set this to 'true' to add iridium sell prices, health, and energy
|custom_price= Set with a template call to Infosection price to overwrite standard price section.
               See Salmonberry for an example.
|roe         = Set this to the color of the Roe (matching the filenames in Category:Roe images) to add 
               a section showing roe, aged roe, and prices
|hideprice   = Qualities (normal,silver,gold) to hide from sell price section (DEPRECATED) - use quality
|healq       = Energy/Health qualities to show (normal,silver,gold)  (DEPRECATED) - use quality
               Use this parameter to suppress qualities that are not specified
}}