Difference between revisions of "Template:NPCInfo/doc"
From SpiralKnights
m (→Optional) |
m (→Paramters: typo) |
||
| (3 intermediate revisions by one other user not shown) | |||
| 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. | ||
| Line 11: | Line 12: | ||
</pre> | </pre> | ||
| − | == | + | ==Parameters== |
===Required=== | ===Required=== | ||
|name | |name | ||
| Line 17: | Line 18: | ||
|type = | |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. | + | :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 for visual purposes. |
|role = | |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 "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. Link to terms as appropriate. Certain roles are exclusive to certain NPCs and do not require linking. |
===Optional=== | ===Optional=== | ||
| Line 48: | Line 49: | ||
|resist | |resist | ||
:If the NPC can take damage, describe the resistances and weaknesses here. Use a similar format to MonsterInfo. | :If the NPC can take damage, describe the resistances and weaknesses here. Use a similar format to MonsterInfo. | ||
| + | |||
| + | |intro<br> | ||
| + | :Override the default "NAME is an [[NPC]]." to appropriate grammar or phrasing. | ||
==Example== | ==Example== | ||
Latest revision as of 00:17, 8 May 2020
 |
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 =
}}
Parameters
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 for visual purposes.
|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. Link to terms as appropriate. Certain roles are exclusive to certain NPCs and do not require linking.
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.
|intro
- Override the default "NAME is an NPC." to appropriate grammar or phrasing.
Example
See what links here for examples of this template in action.
