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

From Stardew Valley Wiki
Jump to navigation Jump to search
(image parameter was removed in favor of eng parameter in all languages)
Line 1: Line 1:
−
This template is used to provide a template that displays an infobox for fishpages
+
==Description==
 +
This template is used to display an infobox for fish (and fish-like item) pages. '''Do not use this on your user page. It is reserved for content pages.'''
  
−
==Usage==
+
==Parameters==
−
This template can be used by entering the following onto a relevant page. '''Do not use this on your user page. It is reserved for content pages.'''
+
<pre>eng        = English fish name
−
 
+
description = In-game item description (optional -- populated by [[:Template:Description]] if omitted)
−
<pre>{{Infobox fish
+
location    = Area(s) where the Fish can be caught
−
|name        =
+
source      = How to obtain the fish, other than fishing pole
−
|eng        =
+
time        = What time range the fish can be caught in
−
|description =
+
season      = What season(s) the fish can caught in (''e.g.,'' Summer)
−
|location    =
+
weather    = What weather the fish can be found in (''e.g.,'' Rain)
−
|source      =
+
difficulty  = Difficulty level of the fish.  Auto-populates Fishing XP section if present.
−
|time        =
+
behavior    = Behavior type of the fish (described in [[Fish#Behavior]])
−
|season      =
+
fl          = Required fishing level (optional)
−
|weather    =
+
size        = Size range of the fish in INCHES (converts to other languages automatically)
−
|difficulty  =
+
xp          = XP (and type of XP).  Only for non-fishing-pole fish.
−
|behavior    =
+
price      = Base price of the fish, no star
−
|fl          =
+
edibility  = Base edibility of the fish, no star
−
|size        =
+
quality    = Set to normal or false for fish that come only in normal quality (Optional)
−
|xp          =
+
roe        = The color of the Roe (matching the filenames in [[:Category:Roe images]]) to add a section showing roe, aged roe, and prices
−
|price      =
 
−
|edibility  =
 
−
|quality    =
 
−
|iridium    =
 
−
|custom_price=
 
−
|roe        =
 
−
}}</pre>
 
−
 
 
−
===Parameters===
 
−
<nowiki>{{</nowiki>[[Template:Infobox fish|Infobox fish]]
 
−
|name        = Fish name (optional - set to <nowiki>{{PAGENAME}}</nowiki> if omitted)
 
−
|eng        = English fish name
 
−
|description = In-game item description (optional -- populated by [[Template:Description]] if omitted)
 
−
|location    = Where the Fish is found
 
−
|source      = How to obtain the fish, other than fishing pole
 
−
|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.  Auto-populates Fishing XP section, too, for fishing-pole 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)
 
−
|xp          = XP points (and type of XP).  Only for non-fishing-pole fish
 
−
|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 [[Template:Infosection price|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
 
−
<nowiki>}}</nowiki>
 
 
<includeonly>[[Category:Infobox templates]]{{Addlanglinks}}</includeonly><noinclude>[[Category:Template documentation]]</noinclude>
 
<includeonly>[[Category:Infobox templates]]{{Addlanglinks}}</includeonly><noinclude>[[Category:Template documentation]]</noinclude>

Revision as of 03:23, 26 October 2022

Description

This template is used to display an infobox for fish (and fish-like item) pages. Do not use this on your user page. It is reserved for content pages.

Parameters

eng         = English fish name
description = In-game item description (optional -- populated by Template:Description if omitted)
location    = Area(s) where the Fish can be caught
source      = How to obtain the fish, other than fishing pole
time        = What time range the fish can be caught in
season      = What season(s) the fish can caught in (e.g., Summer)
weather     = What weather the fish can be found in (e.g., Rain)
difficulty  = Difficulty level of the fish.  Auto-populates Fishing XP section if present.
behavior    = Behavior type of the fish (described in Fish#Behavior)
fl          = Required fishing level (optional)
size        = Size range of the fish in INCHES (converts to other languages automatically)
xp          = XP (and type of XP).  Only for non-fishing-pole fish.
price       = Base price of the fish, no star
edibility   = Base edibility of the fish, no star
quality     = Set to normal or false for fish that come only in normal quality (Optional)
roe         = The color of the Roe (matching the filenames in Category:Roe images) to add a section showing roe, aged roe, and prices
Retrieved from "https://stardewvalleywiki.com/mediawiki/index.php?title=Template:Infobox_fish/doc&oldid=142561"