v50 Steam/Premium information for editors
  • v50 information can now be added to pages in the main namespace. v0.47 information can still be found in the DF2014 namespace. See here for more details on the new versioning policy.
  • Use this page to report any issues related to the migration.
This notice may be cached—the current version can be found here.

23a:Armor token

From Dwarf Fortress Wiki
Jump to navigation Jump to search
This article is about an older version of DF.

The tokens for armor, gloves, shoes, shields, helms, and pants. Usage column gives information on where use of the token might be restricted to.

Token Arguments Usage Description
NAME singular:plural All What this item will be called ingame.
PREPLURAL <phrase> of

item_armor
item_pants

Changes the plural form of this item to "<phrase of> item". Primarily pertains to the stock screens. Example, "suits of" platemail, "pairs of" trousers, etc.
MATERIAL_PLACEHOLDER <phrase> item_armor

item_pants

This sets a word to be used in-game instead of a material type, currently only appears on leather armor e.g. steel full plate becomes <phrase> full plate.
WEIGHT value All How much the item weighs.
VALUE value All Value multiplier of the item. It will be multiplied by item quality and material.
ARMORLEVEL

omitted - clothing
1 - leather
2 - chain
3 - plate

All What category this item falls under. Lack of this tag makes this item clothes level. For shields, level 1 is Buckler and level 2 is Shield.
UPSTEP value, MAX item_gloves

item_shoes
item_shield

Item protects body parts a step up from where it is. Example, bucklers with an upstep of one, protect the lower arm, but should also protect the upper arm. Unknown what MAX does. Chausses have an upstep of this value.
UBSTEP value, MAX item_armor How many steps up away from upper body the armor protects. Only present on torso armor. Coats/shirts/cloaks have it at MAX; Plate/chain/leather armors and togas/dresses/robes have it at 1; Tunics/capes/vests have it at 0
LBSTEP value or MAX

item_armor
item_pants

How many steps down the armor protects. Torso armor has this at 1, most leg armor has this at MAX.
BLOCKPOWER value

item_gloves
item_shoes
item_shield
item_helm
item_pants

How much damage the item blocks when that body part is struck.
BLOCKCHANCE value item_shield Affects the block chance of the shield.
CHAIN_METAL item_pants Metal versions of this item will have "chain" added between the material and item name.
METAL_ARMOR_LEVELS

item_armor
item_gloves
item_shoes
item_helm
item_pants

Metal versions of this item count as one ARMORLEVEL higher.
MAINBLOCK value item_armor Only used when defining chest slot armor. Affects the item's primary block value.
SECONDBLOCK value item_armor Tag only present for chest armors. Affects secondary block value, that is, the block value for parts protected only thanks to UB/LBSTEP rather than by being the main part(like the torso)
MATERIAL_SIZE value All How much material is needed to make the item. Most important with bars. The number of bars required to make the item is the value divided by three.
SOFT All Item can wear when worn. Opposite of [HARD]. Randomly generated equipped armor will have an equal probability of being made of leather or cloth, when this token is present and [METAL] is absent.
HARD All Item does not wear when worn. Opposite of [SOFT]. No tag defaults to [HARD].
METAL All Item can be made with metal. Randomly generated equipped armor will always be made out of metal whenever possible.
BARRED All Can be crafted out of bone. Randomly generated equipped armor will never be made out of bone.
SCALED All Can be crafted from shell. Randomly generated equipped armor will never be made of shell.
LEATHER All Item can be made from leather. Randomly generated equipped armor with [LEATHER] will not be made of cloth, unless [SOFT] is also present.
SHAPED All Only one shaped piece of clothing can be worn on a single body slot at a time.
LAYER_SIZE value All What the size of this item in question is, when it is put on. See Armor for more on item sizes and layering.
LAYER_PERMIT value All The maximum number of items allowed on that body slot. If the body slot's layer value is over this, no more of this item can be put on. See Armor for more on item sizes and layering.
LAYER OVER, UNDER, ARMOR, COVER All How this item is layered.
COVERAGE value All Coverage influences how often contaminants get through clothes and temperature effects