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.

Editing Material definition token

Jump to navigation Jump to search

Warning: You are not logged in.
Your IP address will be recorded in this page's edit history.

If you are creating a redirect to the current version's page, do not use any namespace. For example: use #REDIRECT [[Cat]], not #REDIRECT [[Main:Cat]] or #REDIRECT [[cv:Cat]]. See DF:Versions for more information.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

Latest revision Your text
Line 1: Line 1:
−
{{Quality|Fine}}
+
{{Quality|Fine|11:11, 18 May 2015 (UTC)}}
 
{{av}}
 
{{av}}
−
{{Modding}}
 
  
−
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]].
+
The following tokens can be used in material definitions (whether for inorganics or those within plants and creatures) as well as in material templates.
  
−
__TOC__
+
==Material Properties==
−
{{clear}}
 
−
 
 
−
==Material properties==
 
 
{| {{prettytable}}
 
{| {{prettytable}}
 
|- bgcolor="#C0C0C0"
 
|- bgcolor="#C0C0C0"
Line 14: Line 10:
 
! Arguments
 
! Arguments
 
! Description
 
! Description
−
 
−
|-
 
−
| {{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}}
 
| {{text_anchor|PREFIX}}
 
|
 
|
−
* <prefix> or NONE
+
* string 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.'''
  
Line 30: Line 20:
 
| {{text_anchor|STONE_NAME}}
 
| {{text_anchor|STONE_NAME}}
 
|
 
|
−
* <name>
+
* string
−
| 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").
+
| Overrides the name of mined-out stones (used for native copper/silver/gold/platinum to make them be called "nuggets").
  
 
|-
 
|-
 
| {{text_anchor|IS_GEM}}
 
| {{text_anchor|IS_GEM}}
 
|
 
|
−
* <name>
+
* name
−
* <plural>
+
* plural
−
* OVERWRITE_SOLID (optional)
+
* state
 
| 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.
  
Line 44: Line 34:
 
| {{text_anchor|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.
  
 
|-
 
|-
 
| {{text_anchor|POWDER_DYE}}
 
| {{text_anchor|POWDER_DYE}}
−
|
+
| [[color|color name]]
−
*<[[Color#Color_tokens|color token]]>
 
 
| Allows the material to be used as [[dye]], and defines color of dyed items.
 
| Allows the material to be used as [[dye]], and defines color of dyed items.
  
 
|-
 
|-
 
| {{text_anchor|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 ('█').
  
 
|-
 
|-
 
| {{text_anchor|ITEM_SYMBOL}}
 
| {{text_anchor|ITEM_SYMBOL}}
−
|
+
| tile
−
*<[[Main:Character table|tile value or character]]>
+
| Specifies the tile that will be used to represent BOULDER objects made of this material. Generally only used with stones. Defaults to 7 ('•').
−
| 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 ('•').
 
  
 
|-
 
|-
 
| {{text_anchor|DISPLAY_COLOR}}
 
| {{text_anchor|DISPLAY_COLOR}}
 
|
 
|
−
*<[[Color#Color_values|foreground color]]>
+
*foreground color
−
*<[[Color#Color_values|background color]]>
+
*background color
−
*<[[Color#Color_values|foreground brightness]]>
+
*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]
  
Line 76: Line 63:
 
| {{text_anchor|BUILD_COLOR}}
 
| {{text_anchor|BUILD_COLOR}}
 
|
 
|
−
*<[[Color#Color_values|foreground color]]>
+
*foreground color
−
*<[[Color#Color_values|background color]]>
+
*background color
−
*<[[Color#Color_values|foreground brightness]]>
+
*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).
  
Line 84: Line 71:
 
| {{text_anchor|TILE_COLOR}}
 
| {{text_anchor|TILE_COLOR}}
 
|
 
|
−
*<[[Color#Color_values|foreground color]]>
+
*foreground color
−
*<[[Color#Color_values|background color]]>
+
*background color
−
*<[[Color#Color_values|foreground brightness]]>
+
*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).
  
Line 92: Line 79:
 
| {{text_anchor|BASIC_COLOR}}
 
| {{text_anchor|BASIC_COLOR}}
 
|
 
|
−
*<[[Color#Color_values|foreground color]]>
+
*color
−
*<[[Color#Color_values|foreground brightness]]>
+
*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).
  
Line 99: Line 86:
 
| {{text_anchor|STATE_COLOR}}
 
| {{text_anchor|STATE_COLOR}}
 
|
 
|
−
*<[[Material_definition_token#Material States|material state]]>
+
*state
−
*<[[Color#Color_tokens|color token]]>
+
*[[color]] token
−
| 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:
+
| The state may be SOLID, LIQUID, GAS, POWDER/SOLID_POWDER, PASTE/SOLID_PASTE, PRESSED/SOLID_PRESSED, ALL_SOLID, or ALL.
 +
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:GRAY]
  
Line 107: Line 95:
 
| {{text_anchor|STATE_NAME}}
 
| {{text_anchor|STATE_NAME}}
 
|
 
|
−
*<[[Material_definition_token#Material States|material state]]>
+
*state
−
*<name>
+
*name
−
| Determines the name of the material at the specified state, as displayed in-game.
+
| The name of the material as displayed in-game.
 
[STATE_NAME:ALL_SOLID:stone]
 
[STATE_NAME:ALL_SOLID:stone]
  
 
|-
 
|-
−
| {{text_anchor|STATE_ADJ}}
+
| {{text_anchor|STATE_NAME_ADJ}}
 
|
 
|
−
*<[[Material_definition_token#Material States|material state]]>
+
*state
−
*<adjective>
+
*name/adjective
−
| 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.
+
| Sets both STATE_NAME and STATE_ADJ at the same time.
  
 
|-
 
|-
−
| {{text_anchor|STATE_NAME_ADJ}}
+
| {{text_anchor|STATE_ADJ}}
 
|
 
|
−
*<[[Material_definition_token#Material States|material state]]>
+
*state
−
*<name>
+
*adjective
−
*<adjective>
+
| Like STATE_NAME, but used in different situations. Equipment made from the material uses the state adjective and not the state name.
−
| Sets both [[Material_definition_token#STATE_NAME|STATE_NAME]] and [[Material_definition_token#STATE_ADJ|STATE_ADJ]] at the same time.
 
  
 
|-
 
|-
 
| {{text_anchor|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.
  
Line 136: Line 123:
 
| {{text_anchor|IMPACT_YIELD}}
 
| {{text_anchor|IMPACT_YIELD}}
 
|
 
|
−
*<value>
+
*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.
 
| 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.
  
Line 142: Line 129:
 
| {{text_anchor|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.
  
Line 148: Line 135:
 
| {{text_anchor|IMPACT_STRAIN_AT_YIELD}} or {{text_anchor|IMPACT_ELASTICITY}}
 
| {{text_anchor|IMPACT_STRAIN_AT_YIELD}} or {{text_anchor|IMPACT_ELASTICITY}}
 
|
 
|
−
*<value>
+
*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)
 
| 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)
  
Line 154: Line 141:
 
| {{text_anchor|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.
  
Line 160: Line 147:
 
| {{text_anchor|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.
  
Line 166: Line 153:
 
| {{text_anchor|COMPRESSIVE_STRAIN_AT_YIELD}} or {{text_anchor|COMPRESSIVE_ELASTICITY}}
 
| {{text_anchor|COMPRESSIVE_STRAIN_AT_YIELD}} or {{text_anchor|COMPRESSIVE_ELASTICITY}}
 
|
 
|
−
*<value>
+
*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.
 
| 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.
  
Line 172: Line 159:
 
| {{text_anchor|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.
  
Line 178: Line 165:
 
| {{text_anchor|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.
  
Line 184: Line 171:
 
| {{text_anchor|TENSILE_STRAIN_AT_YIELD}} or {{text_anchor|TENSILE_ELASTICITY}}
 
| {{text_anchor|TENSILE_STRAIN_AT_YIELD}} or {{text_anchor|TENSILE_ELASTICITY}}
 
|
 
|
−
*<value>
+
*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.
 
| 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.
  
Line 190: Line 177:
 
| {{text_anchor|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 (no default creature has such an attack, but they can be modded in).  Defaults to 10000.
  
Line 196: Line 183:
 
| {{text_anchor|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 (no default creature has such an attack, but they can be modded in).  Defaults to 10000.
  
Line 202: Line 189:
 
| {{text_anchor|TORSION_STRAIN_AT_YIELD}} or {{text_anchor|TORSION_ELASTICITY}}
 
| {{text_anchor|TORSION_STRAIN_AT_YIELD}} or {{text_anchor|TORSION_ELASTICITY}}
 
|
 
|
−
*<value>
+
*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 (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 (no default creature has such an attack, but they can be modded in).  Defaults to 0.
  
Line 208: Line 195:
 
| {{text_anchor|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.
  
Line 214: Line 201:
 
| {{text_anchor|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.
  
Line 220: Line 207:
 
| {{text_anchor|SHEAR_STRAIN_AT_YIELD}} or {{text_anchor|SHEAR_ELASTICITY}}
 
| {{text_anchor|SHEAR_STRAIN_AT_YIELD}} or {{text_anchor|SHEAR_ELASTICITY}}
 
|
 
|
−
*<value>
+
*value
 
| Specifies how much the material will have given when sheared to 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.
  
Line 226: Line 213:
 
| {{text_anchor|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.
  
Line 232: Line 219:
 
| {{text_anchor|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.
  
Line 238: Line 225:
 
| {{text_anchor|BENDING_STRAIN_AT_YIELD}} or {{text_anchor|BENDING_ELASTICITY}}
 
| {{text_anchor|BENDING_STRAIN_AT_YIELD}} or {{text_anchor|BENDING_ELASTICITY}}
 
|
 
|
−
*<value>
+
*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.
 
| 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.
  
Line 244: Line 231:
 
| {{text_anchor|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. Does not allow an inferior metal to penetrate superior armor. Applying a value of at least 10000 to a stone will allow weapons to be made from that stone. Defaults to 10000.
  
 
|-
 
|-
 
| {{text_anchor|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.
  
Line 256: Line 243:
 
| {{text_anchor|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.'''
  
Line 262: Line 249:
 
| {{text_anchor|SPEC_HEAT}}
 
| {{text_anchor|SPEC_HEAT}}
 
|
 
|
−
*<specific heat capacity>
+
*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.
+
| Rate at which the material heats up or cools down (in joules/kilokelvin). If set to NONE, the temperature will be fixed at its initial value. See [[Temperature]] for more information. Defaults to NONE.
  
 
|-
 
|-
 
| {{text_anchor|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.
  
Line 274: Line 261:
 
| {{text_anchor|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.
  
Line 280: Line 267:
 
| {{text_anchor|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.
  
Line 286: Line 273:
 
| {{text_anchor|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.
  
Line 292: Line 279:
 
| {{text_anchor|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.
  
Line 298: Line 285:
 
| {{text_anchor|MAT_FIXED_TEMP}}
 
| {{text_anchor|MAT_FIXED_TEMP}}
 
|
 
|
−
*<temperature>
+
*temperature
 
| 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.
 
| 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.
  
Line 304: Line 291:
 
| {{text_anchor|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.'''
  
Line 310: Line 297:
 
| {{text_anchor|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.'''
  
Line 316: Line 303:
 
| {{text_anchor|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.'''
  
Line 322: Line 309:
 
| {{text_anchor|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.'''
  
Line 328: Line 315:
 
| {{text_anchor|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.'''
  
Line 334: Line 321:
 
| {{text_anchor|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.'''
  
Line 340: Line 327:
 
| {{text_anchor|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 weak-in-impact-yield blunt attacks to pierce armor. 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 edged weapons to pierce tissue layers{{verify}}. Defaults to NONE.
  
 
|-
 
|-
 
| {{text_anchor|LIQUID_DENSITY}}
 
| {{text_anchor|LIQUID_DENSITY}}
 
|
 
|
−
*<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).
+
| Specifies the density of the material when in liquid form. Defaults to NONE.
  
 
|-
 
|-
 
| {{text_anchor|MOLAR_MASS}}
 
| {{text_anchor|MOLAR_MASS}}
 
|
 
|
−
*<value>
+
*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).
+
| Supposedly not used{{verify}}. Theoretically, should determine density (at given pressure) in gas state, on which in turn would depend (together with weight of vaporized material) on the volume covered by spreading vapors. Defaults to NONE.
  
 
|-
 
|-
 
| {{text_anchor|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.
  
Line 363: Line 350:
 
| {{text_anchor|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.
  
Line 369: Line 356:
 
| {{text_anchor|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.
  
Line 377: Line 364:
 
| {{text_anchor|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.
  
Line 389: Line 376:
 
| {{text_anchor|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]
Line 397: Line 384:
 
| {{text_anchor|ITEM_REACTION_PRODUCT}}
 
| {{text_anchor|ITEM_REACTION_PRODUCT}}
 
|
 
|
−
*<item reference>
+
*item reference
−
*<[[item token]]>
+
*[[item token]]
−
*<[[material 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.
 
| 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]
 
[ITEM_REACTION_PRODUCT:BAG_ITEM:PLANT_GROWTH:LEAVES:LOCAL_PLANT_MAT:LEAF]
Line 406: Line 393:
 
| {{text_anchor|REACTION_CLASS}}
 
| {{text_anchor|REACTION_CLASS}}
 
|
 
|
−
*<reaction class name>
+
*reaction reference
 
| Used to classify all items made of the material, so that reactions can use them as generic reagents.
 
| 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:
 
In default raws, the following are used:
Line 413: Line 400:
 
* FLUX - can be used as [[flux]] in pig iron and steel making.
 
* FLUX - can be used as [[flux]] in pig iron and steel making.
 
* GYPSUM - can be processed into [[gypsum plaster]].
 
* GYPSUM - can be processed into [[gypsum plaster]].
−
* CALCIUM_CARBONATE - can be used in production of [[quicklime]].
+
* CALCIUM_CARBONATE - can be used in production of [[quicklime]].{{version|0.42.01}}
  
 
|-
 
|-
 
| {{text_anchor|METAL_ORE}}
 
| {{text_anchor|METAL_ORE}}
 
|
 
|
−
* <inorganic material name e.g. [[lead|LEAD]]>
+
* MATERIAL_NAME
−
* <value>
+
* value
−
| 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).
+
| 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).
  
 
|-
 
|-
 
| {{text_anchor|THREAD_METAL}}
 
| {{text_anchor|THREAD_METAL}}
 
|
 
|
−
* <inorganic material name e.g. [[Raw_adamantine|RAW_ADAMANTINE]]>
+
* MATERIAL_NAME
−
* <value>
+
* 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}}
+
| 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}}
  
 
|-
 
|-
 
| {{text_anchor|HARDENS_WITH_WATER}}
 
| {{text_anchor|HARDENS_WITH_WATER}}
 
|
 
|
−
* <[[material token]]>
+
* [[material token]]
 
| Allows the material to be used to make [[healthcare|casts]].
 
| Allows the material to be used to make [[healthcare|casts]].
  
Line 438: Line 425:
 
| {{text_anchor|SOAP_LEVEL}}
 
| {{text_anchor|SOAP_LEVEL}}
 
|
 
|
−
*<value>
+
*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.
+
| [[Soap]] has [SOAP_LEVEL:2]. Effects unknown. Defaults to 0.
  
 
|-
 
|-
Line 445: Line 432:
 
|
 
|
 
| Begins defining a [[syndrome]] applied by the material. Multiple syndromes can be specified. See [[Syndrome token]].
 
| 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}}
 
−
|
 
−
| Probably used in graphics.
 
−
|
 
−
 
−
|-
 
−
| {{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 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==
+
==Material Usage Tokens==
 
{| {{prettytable}}
 
{| {{prettytable}}
 
|- bgcolor="#C0C0C0"
 
|- bgcolor="#C0C0C0"
Line 546: Line 444:
 
| {{text_anchor|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 ([[elf|Elves]] in vanilla) 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 (which currently does '''not''' include [[elf|Elves]]) will refuse to accept these items in trade.
  
 
|-
 
|-
Line 586: Line 484:
 
| {{text_anchor|POWDER_MISC_CREATURE}}
 
| {{text_anchor|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.
+
| Classifies the material as creature powder, allowing its storage in food stockpiles under "Bone Meal".
  
 
|-
 
|-
Line 667: Line 565:
 
|
 
|
 
| 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.
−
 
−
|-
 
−
| {{text_anchor|HAIR}}
 
−
|
 
−
| Classifies the material as hair, allowing for its use for spinners and restriction from refuse stockpiles by material.
 
  
 
|-
 
|-
Line 712: Line 605:
 
|
 
|
 
| Material will rot if not stockpiled appropriately. Currently only affects [[food]] and [[refuse]], other items made of this material will not rot.
 
| 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}}
 
−
|
 
−
| In most living creatures, it controls many bodily functions and movements by sending signals around the body. See: [[Nervous tissue]]
 
  
 
|-
 
|-
Line 796: Line 684:
 
| {{text_anchor|ITEMS_METAL}}
 
| {{text_anchor|ITEMS_METAL}}
 
|
 
|
−
| The material can be made into minecarts, wheelbarrows, and stepladders at the metalsmith's forge.
+
| Allows the creation of metal furniture at the metalsmith's forge.
  
 
|-
 
|-
Line 816: Line 704:
 
| {{text_anchor|ITEMS_SOFT}}
 
| {{text_anchor|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]].
+
| Random [[finished goods|crafts]] made from this material cannot be made into rings, crowns, scepters or figurines. Given to [[plant fiber]], [[silk]] and [[wool]].
  
 
|-
 
|-
 
| {{text_anchor|ITEMS_HARD}}
 
| {{text_anchor|ITEMS_HARD}}
 
|
 
|
−
| 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.
+
| 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.
  
 
|-
 
|-
Line 856: Line 744:
 
| {{text_anchor|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.
+
| Used internally by green glass, clear glass, and crystal glass.
−
 
 
−
|-
 
−
| {{text_anchor|IS_CERAMIC}}
 
−
|
 
−
| Defines the material as a ceramic. Examples include CERAMIC_EARTHENWARE, CERAMIC_STONEWARE and CERAMIC_PORCELAIN.
 
  
 
|-
 
|-
Line 911: Line 794:
 
| {{text_anchor|ITEMS_QUERN}}
 
| {{text_anchor|ITEMS_QUERN}}
 
|
 
|
−
| Querns and millstones can be made out of this material. Does not appear to work.
+
| Querns and millstones can be made out of this material.{{verify}}
 
|}
 
|}
  
 
==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.
+
 
 +
For more details, see the [[Syndrome token]] page.
  
 
{| {{prettytable}}
 
{| {{prettytable}}
Line 1,000: Line 884:
 
* [[Inorganic material definition token]]
 
* [[Inorganic material definition token]]
 
* [[Syndrome]]
 
* [[Syndrome]]
−
* [[Hardcoded material]]
 
  
 
{{Category|Modding}}
 
{{Category|Modding}}
 
{{Category|Tokens}}
 
{{Category|Tokens}}
 
[[ru:Material definition token]]
 
[[ru:Material definition token]]

Please note that all contributions to Dwarf Fortress Wiki are considered to be released under the GFDL & MIT (see Dwarf Fortress Wiki:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!

To protect the wiki against automated edit spam, we kindly ask you to solve the following CAPTCHA:

Cancel Editing help (opens in new window)

Templates used on this page:

This page is a member of 2 hidden categories:

Retrieved from "https://dwarffortresswiki.org/index.php/Material_definition_token"