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.

Difference between revisions of "v0.34:Armor token"

From Dwarf Fortress Wiki
Jump to navigation Jump to search
(→‎Tokens: Testing and some code research identified the effects of the STRUCTURAL_ELASTICITY_* tokens)
m (→‎Tokens: <font> → {{tc}})
 
(3 intermediate revisions by 3 users not shown)
Line 14: Line 14:
  
 
|-
 
|-
−
| NAME
+
| {{text anchor|NAME}}
 
| singular:plural
 
| singular:plural
−
| All
+
| {{tc|red|Required}}
 
| What this item will be called ingame.
 
| What this item will be called ingame.
  
 
|-
 
|-
−
| PREPLURAL
+
| {{text anchor|MATERIAL_SIZE}}
 +
| value
 +
| {{tc|red|Required}}
 +
| 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.
 +
 
 +
|-
 +
| {{text anchor|ARMORLEVEL}}
 +
|
 +
0 - clothing<br>
 +
1 - leather<br>
 +
2 - chain<br>
 +
3 - plate
 +
| All garments and shields
 +
| The garment's general purpose. Defaults to 1 for shields, 0 for everything else. Class 0 items are claimed and used by civilians as ordinary clothing and are subject to [[wear]].
 +
 
 +
|-
 +
| {{text anchor|METAL_ARMOR_LEVELS}}
 +
|
 +
| All garments
 +
| Metal versions of this item count as one ARMORLEVEL higher and thus won't be worn by random peasants.
 +
 
 +
|-
 +
| {{text anchor|CHAIN_METAL_TEXT}}
 +
|
 +
| All garments
 +
| Metal versions of this item will have "chain" added between the material and item name.
 +
 
 +
|-
 +
| {{text anchor|PREPLURAL}}
 
| <phrase> of
 
| <phrase> of
 
| ITEM_ARMOR<br />ITEM_PANTS
 
| ITEM_ARMOR<br />ITEM_PANTS
Line 26: Line 54:
  
 
|-
 
|-
−
| MATERIAL_PLACEHOLDER
+
| {{text anchor|MATERIAL_PLACEHOLDER}}
 
| adjective
 
| adjective
 
| ITEM_ARMOR<br />ITEM_PANTS
 
| ITEM_ARMOR<br />ITEM_PANTS
Line 32: Line 60:
  
 
|-
 
|-
−
| VALUE
+
| {{text anchor|VALUE}}
−
| num
+
|
−
| ITEM_ARMOR<br />ITEM_GLOVES<br />ITEM_SHOES<br />ITEM_SHIELD<br />ITEM_HELM
+
|
 
| Unused. Defaults to -1.
 
| Unused. Defaults to -1.
  
 
|-
 
|-
−
| ARMORLEVEL
+
| {{text anchor|UPSTEP}}
−
|
 
−
0 - clothing<br>
 
−
1 - leather<br>
 
−
2 - chain<br>
 
−
3 - plate
 
−
| All
 
−
| What category this item falls under. Defaults to 1 for shields, 0 for everything else. Clothing-category armor is subject to [[wear]] as well as being used as every-day clothing by dwarves.
 
−
 
 
−
|-
 
−
| UPSTEP
 
 
| value, MAX
 
| value, MAX
 
| ITEM_GLOVES<br />ITEM_SHOES<br />ITEM_SHIELD
 
| ITEM_GLOVES<br />ITEM_SHOES<br />ITEM_SHIELD
−
| This token functions exactly like LBSTEP but in reverse.  How many steps up this item protects.  'Up'is defined as "Connected through a series of one or more body parts with the [LIMB] token to an UPPERBODY part. Gloves and shoes can not protect upper or lower bodies.  Example, chausses with an upstep of MAX, protect the the foot and the entire leg, but not the lower body. The same effect could be achieved (on a humanoid) with UPSTEP>=2.  Since toes and fingers lack the [LIMB] token, gloves and boots do not protect them. This may be a bug.
+
| Length of gloves or footwear, counted in [LIMB] body parts towards the torso. A value of 1 lets gloves cover the lower arms, a value of 2 stretches a boot all the way over the upper leg and so on. Regardless of the value, none of these items can ever extend to cover the upper or lower body. Shields also have this token, but it only seems to affect weight.
  
 
|-
 
|-
−
| UBSTEP
+
| {{text anchor|UBSTEP}}
 
| value, MAX
 
| value, MAX
 
| ITEM_ARMOR
 
| ITEM_ARMOR
−
| How many steps away from upper body the armor protects. Only present on torso armor. When counting steps, ignore any steps through upper or lower body parts(UBSTEP:0 items protect the upper and lower bodies as a result of this). Currently bugged{{bug|1821}}, high values of UBSTEP will result in the item protecting facial features, fingers, and toes, while leaving those parts that it can not protect unprotected (but still counting them as steps).  Torso armor can not protect hands, feet, or heads (parts with [GRASP],[STANCE], or [HEAD] tokens respectively) regardless of the UBSTEP value.  UBSTEP can also not protect parts that can be protected by LBSTEP.  Example, torso armor with [UBSTEP:1] will protect upper arms, wings, non-[STANCE] tails, the torso, and lower body.  However, a torso armor with [UBSTEP:4] or higher will also cover lower arms, fingers, facial features, and toes.  
+
| Length of the sleeves, counted in [LIMB] body parts towards the hands. A value of 0 only protects both halves of the torso, 1 extends over the upper arms and so on. Regardless of the value, body armor can never extend to cover the hands or head.
 +
 
 +
Currently bugged{{bug|1821}}, high values of UBSTEP will result in the item protecting facial features, fingers, and toes, while leaving those parts that it can not protect unprotected (but still counting them as steps).
  
 
|-
 
|-
−
| LBSTEP
+
| {{text anchor|LBSTEP}}
 
| value or MAX
 
| value or MAX
 
| ITEM_ARMOR<br />ITEM_PANTS
 
| ITEM_ARMOR<br />ITEM_PANTS
−
| How many steps down the armor protects. 'Down' is defined as "Connected through a series of one or more body parts with the [LIMB] token to a body part with the [STANCE] token. [LBSTEP] can not protect feet (parts with the [STANCE] token).  When counting steps, ignore any steps through upper or lower body parts.  Example, torso armor with a LBSTEP:1 will protect both the lower body and the upper legs in addition to the torso(the lower body step is not counted).  Leg armor with LBSTEP:MAX will protect the lower body, the entire legs, but not the feet or toes.  
+
| Length of the legs/hem, counted in [LIMB] body parts towards the feet. A value of 0 only covers the lower body, 1 extends over the upper legs and so on. Regardless of the value, body armor or pants can never extend to cover the feet.  
  
 
|-
 
|-
−
| METAL_ARMOR_LEVELS
+
| {{text anchor|BLOCKCHANCE}}
−
|
 
−
| ITEM_ARMOR<br />ITEM_GLOVES<br />ITEM_SHOES<br />ITEM_HELM<br />ITEM_PANTS
 
−
| Metal versions of this item count as one ARMORLEVEL higher.
 
−
 
 
−
|-
 
−
| BLOCKCHANCE
 
 
| value
 
| value
 
| ITEM_SHIELD
 
| ITEM_SHIELD
Line 78: Line 92:
  
 
|-
 
|-
−
| MATERIAL_SIZE
+
| {{text anchor|SOFT}}
−
| 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. <font color="red">Required</font>.
 
−
 
 
−
|-
 
−
| SOFT
 
 
|  
 
|  
−
| All but ITEM_SHIELD
+
| All garments
−
| 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. Further uses of this tag are unknown.
+
| Clothiers can make this item from all kinds of cloth. If paired with [LEATHER], the item has an equal chance of being either in randomly generated outfits. Further uses of this tag are unknown.
  
 
|-
 
|-
−
| HARD
+
| {{text anchor|HARD}}
 
|  
 
|  
−
| All but ITEM_SHIELD
+
| All garments
−
| Allows armor to be made of wood.
+
| Default state in the absence of a [SOFT] token. Actual effects unknown.
  
 
|-
 
|-
−
| METAL
+
| {{text anchor|METAL}}
 
|  
 
|  
−
| All but ITEM_SHIELD
+
| All garments
−
| Item can be made with metal. Randomly generated equipped armor will always be made out of metal whenever possible.
+
| Item can be made from metal. Overrides [SOFT] and [LEATHER] in randomly generated outfits, if the ARMORLEVEL permits. Civilizations with [[Entity_token#WOOD_ARMOR|[WOOD_ARMOR]]] will make this item out of wood instead.
  
 
|-
 
|-
−
| BARRED
+
| {{text anchor|BARRED}}
 
|  
 
|  
−
| All but ITEM_SHIELD
+
| All garments
−
| Can be crafted out of bone. Randomly generated equipped armor will never be made out of bone.
+
| Craftsmen can make this item from bones. Randomly generated outfits don't include bone armor.
  
 
|-
 
|-
−
| SCALED
+
| {{text anchor|SCALED}}
 
|  
 
|  
−
| All but ITEM_SHIELD
+
| All garments
−
| Can be crafted from shell. Randomly generated equipped armor will never be made of shell.
+
| Craftsmen can make this item from shells. Randomly generated outfits don't include shell armor.
  
 
|-
 
|-
−
| LEATHER
+
| {{text anchor|LEATHER}}
 
|  
 
|  
−
| All but ITEM_SHIELD
+
| All garments
−
| Item can be made from leather. Randomly generated equipped armor with [LEATHER] will not be made of cloth, unless [SOFT] is also present.
+
| Leatherworkers can make this item from leather. If paired with [SOFT], this item has an equal chance of being either in randomly generated outfits.
  
 
|-
 
|-
−
| SHAPED
+
| {{text anchor|SHAPED}}
 
|  
 
|  
−
| All but ITEM_SHIELD
+
| All garments
 
| Only one shaped piece of clothing can be worn on a single body slot at a time.
 
| Only one shaped piece of clothing can be worn on a single body slot at a time.
  
 
|-
 
|-
−
| CHAIN_METAL_TEXT
+
| {{text anchor|STRUCTURAL_ELASTICITY_CHAIN_ALL}}
 
|  
 
|  
−
| All but ITEM_SHIELD
+
| All garments
−
| Metal versions of this item will have "chain" added between the material and item name.
+
| Increases the *_STRAIN_AT_YIELD properties of the armor's material to 50000, if lower. This makes the garment flex and give way instead of shattering under force. Strong materials that resist cutting will blunt edged attacks into bone-crushing hits instead.
  
 
|-
 
|-
−
| STRUCTURAL_ELASTICITY_WOVEN_THREAD
+
| {{text anchor|STRUCTURAL_ELASTICITY_CHAIN_METAL}}
−
|
 
−
| All but ITEM_SHIELD
 
−
| Behaves almost the same as STRUCTURAL_ELASTICITY_CHAIN_ALL, but only when the object is made from woven thread. Also, the SHEAR_YIELD of the armor is capped at 20000 and the SHEAR_FRACTURE is capped at 30000. This causes the armor to be significantly weaker against edged (cutting/slashing/piercing) damage, even if the thread material is normally very strong.
 
−
 
 
−
|-
 
−
| STRUCTURAL_ELASTICITY_CHAIN_METAL
 
 
|  
 
|  
−
| All but ITEM_SHIELD
+
| All garments
−
| Behaves the same as STRUCTURAL_ELASTICITY_CHAIN_ALL, but only when the object is made of metal.
+
| Increases the *_STRAIN_AT_YIELD properties of the armor's material to 50000, but only if the garment is made from metal.
  
 
|-
 
|-
−
| STRUCTURAL_ELASTICITY_CHAIN_ALL
+
| {{text anchor|STRUCTURAL_ELASTICITY_WOVEN_THREAD}}
−
|  
+
|
−
| All but ITEM_SHIELD
+
| All garments
−
| Sets the *_STRAIN_AT_YIELD properties of the armor's material to a minimum of 50000, if not already higher. This causes the armor to flex like skin and pass blunt damage to the layers below.
+
| Reduces the armor material's SHEAR_YIELD to 20000, SHEAR_FRACTURE to 30000 and increases the *_STRAIN_AT_YIELD properties to 50000, but only if the garment is made from cloth. This makes the item very weak against edged attacks, even if the thread material is normally very strong.
  
 
|-
 
|-
−
| LAYER_SIZE
+
| {{text anchor|LAYER_SIZE}}
 
| value
 
| value
−
| All but ITEM_SHIELD
+
| All garments
−
| What the size of this item in question is, when it is put on. Also affects armor weight. See [[Armor]] for more on item sizes and layering. Defaults to 10.  
+
| The item's bulkiness when worn. Aside from the layer limitations, it's a big contributor to the thickness and weight (and therefore price) of the garment. See [[Armor]] for more on item sizes and layering. Defaults to 10.  
  
 
|-
 
|-
−
| LAYER_PERMIT
+
| {{text anchor|LAYER_PERMIT}}
 
| value
 
| value
−
| All but ITEM_SHIELD
+
| All garments
−
| 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. Defaults to 10.
+
| The maximum amount of crap that can fit underneath the garment. See [[Armor]] for more on item sizes and layering. Defaults to 10.
  
 
|-
 
|-
−
| LAYER
+
| {{text anchor|LAYER}}
−
| UNDER, OVER, ARMOR, COVER
+
| UNDER<br />OVER<br />ARMOR<br />COVER
−
| All but ITEM_SHIELD
+
| All garments
−
| How this item is layered. The [LAYER_PERMIT:#] of a [LAYER:ARMOR] item overrides the [LAYER_PERMIT:#] of other items on the same ITEM_<name1>, unless it is a [LAYER:COVER] items. Defaults to UNDER.
+
| Where the item goes in relation to other clothes. Socks cannot be worn on top of boots!
 +
The LAYER_PERMIT of the highest layer is used on a given section of the body - you can fit a lot of shirts and other undergarments underneath a robe, but not if you wear a leather jerkin on top of it, and you can still wear a cloak over the whole ensemble. Defaults to UNDER.
  
 
|-
 
|-
−
| COVERAGE
+
| {{text anchor|COVERAGE}}
 
| % value
 
| % value
−
| All but ITEM_SHIELD
+
| All garments
−
| Coverage determines how often attacks and contaminants get through clothes. Armor with a 5% coverage value, for example, will be near useless because 95% of attacks will bypass it completely. Temperature effects are also influenced by coverage. Defaults to 100.
+
| How often the garment gets in the way of a contaminant or an attack. Armor with a 5% coverage value, for example, will be near useless because 95% of attacks will bypass it completely. Temperature effects and armor thickness are also influenced. Defaults to 100.
  
 
|}
 
|}

Latest revision as of 18:51, 17 March 2014

xTATTEREDx  · +FINE+  · *SUPERIOR*  · ≡EXCEPTIONAL≡  · ☼MASTERWORK☼
v50.14 · v0.47 · v0.34.11 · v0.31 · v0.28 · v0.23
This article is about an older version of DF.

The tokens for all types of armor on all slots, including shields. Usage column gives information on what types of armor the token might be restricted to.

These tokens can only be placed within an ITEM_ARMOR, ITEM_GLOVES, ITEM_SHOES, ITEM_SHIELD, ITEM_HELM, or ITEM_PANTS object definition, most do not function in weapon objects.

Tokens[edit]

Token Arguments Usage Description
NAME singular:plural Required What this item will be called ingame.
MATERIAL_SIZE value Required 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.
ARMORLEVEL

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

All garments and shields The garment's general purpose. Defaults to 1 for shields, 0 for everything else. Class 0 items are claimed and used by civilians as ordinary clothing and are subject to wear.
METAL_ARMOR_LEVELS All garments Metal versions of this item count as one ARMORLEVEL higher and thus won't be worn by random peasants.
CHAIN_METAL_TEXT All garments Metal versions of this item will have "chain" added between the material and item name.
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 adjective ITEM_ARMOR
ITEM_PANTS 		If the item has no material associated with it (e.g. stockpile menus and trade negotiations), this will be displayed in its place. Used for leather armor.
VALUE Unused. Defaults to -1.
UPSTEP value, MAX ITEM_GLOVES
ITEM_SHOES
ITEM_SHIELD 		Length of gloves or footwear, counted in [LIMB] body parts towards the torso. A value of 1 lets gloves cover the lower arms, a value of 2 stretches a boot all the way over the upper leg and so on. Regardless of the value, none of these items can ever extend to cover the upper or lower body. Shields also have this token, but it only seems to affect weight.
UBSTEP value, MAX ITEM_ARMOR Length of the sleeves, counted in [LIMB] body parts towards the hands. A value of 0 only protects both halves of the torso, 1 extends over the upper arms and so on. Regardless of the value, body armor can never extend to cover the hands or head.

Currently buggedBug:1821, high values of UBSTEP will result in the item protecting facial features, fingers, and toes, while leaving those parts that it can not protect unprotected (but still counting them as steps).

LBSTEP value or MAX ITEM_ARMOR
ITEM_PANTS 		Length of the legs/hem, counted in [LIMB] body parts towards the feet. A value of 0 only covers the lower body, 1 extends over the upper legs and so on. Regardless of the value, body armor or pants can never extend to cover the feet.
BLOCKCHANCE value ITEM_SHIELD Affects the block chance of the shield. Defaults to 10.
SOFT All garments Clothiers can make this item from all kinds of cloth. If paired with [LEATHER], the item has an equal chance of being either in randomly generated outfits. Further uses of this tag are unknown.
HARD All garments Default state in the absence of a [SOFT] token. Actual effects unknown.
METAL All garments Item can be made from metal. Overrides [SOFT] and [LEATHER] in randomly generated outfits, if the ARMORLEVEL permits. Civilizations with [WOOD_ARMOR] will make this item out of wood instead.
BARRED All garments Craftsmen can make this item from bones. Randomly generated outfits don't include bone armor.
SCALED All garments Craftsmen can make this item from shells. Randomly generated outfits don't include shell armor.
LEATHER All garments Leatherworkers can make this item from leather. If paired with [SOFT], this item has an equal chance of being either in randomly generated outfits.
SHAPED All garments Only one shaped piece of clothing can be worn on a single body slot at a time.
STRUCTURAL_ELASTICITY_CHAIN_ALL All garments Increases the *_STRAIN_AT_YIELD properties of the armor's material to 50000, if lower. This makes the garment flex and give way instead of shattering under force. Strong materials that resist cutting will blunt edged attacks into bone-crushing hits instead.
STRUCTURAL_ELASTICITY_CHAIN_METAL All garments Increases the *_STRAIN_AT_YIELD properties of the armor's material to 50000, but only if the garment is made from metal.
STRUCTURAL_ELASTICITY_WOVEN_THREAD All garments Reduces the armor material's SHEAR_YIELD to 20000, SHEAR_FRACTURE to 30000 and increases the *_STRAIN_AT_YIELD properties to 50000, but only if the garment is made from cloth. This makes the item very weak against edged attacks, even if the thread material is normally very strong.
LAYER_SIZE value All garments The item's bulkiness when worn. Aside from the layer limitations, it's a big contributor to the thickness and weight (and therefore price) of the garment. See Armor for more on item sizes and layering. Defaults to 10.
LAYER_PERMIT value All garments The maximum amount of crap that can fit underneath the garment. See Armor for more on item sizes and layering. Defaults to 10.
LAYER UNDER
OVER
ARMOR
COVER 		All garments Where the item goes in relation to other clothes. Socks cannot be worn on top of boots!

The LAYER_PERMIT of the highest layer is used on a given section of the body - you can fit a lot of shirts and other undergarments underneath a robe, but not if you wear a leather jerkin on top of it, and you can still wear a cloak over the whole ensemble. Defaults to UNDER.

COVERAGE % value All garments How often the garment gets in the way of a contaminant or an attack. Armor with a 5% coverage value, for example, will be near useless because 95% of attacks will bypass it completely. Temperature effects and armor thickness are also influenced. Defaults to 100.
Retrieved from "https://dwarffortresswiki.org/index.php?title=v0.34:Armor_token&oldid=197710"