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.31:Armor token"

From Dwarf Fortress Wiki
Jump to navigation Jump to search
(ITEM_* is not a token - it's the object definition header!)
(reorder, add missing tokens, and properly indicate which tokens are supported for each item type)
Line 3: Line 3:
 
The tokens for all types of {{l|armor}} on all slots, including {{l|shield}}s. Usage column gives information on what types of armor the token might be restricted to.
 
The tokens for all types of {{l|armor}} on all slots, including {{l|shield}}s. 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_HELM, ITEM_SHOES, ITEM_SHIELD, ITEM_PANTS, or ITEM_GLOVES object definition.
+
These tokens can only be placed within an ITEM_ARMOR, ITEM_GLOVES, ITEM_SHOES, ITEM_SHIELD, ITEM_HELM, or ITEM_PANTS object definition.
  
 
==Tokens==
 
==Tokens==
Line 12: Line 12:
 
! Usage
 
! Usage
 
! Description
 
! Description
 +
 +
|-
 +
| NAME
 +
| singular:plural
 +
| All
 +
| What this item will be called ingame.
 +
 +
|-
 +
| PREPLURAL
 +
| <phrase> of
 +
| ITEM_ARMOR<br />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<br />ITEM_PANTS
 +
|
 +
 +
|-
 +
| VALUE
 +
| num
 +
| ITEM_ARMOR<br />ITEM_GLOVES<br />ITEM_SHOES<br />ITEM_SHIELD<br />ITEM_HELM
 +
| Unused
 +
 
|-
 
|-
 
| ARMORLEVEL
 
| ARMORLEVEL
Line 23: Line 48:
  
 
|-
 
|-
−
| BARRED
+
| UPSTEP
 +
| value, MAX
 +
| 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.{{version|0.31.03}}  Although this is a valid token for body armor, it has no effect.
 +
 
 +
|-
 +
| UBSTEP
 +
| value, MAX
 +
| 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,{{version|0.31.03}} 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.
 +
 
 +
|-
 +
| LBSTEP
 +
| value or MAX
 +
| 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.
 +
 
 +
|-
 +
| METAL_ARMOR_LEVELS
 
|  
 
|  
−
| All
+
| ITEM_ARMOR<br />ITEM_GLOVES<br />ITEM_SHOES<br />ITEM_HELM<br />ITEM_PANTS
−
| Can be crafted out of bone. Randomly generated equipped armor will never be made out of bone.
+
| Metal versions of this item count as one ARMORLEVEL higher.
  
 
|-
 
|-
 
| BLOCKCHANCE
 
| BLOCKCHANCE
 
| value
 
| value
−
| item_shield
+
| ITEM_SHIELD
−
| Tag only present for shields. Affects the block chance of the shield.
+
| Affects the block chance of the shield.
  
 
|-
 
|-
−
| CHAIN_METAL_TEXT
+
| MATERIAL_SIZE
−
|  
+
| value
−
| item_pants
+
| All
−
| Metal versions of this item will have "chain" added between the material and item name. Not a valid token for some armor slots.
+
| 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.
  
 
|-
 
|-
−
| COVERAGE
+
| SOFT
−
| % value
+
|  
 
| All
 
| All
−
| 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 compleatly.  Temperature effects are also influenced by coverage.
+
| Item can {{L|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.
  
 
|-
 
|-
Line 53: Line 96:
  
 
|-
 
|-
−
| LAYER
+
| METAL
−
| UNDER, OVER, ARMOR, COVER
+
|  
 
| All
 
| All
−
| 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.
+
| Item can be made with metal. Randomly generated equipped armor will always be made out of metal whenever possible.
  
 
|-
 
|-
−
| LAYER_SIZE
+
| BARRED
−
| value
+
|  
 
| All
 
| All
−
| What the size of this item in question is, when it is put on. See {{L|Armor}} for more on item sizes and layering.
+
| Can be crafted out of bone. Randomly generated equipped armor will never be made out of bone.
  
 
|-
 
|-
−
| LAYER_PERMIT
+
| SCALED
−
| value
+
|  
 
| All
 
| 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 {{L|Armor}} for more on item sizes and layering.
+
| Can be crafted from shell. Randomly generated equipped armor will never be made of shell.
−
 
 
−
|-
 
−
| LBSTEP
 
−
| value or MAX
 
−
|
 
−
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.  
 
  
 
|-
 
|-
Line 85: Line 120:
  
 
|-
 
|-
−
| MATERIAL_SIZE
+
| SHAPED
−
| value
+
|  
 
| All
 
| 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.
+
| Only one shaped piece of clothing can be worn on a single body slot at a time.
  
 
|-
 
|-
−
| METAL
+
| CHAIN_METAL_TEXT
 
|  
 
|  
 
| All
 
| All
−
| Item can be made with metal. Randomly generated equipped armor will always be made out of metal whenever possible.
+
| Metal versions of this item will have "chain" added between the material and item name.
  
 
|-
 
|-
−
| METAL_ARMOR_LEVELS
+
| STRUCTURAL_ELASTICITY_WOVEN_THREAD
−
|
 
 
|
 
|
−
| Metal versions of this item count as one ARMORLEVEL higher. Only present in helms, caps, low boots, and high boots.
 
−
 
−
|-
 
−
| NAME
 
−
| singular:plural
 
 
| All
 
| All
−
| What this item will be called ingame.
+
|  
  
 
|-
 
|-
−
| PREPLURAL
+
| STRUCTURAL_ELASTICITY_CHAIN_METAL
−
| <phrase> of
 
−
|
 
−
item_armor<br>
 
−
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.
 
−
 
 
−
|-
 
−
| SCALED
 
 
|  
 
|  
 
| All
 
| All
−
| Can be crafted from shell. Randomly generated equipped armor will never be made of shell.
+
|  
  
 
|-
 
|-
−
| SHAPED
+
| STRUCTURAL_ELASTICITY_CHAIN_ALL
 
|  
 
|  
 
| All
 
| All
−
| Only one shaped piece of clothing can be worn on a single body slot at a time.
+
|  
  
 
|-
 
|-
−
| SOFT
+
| LAYER_SIZE
−
|  
+
| value
 
| All
 
| All
−
| Item can {{L|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.
+
| What the size of this item in question is, when it is put on. See {{L|Armor}} for more on item sizes and layering.
  
 
|-
 
|-
−
| UBSTEP
+
| LAYER_PERMIT
−
| value, MAX
+
| value
−
| item_armor
+
| All
−
| 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,{{version|0.31.03}} 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.  
+
| 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 {{L|Armor}} for more on item sizes and layering.
  
 
|-
 
|-
−
| UPSTEP
+
| LAYER
−
| value, MAX
+
| UNDER, OVER, ARMOR, COVER
−
| item_armor, item_gloves, item_shoes
+
| All
−
| 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.{{version|0.31.03}}  Although this is a valid token for body armor, it has no effect.
+
| 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.
  
 
|-
 
|-
−
| STRUCTURAL_ELASTICITY_WOVEN_THREAD
+
| COVERAGE
−
|
+
| % value
−
| item_helm, item_gloves, item_pants, item_shoes, item_armor
+
| All
−
|
+
| 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 compleatly.  Temperature effects are also influenced by coverage.
  
−
|-
 
−
| STRUCTURAL_ELASTICITY_CHAIN_METAL
 
−
|
 
−
| item_pants, item_armor
 
−
|
 
 
|}
 
|}
  
 
{{Category|Modding}}
 
{{Category|Modding}}
 
{{Category|Tokens}}
 
{{Category|Tokens}}

Revision as of 14:54, 24 February 2011

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

The tokens for all types of Template:L on all slots, including Template:Ls. 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.

Tokens

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 adjective ITEM_ARMOR
ITEM_PANTS
VALUE num ITEM_ARMOR
ITEM_GLOVES
ITEM_SHOES
ITEM_SHIELD
ITEM_HELM 		Unused
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.
UPSTEP value, MAX ITEM_GLOVES
ITEM_SHOES
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.v0.31.03 Although this is a valid token for body armor, it has no effect.
UBSTEP value, MAX 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,v0.31.03 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.
LBSTEP value or MAX ITEM_ARMOR
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.
METAL_ARMOR_LEVELS ITEM_ARMOR
ITEM_GLOVES
ITEM_SHOES
ITEM_HELM
ITEM_PANTS 		Metal versions of this item count as one ARMORLEVEL higher.
BLOCKCHANCE value ITEM_SHIELD Affects the block chance of the shield.
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 Template:L 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 Template:L 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.
CHAIN_METAL_TEXT All Metal versions of this item will have "chain" added between the material and item name.
STRUCTURAL_ELASTICITY_WOVEN_THREAD All
STRUCTURAL_ELASTICITY_CHAIN_METAL All
STRUCTURAL_ELASTICITY_CHAIN_ALL All
LAYER_SIZE value All What the size of this item in question is, when it is put on. See Template:L 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 Template:L for more on item sizes and layering.
LAYER UNDER, OVER, ARMOR, COVER All 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.
COVERAGE % value All 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 compleatly. Temperature effects are also influenced by coverage.
Retrieved from "https://dwarffortresswiki.org/index.php?title=v0.31:Armor_token&oldid=136922"