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 "Material definition token"

From Dwarf Fortress Wiki
Jump to navigation Jump to search
([LEAF_MAT] has been replaced by [STOCKPILE_PLANT_GROWTH])
m (mouths too actually)
 
(77 intermediate revisions by 32 users not shown)
Line 1: Line 1:
−
{{Migrated_article}}
+
{{Quality|Fine}}
−
{{quality|unrated}}
+
{{av}}
 +
{{Modding}}
  
−
The following tokens can be used in material definitions (whether for inorganics or those within plants and creatures) as well as in material templates.
+
The following [[token]]s can be used in [[material]] definitions (whether for inorganics or those within plants and creatures) as well as in [[:Category:material template raw pages|material templates]].
  
−
==Material Properties==
+
__TOC__
 +
{{clear}}
 +
 
 +
==Material properties==
 
{| {{prettytable}}
 
{| {{prettytable}}
 
|- bgcolor="#C0C0C0"
 
|- bgcolor="#C0C0C0"
Line 12: Line 16:
  
 
|-
 
|-
−
| PREFIX
+
| {{text_anchor|USE_MATERIAL_TEMPLATE}}
 +
|
 +
* <template name>
 +
| Resets all material tokens back to their default values, then imports the tokens of the specified preexisting material template (overriding any tokens defined prior to itself in the material). This means USE_MATERIAL_TEMPLATE should be the first token present in any material using it. It cannot be used inside of a [MATERIAL_TEMPLATE:X] which prevents the creation of nested material template structures.
 +
 
 +
|-
 +
| {{text_anchor|PREFIX}}
 
|
 
|
−
* string
+
* <prefix> or NONE
 
| Applies a prefix to all items made from the material. For PLANT and CREATURE materials, this defaults to the plant/creature name. '''Not permitted in material template definitions.'''
 
| Applies a prefix to all items made from the material. For PLANT and CREATURE materials, this defaults to the plant/creature name. '''Not permitted in material template definitions.'''
  
 
|-
 
|-
−
| STONE_NAME
+
| {{text_anchor|STONE_NAME}}
 
|
 
|
−
* string
+
* <name>
−
| Overrides the name of mined out stones (used for native copper/silver/gold/platinum to make them be called "nuggets").
+
| Overrides the name of [[Item_token#BOULDER|BOULDER]] items (i.e. mined-out stones) made of the material (used for native copper/silver/gold/platinum to make them be called "nuggets" instead of "boulders").
  
 
|-
 
|-
−
| IS_GEM
+
| {{text_anchor|IS_GEM}}
 
|
 
|
−
* name
+
* <name>
−
* plural
+
* <plural>
−
* state
+
* OVERWRITE_SOLID (optional)
 
| Used to indicate that said material is a gemstone - when tiles are mined out, rough gems will be yielded instead of boulders. Plural can be "STP" to automatically append an "s" to the singular form, and OVERWRITE_SOLID will override the relevant STATE_NAME and STATE_ADJ values.
 
| Used to indicate that said material is a gemstone - when tiles are mined out, rough gems will be yielded instead of boulders. Plural can be "STP" to automatically append an "s" to the singular form, and OVERWRITE_SOLID will override the relevant STATE_NAME and STATE_ADJ values.
  
 
|-
 
|-
−
| TEMP_DIET_INFO
+
| {{text_anchor|TEMP_DIET_INFO}}
 
|  
 
|  
−
* type
+
* <type>
 
| Specifies what the material should be treated as when drinking water contaminated by it, for generating unhappy [[thought]]s. Valid values are BLOOD, SLIME, VOMIT, ICHOR, PUS, GOO, GRIME, and FILTH.
 
| Specifies what the material should be treated as when drinking water contaminated by it, for generating unhappy [[thought]]s. Valid values are BLOOD, SLIME, VOMIT, ICHOR, PUS, GOO, GRIME, and FILTH.
  
 
|-
 
|-
−
| POWDER_DYE
+
| {{text_anchor|POWDER_DYE}}
−
| [[color]] token
+
|
−
| Defines the material as a type of dye.
+
*<[[Color#Color_tokens|color token]]>
 +
| Allows the material to be used as [[dye]], and defines color of dyed items.
  
 
|-
 
|-
−
| TILE
+
| {{text_anchor|TILE}}
−
| [[Main:Character table|tile]]
+
|  
 +
*<[[Main:Character table|tile value or character]]>
 
| Specifies the tile that will be used to represent unmined tiles made of this material. Generally only used with stones. Defaults to 219 ('█').
 
| Specifies the tile that will be used to represent unmined tiles made of this material. Generally only used with stones. Defaults to 219 ('█').
  
 
|-
 
|-
−
| ITEM_SYMBOL
+
| {{text_anchor|ITEM_SYMBOL}}
−
| tile
+
|
−
| Specifies the tile that will be used to represent BOULDER objects made of this material. Generally only used with stones. Defaults to 7 ('•').
+
*<[[Main:Character table|tile value or character]]>
 +
| Specifies the tile that will be used to represent [[Item_token#BOULDER|BOULDER]] items made of this material. Generally only used with stones. Defaults to 7 ('•').
  
 
|-
 
|-
−
| DISPLAY_COLOR
+
| {{text_anchor|DISPLAY_COLOR}}
 
|
 
|
−
*foreground color
+
*<[[Color#Color_values|foreground color]]>
−
*background color
+
*<[[Color#Color_values|background color]]>
−
*foreground brightness
+
*<[[Color#Color_values|foreground brightness]]>
 
| The on-screen color of the material. Uses a standard 3-digit [[Color|color token]]. Equivalent to [TILE_COLOR:a:b:c], [BUILD_COLOR:b:a:X] (X = 1 if 'a' equals 'b', 0 otherwise), and [BASIC_COLOR:a:c]
 
| The on-screen color of the material. Uses a standard 3-digit [[Color|color token]]. Equivalent to [TILE_COLOR:a:b:c], [BUILD_COLOR:b:a:X] (X = 1 if 'a' equals 'b', 0 otherwise), and [BASIC_COLOR:a:c]
  
 
|-
 
|-
−
| BUILD_COLOR
+
| {{text_anchor|BUILD_COLOR}}
 
|
 
|
−
*foreground color
+
*<[[Color#Color_values|foreground color]]>
−
*background color
+
*<[[Color#Color_values|background color]]>
−
*foreground brightness
+
*<[[Color#Color_values|foreground brightness]]>
 
| The color of objects made of this material which use both the foreground and background color: [[door]]s, [[floodgate]]s, [[hatch cover]]s, [[bin]]s, [[barrel]]s, and [[cage]]s. Defaults to 7:7:1 (white).
 
| The color of objects made of this material which use both the foreground and background color: [[door]]s, [[floodgate]]s, [[hatch cover]]s, [[bin]]s, [[barrel]]s, and [[cage]]s. Defaults to 7:7:1 (white).
  
 
|-
 
|-
−
| TILE_COLOR
+
| {{text_anchor|TILE_COLOR}}
 
|
 
|
−
*foreground color
+
*<[[Color#Color_values|foreground color]]>
−
*background color
+
*<[[Color#Color_values|background color]]>
−
*foreground brightness
+
*<[[Color#Color_values|foreground brightness]]>
 
| The color of unmined tiles containing this material (for stone and soil), as well as [[engraving]]s in this material. Defaults to 7:7:1 (white).
 
| The color of unmined tiles containing this material (for stone and soil), as well as [[engraving]]s in this material. Defaults to 7:7:1 (white).
  
 
|-
 
|-
−
| BASIC_COLOR
+
| {{text_anchor|BASIC_COLOR}}
 
|
 
|
−
*color
+
*<[[Color#Color_values|foreground color]]>
−
*brightness
+
*<[[Color#Color_values|foreground brightness]]>
 
| The color of objects made of this material which use only the foreground color, including workshops, floors and boulders, and smoothed walls. Defaults to 7:1 (white).
 
| The color of objects made of this material which use only the foreground color, including workshops, floors and boulders, and smoothed walls. Defaults to 7:1 (white).
  
 
|-
 
|-
−
| STATE_COLOR
+
| {{text_anchor|STATE_COLOR}}
 
|
 
|
−
*state
+
*<[[Material_definition_token#Material States|material state]]>
−
*[[color]] token
+
*<[[Color#Color_tokens|color token]]>
−
| The state may be SOLID, LIQUID, GAS, POWDER/SOLID_POWDER, PASTE/SOLID_PASTE, PRESSED/SOLID_PRESSED, ALL_SOLID, or ALL.
+
| Determines the color of the material at the specified state. See [[Material_definition_token#Material states|below]] for a list of valid material states. Color comes from descriptor_color_standard.txt. The nearest color value is used to display contaminants and body parts made of this material in ASCII and to color items and constructions made from this material with graphics. Example:
−
Color comes from descriptor_color_standard.txt and is used to indicate the color of the material. The nearest color value is used to display contaminants and body parts made of this material.
+
[STATE_COLOR:ALL_SOLID:GRAY]
−
[STATE_COLOR:ALL_SOLID:GREY]
 
  
 
|-
 
|-
−
| STATE_NAME
+
| {{text_anchor|STATE_NAME}}
 
|
 
|
−
*state
+
*<[[Material_definition_token#Material States|material state]]>
−
*name
+
*<name>
−
| The name of the material as displayed in-game.
+
| Determines the name of the material at the specified state, as displayed in-game.
 
[STATE_NAME:ALL_SOLID:stone]
 
[STATE_NAME:ALL_SOLID:stone]
  
 
|-
 
|-
−
| STATE_NAME_ADJ
+
| {{text_anchor|STATE_ADJ}}
 
|
 
|
−
*state
+
*<[[Material_definition_token#Material States|material state]]>
−
*name/adjective
+
*<adjective>
−
| Sets both STATE_NAME and STATE_ADJ at the same time.
+
| Like [[Material_definition_token#STATE_NAME|STATE_NAME]], but used in different situations. Equipment made from the material uses the state adjective and not the state name.
  
 
|-
 
|-
−
| STATE_ADJ
+
| {{text_anchor|STATE_NAME_ADJ}}
 
|
 
|
−
*state
+
*<[[Material_definition_token#Material States|material state]]>
−
*adjective
+
*<name>
−
| Like STATE_NAME, but used in different situations. Equipment made from the material uses the state adjective and not the state name.
+
*<adjective>
 +
| Sets both [[Material_definition_token#STATE_NAME|STATE_NAME]] and [[Material_definition_token#STATE_ADJ|STATE_ADJ]] at the same time.
  
 
|-
 
|-
−
| ABSORPTION
+
| {{text_anchor|ABSORPTION}}
 
|
 
|
−
*value
+
*<value>
 
| The material's tendency to absorb liquids. Containers made of materials with nonzero absorption cannot hold liquids unless they have been [[glaze]]d. Defaults to 0.
 
| The material's tendency to absorb liquids. Containers made of materials with nonzero absorption cannot hold liquids unless they have been [[glaze]]d. Defaults to 0.
  
 
|-
 
|-
−
| IMPACT_YIELD
+
| {{text_anchor|IMPACT_YIELD}}
 
|
 
|
−
*value
+
*<value>
−
| Specifies how hard of an impact the material can withstand before it will start deforming permanently. Used for blunt-force combat. Defaults to 10000.
+
| Specifies how hard of an impact (in kilopascals) the material can withstand before it will start deforming permanently. Used for blunt-force combat. Defaults to 10000.
  
 
|-
 
|-
−
| IMPACT_FRACTURE
+
| {{text_anchor|IMPACT_FRACTURE}}
 
|
 
|
−
*value
+
*<value>
 
| Specifies how hard of an impact the material can withstand before it will fail entirely. Used for blunt-force combat. Defaults to 10000.
 
| Specifies how hard of an impact the material can withstand before it will fail entirely. Used for blunt-force combat. Defaults to 10000.
  
 
|-
 
|-
−
| IMPACT_STRAIN_AT_YIELD or IMPACT_ELASTICITY
+
| {{text_anchor|IMPACT_STRAIN_AT_YIELD}} or {{text_anchor|IMPACT_ELASTICITY}}
 
|
 
|
−
*value
+
*<value>
−
| Specifies how much the material will give when the yield point is reached.{{verify}} Used for blunt-force combat. Defaults to 0. Apparently affects in combat whether the corresponding tissue is bruised (value >= 50000), torn (value between 25000 and 49999), or fractured (value <= 24999)
+
| Specifies how much the material will have given (in parts-per-100000) when the yield point is reached. Used for blunt-force combat. Defaults to 0. Apparently affects in combat whether the corresponding tissue is bruised (value >= 50000), torn (value between 25000 and 49999), or fractured (value <= 24999)
  
 
|-
 
|-
−
| COMPRESSIVE_YIELD
+
| {{text_anchor|COMPRESSIVE_YIELD}}
 
|
 
|
−
*value
+
*<value>
 
| Specifies how hard the material can be compressed before it will start deforming permanently. Determines a tissue's resistance to pinching and response to strangulation. Defaults to 10000.
 
| Specifies how hard the material can be compressed before it will start deforming permanently. Determines a tissue's resistance to pinching and response to strangulation. Defaults to 10000.
  
 
|-
 
|-
−
| COMPRESSIVE_FRACTURE
+
| {{text_anchor|COMPRESSIVE_FRACTURE}}
 
|
 
|
−
*value
+
*<value>
 
| Specifies how hard the material can be compressed before it will fail entirely. Determines a tissue's resistance to pinching and response to strangulation. Defaults to 10000.
 
| Specifies how hard the material can be compressed before it will fail entirely. Determines a tissue's resistance to pinching and response to strangulation. Defaults to 10000.
  
 
|-
 
|-
−
| COMPRESSIVE_STRAIN_AT_YIELD or COMPRESSIVE_ELASTICITY
+
| {{text_anchor|COMPRESSIVE_STRAIN_AT_YIELD}} or {{text_anchor|COMPRESSIVE_ELASTICITY}}
 
|
 
|
−
*value
+
*<value>
−
| Specifies how much the material will give when it is compressed past its yield point.{{verify}} Determines a tissue's resistance to pinching and response to strangulation. Defaults to 0.
+
| Specifies how much the material will have given when it has been compressed to its yield point. Determines a tissue's resistance to pinching and response to strangulation. Defaults to 0.
  
 
|-
 
|-
−
| TENSILE_YIELD
+
| {{text_anchor|TENSILE_YIELD}}
 
|
 
|
−
*value
+
*<value>
 
| Specifies how hard the material can be stretched before it will start deforming permanently. Determines a tissue's resistance to a latching and tearing bite. Defaults to 10000.
 
| Specifies how hard the material can be stretched before it will start deforming permanently. Determines a tissue's resistance to a latching and tearing bite. Defaults to 10000.
  
 
|-
 
|-
−
| TENSILE_FRACTURE
+
| {{text_anchor|TENSILE_FRACTURE}}
 
|
 
|
−
*value
+
*<value>
 
| Specifies how hard the material can be stretched before it will fail entirely. Determines a tissue's resistance to a latching and tearing bite. Defaults to 10000.
 
| Specifies how hard the material can be stretched before it will fail entirely. Determines a tissue's resistance to a latching and tearing bite. Defaults to 10000.
  
 
|-
 
|-
−
| TENSILE_STRAIN_AT_YIELD or TENSILE_ELASTICITY
+
| {{text_anchor|TENSILE_STRAIN_AT_YIELD}} or {{text_anchor|TENSILE_ELASTICITY}}
 
|
 
|
−
*value
+
*<value>
−
| Specifies how much the material will give when it is stretched past its yield point. Determines a tissue's resistance to a latching and tearing bite. Defaults to 0.
+
| Specifies how much the material will have given when it is stretched to its yield point. Determines a tissue's resistance to a latching and tearing bite. Defaults to 0.
  
 
|-
 
|-
−
| TORSION_YIELD
+
| {{text_anchor|TORSION_YIELD}}
 
|
 
|
−
*value
+
*<value>
−
| Specifies how hard the material can be twisted before it will start deforming permanently. Used for latching and shaking with a blunt attack (no default creature has such an attack, but they can be modded in).  Defaults to 10000.
+
| Specifies how hard the material can be twisted before it will start deforming permanently. Used for latching and shaking with a blunt attack (certain generated creatures can do this).  Defaults to 10000.
  
 
|-
 
|-
−
| TORSION_FRACTURE
+
| {{text_anchor|TORSION_FRACTURE}}
 
|
 
|
−
*value
+
*<value>
−
| Specifies how hard the material can be twisted before it will fail entirely. Used for latching and shaking with a blunt attack (no default creature has such an attack, but they can be modded in).  Defaults to 10000.
+
| Specifies how hard the material can be twisted before it will fail entirely. Used for latching and shaking with a blunt attack (certain generated creatures can do this).  Defaults to 10000.
  
 
|-
 
|-
−
| TORSION_STRAIN_AT_YIELD or TORSION_ELASTICITY
+
| {{text_anchor|TORSION_STRAIN_AT_YIELD}} or {{text_anchor|TORSION_ELASTICITY}}
 
|
 
|
−
*value
+
*<value>
−
| Specifies how much the material will give when it is twisted past its yield point.{{verify}} Used for latching and shaking with a blunt attack (no default creature has such an attack, but they can be modded in).  Defaults to 0.
+
| Specifies how much the material will have given when it is twisted to its yield point. Used for latching and shaking with a blunt attack (certain generated creatures can do this).  Defaults to 0.
  
 
|-
 
|-
−
| SHEAR_YIELD
+
| {{text_anchor|SHEAR_YIELD}}
 
|
 
|
−
*value
+
*<value>
 
| Specifies how hard the material can be sheared before it will start deforming permanently. Used for cutting calculations. Defaults to 10000.
 
| Specifies how hard the material can be sheared before it will start deforming permanently. Used for cutting calculations. Defaults to 10000.
  
 
|-
 
|-
−
| SHEAR_FRACTURE
+
| {{text_anchor|SHEAR_FRACTURE}}
 
|
 
|
−
*value
+
*<value>
 
| Specifies how hard the material can be sheared before it will fail entirely. Used for cutting calculations. Defaults to 10000.
 
| Specifies how hard the material can be sheared before it will fail entirely. Used for cutting calculations. Defaults to 10000.
  
 
|-
 
|-
−
| SHEAR_STRAIN_AT_YIELD or SHEAR_ELASTICITY
+
| {{text_anchor|SHEAR_STRAIN_AT_YIELD}} or {{text_anchor|SHEAR_ELASTICITY}}
 
|
 
|
−
*value
+
*<value>
−
| Specifies how much the material will give when sheared past its yield point. Used for cutting calculations. Defaults to 0.
+
| Specifies how much the material will have given when sheared to its yield point. Used for cutting calculations. Defaults to 0.
  
 
|-
 
|-
−
| BENDING_YIELD  
+
| {{text_anchor|BENDING_YIELD}}
 
|
 
|
−
*value
+
*<value>
 
| Specifies how hard the material can be bent before it will start deforming permanently. Determines a tissue's resistance to being mangled with a joint lock. Defaults to 10000.
 
| Specifies how hard the material can be bent before it will start deforming permanently. Determines a tissue's resistance to being mangled with a joint lock. Defaults to 10000.
  
 
|-
 
|-
−
| BENDING_FRACTURE
+
| {{text_anchor|BENDING_FRACTURE}}
 
|
 
|
−
*value
+
*<value>
 
| Specifies how hard the material can be bent before it will fail entirely. Determines a tissue's resistance to being mangled with a joint lock. Defaults to 10000.
 
| Specifies how hard the material can be bent before it will fail entirely. Determines a tissue's resistance to being mangled with a joint lock. Defaults to 10000.
  
 
|-
 
|-
−
| BENDING_STRAIN_AT_YIELD or BENDING_ELASTICITY
+
| {{text_anchor|BENDING_STRAIN_AT_YIELD}} or {{text_anchor|BENDING_ELASTICITY}}
 
|
 
|
−
*value
+
*<value>
−
| Specifies how much the material will give when bent past its yield point.{{verify}} Determines a tissue's resistance to being mangled with a joint lock. Defaults to 0.
+
| Specifies how much the material will have given when bent to its yield point. Determines a tissue's resistance to being mangled with a joint lock. Defaults to 0.
  
 
|-
 
|-
−
| MAX_EDGE
+
| {{text_anchor|MAX_EDGE}}
 
|
 
|
−
*value
+
*<value>
 
| How sharp the material is. Used in cutting calculations. Applying a value of at least 10000 to a stone will allow weapons to be made from that stone. Defaults to 10000.
 
| How sharp the material is. Used in cutting calculations. Applying a value of at least 10000 to a stone will allow weapons to be made from that stone. Defaults to 10000.
  
 
|-
 
|-
−
| MATERIAL_VALUE
+
| {{text_anchor|MATERIAL_VALUE}}
 
|
 
|
−
*value
+
*<value>
 
| Value modifier for the material. Defaults to 1. This number can be made negative by placing a "-" in front, resulting in things that you are paid to buy and must pay to sell.
 
| Value modifier for the material. Defaults to 1. This number can be made negative by placing a "-" in front, resulting in things that you are paid to buy and must pay to sell.
  
 
|-
 
|-
−
| MULTIPLY_VALUE
+
| {{text_anchor|MULTIPLY_VALUE}}
 
|
 
|
−
*value
+
*<value>
 
| Multiplies the value of the material. '''Not permitted in material template definitions.'''
 
| Multiplies the value of the material. '''Not permitted in material template definitions.'''
  
 
|-
 
|-
−
| SPEC_HEAT
+
| {{text_anchor|SPEC_HEAT}}
 
|
 
|
−
*specific heat capacity
+
*<specific heat capacity>
−
| Rate at which the material heats up or cools down. See [[SPEC HEAT]] for more information. Defaults to NONE.
+
| Rate at which the material heats up or cools down (in joules/kilogram-kelvin). If set to NONE, the temperature will be fixed at its initial value. See [[Temperature]] for more information. Defaults to NONE.
  
 
|-
 
|-
−
| HEATDAM_POINT
+
| {{text_anchor|HEATDAM_POINT}}
 
|
 
|
−
*temperature
+
*<temperature>
 
| Temperature above which the material takes damage from heat. May be set to NONE. If the material has an ignite point but no heatdam point, it will burn for a very long time (9 months and 16.8 days). Defaults to NONE.
 
| Temperature above which the material takes damage from heat. May be set to NONE. If the material has an ignite point but no heatdam point, it will burn for a very long time (9 months and 16.8 days). Defaults to NONE.
  
 
|-
 
|-
−
| COLDDAM_POINT
+
| {{text_anchor|COLDDAM_POINT}}
 
|
 
|
−
*temperature
+
*<temperature>
 
| Temperature below which the material takes damage from cold. Defaults to NONE.
 
| Temperature below which the material takes damage from cold. Defaults to NONE.
  
 
|-
 
|-
−
| IGNITE_POINT
+
| {{text_anchor|IGNITE_POINT}}
 
|
 
|
−
*temperature
+
*<temperature>
 
| Temperature at which the material will catch fire. Defaults to NONE.
 
| Temperature at which the material will catch fire. Defaults to NONE.
  
 
|-
 
|-
−
| MELTING_POINT
+
| {{text_anchor|MELTING_POINT}}
 
|
 
|
−
*temperature
+
*<temperature>
 
| Temperature at which the material melts. Defaults to NONE.
 
| Temperature at which the material melts. Defaults to NONE.
  
 
|-
 
|-
−
| BOILING_POINT
+
| {{text_anchor|BOILING_POINT}}
 
|
 
|
−
*temperature
+
*<temperature>
 
| Temperature at which the material boils. Defaults to NONE.
 
| Temperature at which the material boils. Defaults to NONE.
  
 
|-
 
|-
−
| MAT_FIXED_TEMP
+
| {{text_anchor|MAT_FIXED_TEMP}}
 
|
 
|
−
*temperature
+
*<temperature>
−
| Constant temperature emitted by the material. Defaults to NONE.
+
| Items composed of this material will initially have this temperature. Used in conjunction with <code>[SPEC_HEAT:NONE]</code> to make material's temperature fixed at the specified value. Defaults to NONE.
  
 
|-
 
|-
−
| IF_EXISTS_SET_HEATDAM_POINT
+
| {{text_anchor|IF_EXISTS_SET_HEATDAM_POINT}}
 
|
 
|
−
*temperature
+
*<temperature>
 
| Changes a material's HEATDAM_POINT, but only if it was not set to NONE. '''Not permitted in material template definitions.'''
 
| Changes a material's HEATDAM_POINT, but only if it was not set to NONE. '''Not permitted in material template definitions.'''
  
 
|-
 
|-
−
| IF_EXISTS_SET_COLDDAM_POINT
+
| {{text_anchor|IF_EXISTS_SET_COLDDAM_POINT}}
 
|
 
|
−
*temperature
+
*<temperature>
 
| Changes a material's COLDDAM_POINT, but only if it was not set to NONE. '''Not permitted in material template definitions.'''
 
| Changes a material's COLDDAM_POINT, but only if it was not set to NONE. '''Not permitted in material template definitions.'''
  
 
|-
 
|-
−
| IF_EXISTS_SET_IGNITE_POINT
+
| {{text_anchor|IF_EXISTS_SET_IGNITE_POINT}}
 
|
 
|
−
*temperature
+
*<temperature>
 
| Changes a material's IGNITE_POINT, but only if it was not set to NONE. '''Not permitted in material template definitions.'''
 
| Changes a material's IGNITE_POINT, but only if it was not set to NONE. '''Not permitted in material template definitions.'''
  
 
|-
 
|-
−
| IF_EXISTS_SET_MELTING_POINT
+
| {{text_anchor|IF_EXISTS_SET_MELTING_POINT}}
 
|
 
|
−
*temperature
+
*<temperature>
 
| Changes a material's MELTING_POINT, but only if it was not set to NONE. '''Not permitted in material template definitions.'''
 
| Changes a material's MELTING_POINT, but only if it was not set to NONE. '''Not permitted in material template definitions.'''
  
 
|-
 
|-
−
| IF_EXISTS_SET_BOILING_POINT
+
| {{text_anchor|IF_EXISTS_SET_BOILING_POINT}}
 
|
 
|
−
*temperature
+
*<temperature>
 
| Changes a material's BOILING_POINT, but only if it was not set to NONE. '''Not permitted in material template definitions.'''
 
| Changes a material's BOILING_POINT, but only if it was not set to NONE. '''Not permitted in material template definitions.'''
  
 
|-
 
|-
−
| IF_EXISTS_SET_MAT_FIXED_TEMP
+
| {{text_anchor|IF_EXISTS_SET_MAT_FIXED_TEMP}}
 
|
 
|
−
*temperature
+
*<temperature>
 
| Changes a material's MAT_FIXED_TEMP, but only if it was not set to NONE. '''Not permitted in material template definitions.'''
 
| Changes a material's MAT_FIXED_TEMP, but only if it was not set to NONE. '''Not permitted in material template definitions.'''
  
 
|-
 
|-
−
| SOLID_DENSITY
+
| {{text_anchor|SOLID_DENSITY}}
 
|
 
|
−
*density
+
*<density>
−
| Specifies the density (in kilograms per cubic meter) of the material when in solid form. Also affects combat calculations; affects blunt-force damage and ability of edged weapons to pierce tissue layers{{verify}}. Defaults to NONE.
+
| Specifies the density (in kilograms per cubic meter) of the material when in solid form. Also affects combat calculations; affects blunt-force damage and ability of weak-in-impact-yield blunt attacks to pierce armor. Defaults to NONE.
  
 
|-
 
|-
−
| LIQUID_DENSITY
+
| {{text_anchor|LIQUID_DENSITY}}
 
|
 
|
−
*density
+
*<density>
−
| Specifies the density of the material when in liquid form. Defaults to NONE.
+
| Specifies the density of the material when in liquid form. Defaults to NONE. Also affects combat calculations; affects blunt force damage like SOLID_DENSITY, but only for attacks made by liquids (e.g. forgotten beasts made of water).
  
 
|-
 
|-
−
| MOLAR_MASS
+
| {{text_anchor|MOLAR_MASS}}
 
|
 
|
−
*value
+
*<value>
−
| Supposedly not used{{verify}}. Theoretically, should determine density (at given pressure) in gas state, on which in turn would depends (together with weight of vaporized material) the volume covered by spreading vapors. Defaults to NONE.
+
| Specifies (in kg/mol) the molar mass of the material in gaseous form. Only affects combat calculations like the densities, and only for attacks made by gases (e.g. forgotten beasts made of steam).
  
 
|-
 
|-
−
| EXTRACT_STORAGE
+
| {{text_anchor|EXTRACT_STORAGE}}
−
| BARREL or FLASK
+
| * BARREL or FLASK
 
| Specifies the type of container used to store the material. Used in conjunction with the [EXTRACT_BARREL], [EXTRACT_VIAL], or [EXTRACT_STILL_VIAL] [[plant token]]s. Defaults to BARREL.
 
| Specifies the type of container used to store the material. Used in conjunction with the [EXTRACT_BARREL], [EXTRACT_VIAL], or [EXTRACT_STILL_VIAL] [[plant token]]s. Defaults to BARREL.
  
 
|-
 
|-
−
| BUTCHER_SPECIAL
+
| {{text_anchor|BUTCHER_SPECIAL}}
 
|
 
|
−
*[[item token]]
+
*<[[item token]]>
 
| Specifies the item type used for butchering results made of this material. Stock raws use GLOB:NONE for fat and MEAT:NONE for other meat materials.
 
| Specifies the item type used for butchering results made of this material. Stock raws use GLOB:NONE for fat and MEAT:NONE for other meat materials.
  
 
|-
 
|-
−
| MEAT_NAME
+
| {{text_anchor|MEAT_NAME}}
 
|
 
|
−
*prefix
+
*<prefix>
−
*name
+
*<name>
−
*adjective
+
*<adjective>
 
| When a creature is butchered, meat yielded from organs made from this material will be named via this token.
 
| When a creature is butchered, meat yielded from organs made from this material will be named via this token.
  
 
|-
 
|-
−
| BLOCK_NAME
+
| {{text_anchor|BLOCK_NAME}}
 
|
 
|
−
*singular
+
*<singular>
−
*plural
+
*<plural>
 
| Specifies the name of [[block]]s made from this material.
 
| Specifies the name of [[block]]s made from this material.
  
 
|-
 
|-
−
| WAFERS
+
| {{text_anchor|WAFERS}}
 
|
 
|
 
| The material forms "wafers" instead of "[[bar]]s".
 
| The material forms "wafers" instead of "[[bar]]s".
  
 
|-
 
|-
−
| MATERIAL_REACTION_PRODUCT
+
| {{text_anchor|MATERIAL_REACTION_PRODUCT}}
 
|
 
|
−
*reaction reference
+
*<reaction reference>
−
*[[material token]]
+
*<[[material token]]>
 
| Used with reaction raws to associate a reagent material with a product material. The first argument is used by HAS_MATERIAL_REACTION_PRODUCT and GET_MATERIAL_FROM_REAGENT in reaction raws. The remainder is a material reference, generally LOCAL_CREATURE_MAT:SUBTYPE or LOCAL_PLANT_MAT:SUBTYPE or INORGANIC:STONETYPE.
 
| Used with reaction raws to associate a reagent material with a product material. The first argument is used by HAS_MATERIAL_REACTION_PRODUCT and GET_MATERIAL_FROM_REAGENT in reaction raws. The remainder is a material reference, generally LOCAL_CREATURE_MAT:SUBTYPE or LOCAL_PLANT_MAT:SUBTYPE or INORGANIC:STONETYPE.
 
[MATERIAL_REACTION_PRODUCT:TAN_MAT:LOCAL_CREATURE_MAT:LEATHER]
 
[MATERIAL_REACTION_PRODUCT:TAN_MAT:LOCAL_CREATURE_MAT:LEATHER]
  
 
|-
 
|-
−
| REACTION_CLASS
+
| {{text_anchor|ITEM_REACTION_PRODUCT}}
 
|
 
|
−
*reaction reference
+
*<item reference>
−
| Used to classify all items made of the material so that reactions can use them as generic reagents.
+
*<[[item token]]>
 +
*<[[material token]]>
 +
| Used with reaction raws to associate a reagent material with a complete item.  The first argument is used by HAS_ITEM_REACTION_PRODUCT and GET_ITEM_DATA_FROM_REAGENT in reaction raws.  The rest refers to the type of item, then its material.
 +
[ITEM_REACTION_PRODUCT:BAG_ITEM:PLANT_GROWTH:LEAVES:LOCAL_PLANT_MAT:LEAF]
  
 
|-
 
|-
−
| METAL_ORE
+
| {{text_anchor|REACTION_CLASS}}
 
|
 
|
−
* MATERIAL_NAME
+
*<reaction class name>
−
* value
+
| Used to classify all items made of the material, so that reactions can use them as generic reagents.
−
| Makes BOULDER acceptable as a [[Reactions#Reagents|reagent]] in reactions that require [[Item_token#Related_Tokens|"METAL_ORE:MATERIAL_NAME"]], as well as [[Smelter|smelting]] directly into metal [[bar]]s.<br /> Places the material under "Metal Ores" in Stone stockpiles.<br /> Value determines the probability for this product (see [[Tetrahedrite]] or [[Galena]] for details).
+
In default raws, the following are used:
 +
* FAT, TALLOW, SOAP, PARCHMENT, PAPER_PLANT, PAPER_SLURRY, MILK, CHEESE, WAX
 +
* CAN_GLAZE - items made from this material can be glazed.
 +
* FLUX - can be used as [[flux]] in pig iron and steel making.
 +
* GYPSUM - can be processed into [[gypsum plaster]].
 +
* CALCIUM_CARBONATE - can be used in production of [[quicklime]].
  
 
|-
 
|-
−
| THREAD_METAL
+
| {{text_anchor|METAL_ORE}}
 
|
 
|
−
* MATERIAL_NAME
+
* <inorganic material name e.g. [[lead|LEAD]]>
−
* value
+
* <value>
−
| Makes BOULDER acceptable for [[Strand extractor|strand extraction]] into threads; see also STOCKPILE_THREAD_METAL. Value presumably determines the probability of this product extracted.{{verify}}
+
| Makes BOULDER acceptable as a [[Reactions#Reagents|reagent]] in reactions that require [[Item_token#Related_Tokens|"METAL_ORE:MATERIAL_NAME"]], as well as [[Smelter|smelting]] directly into metal [[bar]]s.<br /> Places the material under "Metal Ores" in Stone stockpiles.<br /> The specified value determines the probability for this product (see [[Tetrahedrite]] or [[Galena]] for details).
  
 
|-
 
|-
−
| HARDENS_WITH_WATER
+
| {{text_anchor|THREAD_METAL}}
 
|
 
|
−
* [[material token]]
+
* <inorganic material name e.g. [[Raw_adamantine|RAW_ADAMANTINE]]>
 +
* <value>
 +
| Makes BOULDER items made of the material acceptable for [[Strand extractor|strand extraction]] into threads; see also STOCKPILE_THREAD_METAL. Value presumably determines the probability of this product extracted.{{verify}}
 +
 
 +
|-
 +
| {{text_anchor|HARDENS_WITH_WATER}}
 +
|
 +
* <[[material token]]>
 
| Allows the material to be used to make [[healthcare|casts]].
 
| Allows the material to be used to make [[healthcare|casts]].
  
 
|-
 
|-
−
| SOAP_LEVEL
+
| {{text_anchor|SOAP_LEVEL}}
 +
|
 +
*<value>
 +
| Determines effectiveness of soap - if the amount of grime on a body part is more than 3-SOAP_LEVEL, it sets it to 3-SOAP_LEVEL; as such setting it above 3 is bad. [[Soap]] has [SOAP_LEVEL:2]. Defaults to 0.
 +
 
 +
|-
 +
| {{text_anchor|SYNDROME}}
 +
|
 +
| Begins defining a [[syndrome]] applied by the material. Multiple syndromes can be specified. See [[Syndrome token]].
 +
 
 +
|-
 +
| {{text_anchor|ANTLER}}
 +
|
 +
| Found in the raws of several antler-wielding animals. It is used to show an antler as bodypart.
 +
|
 +
 
 +
|-
 +
| {{text_anchor|HAIR}}
 +
|
 +
| Probably used in graphics.
 +
|
 +
 
 +
|-
 +
| {{text_anchor|FEATHER}}
 +
|
 +
| Probably used in graphics.
 +
|
 +
 
 +
|-
 +
| {{text_anchor|SCALE}}
 
|
 
|
−
*value
+
| Probably used in graphics.
−
| Unknown. Defaults to 0.
+
|
 +
 
 +
|-
 +
| {{text_anchor|HOOF}}
 +
|
 +
| Probably used in graphics.
 +
|
 +
 
 +
|-
 +
| {{text_anchor|CHITIN}}
 +
|
 +
| Probably used in graphics.
 +
|
 +
 
 +
|-
 +
| {{text_anchor|CARTILAGE}}
 +
|
 +
| Probably used in graphics.
 +
|
 +
 
 +
|-
 +
| {{text_anchor|NERVOUS_TISSUE}}
 +
|
 +
| Probably used in graphics.
 +
|
 +
 
 +
|-
 +
| {{text_anchor|MEAT_CATEGORY}}
 +
| category
 +
| Probably used in graphics. The following values for "category" are used in the vanilla raws: STANDARD, EYE, BRIAN, LUNG, HEART, LIVER, INTESTINES, STOMACH, GIZZARD, PANCREAS, SPLEEN, KIDNEY.
 
|}
 
|}
  
−
==Material Usage Tokens==
+
 
 +
 
 +
 
 +
===Material states===
 +
 
 +
The following is a list of valid material states:
 +
 
 +
{| {{prettytable}}
 +
|-
 +
|'''SOLID'''
 +
|-
 +
|'''LIQUID'''
 +
|-
 +
|'''GAS'''
 +
|-
 +
|'''POWDER''' (or '''SOLID_POWDER''')
 +
|-
 +
|'''PASTE''' (or '''SOLID_PASTE''')
 +
|-
 +
|'''PRESSED''' (or '''SOLID_PRESSED''')
 +
|}
 +
 
 +
The following can be specified within tokens such as [[Material_definition_token#STATE_NAME|STATE_NAME]], [[Material_definition_token#STATE_NAME_ADJ|STATE_NAME_ADJ]] and [[Material_definition_token#STATE_ADJ|STATE_ADJ]] to make them apply to several of the above material states simultaneously:
 +
 
 +
{| {{prettytable}}
 +
|- bgcolor="#C0C0C0"
 +
!Value
 +
!Description
 +
|-
 +
|'''ALL'''
 +
|Denotes all possible material states.
 +
|-
 +
|'''ALL_SOLID'''
 +
|Denotes 'SOLID', 'POWDER', 'PASTE' and 'PRESSED'.
 +
|}
 +
 
 +
==Material usage tokens==
 
{| {{prettytable}}
 
{| {{prettytable}}
 
|- bgcolor="#C0C0C0"
 
|- bgcolor="#C0C0C0"
Line 422: Line 544:
  
 
|-
 
|-
−
| IMPLIES_ANIMAL_KILL
+
| {{text_anchor|IMPLIES_ANIMAL_KILL}}
 
|
 
|
−
| Lets the game know that an animal was likely killed in the production of this item. Entities opposed to killing animals (which currently does '''not''' include Elves) will refuse to accept these items in trade.
+
| Lets the game know that an animal was likely killed in the production of this item. Entities opposed to killing animals ([[elf|Elves]] in vanilla) will refuse to accept these items in trade.
  
 
|-
 
|-
−
| ALCOHOL_PLANT
+
| {{text_anchor|ALCOHOL_PLANT}}
 
|
 
|
 
| Classifies the material as plant-based alcohol, allowing its storage in food stockpiles under "Drink (Plant)".
 
| Classifies the material as plant-based alcohol, allowing its storage in food stockpiles under "Drink (Plant)".
  
 
|-
 
|-
−
| ALCOHOL_CREATURE
+
| {{text_anchor|ALCOHOL_CREATURE}}
 
|
 
|
 
| Classifies the material as animal-based alcohol, allowing its storage in food stockpiles under "Drink (Animal)".
 
| Classifies the material as animal-based alcohol, allowing its storage in food stockpiles under "Drink (Animal)".
  
 
|-
 
|-
−
| ALCOHOL
+
| {{text_anchor|ALCOHOL}}
 
|
 
|
 
| Classifies the material as generic alcohol. Implied by both ALCOHOL_PLANT and ALCOHOL_CREATURE. Exact behavior unknown, possibly vestigial.
 
| Classifies the material as generic alcohol. Implied by both ALCOHOL_PLANT and ALCOHOL_CREATURE. Exact behavior unknown, possibly vestigial.
  
 
|-
 
|-
−
| CHEESE_PLANT
+
| {{text_anchor|CHEESE_PLANT}}
 
|
 
|
 
| Classifies the material as plant-based cheese,  allowing its storage in food stockpiles under "Cheese (Plant)".
 
| Classifies the material as plant-based cheese,  allowing its storage in food stockpiles under "Cheese (Plant)".
  
 
|-
 
|-
−
| CHEESE_CREATURE
+
| {{text_anchor|CHEESE_CREATURE}}
 
|
 
|
 
| Classifies the material as animal-based cheese, allowing its storage in food stockpiles under "Cheese (Animal)".
 
| Classifies the material as animal-based cheese, allowing its storage in food stockpiles under "Cheese (Animal)".
  
 
|-
 
|-
−
| CHEESE
+
| {{text_anchor|CHEESE}}
 
|
 
|
 
| Classifies the material as generic cheese. Implied by both CHEESE_PLANT and CHEESE_CREATURE. Exact behavior unknown, possibly vestigial.
 
| Classifies the material as generic cheese. Implied by both CHEESE_PLANT and CHEESE_CREATURE. Exact behavior unknown, possibly vestigial.
  
 
|-
 
|-
−
| POWDER_MISC_PLANT
+
| {{text_anchor|POWDER_MISC_PLANT}}
 
|
 
|
−
| Classifies the material as plant powder, allowing its storage in in food stockpiles under "Milled Plant".
+
| Classifies the material as plant powder, allowing its storage in food stockpiles under "Milled Plant".
  
 
|-
 
|-
−
| POWDER_MISC_CREATURE
+
| {{text_anchor|POWDER_MISC_CREATURE}}
 
|
 
|
−
| Classifies the material as creature powder, allowing its storage in food stockpiles under "Bone Meal".
+
| Classifies the material as creature powder, allowing its storage in food stockpiles under "Bone Meal". Unlike milled plants, such as sugar and flour, "Bone Meal" barrels or pots may not contain bags. Custom reactions using this product better use buckets or jugs instead.
  
 
|-
 
|-
−
| POWDER_MISC
+
| {{text_anchor|POWDER_MISC}}
 
|
 
|
 
| Classifies the material as generic powder. Implied by both POWDER_MISC_PLANT and POWDER_MISC_CREATURE. Exact behavior unknown, possibly vestigial.
 
| Classifies the material as generic powder. Implied by both POWDER_MISC_PLANT and POWDER_MISC_CREATURE. Exact behavior unknown, possibly vestigial.
  
 
|-
 
|-
−
| STOCKPILE_GLOB or STOCKPILE_GLOB_SOLID
+
| {{text_anchor|STOCKPILE_GLOB}} or {{text_anchor|STOCKPILE_GLOB_SOLID}}
 
|
 
|
 
| Permits globs of the material in solid form to be stored in food stockpiles under "Fat" - without it, dwarves will come by and "clean" the items, destroying them (unless [DO_NOT_CLEAN_GLOB] is also included).
 
| Permits globs of the material in solid form to be stored in food stockpiles under "Fat" - without it, dwarves will come by and "clean" the items, destroying them (unless [DO_NOT_CLEAN_GLOB] is also included).
  
 
|-
 
|-
−
| STOCKPILE_GLOB_PASTE
+
| {{text_anchor|STOCKPILE_GLOB_PASTE}}
 
|
 
|
 
| Classifies the material as milled paste, allowing its storage in food stockpiles under "Paste".
 
| Classifies the material as milled paste, allowing its storage in food stockpiles under "Paste".
  
 
|-
 
|-
−
| STOCKPILE_GLOB_PRESSED
+
| {{text_anchor|STOCKPILE_GLOB_PRESSED}}
 
|
 
|
 
| Classifies the material as pressed goods, allowing its storage in food stockpiles under "Pressed Material".
 
| Classifies the material as pressed goods, allowing its storage in food stockpiles under "Pressed Material".
  
 
|-
 
|-
−
| STOCKPILE_PLANT_GROWTH
+
| {{text_anchor|STOCKPILE_PLANT_GROWTH}}
 
|
 
|
 
| Classifies the material as a plant growth (e.g. fruits, leaves), allowing its storage in food stockpiles under Plant Growth/Fruit.
 
| Classifies the material as a plant growth (e.g. fruits, leaves), allowing its storage in food stockpiles under Plant Growth/Fruit.
  
 
|-
 
|-
−
| LIQUID_MISC_PLANT
+
| {{text_anchor|LIQUID_MISC_PLANT}}
 
|
 
|
 
| Classifies the material as a plant extract, allowing its storage in food stockpiles under "Extract (Plant)".
 
| Classifies the material as a plant extract, allowing its storage in food stockpiles under "Extract (Plant)".
  
 
|-
 
|-
−
| LIQUID_MISC_CREATURE
+
| {{text_anchor|LIQUID_MISC_CREATURE}}
 
|
 
|
 
| Classifies the material as a creature extract, allowing its storage in food stockpiles under "Extract (Animal)".
 
| Classifies the material as a creature extract, allowing its storage in food stockpiles under "Extract (Animal)".
  
 
|-
 
|-
−
| LIQUID_MISC_OTHER
+
| {{text_anchor|LIQUID_MISC_OTHER}}
 
|
 
|
 
| Classifies the material as a miscellaneous liquid, allowing its storage in food stockpiles under "Misc. Liquid" along with lye.
 
| Classifies the material as a miscellaneous liquid, allowing its storage in food stockpiles under "Misc. Liquid" along with lye.
  
 
|-
 
|-
−
| LIQUID_MISC
+
| {{text_anchor|LIQUID_MISC}}
 
|
 
|
−
| Classifies the material as a generic liquid. Implied by LIQUID_MISC_PLANT, LIQUID_MISC_CREATURE, and LIQUID_MISC_OTHER. Exact behavior unknown. Possibly vestigial.
+
| Classifies the material as a generic liquid. Implied by LIQUID_MISC_PLANT, LIQUID_MISC_CREATURE, and LIQUID_MISC_OTHER. Exact behavior unknown, possibly vestigial.
  
 
|-
 
|-
−
| STRUCTURAL_PLANT_MAT
+
| {{text_anchor|STRUCTURAL_PLANT_MAT}}
 
|
 
|
−
| Classifies the material as plant, allowing its storage in food stockpiles under "Plants".
+
| Classifies the material as a plant, allowing its storage in food stockpiles under "Plants".
  
 
|-
 
|-
−
| SEED_MAT
+
| {{text_anchor|SEED_MAT}}
 
|
 
|
−
| Classifies the material as plant seed, allowing its storage in food stockpiles under "Seeds".
+
| Classifies the material as a plant seed, allowing its storage in food stockpiles under "Seeds".
  
 
|-
 
|-
−
| BONE
+
| {{text_anchor|BONE}}
 
|
 
|
 
| Classifies the material as bone, allowing its use for bone carvers and restriction from stockpiles by material.
 
| Classifies the material as bone, allowing its use for bone carvers and restriction from stockpiles by material.
  
 
|-
 
|-
−
| WOOD
+
| {{text_anchor|WOOD}}
 
|
 
|
 
| Classifies the material as wood, allowing its use for carpenters and storage in wood stockpiles. Entities opposed to killing plants (i.e. [[Elf|Elves]]) will refuse to accept these items in trade.
 
| Classifies the material as wood, allowing its use for carpenters and storage in wood stockpiles. Entities opposed to killing plants (i.e. [[Elf|Elves]]) will refuse to accept these items in trade.
  
 
|-
 
|-
−
| THREAD_PLANT
+
| {{text_anchor|THREAD_PLANT}}
 
|
 
|
 
| Classifies the material as plant fiber, allowing its use for clothiers and storage in cloth stockpiles under "Thread (Plant)" and "Cloth (Plant)".
 
| Classifies the material as plant fiber, allowing its use for clothiers and storage in cloth stockpiles under "Thread (Plant)" and "Cloth (Plant)".
  
 
|-
 
|-
−
| TOOTH
+
| {{text_anchor|TOOTH}}
 
|
 
|
 
| Classifies the material as tooth, allowing its use for bone carvers and restriction from stockpiles by material.
 
| Classifies the material as tooth, allowing its use for bone carvers and restriction from stockpiles by material.
  
 
|-
 
|-
−
| HORN
+
| {{text_anchor|HORN}}
 
|
 
|
 
| Classifies the material as horn, allowing its use for bone carvers and restriction from stockpiles by material.
 
| Classifies the material as horn, allowing its use for bone carvers and restriction from stockpiles by material.
  
 
|-
 
|-
−
| PEARL
+
| {{text_anchor|HAIR}}
 +
|
 +
| Classifies the material as hair, allowing for its use for spinners and restriction from refuse stockpiles by material.
 +
 
 +
|-
 +
| {{text_anchor|PEARL}}
 
|
 
|
 
| Classifies the material as pearl, allowing its use for bone carvers and restriction from stockpiles by material.
 
| Classifies the material as pearl, allowing its use for bone carvers and restriction from stockpiles by material.
  
 
|-
 
|-
−
| SHELL
+
| {{text_anchor|SHELL}}
 
|
 
|
 
| Classifies the material as shell, allowing its use for bone carvers and restriction from stockpiles by material.
 
| Classifies the material as shell, allowing its use for bone carvers and restriction from stockpiles by material.
  
 
|-
 
|-
−
| LEATHER
+
| {{text_anchor|LEATHER}}
 
|
 
|
 
| Classifies the material as leather, allowing its use for leatherworkers and storage in leather stockpiles.
 
| Classifies the material as leather, allowing its use for leatherworkers and storage in leather stockpiles.
  
 
|-
 
|-
−
| SILK
+
| {{text_anchor|SILK}}
 
|
 
|
 
| Classifies the material as silk, allowing its use for clothiers and storage in cloth stockpiles under "Thread (Silk)" and "Cloth (Silk)".
 
| Classifies the material as silk, allowing its use for clothiers and storage in cloth stockpiles under "Thread (Silk)" and "Cloth (Silk)".
  
 
|-
 
|-
−
| SOAP
+
| {{text_anchor|SOAP}}
 
|
 
|
 
| Classifies the material as soap, allowing it to be used as a bath detergent and stored in bar/block stockpiles under "Bars: Other Materials".{{verify}}
 
| Classifies the material as soap, allowing it to be used as a bath detergent and stored in bar/block stockpiles under "Bars: Other Materials".{{verify}}
  
 
|-
 
|-
−
| GENERATES_MIASMA
+
| {{text_anchor|GENERATES_MIASMA}}
 
|
 
|
−
| Material generates miasma when it rots
+
| Material generates miasma when it rots.
  
 
|-
 
|-
−
| MEAT
+
| {{text_anchor|MEAT}}
 
|
 
|
 
| Classifies the material as edible meat.{{verify}}
 
| Classifies the material as edible meat.{{verify}}
  
 
|-
 
|-
−
| ROTS
+
| {{text_anchor|ROTS}}
 +
|
 +
| Material will rot if not stockpiled appropriately. Currently only affects [[food]] and [[refuse]], other items made of this material will not rot.
 +
 
 +
|-
 +
| {{text_anchor|NERVOUS_TISSUE}}
 
|
 
|
−
| Material will rot if not stockpiled appropriately
+
| In most living creatures, it controls many bodily functions and movements by sending signals around the body. See: [[Nervous tissue]]
  
 
|-
 
|-
−
| BLOOD_MAP_DESCRIPTOR
+
| {{text_anchor|BLOOD_MAP_DESCRIPTOR}}
 
|
 
|
 
| Tells the game to classify contaminants of this material as being "blood" in Adventurer mode tile descriptions ("Here we have a Dwarf in a slurry of blood.").
 
| Tells the game to classify contaminants of this material as being "blood" in Adventurer mode tile descriptions ("Here we have a Dwarf in a slurry of blood.").
  
 
|-
 
|-
−
| ICHOR_MAP_DESCRIPTOR
+
| {{text_anchor|ICHOR_MAP_DESCRIPTOR}}
 
|
 
|
 
| Tells the game to classify contaminants of this material as being "ichor".
 
| Tells the game to classify contaminants of this material as being "ichor".
  
 
|-
 
|-
−
| GOO_MAP_DESCRIPTOR
+
| {{text_anchor|GOO_MAP_DESCRIPTOR}}
 
|
 
|
 
| Tells the game to classify contaminants of this material as being "goo".
 
| Tells the game to classify contaminants of this material as being "goo".
  
 
|-
 
|-
−
| SLIME_MAP_DESCRIPTOR
+
| {{text_anchor|SLIME_MAP_DESCRIPTOR}}
 
|
 
|
 
| Tells the game to classify contaminants of this material as being "slime".
 
| Tells the game to classify contaminants of this material as being "slime".
  
 
|-
 
|-
−
| PUS_MAP_DESCRIPTOR
+
| {{text_anchor|PUS_MAP_DESCRIPTOR}}
 
|
 
|
 
| Tells the game to classify contaminants of this material as being "pus".
 
| Tells the game to classify contaminants of this material as being "pus".
  
 
|-
 
|-
−
| ENTERS_BLOOD
+
| {{text_anchor|SWEAT_MAP_DESCRIPTOR}}
 +
|
 +
| Tells the game to classify contaminants of this material as being "sweat".
 +
 
 +
|-
 +
| {{text_anchor|TEARS_MAP_DESCRIPTOR}}
 +
|
 +
| Tells the game to classify contaminants of this material as being "tears".
 +
 
 +
|-
 +
| {{text_anchor|SPIT_MAP_DESCRIPTOR}}
 +
|
 +
| Tells the game to classify contaminants of this material as being "spit".
 +
 
 +
|-
 +
| {{text_anchor|EVAPORATES}}
 +
|
 +
| Contaminants composed of this material evaporate over time, slowly disappearing from the map. Used internally by water.
 +
 
 +
|-
 +
| {{text_anchor|ENTERS_BLOOD}}
 
|
 
|
 
| Used for materials which cause [[syndrome]]s, causes it to enter the creature's blood instead of simply spattering on the surface.
 
| Used for materials which cause [[syndrome]]s, causes it to enter the creature's blood instead of simply spattering on the surface.
  
 
|-
 
|-
−
| EDIBLE_VERMIN
+
| {{text_anchor|EDIBLE_VERMIN}}
 
|
 
|
 
| Can be eaten by vermin.
 
| Can be eaten by vermin.
  
 
|-
 
|-
−
| EDIBLE_RAW
+
| {{text_anchor|EDIBLE_RAW}}
 
|
 
|
 
| Can be eaten raw.
 
| Can be eaten raw.
  
 
|-
 
|-
−
| EDIBLE_COOKED
+
| {{text_anchor|EDIBLE_COOKED}}
 
|
 
|
 
| Can be cooked and then eaten.
 
| Can be cooked and then eaten.
  
 
|-
 
|-
−
| DO_NOT_CLEAN_GLOB
+
| {{text_anchor|DO_NOT_CLEAN_GLOB}}
 
|
 
|
 
| Prevents globs made of this material from being cleaned up and destroyed.
 
| Prevents globs made of this material from being cleaned up and destroyed.
  
 
|-
 
|-
−
| NO_STONE_STOCKPILE
+
| {{text_anchor|NO_STONE_STOCKPILE}}
 
|
 
|
 
| Prevents the material from showing up in Stone stockpile settings.
 
| Prevents the material from showing up in Stone stockpile settings.
  
 
|-
 
|-
−
| ITEMS_METAL
+
| {{text_anchor|ITEMS_METAL}}
 
|
 
|
−
| Effect unknown. Possibly vestigial.
+
| The material can be made into minecarts, wheelbarrows, and stepladders at the metalsmith's forge.
  
 
|-
 
|-
−
| ITEMS_BARRED
+
| {{text_anchor|ITEMS_BARRED}}
 
|
 
|
 
| Equivalent to ITEMS_HARD. Given to [[bone]].
 
| Equivalent to ITEMS_HARD. Given to [[bone]].
  
 
|-
 
|-
−
| ITEMS_SCALED
+
| {{text_anchor|ITEMS_SCALED}}
 
|
 
|
 
| Equivalent to ITEMS_HARD. Given to [[shell]].
 
| Equivalent to ITEMS_HARD. Given to [[shell]].
  
 
|-
 
|-
−
| ITEMS_LEATHER
+
| {{text_anchor|ITEMS_LEATHER}}
 
|
 
|
 
| Equivalent to ITEMS_SOFT. Given to [[leather]].
 
| Equivalent to ITEMS_SOFT. Given to [[leather]].
  
 
|-
 
|-
−
| ITEMS_SOFT
+
| {{text_anchor|ITEMS_SOFT}}
 
|
 
|
−
| Random [[finished goods|crafts]] made from this material can not be made into rings, crowns, scepters or figurines. Given to [[plant fiber]], [[silk]] and [[wool]].
+
| The material can be made into clothing, amulets, bracelets, earrings, backpacks, and quivers, contingent on which workshops accept the material. Given to [[plant fiber]], [[silk]] and [[wool]].
  
 
|-
 
|-
−
| ITEMS_HARD
+
| {{text_anchor|ITEMS_HARD}}
 
|
 
|
−
| Random [[finished goods|crafts]] made from this material include all seven items. Given to [[stone]], [[wood]], [[bone]], [[shell]], [[chitin]], [[nail|claws]], [[tooth|teeth]], [[horn|horns]], [[horn|hooves]] and [[wax|beeswax]]. [[Hair]], [[pearl|pearls]] and eggshells also have the tag.
+
| The material can be made into furniture, crafts, mechanisms, and blocks, contingent on which workshops accept the material. Random [[finished goods|crafts]] made from this material include all seven items. Given to [[stone]], [[wood]], [[bone]], [[shell]], [[chitin]], [[nail|claws]], [[tooth|teeth]], [[horn|horns]], [[horn|hooves]] and [[wax|beeswax]]. [[Hair]], [[pearl|pearls]] and eggshells also have the tag.
  
 
|-
 
|-
−
| IS_STONE
+
| {{text_anchor|IS_STONE}}
 
|
 
|
−
| Used to define that said material is stone. Allows its storage in stone stockpiles, among other effects.
+
| Used to define that the material is a stone. Allows its usage in [[masonry]] and [[stonecrafting]] and storage in stone stockpiles, among other effects.
  
 
|-
 
|-
−
| UNDIGGABLE
+
| {{text_anchor|UNDIGGABLE}}
 
|  
 
|  
 
| Used for a stone that cannot be dug into.
 
| Used for a stone that cannot be dug into.
  
 
|-
 
|-
−
| DISPLAY_UNGLAZED
+
| {{text_anchor|DISPLAY_UNGLAZED}}
 
|
 
|
 
| Causes containers made of this material to be prefixed with "unglazed" if they have not yet been [[glaze]]d.
 
| Causes containers made of this material to be prefixed with "unglazed" if they have not yet been [[glaze]]d.
  
 
|-
 
|-
−
| YARN
+
| {{text_anchor|YARN}}
 
|
 
|
 
| Classifies the material as yarn, allowing its use for clothiers and its storage in cloth stockpiles under "Thread (Yarn)" and "Cloth (Yarn)".
 
| Classifies the material as yarn, allowing its use for clothiers and its storage in cloth stockpiles under "Thread (Yarn)" and "Cloth (Yarn)".
  
 
|-
 
|-
−
| STOCKPILE_THREAD_METAL
+
| {{text_anchor|STOCKPILE_THREAD_METAL}}
 
|
 
|
 
| Classifies the material as metal thread, permitting thread and cloth to be stored in cloth stockpiles under "Thread (Metal)" and "Cloth (Metal)".
 
| Classifies the material as metal thread, permitting thread and cloth to be stored in cloth stockpiles under "Thread (Metal)" and "Cloth (Metal)".
  
 
|-
 
|-
−
| IS_METAL
+
| {{text_anchor|IS_METAL}}
 
|
 
|
 
| Defines the material as being metal, allowing it to be used at forges.
 
| Defines the material as being metal, allowing it to be used at forges.
  
 
|-
 
|-
−
| IS_GLASS
+
| {{text_anchor|IS_GLASS}}
 +
|
 +
| Used internally by green glass, clear glass, and crystal glass. Appears to only affect the [[Reaction#GLASS_MATERIAL|[GLASS_MATERIAL]]] reaction token. Does not cause the game to treat the material like glass, i.e being referred to as "raw" instead of "rough" in its raw form or being displayed in the "glass" trade/embark category.
 +
 
 +
|-
 +
| {{text_anchor|IS_CERAMIC}}
 
|
 
|
−
| Used internally by green glass, clear glass, and crystal glass.
+
| Defines the material as a ceramic. Examples include CERAMIC_EARTHENWARE, CERAMIC_STONEWARE and CERAMIC_PORCELAIN.
  
 
|-
 
|-
−
| CRYSTAL_GLASSABLE
+
| {{text_anchor|CRYSTAL_GLASSABLE}}
 
|
 
|
 
| Can be used in the production of crystal glass.
 
| Can be used in the production of crystal glass.
  
 
|-
 
|-
−
| ITEMS_WEAPON
+
| {{text_anchor|ITEMS_WEAPON}}
 
|  
 
|  
 
| Melee [[Weapon#Manufactured weapons|weapons]] can be made out of this material.
 
| Melee [[Weapon#Manufactured weapons|weapons]] can be made out of this material.
  
 
|-
 
|-
−
| ITEMS_WEAPON_RANGED
+
| {{text_anchor|ITEMS_WEAPON_RANGED}}
 
|
 
|
 
| Ranged weapons can be made out of this material.
 
| Ranged weapons can be made out of this material.
  
 
|-
 
|-
−
| ITEMS_ANVIL
+
| {{text_anchor|ITEMS_ANVIL}}
 
|
 
|
 
| [[Anvil]]s can be made out of this material.
 
| [[Anvil]]s can be made out of this material.
  
 
|-
 
|-
−
| ITEMS_AMMO
+
| {{text_anchor|ITEMS_AMMO}}
 
|
 
|
 
| [[Weapon#Ammunition|Ammunition]] can be made out of this material.
 
| [[Weapon#Ammunition|Ammunition]] can be made out of this material.
  
 
|-
 
|-
−
| ITEMS_DIGGER
+
| {{text_anchor|ITEMS_DIGGER}}
 
|
 
|
 
| [[Weapon#Dwarf-manufactured weapons|Picks]] can be made out of this material.
 
| [[Weapon#Dwarf-manufactured weapons|Picks]] can be made out of this material.
  
 
|-
 
|-
−
| ITEMS_ARMOR
+
| {{text_anchor|ITEMS_ARMOR}}
 
|
 
|
 
| [[Armor]] can be made out of this material.
 
| [[Armor]] can be made out of this material.
  
 
|-
 
|-
−
| ITEMS_DELICATE
+
| {{text_anchor|ITEMS_DELICATE}}
 
|
 
|
 
| Used internally by amber and coral. Functionally equivalent to ITEMS_HARD.
 
| Used internally by amber and coral. Functionally equivalent to ITEMS_HARD.
  
 
|-
 
|-
−
| ITEMS_SIEGE_ENGINE
+
| {{text_anchor|ITEMS_SIEGE_ENGINE}}
 
|
 
|
 
| Siege engine parts can be made out of this material. Does not appear to work.
 
| Siege engine parts can be made out of this material. Does not appear to work.
  
 
|-
 
|-
−
| ITEMS_QUERN
+
| {{text_anchor|ITEMS_QUERN}}
 
|
 
|
−
| Querns and millstones can be made out of this material.{{verify}}
+
| Querns and millstones can be made out of this material. Does not appear to work.
 
|}
 
|}
  
 
==Syndrome tokens==
 
==Syndrome tokens==
 +
Below is a table with some of the tokens you can use when declaring a [SYNDROME] token. For all the tokens you can use, see the [[Syndrome token]] page.
  
 
{| {{prettytable}}
 
{| {{prettytable}}
Line 766: Line 924:
  
 
|-  
 
|-  
−
| SYN_NAME  
+
| {{text_anchor|SYN_NAME  
−
| text  
+
|  
−
| defines the name of the syndrome
+
* text  
 +
| Defines the name of the syndrome
  
 
|-
 
|-
−
| SYN_INJECTED  
+
| {{text_anchor|SYN_INJECTED}}
 
|   
 
|   
−
| syndrome can be contracted by injection (by a creature)
+
| Syndrome can be contracted by injection (by a creature)
  
 
|-  
 
|-  
−
| SYN_CONTACT  
+
| {{text_anchor|SYN_CONTACT}}
 
|   
 
|   
−
| syndrome can be contracted on contact (e.g. poison dust or liquid)
+
| Syndrome can be contracted on contact (e.g. poison dust or liquid)
  
 
|-  
 
|-  
−
| SYN_INHALED  
+
| {{text_anchor|SYN_INHALED}}
 +
| 
 +
| Syndrome can be contracted by inhalation (e.g. poison vapor or gas)
 +
 
 +
|-
 +
| {{text_anchor|SYN_INGESTED}}
 
|   
 
|   
−
| syndrome can be contracted by inhalation (e.g. poison vapor or gas)
+
| Syndrome can be contracted by ingestion (when the material is eaten in solid or liquid form)
  
 
|-  
 
|-  
−
| SYN_AFFECTED_CLASS  
+
| {{text_anchor|SYN_AFFECTED_CLASS}}
−
|
+
|  
−
| adds a class of creatures to those affected, such as CREATURE_CLASS:GENERAL_POISON
+
* creature class name
 +
| Adds a class of creatures to those affected, such as CREATURE_CLASS:GENERAL_POISON
  
 
|-  
 
|-  
−
| SYN_IMMUNE_CLASS
+
| {{text_anchor|SYN_IMMUNE_CLASS}}
−
|
+
|  
−
| makes the class of creatures immune to the syndrome
+
* creature class name
 +
| Makes the class of creatures immune to the syndrome
  
 
|-  
 
|-  
−
| SYN_AFFECTED_CREATURE
+
| {{text_anchor|SYN_AFFECTED_CREATURE}}
−
| creature
+
|  
−
| adds a specific creature to those affected.
+
* creature name
 +
* caste name or ALL
 +
| Adds a specific creature to those affected.
  
 
|-  
 
|-  
−
| SYN_IMMUNE_CREATURE
+
| {{text_anchor|SYN_IMMUNE_CREATURE}}
−
| creature
+
|  
−
| makes the creature immune to the syndrome
+
* creature name
 +
* caste name or ALL
 +
| Makes the creature immune to the syndrome
  
 
|-  
 
|-  
Line 827: Line 997:
 
|}
 
|}
  
−
==See Also==
+
==See also==
 
* [[Inorganic material definition token]]
 
* [[Inorganic material definition token]]
 
* [[Syndrome]]
 
* [[Syndrome]]
 +
* [[Hardcoded material]]
  
 
{{Category|Modding}}
 
{{Category|Modding}}
 
{{Category|Tokens}}
 
{{Category|Tokens}}
 +
[[ru:Material definition token]]

Latest revision as of 21:59, 1 August 2024

xTATTEREDx  · +FINE+  · *SUPERIOR*  · ≡EXCEPTIONAL≡  · ☼MASTERWORK☼
v50.14 · v0.47.05
This article is about the current version of DF.
Note that some content may still need to be updated.

Modding
Tokens
Audio · Biome · Graphics · Interaction · Mod info · Plant · Speech · Sphere · Syndrome · World
Body tokens
Body · Body detail plan · Bodygloss · Tissue
Creature tokens
Creature · Creature mannerism · Personality · Creature variation · Procedural graphics layer
Descriptor tokens
Descriptor color · Color · Descriptor pattern · Descriptor shape
Entity tokens
Entity · Ethic · Language · Value · Position
Job tokens
Building · Labor · Reaction · Skill · Unit type
Item tokens
Item type · Item definition · Ammo · Armor · Instrument · Tool · Trap component · Weapon
Material tokens
Material type · Material definition · Inorganic material definition
v · t · e


The following tokens can be used in material definitions (whether for inorganics or those within plants and creatures) as well as in material templates.

Material properties[edit]

Token Arguments Description
USE_MATERIAL_TEMPLATE
  • <template name>
 Resets all material tokens back to their default values, then imports the tokens of the specified preexisting material template (overriding any tokens defined prior to itself in the material). This means USE_MATERIAL_TEMPLATE should be the first token present in any material using it. It cannot be used inside of a [MATERIAL_TEMPLATE:X] which prevents the creation of nested material template structures.
PREFIX
  • <prefix> or NONE
 Applies a prefix to all items made from the material. For PLANT and CREATURE materials, this defaults to the plant/creature name. Not permitted in material template definitions.
STONE_NAME
  • <name>
 Overrides the name of BOULDER items (i.e. mined-out stones) made of the material (used for native copper/silver/gold/platinum to make them be called "nuggets" instead of "boulders").
IS_GEM
  • <name>
  • <plural>
  • OVERWRITE_SOLID (optional)
 Used to indicate that said material is a gemstone - when tiles are mined out, rough gems will be yielded instead of boulders. Plural can be "STP" to automatically append an "s" to the singular form, and OVERWRITE_SOLID will override the relevant STATE_NAME and STATE_ADJ values.
TEMP_DIET_INFO
  • <type>
 Specifies what the material should be treated as when drinking water contaminated by it, for generating unhappy thoughts. Valid values are BLOOD, SLIME, VOMIT, ICHOR, PUS, GOO, GRIME, and FILTH.
POWDER_DYE Allows the material to be used as dye, and defines color of dyed items.
TILE Specifies the tile that will be used to represent unmined tiles made of this material. Generally only used with stones. Defaults to 219 ('█').
ITEM_SYMBOL Specifies the tile that will be used to represent BOULDER items made of this material. Generally only used with stones. Defaults to 7 ('•').
DISPLAY_COLOR The on-screen color of the material. Uses a standard 3-digit color token. Equivalent to [TILE_COLOR:a:b:c], [BUILD_COLOR:b:a:X] (X = 1 if 'a' equals 'b', 0 otherwise), and [BASIC_COLOR:a:c]
BUILD_COLOR The color of objects made of this material which use both the foreground and background color: doors, floodgates, hatch covers, bins, barrels, and cages. Defaults to 7:7:1 (white).
TILE_COLOR The color of unmined tiles containing this material (for stone and soil), as well as engravings in this material. Defaults to 7:7:1 (white).
BASIC_COLOR The color of objects made of this material which use only the foreground color, including workshops, floors and boulders, and smoothed walls. Defaults to 7:1 (white).
STATE_COLOR Determines the color of the material at the specified state. See below for a list of valid material states. Color comes from descriptor_color_standard.txt. The nearest color value is used to display contaminants and body parts made of this material in ASCII and to color items and constructions made from this material with graphics. Example:

[STATE_COLOR:ALL_SOLID:GRAY]

STATE_NAME Determines the name of the material at the specified state, as displayed in-game.

[STATE_NAME:ALL_SOLID:stone]

STATE_ADJ Like STATE_NAME, but used in different situations. Equipment made from the material uses the state adjective and not the state name.
STATE_NAME_ADJ Sets both STATE_NAME and STATE_ADJ at the same time.
ABSORPTION
  • <value>
 The material's tendency to absorb liquids. Containers made of materials with nonzero absorption cannot hold liquids unless they have been glazed. Defaults to 0.
IMPACT_YIELD
  • <value>
 Specifies how hard of an impact (in kilopascals) the material can withstand before it will start deforming permanently. Used for blunt-force combat. Defaults to 10000.
IMPACT_FRACTURE
  • <value>
 Specifies how hard of an impact the material can withstand before it will fail entirely. Used for blunt-force combat. Defaults to 10000.
IMPACT_STRAIN_AT_YIELD or IMPACT_ELASTICITY
  • <value>
 Specifies how much the material will have given (in parts-per-100000) when the yield point is reached. Used for blunt-force combat. Defaults to 0. Apparently affects in combat whether the corresponding tissue is bruised (value >= 50000), torn (value between 25000 and 49999), or fractured (value <= 24999)
COMPRESSIVE_YIELD
  • <value>
 Specifies how hard the material can be compressed before it will start deforming permanently. Determines a tissue's resistance to pinching and response to strangulation. Defaults to 10000.
COMPRESSIVE_FRACTURE
  • <value>
 Specifies how hard the material can be compressed before it will fail entirely. Determines a tissue's resistance to pinching and response to strangulation. Defaults to 10000.
COMPRESSIVE_STRAIN_AT_YIELD or COMPRESSIVE_ELASTICITY
  • <value>
 Specifies how much the material will have given when it has been compressed to its yield point. Determines a tissue's resistance to pinching and response to strangulation. Defaults to 0.
TENSILE_YIELD
  • <value>
 Specifies how hard the material can be stretched before it will start deforming permanently. Determines a tissue's resistance to a latching and tearing bite. Defaults to 10000.
TENSILE_FRACTURE
  • <value>
 Specifies how hard the material can be stretched before it will fail entirely. Determines a tissue's resistance to a latching and tearing bite. Defaults to 10000.
TENSILE_STRAIN_AT_YIELD or TENSILE_ELASTICITY
  • <value>
 Specifies how much the material will have given when it is stretched to its yield point. Determines a tissue's resistance to a latching and tearing bite. Defaults to 0.
TORSION_YIELD
  • <value>
 Specifies how hard the material can be twisted before it will start deforming permanently. Used for latching and shaking with a blunt attack (certain generated creatures can do this). Defaults to 10000.
TORSION_FRACTURE
  • <value>
 Specifies how hard the material can be twisted before it will fail entirely. Used for latching and shaking with a blunt attack (certain generated creatures can do this). Defaults to 10000.
TORSION_STRAIN_AT_YIELD or TORSION_ELASTICITY
  • <value>
 Specifies how much the material will have given when it is twisted to its yield point. Used for latching and shaking with a blunt attack (certain generated creatures can do this). Defaults to 0.
SHEAR_YIELD
  • <value>
 Specifies how hard the material can be sheared before it will start deforming permanently. Used for cutting calculations. Defaults to 10000.
SHEAR_FRACTURE
  • <value>
 Specifies how hard the material can be sheared before it will fail entirely. Used for cutting calculations. Defaults to 10000.
SHEAR_STRAIN_AT_YIELD or SHEAR_ELASTICITY
  • <value>
 Specifies how much the material will have given when sheared to its yield point. Used for cutting calculations. Defaults to 0.
BENDING_YIELD
  • <value>
 Specifies how hard the material can be bent before it will start deforming permanently. Determines a tissue's resistance to being mangled with a joint lock. Defaults to 10000.
BENDING_FRACTURE
  • <value>
 Specifies how hard the material can be bent before it will fail entirely. Determines a tissue's resistance to being mangled with a joint lock. Defaults to 10000.
BENDING_STRAIN_AT_YIELD or BENDING_ELASTICITY
  • <value>
 Specifies how much the material will have given when bent to its yield point. Determines a tissue's resistance to being mangled with a joint lock. Defaults to 0.
MAX_EDGE
  • <value>
 How sharp the material is. Used in cutting calculations. Applying a value of at least 10000 to a stone will allow weapons to be made from that stone. Defaults to 10000.
MATERIAL_VALUE
  • <value>
 Value modifier for the material. Defaults to 1. This number can be made negative by placing a "-" in front, resulting in things that you are paid to buy and must pay to sell.
MULTIPLY_VALUE
  • <value>
 Multiplies the value of the material. Not permitted in material template definitions.
SPEC_HEAT
  • <specific heat capacity>
 Rate at which the material heats up or cools down (in joules/kilogram-kelvin). If set to NONE, the temperature will be fixed at its initial value. See Temperature for more information. Defaults to NONE.
HEATDAM_POINT
  • <temperature>
 Temperature above which the material takes damage from heat. May be set to NONE. If the material has an ignite point but no heatdam point, it will burn for a very long time (9 months and 16.8 days). Defaults to NONE.
COLDDAM_POINT
  • <temperature>
 Temperature below which the material takes damage from cold. Defaults to NONE.
IGNITE_POINT
  • <temperature>
 Temperature at which the material will catch fire. Defaults to NONE.
MELTING_POINT
  • <temperature>
 Temperature at which the material melts. Defaults to NONE.
BOILING_POINT
  • <temperature>
 Temperature at which the material boils. Defaults to NONE.
MAT_FIXED_TEMP
  • <temperature>
 Items composed of this material will initially have this temperature. Used in conjunction with [SPEC_HEAT:NONE] to make material's temperature fixed at the specified value. Defaults to NONE.
IF_EXISTS_SET_HEATDAM_POINT
  • <temperature>
 Changes a material's HEATDAM_POINT, but only if it was not set to NONE. Not permitted in material template definitions.
IF_EXISTS_SET_COLDDAM_POINT
  • <temperature>
 Changes a material's COLDDAM_POINT, but only if it was not set to NONE. Not permitted in material template definitions.
IF_EXISTS_SET_IGNITE_POINT
  • <temperature>
 Changes a material's IGNITE_POINT, but only if it was not set to NONE. Not permitted in material template definitions.
IF_EXISTS_SET_MELTING_POINT
  • <temperature>
 Changes a material's MELTING_POINT, but only if it was not set to NONE. Not permitted in material template definitions.
IF_EXISTS_SET_BOILING_POINT
  • <temperature>
 Changes a material's BOILING_POINT, but only if it was not set to NONE. Not permitted in material template definitions.
IF_EXISTS_SET_MAT_FIXED_TEMP
  • <temperature>
 Changes a material's MAT_FIXED_TEMP, but only if it was not set to NONE. Not permitted in material template definitions.
SOLID_DENSITY
  • <density>
 Specifies the density (in kilograms per cubic meter) of the material when in solid form. Also affects combat calculations; affects blunt-force damage and ability of weak-in-impact-yield blunt attacks to pierce armor. Defaults to NONE.
LIQUID_DENSITY
  • <density>
 Specifies the density of the material when in liquid form. Defaults to NONE. Also affects combat calculations; affects blunt force damage like SOLID_DENSITY, but only for attacks made by liquids (e.g. forgotten beasts made of water).
MOLAR_MASS
  • <value>
 Specifies (in kg/mol) the molar mass of the material in gaseous form. Only affects combat calculations like the densities, and only for attacks made by gases (e.g. forgotten beasts made of steam).
EXTRACT_STORAGE * BARREL or FLASK Specifies the type of container used to store the material. Used in conjunction with the [EXTRACT_BARREL], [EXTRACT_VIAL], or [EXTRACT_STILL_VIAL] plant tokens. Defaults to BARREL.
BUTCHER_SPECIAL Specifies the item type used for butchering results made of this material. Stock raws use GLOB:NONE for fat and MEAT:NONE for other meat materials.
MEAT_NAME
  • <prefix>
  • <name>
  • <adjective>
 When a creature is butchered, meat yielded from organs made from this material will be named via this token.
BLOCK_NAME
  • <singular>
  • <plural>
 Specifies the name of blocks made from this material.
WAFERS The material forms "wafers" instead of "bars".
MATERIAL_REACTION_PRODUCT Used with reaction raws to associate a reagent material with a product material. The first argument is used by HAS_MATERIAL_REACTION_PRODUCT and GET_MATERIAL_FROM_REAGENT in reaction raws. The remainder is a material reference, generally LOCAL_CREATURE_MAT:SUBTYPE or LOCAL_PLANT_MAT:SUBTYPE or INORGANIC:STONETYPE.

[MATERIAL_REACTION_PRODUCT:TAN_MAT:LOCAL_CREATURE_MAT:LEATHER]

ITEM_REACTION_PRODUCT Used with reaction raws to associate a reagent material with a complete item. The first argument is used by HAS_ITEM_REACTION_PRODUCT and GET_ITEM_DATA_FROM_REAGENT in reaction raws. The rest refers to the type of item, then its material.

[ITEM_REACTION_PRODUCT:BAG_ITEM:PLANT_GROWTH:LEAVES:LOCAL_PLANT_MAT:LEAF]

REACTION_CLASS
  • <reaction class name>
 Used to classify all items made of the material, so that reactions can use them as generic reagents.

In default raws, the following are used:

  • FAT, TALLOW, SOAP, PARCHMENT, PAPER_PLANT, PAPER_SLURRY, MILK, CHEESE, WAX
  • CAN_GLAZE - items made from this material can be glazed.
  • FLUX - can be used as flux in pig iron and steel making.
  • GYPSUM - can be processed into gypsum plaster.
  • CALCIUM_CARBONATE - can be used in production of quicklime.
METAL_ORE
  • <inorganic material name e.g. LEAD>
  • <value>
 Makes BOULDER acceptable as a reagent in reactions that require "METAL_ORE:MATERIAL_NAME", as well as smelting directly into metal bars.
Places the material under "Metal Ores" in Stone stockpiles.
The specified value determines the probability for this product (see Tetrahedrite or Galena for details).
THREAD_METAL Makes BOULDER items made of the material acceptable for strand extraction into threads; see also STOCKPILE_THREAD_METAL. Value presumably determines the probability of this product extracted.[Verify]
HARDENS_WITH_WATER Allows the material to be used to make casts.
SOAP_LEVEL
  • <value>
 Determines effectiveness of soap - if the amount of grime on a body part is more than 3-SOAP_LEVEL, it sets it to 3-SOAP_LEVEL; as such setting it above 3 is bad. Soap has [SOAP_LEVEL:2]. Defaults to 0.
SYNDROME Begins defining a syndrome applied by the material. Multiple syndromes can be specified. See Syndrome token.
ANTLER Found in the raws of several antler-wielding animals. It is used to show an antler as bodypart.
HAIR Probably used in graphics.
FEATHER Probably used in graphics.
SCALE Probably used in graphics.
HOOF Probably used in graphics.
CHITIN Probably used in graphics.
CARTILAGE Probably used in graphics.
NERVOUS_TISSUE Probably used in graphics.
MEAT_CATEGORY category Probably used in graphics. The following values for "category" are used in the vanilla raws: STANDARD, EYE, BRIAN, LUNG, HEART, LIVER, INTESTINES, STOMACH, GIZZARD, PANCREAS, SPLEEN, KIDNEY.



Material states[edit]

The following is a list of valid material states:

SOLID
LIQUID
GAS
POWDER (or SOLID_POWDER)
PASTE (or SOLID_PASTE)
PRESSED (or SOLID_PRESSED)

The following can be specified within tokens such as STATE_NAME, STATE_NAME_ADJ and STATE_ADJ to make them apply to several of the above material states simultaneously:

Value Description
ALL Denotes all possible material states.
ALL_SOLID Denotes 'SOLID', 'POWDER', 'PASTE' and 'PRESSED'.

Material usage tokens[edit]

Token Arguments Description
IMPLIES_ANIMAL_KILL Lets the game know that an animal was likely killed in the production of this item. Entities opposed to killing animals (Elves in vanilla) will refuse to accept these items in trade.
ALCOHOL_PLANT Classifies the material as plant-based alcohol, allowing its storage in food stockpiles under "Drink (Plant)".
ALCOHOL_CREATURE Classifies the material as animal-based alcohol, allowing its storage in food stockpiles under "Drink (Animal)".
ALCOHOL Classifies the material as generic alcohol. Implied by both ALCOHOL_PLANT and ALCOHOL_CREATURE. Exact behavior unknown, possibly vestigial.
CHEESE_PLANT Classifies the material as plant-based cheese, allowing its storage in food stockpiles under "Cheese (Plant)".
CHEESE_CREATURE Classifies the material as animal-based cheese, allowing its storage in food stockpiles under "Cheese (Animal)".
CHEESE Classifies the material as generic cheese. Implied by both CHEESE_PLANT and CHEESE_CREATURE. Exact behavior unknown, possibly vestigial.
POWDER_MISC_PLANT Classifies the material as plant powder, allowing its storage in food stockpiles under "Milled Plant".
POWDER_MISC_CREATURE Classifies the material as creature powder, allowing its storage in food stockpiles under "Bone Meal". Unlike milled plants, such as sugar and flour, "Bone Meal" barrels or pots may not contain bags. Custom reactions using this product better use buckets or jugs instead.
POWDER_MISC Classifies the material as generic powder. Implied by both POWDER_MISC_PLANT and POWDER_MISC_CREATURE. Exact behavior unknown, possibly vestigial.
STOCKPILE_GLOB or STOCKPILE_GLOB_SOLID Permits globs of the material in solid form to be stored in food stockpiles under "Fat" - without it, dwarves will come by and "clean" the items, destroying them (unless [DO_NOT_CLEAN_GLOB] is also included).
STOCKPILE_GLOB_PASTE Classifies the material as milled paste, allowing its storage in food stockpiles under "Paste".
STOCKPILE_GLOB_PRESSED Classifies the material as pressed goods, allowing its storage in food stockpiles under "Pressed Material".
STOCKPILE_PLANT_GROWTH Classifies the material as a plant growth (e.g. fruits, leaves), allowing its storage in food stockpiles under Plant Growth/Fruit.
LIQUID_MISC_PLANT Classifies the material as a plant extract, allowing its storage in food stockpiles under "Extract (Plant)".
LIQUID_MISC_CREATURE Classifies the material as a creature extract, allowing its storage in food stockpiles under "Extract (Animal)".
LIQUID_MISC_OTHER Classifies the material as a miscellaneous liquid, allowing its storage in food stockpiles under "Misc. Liquid" along with lye.
LIQUID_MISC Classifies the material as a generic liquid. Implied by LIQUID_MISC_PLANT, LIQUID_MISC_CREATURE, and LIQUID_MISC_OTHER. Exact behavior unknown, possibly vestigial.
STRUCTURAL_PLANT_MAT Classifies the material as a plant, allowing its storage in food stockpiles under "Plants".
SEED_MAT Classifies the material as a plant seed, allowing its storage in food stockpiles under "Seeds".
BONE Classifies the material as bone, allowing its use for bone carvers and restriction from stockpiles by material.
WOOD Classifies the material as wood, allowing its use for carpenters and storage in wood stockpiles. Entities opposed to killing plants (i.e. Elves) will refuse to accept these items in trade.
THREAD_PLANT Classifies the material as plant fiber, allowing its use for clothiers and storage in cloth stockpiles under "Thread (Plant)" and "Cloth (Plant)".
TOOTH Classifies the material as tooth, allowing its use for bone carvers and restriction from stockpiles by material.
HORN Classifies the material as horn, allowing its use for bone carvers and restriction from stockpiles by material.
HAIR Classifies the material as hair, allowing for its use for spinners and restriction from refuse stockpiles by material.
PEARL Classifies the material as pearl, allowing its use for bone carvers and restriction from stockpiles by material.
SHELL Classifies the material as shell, allowing its use for bone carvers and restriction from stockpiles by material.
LEATHER Classifies the material as leather, allowing its use for leatherworkers and storage in leather stockpiles.
SILK Classifies the material as silk, allowing its use for clothiers and storage in cloth stockpiles under "Thread (Silk)" and "Cloth (Silk)".
SOAP Classifies the material as soap, allowing it to be used as a bath detergent and stored in bar/block stockpiles under "Bars: Other Materials".[Verify]
GENERATES_MIASMA Material generates miasma when it rots.
MEAT Classifies the material as edible meat.[Verify]
ROTS Material will rot if not stockpiled appropriately. Currently only affects food and refuse, other items made of this material will not rot.
NERVOUS_TISSUE In most living creatures, it controls many bodily functions and movements by sending signals around the body. See: Nervous tissue
BLOOD_MAP_DESCRIPTOR Tells the game to classify contaminants of this material as being "blood" in Adventurer mode tile descriptions ("Here we have a Dwarf in a slurry of blood.").
ICHOR_MAP_DESCRIPTOR Tells the game to classify contaminants of this material as being "ichor".
GOO_MAP_DESCRIPTOR Tells the game to classify contaminants of this material as being "goo".
SLIME_MAP_DESCRIPTOR Tells the game to classify contaminants of this material as being "slime".
PUS_MAP_DESCRIPTOR Tells the game to classify contaminants of this material as being "pus".
SWEAT_MAP_DESCRIPTOR Tells the game to classify contaminants of this material as being "sweat".
TEARS_MAP_DESCRIPTOR Tells the game to classify contaminants of this material as being "tears".
SPIT_MAP_DESCRIPTOR Tells the game to classify contaminants of this material as being "spit".
EVAPORATES Contaminants composed of this material evaporate over time, slowly disappearing from the map. Used internally by water.
ENTERS_BLOOD Used for materials which cause syndromes, causes it to enter the creature's blood instead of simply spattering on the surface.
EDIBLE_VERMIN Can be eaten by vermin.
EDIBLE_RAW Can be eaten raw.
EDIBLE_COOKED Can be cooked and then eaten.
DO_NOT_CLEAN_GLOB Prevents globs made of this material from being cleaned up and destroyed.
NO_STONE_STOCKPILE Prevents the material from showing up in Stone stockpile settings.
ITEMS_METAL The material can be made into minecarts, wheelbarrows, and stepladders at the metalsmith's forge.
ITEMS_BARRED Equivalent to ITEMS_HARD. Given to bone.
ITEMS_SCALED Equivalent to ITEMS_HARD. Given to shell.
ITEMS_LEATHER Equivalent to ITEMS_SOFT. Given to leather.
ITEMS_SOFT The material can be made into clothing, amulets, bracelets, earrings, backpacks, and quivers, contingent on which workshops accept the material. Given to plant fiber, silk and wool.
ITEMS_HARD The material can be made into furniture, crafts, mechanisms, and blocks, contingent on which workshops accept the material. Random crafts made from this material include all seven items. Given to stone, wood, bone, shell, chitin, claws, teeth, horns, hooves and beeswax. Hair, pearls and eggshells also have the tag.
IS_STONE Used to define that the material is a stone. Allows its usage in masonry and stonecrafting and storage in stone stockpiles, among other effects.
UNDIGGABLE Used for a stone that cannot be dug into.
DISPLAY_UNGLAZED Causes containers made of this material to be prefixed with "unglazed" if they have not yet been glazed.
YARN Classifies the material as yarn, allowing its use for clothiers and its storage in cloth stockpiles under "Thread (Yarn)" and "Cloth (Yarn)".
STOCKPILE_THREAD_METAL Classifies the material as metal thread, permitting thread and cloth to be stored in cloth stockpiles under "Thread (Metal)" and "Cloth (Metal)".
IS_METAL Defines the material as being metal, allowing it to be used at forges.
IS_GLASS Used internally by green glass, clear glass, and crystal glass. Appears to only affect the [GLASS_MATERIAL] reaction token. Does not cause the game to treat the material like glass, i.e being referred to as "raw" instead of "rough" in its raw form or being displayed in the "glass" trade/embark category.
IS_CERAMIC Defines the material as a ceramic. Examples include CERAMIC_EARTHENWARE, CERAMIC_STONEWARE and CERAMIC_PORCELAIN.
CRYSTAL_GLASSABLE Can be used in the production of crystal glass.
ITEMS_WEAPON Melee weapons can be made out of this material.
ITEMS_WEAPON_RANGED Ranged weapons can be made out of this material.
ITEMS_ANVIL Anvils can be made out of this material.
ITEMS_AMMO Ammunition can be made out of this material.
ITEMS_DIGGER Picks can be made out of this material.
ITEMS_ARMOR Armor can be made out of this material.
ITEMS_DELICATE Used internally by amber and coral. Functionally equivalent to ITEMS_HARD.
ITEMS_SIEGE_ENGINE Siege engine parts can be made out of this material. Does not appear to work.
ITEMS_QUERN Querns and millstones can be made out of this material. Does not appear to work.

Syndrome tokens[edit]

Below is a table with some of the tokens you can use when declaring a [SYNDROME] token. For all the tokens you can use, see the Syndrome token page.

Token Arguments Description
SYN_NAME
  • text
 Defines the name of the syndrome
SYN_INJECTED Syndrome can be contracted by injection (by a creature)
SYN_CONTACT Syndrome can be contracted on contact (e.g. poison dust or liquid)
SYN_INHALED Syndrome can be contracted by inhalation (e.g. poison vapor or gas)
SYN_INGESTED Syndrome can be contracted by ingestion (when the material is eaten in solid or liquid form)
SYN_AFFECTED_CLASS
  • creature class name
 Adds a class of creatures to those affected, such as CREATURE_CLASS:GENERAL_POISON
SYN_IMMUNE_CLASS
  • creature class name
 Makes the class of creatures immune to the syndrome
SYN_AFFECTED_CREATURE
  • creature name
  • caste name or ALL
 Adds a specific creature to those affected.
SYN_IMMUNE_CREATURE
  • creature name
  • caste name or ALL
 Makes the creature immune to the syndrome
CE_PAIN
CE_SWELLING
CE_OOZING
CE_BRUISING
CE_BLISTERS
CE_NUMBNESS
CE_PARALYSIS
CE_FEVER
CE_BLEEDING
CE_COUGH_BLOOD
CE_VOMIT_BLOOD
CE_NAUSEA
CE_UNCONSCIOUSNESS
CE_NECROSIS
CE_IMPAIR_FUNCTION
CE_DROWSINESS
CE_DIZZINESS
  • SEV:<value> (severity, higher is worse)
  • PROB:<value(1-100)> (probability)
  • RESISTABLE (optional) allows resistance
  • SIZE_DILUTES (optional) lessens effect based on size

Place affected:

  • LOCALIZED (optional)
  • VASCULAR_ONLY (optional)
  • MUSCULAR_ONLY (optional)
  • BP:BY_CATEGORY:category:tissue (optional)
  • BP:BY_TYPE:type:tissue (optional)
  • BP:BY_TOKEN:token:tissue (optional)

Timeline:

  • Start:effect start time
  • Peak:effect peak time
  • End:effect end time
 Specifies the way that a syndrome affects a creature -- more detail can be found on the Syndromes page

See also[edit]

Retrieved from "https://dwarffortresswiki.org/index.php?title=Material_definition_token&oldid=302745"