Difference between revisions of "Template:NPCInfo/doc"
From SpiralKnights
m (→Optional) |
m |
||
Line 1: | Line 1: | ||
+ | <noinclude>{{documentation subpage}}</noinclude> | ||
==Usage== | ==Usage== | ||
To display an infobox about an [[NPC]]. NPCs can include bosses as well as miscellaneous knights with very little information. | To display an infobox about an [[NPC]]. NPCs can include bosses as well as miscellaneous knights with very little information. |
Revision as of 22:59, 20 September 2015
This is a documentation subpage for Template:NPCInfo (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 an infobox about an NPC. NPCs can include bosses as well as miscellaneous knights with very little information.
Code
{{NPCInfo |name = |type = |role = }}
Paramters
Required
|name
- The name of the NPC. Defaults to PAGENAME, but it's best to just put the name in to avoid disambig issues.
|type =
- The "race" of the NPC (use lowercase for template standards and switch registration). Examples include: "stranger," "knight," "gremlin," and so on. The template will automatically capitalize this entry.
|role =
- The "job" of the NPC (use lowercase for template standards and switch registration). This is often indicated by text under or preceding the NPC's name. Examples include: "lieutenant", "vendor" (do not use merchant), "informant," "boss," and so on. The template will automatically capitalize this entry.
Optional
|visual
- The file used to display the NPC. Inputs include "monster", "comlink," and "overworld." Defaults to the mugshot naming convention. This switch is only here to maintain file naming consistency. Remember to tag these file uploads with {{NPC image}}.
If the NPC is |type=knight, the appearance field will switch to a list:
|modifier = |helmet = |armor = |shield = |weapon =
Otherwise, simply use:
|appearance =
- and fill this in following the list format as appropriate.
|location
- The location of the NPC.
|abilities
- If the NPC is seen fighting anywhere, describe the tactics here.
|weak
|resist
- If the NPC can take damage, describe the resistances and weaknesses here. Use a similar format to MonsterInfo.
Example
See what links here for examples of this template in action.