Difference between revisions of "Template:MonstrousProfile/doc"
From SpiralKnights
m (→Optional) |
m (update parameters) |
||
| Line 1: | Line 1: | ||
| + | <noinclude>{{documentation subpage}}</noinclude> | ||
==Usage== | ==Usage== | ||
To display important information about a specific monster species on that monster's page. Please have ToC sections (<nowiki>===NAME===</nowiki>) with the name of the monster immediately before this code. | To display important information about a specific monster species on that monster's page. Please have ToC sections (<nowiki>===NAME===</nowiki>) with the name of the monster immediately before this code. | ||
| Line 21: | Line 22: | ||
|tier | |tier | ||
| − | :The tiers | + | :The tiers in which the monster has can be encountered, considering its visual appearance as well. Some monsters look the same for all tiers. Enter one of the following that fits: |
| − | :: | + | ::universal (example usage is "Zombie") |
| − | :: | + | ::1 (if only encountered in tier 1) |
| − | :: | + | ::2 (if only encountered in tier 2) |
| − | :: | + | ::3 (if only encountered in tier 3) |
| − | ::1,2 | + | ::1,2 (if only encountered in tier 1 or 2) |
::1,3 (this is not used with the way the game works right now) | ::1,3 (this is not used with the way the game works right now) | ||
| − | ::2,3 (example usage is Black Kat) | + | ::2,3 (if only encountered in tier 2 or 3, example usage is "Black Kat") |
| − | ::1,2,3 (most commonly used) | + | ::1,2,3 (most commonly used - this is only for monsters that have a different visual appearance per tier) |
| + | |||
| + | |specific | ||
| + | :yes | ||
| + | :no | ||
| + | ::Defaults to yes for most of the above parameters. Only set to "no" if the monster has the same appearance for every encounter, and/or is isolated to that tier through some convention such as "clan". "specific=yes" means the monster "yes, has a specific appearance per tier." So no would mean the monster looks the same for every encounter, even if it has different attacks. Example usage: Certain bosses, gremlin clan units such as "Ironclaw Mender". When set to "no," there should only be one cell containing a single image. | ||
|combat | |combat | ||
| Line 38: | Line 44: | ||
===Optional=== | ===Optional=== | ||
| − | |||
| − | |||
| − | |||
|notes | |notes | ||
| − | :Most monsters behave the same way as each other within a species, so the template uses a default statement. | + | :Most monsters behave the same way as each other within a species, so the template uses a default statement. Mention [[status]] immunity here. |
|encounter | |encounter | ||
Revision as of 01:12, 8 September 2015
 |
This is a documentation subpage for Template:MonstrousProfile (see that page for the template itself). It contains usage information, categories and other content that is not part of the original template page. |
Usage
To display important information about a specific monster species on that monster's page. Please have ToC sections (===NAME===) with the name of the monster immediately before this code.
Code
{{MonstrousProfile
|name =
|tier =
|description =
|notes =
|combat =
|loot =
|encounter =
}}
Parameters
Required
|name
- The name of the monster
|tier
- The tiers in which the monster has can be encountered, considering its visual appearance as well. Some monsters look the same for all tiers. Enter one of the following that fits:
- universal (example usage is "Zombie")
- 1 (if only encountered in tier 1)
- 2 (if only encountered in tier 2)
- 3 (if only encountered in tier 3)
- 1,2 (if only encountered in tier 1 or 2)
- 1,3 (this is not used with the way the game works right now)
- 2,3 (if only encountered in tier 2 or 3, example usage is "Black Kat")
- 1,2,3 (most commonly used - this is only for monsters that have a different visual appearance per tier)
|specific
- yes
- no
- Defaults to yes for most of the above parameters. Only set to "no" if the monster has the same appearance for every encounter, and/or is isolated to that tier through some convention such as "clan". "specific=yes" means the monster "yes, has a specific appearance per tier." So no would mean the monster looks the same for every encounter, even if it has different attacks. Example usage: Certain bosses, gremlin clan units such as "Ironclaw Mender". When set to "no," there should only be one cell containing a single image.
|combat
- The attacks of the monster in bullet list form. Be sure to mention damage type, status if relevant, and tier.
|loot
- The possible drops of the monster. Please use Template:Material/Monster whenever relevant. Fiends will also use Template:Material/MotT-Fiend. Monsters that do not fit the norm should have specialized entries.
Optional
|notes
- Most monsters behave the same way as each other within a species, so the template uses a default statement. Mention status immunity here.
|encounter
- The possible and set areas in which this monster can be found. This is linked to a subpage specific to each monster. These subpages have a specific format that should be followed. See the Firo Knight/Encounter page for an example.
- If the monster cannot be found anywhere ever (it is obsolete), set this =no, otherwise, do not include this parameter in the code.
Examples
See what links here for examples of this template in action.
Notes
Previous version of this type of information's display: Template:Monster.
See Also
Forum discussions about this template:
- Node 108429 (monster templates could include status resistance information)
- Node 111444 (materials)
