Template:Npc infobox/doc

From Terraria Wiki
Jump to: navigation, search

This template is used for displaying the infobox for an NPC (including enemies, bosses, critters, etc.). Together with {{item infobox}}, it is one of the most important and most powerful infobox templates.

Usage[edit source]

The template's main functionality is to display the standard infobox.

The data which is to be displayed can be manually entered when calling the template, but thanks to {{npcinfo}}, the vast majority of data is generated automatically. To enable automatic data, use the parameter auto and set it to the ID of the NPC (alternatively: auto=yes and either id=<NPC ID>, name=<NPC name>, or nothing else – the latter two methods will cause the template to automatically generate the ID using {{npcNameFromId}}, with the last method using the page title for name reference). This way, all relevant NPC parameters are set automatically. See the table below for affected parameters. However, they can still be overridden, and manually entered parameters always take precedence over the automatic ones.

Basic parameters[edit source]

Notes:
  • The dollar sign ($) is used to signify that the word after it is the name of a template parameter.
  • All parameters which have a default value listed can usually be omitted. Note that this does not mean that parameters which do not have a default value listed should always be filled in.
Parameter Description Auto Example Default value
(if omitted)
Note
{{item infobox
Box-related parameters
| boxwidth Width of the infobox 27em Number with unit. The box is adjusting to the width of the images by default.
| float Position of the infobox left right
| css
 or
| style
CSS style affecting the entire infobox Any width or float properties defined here will override the template's $boxwidth and $float parameters, respectively.
| auto Enables automatic data 201 Can also be yes (see text above).
| id ID of the NPC Yes 201 Cosmetic ID to be displayed, overrides the display of $auto and $idcargo.
| name Name of the NPC Yes Skeleton <page name> Will be displayed as the heading of the infobox.
| name2 Cosmetic addition to the name &#32; / {{expert|Lunatic Cultist}} Will be directly appended to $name.
| namesub Name sub-heading Yes Additional information directly underneath the title of the infobox. Mainly internal NPC variant names, like Astronaut Skeleton.
| namesub2 Name sub-heading First Form Additional information directly underneath the title of the infobox or underneath $namesub. Intended to be used as a manual $namesub, because manually setting $namesub to something would prevent its automatic display.
| namenote Name sub-sub-heading Yes Will be displayed underneath $namesub / $namesub2. Mainly NPC variant descriptions, like Halloween Variant 2.
| expertonly Expert-exclusivity of the NPC yes Causes the {{expert}} formatting to be applied to most of the displayed stats and the following line to be displayed underneath title / $namesub / $namesub2 / $namenote: (Expert mode exclusive)
Image-related parameters
| imagealt Complete custom control over the display of the first image [[File:Skeleton.png]] Overrides the $image and $imagesize parameters. Multiple images can be provided and/or text and other formatting.
| image Main image of the NPC Skeleton.png $namesub.png or $name.png This is the image that is stored to cargo by default.
| imagesize Size of the main image 40x20px*0.75 *1 Corresponds to the size parameter of {{image}}: <width>x<height>*<scale>
| imageexpert Image of the Expert variant Skeleton.png
| image2 Additional image Skeleton.png Default value: <$image without ".png">_(old).png / .gif. Leave it empty to disable this automatic old image discovering.
| imagemode Controls image display full Setting it to anything other than full prevents the automatic display of $image2.
| image3 Additional image Skeleton.png
| imageversion2 Exclusive versions of $image2 desktop-console old-gen-3ds Versions that will be displayed when hovering over $image2 (by default the _(old) one, so the "old" versions are the default). Valid values are desktop, console, mobile, old-gen, and 3ds.
| imageversion3 Exclusive versions of $image3 desktop-console Versions that will be displayed when hovering over $image3. Valid values are the same as for $imageversion2.
| imageother Additional image at the bottom Map Icon Skeletron.png Will be displayed at the bottom of the infobox. Usually used for map icons or sprites of NPCs' temporary states (e.g. the "rolling" state of the Sroller).
| imageothercaption Caption of $imageother Rolling state Will be displayed underneath $imageother. Has no effect if $imageother is not set.
Statistics-related parameters
| type
| type2
| type3
Classification Boss Enemy $type2 will be separated with a dot (•) from $type; type3 will always be on a new line. All types will be linked, if the respective page exists.
| environment
| environment2 (deprecated)
| environment3 (deprecated)
Native environment of the NPC Desert
Forest+Rain
Desert / Forest
Desert / Forest+Rain
Biome in which or event during which the NPC naturally spawns. "+" means AND and "/" means OR; all environments will be linked if the respective page exists. |environment=A|environment2=B|environment3=C is same as |environment=A/B/C
| ai AI style of the NPC Yes Fighter AI
| damage Damage Yes
| damage2 Addition to the damage Will be directly appended to $damage. Can be used, for instance, for differentiation between different attacks of the NPC or different platforms.
| life Maximum health of the NPC Yes
| life2 Addition to the maximum health Will be directly appended to $life.
| defense Defense of the NPC Yes
| defense2 Addition to the defense Will be directly appended to $defense.
| knockback Resistance to knockback of the NPC Yes
| knockback2 Addition to the knockback resistance Will be directly appended to $knockback.
| banner Banner of the NPC Yes yes Setting it to yes will cause it to take $name Banner as the banner name, but it can also simply be set to the name of the banner.

Note that, if using $auto and the NPC having a valid banner associated to it, the banner item will be stored to cargo in a hidden {{item infobox}}.

| immune1
 through
| immune10
Debuffs to which the NPC is immune Yes Will only be displayed if $type is not one of the following:
| immuneall Immunity to all debuffs Yes yes
| immuneallnote Addition to $immuneall Will be directly appended to the text "All debuffs" that is displayed if $immuneall is set. Example: <br/><span style="color:#666;">(except {{item|Stunned|scale=0.5}})</span>
Buff- & Debuff-related parameters
| buff Name or ID of the buff the NPC causes No Dryad's Blessing
| bufftip Buff tooltip Yes No effect if $buff is not set.
| duration Buff duration No 5–10 seconds
| debuff Name or ID of the debuff that the NPC inflicts No Can also be a debuff ID.
| debufftip Debuff tooltip Yes
| debuffchance Debuff chance No
| debuffchancenote Addition to $debuffchance No Will be displayed underneath $debuffchance. Has no effect if $debuffchance is not set.
| debuffduration Debuff duration No
| debuff2 Second debuff that the NPC inflicts No See above. These parameters behave in the exact same manner.
| debufftip2 Debuff tooltip Yes
| debuffchance2 Debuff chance No
| debuffchancenote2 Addition to $debuffchance2 No
| debuffduration Debuff duration No
Drop-related parameters
| money Base amount of money that the NPC drops Yes {{coin|3gc 80sc}} Use the {{coin}} template.
| money2 Addition to dropped money Will be directly appended to $money.
| <item name 1>
| <item quantity 1>
| <item rate 1>


| <item name 2>
| <item quantity 2>
| <item rate 2>

...

| <item name n>
| <item quantity n>
| <item rate n>

Dropped item No |Gel|2–5|75% / {{expert|100%}} Note that these are unnamed parameters, i.e., they are not used with an equals sign (=) like the other parameters.


Repeat this triple of parameters as many times as necessary.

Leave $<item quantity> free to set it to 1.

| group
| <group heading>
| <group size>
Group of dropped items |group|Only one of the following 4 will drop|4 Note that these are unnamed parameters, i.e., they are not used with an equals sign (=) like the other parameters.


Visually groups dropped items. See most bosses' pages, e.g. Queen Bee, for examples.

| custom
| <custom item display>
| <item rate>
Custom dropped item Note that these are unnamed parameters, i.e., they are not used with an equals sign (=) like the other parameters.


Grants custom control over $<item name> and $<item quantity>. See Guide for an example.

Sound-related parameters
| soundhurt Hurt sound effect Yes NPC_Hit_1.wav Can be a comma-separated list for multiple sounds. Caption is "Hurt". Set to an empty value (|soundhurt=) to hide the automatically generated sounds.
| soundkilled Hurt sound effect Yes NPC_Killed_1.wav Can be a comma-separated list for multiple sounds. Caption is "Killed". Set to an empty value (|soundkilled=) to hide the automatically generated sounds.
| sound1 Custom additional sound effect Can be a comma-separated list for multiple sounds.
| soundcaption1 Caption for the sound effect
| sound2 Custom additional sound effect Can be a comma-separated list for multiple sounds.
| soundcaption2 Caption for the sound effect
| sound<n> Custom additional sound effect Can be continued nearly infinitely. Sounds will only be displayed if there is a sound<n> parameter with a corresponding soundcaption<n> parameter.
| soundcaption<n> Caption for the sound effect
Back-end-related parameters
| cate Toggles all categorization No no Set to yes to force categorization when it is disabled by default (on non-mainspace pages). Set to no to disable categorization.
| listcat
| listcat2
Categorization No Supplemental category names (Category:$listcat NPCs).

Note: The template mainly categorizes the page based on the other parameters (using {{npc infobox/cate}}). It takes the values of the following parameters:

  • $type
  • $type2
  • $type3
  • $environment
  • $environment2
  • $ai

and adds the category Category:<parameter value> NPCs.

| allversions Platform version availability No yes Set to yes to assert that the NPC is available on all platforms of Terraria. Categorizes the page in all five version content categories (with the exception of Category:Japanese console content).
| hardmode Hardmode-exclusivity No yes Set to yes to assert that the NPC is not available in pre-Hardmode, but only becomes available in Hardmode. Categorizes the page in Category:Hardmode-only NPCs.
| cargo Toggles cargo data storage No no Set to yes to force cargo data storage when it is disabled by default (on non-mainspace root pages[1]). Set to no to disable cargo data storage.
| idcargo NPC ID to store to cargo No 201 Can be a comma-separated list. Can also be left empty to prevent cargo storage as well.
| imagecargo NPC image to store to cargo No [[File:Skeleton.png]] Define an image to store to cargo, completely overriding the image parameters.

Subpages[edit source]

There are numerous supplemental subpages which are mainly used for formatting certain data:

See also[edit source]

Footnotes[edit source]

  1. A root page is a page that is not a subpage. This prevents language subpages from storing duplicates by default.