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

From Stardew Valley Wiki
Jump to navigation Jump to search
(documentation of nopricebonus)
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
==Description==
 
==Description==
−
This template is used to provide a template that displays an infobox for fishpages
+
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.
+
{|class="wikitable sortable"
−
 
+
|-
−
<pre>{{Infobox fish
+
!Parameter!!Notes
−
|description =  
+
|-
−
|location    =
+
|eng||English fish name ('''Required''' in all languages. Used to populate image and prices.)
−
|time        =
+
|-
−
|season      =
+
|description||In-game item description (optional -- populated by [[:Template:Description]] if omitted). It is preferable to omit this parameter and update Template:Description instead.
−
|weather    =
+
|-
−
|difficulty  =
+
|location||Area(s) where the fish can be caught
−
|behavior    =
+
|-
−
|size        =
+
|source||How to obtain the fish, other than fishing pole
−
|price      =
+
|-
−
|edibility  =
+
|time||What time range the fish can be caught in
−
|hideprice  =
+
|-
−
|healq      =
+
|season||What season(s) the fish can caught in (''e.g.,'' Summer)
−
|iridium    =
+
|-
−
|roe        =
+
|weather||What weather the fish can be found in (''e.g.,'' Rain)
−
|nopricebonus=
+
|-
−
}}</pre>
+
|difficulty||Difficulty level of the fish.  Auto-populates the "Fishing XP" section if present.
−
 
+
|-
−
===Parameters===
+
|behavior||Behavior type of the fish (described in [[Fish#Behavior]])
−
<pre>{{Infobox fish
+
|-
−
|description = In-game item description (optional -- populated by Template:Description if omitted)
+
|fl||Required fishing level (optional)
−
|location   = Where the Fish is found
+
|-
−
|time       = What time range the fish is found in
+
|size||Base size range of the fish in '''inches''' (converts to other languages automatically). Can be found in the data file <samp>Fish.xnb</samp><br />'''Note:''' Size range must be entered using the hyphen key on a standard English keyboard. This will be replaced with the appropriate character in the template (en dash, wave dash, etc.).
−
|season     = What season(s) the fish can be found (e.g., Summer / Winter)
+
|-
−
|weather     = What weather the fish can be found (e.g., Rainy)
+
|xp||XP (and type of XP).  Only for fish without the difficulty parameter set.
−
|difficulty = Difficulty level of the fish
+
|-
−
|behavior   = Behavior type of the fish (described on Fish page)
+
|price||Base price of the fish, no star
−
|size       = Size range of the fish
+
|-
−
|price       = Base price of the fish, no star
+
|edibility||Base edibility of the fish, no star
−
|edibility   = Base edibility of the fish, no star
+
|-
−
|hideprice  = Qualities (normal,silver,gold) to hide from sell price section (Optional)
+
|quality||Set to "normal" or "false" for fish that come only in normal quality (Optional)
−
|healq      = Energy/Health qualities to show (normal,silver,gold)  (Optional)
+
|-
−
              Use this parameter to suppress qualities that are not specified
+
|roe||The color of the Roe (matching the filenames in [[:Category:Roe images]]) to add a section showing Roe, Aged Roe, and prices
−
|iridium    = Set this to 'true' to add iridium sell prices, health, and energy
+
|-
−
|roe         = Set this to the color of the Roe (matching the filenames in [[:Category:Roe images]]) to add  
+
|professions||Set to false to suppress [[Skills#Fishing|Fisher]] & [[Skills#Fishing|Angler]] prices (Optional)
−
              a section showing roe, aged roe, and prices
+
|-
−
|nopricebonus= Set this to 'true' to show sell prices without bonuses from Fisher/Angler professions
+
|}
−
              (if template is being used for non-fish such as Sea Urchins)
+
<includeonly>[[Category:Infobox templates]]{{Addlanglinks}}</includeonly><noinclude>[[Category:Template documentation]]</noinclude>
−
}}</pre>
 
−
<includeonly>[[Category:Infobox templates]]</includeonly><noinclude>[[Category:Template documentation]]</noinclude>
 
−
<includeonly>{{Addlanglinks}}</includeonly>
 

Latest revision as of 19:36, 10 March 2023

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

Parameter Notes
eng English fish name (Required in all languages. Used to populate image and prices.)
description In-game item description (optional -- populated by Template:Description if omitted). It is preferable to omit this parameter and update Template:Description instead.
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 the "Fishing XP" section if present.
behavior Behavior type of the fish (described in Fish#Behavior)
fl Required fishing level (optional)
size Base size range of the fish in inches (converts to other languages automatically). Can be found in the data file Fish.xnb
Note: Size range must be entered using the hyphen key on a standard English keyboard. This will be replaced with the appropriate character in the template (en dash, wave dash, etc.).
xp XP (and type of XP). Only for fish without the difficulty parameter set.
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
professions Set to false to suppress Fisher & Angler prices (Optional)
Retrieved from "https://stardewvalleywiki.com/mediawiki/index.php?title=Template:Infobox_fish/doc&oldid=146612"