Template:dNetHack weapon

From NetHackWiki
Jump to navigation Jump to search
) [[Image:{{{name}}}.png]]
Name DNetHack weapon
Appearance DNetHack weapon
Damage vs. small {{{smalldmg}}}
Damage vs. large {{{largedmg}}}
Damage type (none)
To-hit bonus +0
Weapon skill DNetHack weapon
Expert traits (none)
Primary attribute strength
Magical item? no
Properties (none)
Base size medium
Base price {{{cost}}} zm
(+10/positive
enchant)
Default weight {{{weight}}}
Base material [[{{{material}}}]]

This template is designed for use with articles that cover weapons in dNetHack, notdNetHack and notnotdNetHack, and should be called as follows:

{{dNetHack weapon
 |color=COLOR
 |glyph=GLYPH
 |name=NAME
 |tile=[[TILENAME.EXT]]
 |appearance=APPEARANCE
 |smalldmg=SMALLDMG
 |largedmg=LARGEDMG
 |type=TYPE
 |tohit=''TOHIT''
 |skill=SKILL
 |skill2=SKILL2
 |skill3=SKILL3
 |etraits=ETRAITS
 |attr=ATTR
 |attr2=ATTR2
 |attr3=ATTR3
 |magical=MAGICAL
 |insight=INSIGHT
 |future=FUTURE
 |special=SPECIAL
 |size=SIZE
 |cost=COST
 |weight=WEIGHT
 |material=MATERIAL
}}

Appearance, skill, and color are optional parameters: The first two default to the name of the item, and the color defaults to cyan.

Glyph is an optional parameter, and defaults to )—this allows editors to specify other glyphs when describing weapon-tools or non-weapon objects with this template, e.g. ( or * for weapon-tools and gems respectively.

Type refers to the type of damage the weapon is used to inflict, if any: piercing, slashing, blunt, or explosive. If none are entered, it will default to (none).

Tohit is an optional parameter, and defaults to +0; remember to use a <nowiki> tag.

Skill2 and skill3 are optional parameters designated for weapons that utilize multiple weapon skills, and will not be displayed if unused.

Etraits describes the weapon's expert traits and defaults to (none).

Attribute is a parameter that describes which attributes give a bonus to the user's damage with the weapon, and defaults to strength: attr2 and attr3 are optional parameters designated for weapons that utilize multiple such attributes skills, and will not be displayed if unused.

Inisight refers to insight weapons that have special effects activate for a hero wielding them while their insight is at or past certain thresholds—Madpeople and those who have bound Ose also gain a to-hit bonus equal to the lower value between their experience level and insight (explained further in the linked article). The field will not be displayed if unused.

Magical is optional and defaults to "no": simply enter "yes" if the weapon is a magical item ordinarily (i.e. without object properties or traits added outside of standard item generation).

Future is also optional and describes whether or not the weapon is an item restricted in its proper usage to Anachrononauts or Tourists (the latter of whom can also wish for them)—the field will not be displayed if unused.

Special refers to any other properties the weapon may have that does not fit cleanly into any of the other fields—this is usually done in the form of a bulleted list. If none are entered, it will default to (none).

Size is optional and defaults to "medium"—this replaces the "handedness" parameter in the vanilla template, as item size in these variants affects whether or not a given item needs both hands to wield, as well as the size of the hero or monster attempting to wield the item.

Cost and weight are mandatory and fairly self-explanatory. To remove the "(+10/positive enchant)" note (e.g. for stones), add a noenchant=yes parameter.

Material is mandatory and describes the default object material for the item, since it may appear as a different material in gameplay.

Suggestions for which weapon elements the template should cover or parameters that are not properly documented should be directed towards the talk page.