Difference between revisions of "Template:Monster/Documentation"

From GodWiki
Jump to navigation Jump to search
m (Update examples to avoid explicit subsection-enabling parameters)
(Update documentation for subtype parameters)
Line 48: Line 48:
 
: 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.
 
: 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.
  
;{{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.
+
===Subtype parameters===
::''('''Note:''' Setting {{para|boss|yes}} will categorize the article into the [[:Category:Boss-Monsters|Boss-Monsters]] category.)''
+
;{{para|boss-type}} : ''Optional'' — See the [[#Boss Types|boss types table]].
:;{{para|boss-type}} : ''Optional if '''boss''' is enabled'' — See the [[#Boss Types|boss types table]].
+
:''('''Note:''' Setting {{para|boss-type}} will categorize the article into the [[:Category:Boss-Monsters|Boss-Monsters]] category.)''
  
;{{para|sea|yes}} : ''Optional'' — If set to a positive value (such as ''yes'', ''y'', ''true'', ''1'', etc.), creates a Beastie infobox, and enables one additional parameter. (Alternate name: {{para|beastie}}.)
+
;{{para|pet-levels}} : ''Optional'' — The range of levels the hero must be in to be able to tame the pet. (AKA: {{para|levels}})
::''('''Note:''' Setting {{para|sea|yes}} will categorize the article into the [[:Category:Beasties|Beasties]] category.)''
+
;{{para|pet-feature}} : ''Optional'' — Only include if the pet actually has a feature listed in its stats. (AKA: {{para|pet-features}}, {{para|feature}}, {{para|features}})
:;{{para|names}} : ''Required if '''sea''' is enabled'' — Set to <code>1</code>/<code>one</code> or <code>2</code>/<code>two</code> to indicate how many names the Beastie has, which represents its "type". (Default: ''Unknown''.)
+
:''('''Note:''' Setting {{para|pet-levels}} or {{para|pet-feature}} will categorize the article into the [[:Category:Pets|Pets]] category.)''
  
;{{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.
+
;{{para|sea-names}} : ''Optional'' — Set to <code>1</code>/<code>one</code> or <code>2</code>/<code>two</code> to indicate how many names the Beastie has, which represents its "type". (Note: ''Required'' with {{para|sea|yes}}, default: ''Unknown''. AKA: {{para|names}})
::''('''Note:''' Setting {{para|pet|yes}} will categorize the article into the [[:Category:Pets|Pets]] category.)''
+
:''('''Note:''' Setting {{para|sea-names}} will categorize the article into the [[:Category:Beasties|Beasties]] 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.
 
  
 +
===Subtype switches===
 +
;{{para|boss|yes}}, {{para|pet|yes}}, {{para|sea|yes}},  : ''Optional'' — If set to a positive value (such as ''yes'', ''y'', ''true'', ''1'', etc.), activate the appropriate sub-category, title change, and categorization. Useful when none of the parameters related to the sub-type can be set.
 +
 +
===Template functionality===
 
; {{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.
 
; {{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.
  
Line 75: Line 77:
 
| class =  
 
| class =  
 
| habitat =  
 
| habitat =  
| boss =  <!-- Set to 'yes' if this is a boss-monster, and possibly fill in... -->
+
| boss-type =  <!-- One of: above, dig, quest, 1ab, 2ab, 3ab. See table for details. -->
| boss-type =  <!-- One of: above, dig, quest, 1ab, 2ab, 3ab. See Template:Monster for details. -->
+
| pet-levels = <!-- Hero levels at which the pet can be tamed -->
| pet =  <!-- Set to 'yes' if this is a tameable monster, and possibly fill in... -->
+
| pet-feature =  <!-- Rideable, Sailing, Dungeon, etc. -->
| levels = <!-- Hero levels at which the pet can be tamed -->
+
| sea-names = <!-- 1 or 2, the number of names the Beastie has -->
| feature =  <!-- Rideable, Sailing, Dungeon, etc. -->  
 
 
}}</nowiki></pre>
 
}}</nowiki></pre>
  
Line 114: Line 115:
 
| class = Important
 
| class = Important
 
| habitat = Bottled water streams
 
| habitat = Bottled water streams
| pet-levels = 18-33
+
| pet-levels = 18-33
 
| totem = Example guild
 
| totem = Example guild
 
}}
 
}}
Line 122: Line 123:
 
| class = Important
 
| class = Important
 
| habitat = Bottled water streams
 
| habitat = Bottled water streams
| pet-levels = 18-33
+
| pet-levels = 18-33
 
| totem = Example guild
 
| totem = Example guild
 
}}</nowiki></pre>{{clear}}
 
}}</nowiki></pre>{{clear}}
Line 132: Line 133:
 
| habitat = Dungeons and cubicles  
 
| habitat = Dungeons and cubicles  
 
| description =  A supervising future teller
 
| description =  A supervising future teller
| boss-type = 3ab
+
| boss-type = 3ab
 
}}
 
}}
 
<pre><nowiki>{{monster
 
<pre><nowiki>{{monster
Line 139: Line 140:
 
| habitat = Dungeons and cubicles  
 
| habitat = Dungeons and cubicles  
 
| description =  A supervising future teller
 
| description =  A supervising future teller
| boss-type = 3ab
+
| boss-type = 3ab
 
}}</nowiki></pre>{{clear}}
 
}}</nowiki></pre>{{clear}}
  
Line 148: Line 149:
 
| habitat = The surface of the water
 
| habitat = The surface of the water
 
| description = A weaponized starfish
 
| description = A weaponized starfish
| sea-names = 1
+
| sea-names = 1
 
}}
 
}}
 
<pre><nowiki>{{monster
 
<pre><nowiki>{{monster
Line 155: Line 156:
 
| habitat = The surface of the water
 
| habitat = The surface of the water
 
| description = A weaponized starfish
 
| description = A weaponized starfish
| sea-names = 1
+
| sea-names = 1
 
}}</nowiki></pre>
 
}}</nowiki></pre>
 
{{clear}}<noinclude>
 
{{clear}}<noinclude>
 
[[Category:Templates/Documents|{{PAGENAME}}]]
 
[[Category:Templates/Documents|{{PAGENAME}}]]
 
</noinclude>
 
</noinclude>

Revision as of 22:32, 16 February 2019

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

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)

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).
|caption=Image description
Optional — Use only if |image= is also set. Text of a descriptive caption to display beneath the image.
|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. (default: Unknown)
|habitat=
The habitat the monster is generally found in. (default: Unknown)
|description=
A brief description of the monster's appearance. (default: Unknown)
|latin=
Optional – The monster's latin name. If set, will be listed directly underneath the article title at the top of the infobox. Automatically italicized.
|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.

Subtype parameters

|boss-type=
Optional — See the boss types table.
(Note: Setting |boss-type= will categorize the article into the Boss-Monsters category.)
|pet-levels=
Optional — The range of levels the hero must be in to be able to tame the pet. (AKA: |levels=)
|pet-feature=
Optional — Only include if the pet actually has a feature listed in its stats. (AKA: |pet-features=, |feature=, |features=)
(Note: Setting |pet-levels= or |pet-feature= will categorize the article into the Pets category.)
|sea-names=
Optional — Set to 1/one or 2/two to indicate how many names the Beastie has, which represents its "type". (Note: Required with |sea=yes, default: Unknown. AKA: |names=)
(Note: Setting |sea-names= will categorize the article into the Beasties category.)

Subtype switches

|boss=yes, |pet=yes, |sea=yes,
Optional — If set to a positive value (such as yes, y, true, 1, etc.), activate the appropriate sub-category, title change, and categorization. Useful when none of the parameters related to the sub-type can be set.

Template functionality

|ignore-no-image=yes
Optional — Set to yes (or any similar positive-state value) to disable the automatic placement of {{Picture}} above the infobox.

Examples of Use

Empty quick-start template

This has the most commonly used parameters ready to fill in. Paste this into an article for a quick start on your monster infobox. Unused parameters will be ignored (or appear as "Unknown").

{{monster
| image =   <!-- An image filename (e.g. Example_picture_name.jpg). If the filename doesn't exist, this gives you a link to upload it. -->
| description = 
| latin =   <!-- a Latin-style species name, if known/made-up -->
| class = 
| habitat = 
| boss-type =   <!-- One of: above, dig, quest, 1ab, 2ab, 3ab. See table for details. -->
| pet-levels = <!-- Hero levels at which the pet can be tamed -->
| pet-feature =   <!-- Rideable, Sailing, Dungeon, etc. --> 
| sea-names = <!-- 1 or 2, the number of names the Beastie has -->
}}

Monster

Monsters of Godville
Monster/Documentation
Example.jpg
Class Demon
Habitat Hell, Swamps, and Old Shoes
Health 55
Death Rattle I'll be back!
Artifact Hell's Hailstone
Wanted on Day 1574 g.e.
Totem for James' Guild ⚜️ 
Description An evil red thing with an attitude
{{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

Pets of Godville
Monster/Documentation
Significantotter.jpg
Class Important
Habitat Bottled water streams
Totem for Example guild ⚜️ 
Description Aquatic mammal
Pet
Tame at levels 18-33
Features Unknown
{{monster
| image = Significantotter.jpg
| description = Aquatic mammal
| class = Important
| habitat = Bottled water streams
| pet-levels = 18-33
| totem = Example guild
}}

Boss-Monster

Boss-Monsters of Godville
Monster/Documentation
Bosstradamus.jpg
Class Squid
Habitat Dungeons and cubicles
Description A supervising future teller
Boss
Boss Type 3-Ability Dungeon
Part Level Level 3
{{monster
| image = Bosstradamus.jpg 
| class = Squid 
| habitat = Dungeons and cubicles 
| description =  A supervising future teller
| boss-type = 3ab
}}

Beastie

Beasties of Godville
Monster/Documentation
ninjastar.jpg
Class Serrated Starfish
Habitat The surface of the water
Description A weaponized starfish
Beastie
Type Single-Named
Strength Level 1: 10-19 HP
{{monster
| image = ninjastar.jpg 
| class = Serrated Starfish 
| habitat = The surface of the water
| description = A weaponized starfish
| sea-names = 1
}}