Difference between revisions of "Template:Monster/Documentation"

From GodWiki
Jump to navigation Jump to search
m (Elaborated on default image behaviour, explaining {{Picture}} and how to suppress/detach the templates if required.)
(Update and reformat parameter docs)
Line 4: Line 4:
 
==Parameters==
 
==Parameters==
  
* '''image''' - ''Optional but preferable'' The full image file name.
+
; {{para|image|<var>filename</var>}} : ''Optional but preferred'' The full image file name.
::If {{para|image|<var>image</var>}} is not supplied, the template will default to a generic image, and will automatically insert [[Template:Picture]] above the template, which in turn adds the article to [[:Category:Pictures needed]]. To suppress this behaviour, but still display the default placeholder image (if, for example, {{tlc|{{BASEPAGENAME}}}} is not at the top of the article), you may manually specify the placeholder image by filename using {{para|image|Menagerie.png}}, and separately add {{tl|Picture}} in the appropriate place.
+
: If an image is not supplied, a placeholder will be used, and by default the template will place the {{tlx|picture}} hatnote before the infobox. Disable this if necessary with {{para|ignore-no-image|yes}} ''(see below)''.
  
* '''class''' - The class of the monster e.g. alien, feline, humanoid, demon, amphibian etc.  Be reasonably exact but don't go overboard by using any taxonomy.
+
; {{para|class}} : The class of the monster e.g. alien, feline, humanoid, demon, amphibian etc.  Be reasonably exact but don't go overboard by using any taxonomy.
  
* '''habitat''' - The habitat the monster is generally found in.
+
; {{para|habitat}} : The habitat the monster is generally found in.
  
* '''description''' - A brief description of the monster's appearance
+
; {{para|description}} : A brief description of the monster's appearance.
  
* '''health''' - ''Optional'' To find a monster's health, roll your mouse over the progress bar and it will give you a percentage (let's call it p1). Repeat until you get an EN entry where it tells you how many hp the monster got hit for (call it h). Then roll your mouse over to get the new percentage (call it p2). The health of the monster is: h/((p2-p1)/100).
+
; {{para|health}} : ''Optional'' — The monster's typical health.
 +
: To find a monster's health, roll your mouse over the progress bar and it will give you a percentage (let's call it p1). Repeat until you get an EN entry where it tells you how many hp the monster got hit for (call it h). Then roll your mouse over to get the new percentage (call it p2). The health of the monster is: h/((p2-p1)/100).
  
* '''rattle''' - ''Optional'' Only include if the monster actually has a [[Death Rattle]].
+
; {{para|rattle}} : ''Optional'' Only include if the monster actually has a [[Death Rattle]].
  
* '''artifact''' - ''Optional'' Only include if the monster actually has its [[Monsters' Artifacts|own artifact]].
+
; {{para|artifact|<var>Artifact Name</var>}} : ''Optional'' Only include if the monster actually has its [[Monsters' Artifacts|own artifact]]. Will automatically link to the Godwiki article for that artifact.
  
* '''totem''' - ''Optional'' If the monster is a totem for a guild, the guild may be added here. Write only the guild name.  The name will automatically link to that guild's GodWiki page, and the article will automatically be categorized as a totem monster article.  
+
; {{para|totem|<var>Guild Name</var>}} : ''Optional'' — The Guild which has this monster as its [[Guild Leader#Totem Monster|totem monster]]. Will automatically link to the Godwiki article for that Guild.
 +
::''('''Note:''' Setting {{para|totem}} will categorize the article into the [[:Category:Totem Monsters|Totem Monsters]] category.)''
  
* '''wanted''' - ''Optional'' Add the particular date or dates the monster was wanted in the [[Godville Times]].  In the field, write the word "Day" or "Days" and add the [https://web.archive.org/web/20141229212110*/http://godvillegame.com/news web.archive.org] link of the g.e. day or days the monster was in the godville times. Do no write the letters "g.e." as those are automatically added.
+
;{{para|wanted|<var>date(s)</var>}} : ''Optional'' — Date or dates when the monster was Wanted in the [[Godville Times]].   
 +
: In the field, write the word "Day" or "Days" and add the [https://web.archive.org/web/20141229212110*/http://godvillegame.com/news web.archive.org] link of the g.e. day or days the monster was in the godville times. Don't write the letters "g.e." as those are automatically added.
  
* '''boss''' - ''Optional'' If set to a positive value (such as ''yes'', ''y'', ''true'', ''1'', etc.), creates a Boss-Monster infobox, additionally adds the article to [[:Category:Boss-Monsters]], and enables one additional parameter:
+
;{{para|boss|yes}} : ''Optional'' If set to a positive value (such as ''yes'', ''y'', ''true'', ''1'', etc.), creates a Boss-Monster infobox, and enables one additional parameter:
 +
::''('''Note:''' Setting {{para|boss|yes}} will categorize the article into the [[:Category:Boss Monsters|Boss Monsters]] category.)''
 +
:;{{para|boss-type}} : ''Optional if '''boss''' is enabled'' — See the [[#Boss Types|boss types table]] below.
  
::* '''boss-type''' - ''Optional if '''boss''' is enabled'' (See the table below)
+
;{{para|pet|yes}} : ''Optional'' — If set to a positive value (such as ''yes'', ''y'', ''true'', ''1'', etc.), creates a Pet infobox, and enables two additional parameters:
 +
::''('''Note:''' Setting {{para|pet|yes}} will categorize the article into the [[:Category:Pets|Pets]] category.)''
 +
:;{{para|levels}} : ''Optional if '''pet''' is enabled'' — The range of levels the hero must be in to be able to tame the pet.
 +
:;{{para|feature}} : ''Optional if '''pet''' is enabled'' — Only include if the pet actually has a feature listed in its stats.
  
* '''pet''' - ''Optional'' If set to a positive value (such as ''yes'', ''y'', ''true'', ''1'', etc.), creates a Pet infobox, additionally adds the article to [[:Category:Pets]], and enables two additional parameters:
+
; {{para|ignore-no-image|<var>yes</var>}} : ''Optional'' — Set to <code>yes</code> (or any similar positive-state value) to disable the automatic placement of {{tlx|Picture}} above the infobox.
::* '''levels''' - ''Optional if '''pet''' is enabled'' the range of levels the hero must be in to be able to tame the pet.
 
  
::* '''feature''' - ''Optional if '''pet''' is enabled'' Only include if the pet actually has a feature listed in its stats.
+
===Boss Types===
 
+
: The following codes can be used as arguments to {{para|boss-type}}.
: The pet-optional parameters will be ignored when '''pet''' is undefined, blank, or set to a negative value (''off'', ''no'', ''0'', etc.)
 
 
 
===Available <code>boss-type</code> arguments===
 
 
: {| class="wikitable"
 
: {| class="wikitable"
 
! {{para|boss-type}} !! Boss Type displayed !! Notes
 
! {{para|boss-type}} !! Boss Type displayed !! Notes

Revision as of 04:04, 25 November 2018

As well as automatically categorizing an article into Category:Monsters, this template supplies some standard information about the subject of the article.

Parameters

|image=filename
Optional but preferred — The full image file name.
If an image is not supplied, a placeholder will be used, and by default the template will place the {{picture}} hatnote before the infobox. Disable this if necessary with |ignore-no-image=yes (see below).
|class=
The class of the monster e.g. alien, feline, humanoid, demon, amphibian etc. Be reasonably exact but don't go overboard by using any taxonomy.
|habitat=
The habitat the monster is generally found in.
|description=
A brief description of the monster's appearance.
|health=
Optional — The monster's typical health.
To find a monster's health, roll your mouse over the progress bar and it will give you a percentage (let's call it p1). Repeat until you get an EN entry where it tells you how many hp the monster got hit for (call it h). Then roll your mouse over to get the new percentage (call it p2). The health of the monster is: h/((p2-p1)/100).
|rattle=
Optional — Only include if the monster actually has a Death Rattle.
|artifact=Artifact Name
Optional — Only include if the monster actually has its own artifact. Will automatically link to the Godwiki article for that artifact.
|totem=Guild Name
Optional — The Guild which has this monster as its totem monster. Will automatically link to the Godwiki article for that Guild.
(Note: Setting |totem= will categorize the article into the Totem Monsters category.)
|wanted=date(s)
Optional — Date or dates when the monster was Wanted in the Godville Times.
In the field, write the word "Day" or "Days" and add the web.archive.org link of the g.e. day or days the monster was in the godville times. Don't write the letters "g.e." as those are automatically added.
|boss=yes
Optional — If set to a positive value (such as yes, y, true, 1, etc.), creates a Boss-Monster infobox, and enables one additional parameter:
(Note: Setting |boss=yes will categorize the article into the Boss Monsters category.)
|boss-type=
Optional if boss is enabled — See the boss types table below.
|pet=yes
Optional — If set to a positive value (such as yes, y, true, 1, etc.), creates a Pet infobox, and enables two additional parameters:
(Note: Setting |pet=yes will categorize the article into the Pets category.)
|levels=
Optional if pet is enabled — The range of levels the hero must be in to be able to tame the pet.
|feature=
Optional if pet is enabled — Only include if the pet actually has a feature listed in its stats.
|ignore-no-image=yes
Optional — Set to yes (or any similar positive-state value) to disable the automatic placement of {{Picture}} above the infobox.

Boss Types

The following codes can be used as arguments to |boss-type=.
|boss-type= Boss Type displayed Notes
above Above-Ground
dig or ug Underground
quest Mini-Quest
1 or 1ab 1-Ability Dungeon AKA "Level 1" / "Class C" (old system)
2 or 2ab 2-Ability Dungeon AKA "Level 2" / "Class B"
3 or 3ab or tb 3-Ability Dungeon AKA "Level 3" / "Treasure Boss" / "Class A"
dungeon Dungeon (unknown/generic)

Examples of Use

Monster

{{monster
| image = Example.jpg
| class = Demon
| habitat = Hell, Swamps, and Old Shoes
| description = An evil red thing with an attitude
| health = 55
| rattle = I'll be back!
| artifact = Hell's Hailstone
| totem = James' Guild
| wanted = Day [https://web.archive.org/web/20140830200611/http://godvillegame.com/news 1574]
}}

Pet

{{monster
| image = Significantotter.jpg
| description = Aquatic mammal
| class = Important
| habitat = Bottled water streams
| pet = true
 | levels = 18-33
| totem = Example guild
}}

Boss-Monster

{{monster
| image = Bosstradamus.jpg 
| class = Squid 
| habitat = Dungeons and cubicles 
| description =  A supervising future teller
| boss = true
 | boss-type = 3ab
}}