Difference between revisions of "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.

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	<color token>	Allows the material to be used as dye, and defines color of dyed items.
TILE	<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 ('█').
ITEM_SYMBOL	<tile value or character>	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	<foreground color> <background color> <foreground brightness>	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	<foreground color> <background color> <foreground brightness>	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	<foreground color> <background color> <foreground brightness>	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	<foreground color> <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).
STATE_COLOR	<material state> <color token>	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	<material state> <name>	Determines the name of the material at the specified state, as displayed in-game. [STATE_NAME:ALL_SOLID:stone]
STATE_ADJ	<material state> <adjective>	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	<material state> <name> <adjective>	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	<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.
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	<reaction reference> <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. [MATERIAL_REACTION_PRODUCT:TAN_MAT:LOCAL_CREATURE_MAT:LEATHER]
ITEM_REACTION_PRODUCT	<item reference> <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]
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	<inorganic material name e.g. RAW_ADAMANTINE> <value>	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	<material token>	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

Difference between revisions of "Material definition token"

Latest revision as of 21:59, 1 August 2024

Contents

Material properties[edit]

Material states[edit]

Material usage tokens[edit]

Syndrome tokens[edit]

See also[edit]

Navigation menu

Search

@@ Line 1: / Line 1: @@
-{{Quality|Fine|11:11, 18 May 2015 (UTC)}}
+{{Quality|Fine}}
 {{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}}
 |- bgcolor="#C0C0C0"
@@ Line 10: / Line 14: @@
 ! Arguments
 ! 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}}
 |
-* string or NONE
+* <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.'''
@@ Line 20: / Line 30: @@
 | {{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").
 |-
 | {{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.
@@ Line 34: / Line 44: @@
 | {{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.
 |-
 | {{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.
 |-
 | {{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 ('█').
 |-
 | {{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 ('•').
 |-
 | {{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]
@@ Line 63: / Line 76: @@
 | {{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).
@@ Line 71: / Line 84: @@
 | {{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).
@@ Line 79: / Line 92: @@
 | {{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).
@@ Line 86: / Line 99: @@
 | {{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]
@@ Line 95: / Line 107: @@
 | {{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]
 |-
-| {{text_anchor|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.
 |-
-| {{text_anchor|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.
 |-
 | {{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.
@@ Line 123: / Line 136: @@
 | {{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.
@@ Line 129: / Line 142: @@
 | {{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.
@@ Line 135: / Line 148: @@
 | {{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)
@@ Line 141: / Line 154: @@
 | {{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.
@@ Line 147: / Line 160: @@
 | {{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.
@@ Line 153: / Line 166: @@
 | {{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.
@@ Line 159: / Line 172: @@
 | {{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.
@@ Line 165: / Line 178: @@
 | {{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.
@@ Line 171: / Line 184: @@
 | {{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.
@@ Line 177: / Line 190: @@
 | {{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.
 |-
 | {{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.
 |-
 | {{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 (certain generated creatures can do this).  Defaults to 0.
 |-
 | {{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.
@@ Line 201: / Line 214: @@
 | {{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.
@@ Line 207: / Line 220: @@
 | {{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.
@@ Line 213: / Line 226: @@
 | {{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.
@@ Line 219: / Line 232: @@
 | {{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.
@@ Line 225: / Line 238: @@
 | {{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.
@@ Line 231: / Line 244: @@
 | {{text_anchor|MAX_EDGE}}
 |
-*value
+*<value>
-| 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.
+| 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.
 |-
 | {{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.
@@ Line 243: / Line 256: @@
 | {{text_anchor|MULTIPLY_VALUE}}
 |
-*value
+*<value>
 | Multiplies the value of the material. '''Not permitted in material template definitions.'''
@@ Line 249: / Line 262: @@
 | {{text_anchor|SPEC_HEAT}}
 |
-*specific heat capacity
+*<specific heat capacity>
-| 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.
+| 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.
 |-
 | {{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.
@@ Line 261: / Line 274: @@
 | {{text_anchor|COLDDAM_POINT}}
 |
-*temperature
+*<temperature>
 | Temperature below which the material takes damage from cold. Defaults to NONE.
@@ Line 267: / Line 280: @@
 | {{text_anchor|IGNITE_POINT}}
 |
-*temperature
+*<temperature>
 | Temperature at which the material will catch fire. Defaults to NONE.
@@ Line 273: / Line 286: @@
 | {{text_anchor|MELTING_POINT}}
 |
-*temperature
+*<temperature>
 | Temperature at which the material melts. Defaults to NONE.
@@ Line 279: / Line 292: @@
 | {{text_anchor|BOILING_POINT}}
 |
-*temperature
+*<temperature>
 | Temperature at which the material boils. Defaults to NONE.
@@ Line 285: / Line 298: @@
 | {{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.
@@ Line 291: / Line 304: @@
 | {{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.'''
@@ Line 297: / Line 310: @@
 | {{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.'''
@@ Line 303: / Line 316: @@
 | {{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.'''
@@ Line 309: / Line 322: @@
 | {{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.'''
@@ Line 315: / Line 328: @@
 | {{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.'''
@@ Line 321: / Line 334: @@
 | {{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.'''
@@ Line 327: / Line 340: @@
 | {{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.
 |-
 | {{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).
 |-
 | {{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 depend (together with weight of vaporized material) on 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).
 |-
 | {{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.
@@ Line 350: / Line 363: @@
 | {{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.
@@ Line 356: / Line 369: @@
 | {{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.
@@ Line 364: / Line 377: @@
 | {{text_anchor|BLOCK_NAME}}
 |
-*singular
+*<singular>
-*plural
+*<plural>
 | Specifies the name of [[block]]s made from this material.
@@ Line 376: / Line 389: @@
 | {{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.
 [MATERIAL_REACTION_PRODUCT:TAN_MAT:LOCAL_CREATURE_MAT:LEATHER]
@@ Line 384: / Line 397: @@
 | {{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.
 [ITEM_REACTION_PRODUCT:BAG_ITEM:PLANT_GROWTH:LEAVES:LOCAL_PLANT_MAT:LEAF]
@@ Line 393: / Line 406: @@
 | {{text_anchor|REACTION_CLASS}}
 |
-*reaction reference
+*<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:
@@ Line 400: / Line 413: @@
 * 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]].{{version|0.42.01}}
+* CALCIUM_CARBONATE - can be used in production of [[quicklime]].
 |-
 | {{text_anchor|METAL_ORE}}
 |
-* MATERIAL_NAME
+* <inorganic material name e.g. [[lead|LEAD]]>
-* 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 /> 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 /> The specified value determines the probability for this product (see [[Tetrahedrite]] or [[Galena]] for details).
 |-
 | {{text_anchor|THREAD_METAL}}
 |
-* MATERIAL_NAME
+* <inorganic material name e.g. [[Raw_adamantine|RAW_ADAMANTINE]]>
-* 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 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]]
+* <[[material token]]>
 | Allows the material to be used to make [[healthcare|casts]].
@@ Line 425: / Line 438: @@
 | {{text_anchor|SOAP_LEVEL}}
 |
-*value
+*<value>
-| [[Soap]] has [SOAP_LEVEL:2]. Effects unknown. Defaults to 0.
+| 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.
 |-
@@ Line 432: / Line 445: @@
 |
 | 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}}
 |- bgcolor="#C0C0C0"
@@ Line 444: / Line 546: @@
 | {{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 [[elf|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.
 |-
@@ Line 479: / Line 581: @@
 | {{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".
 |-
 | {{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.
 |-
@@ Line 529: / Line 631: @@
 | {{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.
 |-
 | {{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".
 |-
 | {{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".
 |-
@@ Line 565: / Line 667: @@
 |
 | 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 604: / Line 711: @@
 | {{text_anchor|ROTS}}
 |
-| Material will rot if not stockpiled appropriately.
+| 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 684: / Line 796: @@
 | {{text_anchor|ITEMS_METAL}}
 |
-| Allows the creation of metal furniture at the metalsmith's forge.
+| The material can be made into minecarts, wheelbarrows, and stepladders at the metalsmith's forge.
 |-
@@ Line 704: / Line 816: @@
 | {{text_anchor|ITEMS_SOFT}}
 |
-| Random [[finished goods|crafts]] made from this material cannot 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]].
 |-
 | {{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.
 |-
 | {{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.
 |-
@@ Line 744: / Line 856: @@
 | {{text_anchor|IS_GLASS}}
 |
-| Used internally by green glass, clear glass, and crystal 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}}
+|
+| Defines the material as a ceramic. Examples include CERAMIC_EARTHENWARE, CERAMIC_STONEWARE and CERAMIC_PORCELAIN.
 |-
@@ Line 794: / Line 911: @@
 | {{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==
+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}}
@@ Line 881: / Line 997: @@
 |}
-==See Also==
+==See also==
 * [[Inorganic material definition token]]
 * [[Syndrome]]
+* [[Hardcoded material]]
 {{Category|Modding}}
 {{Category|Tokens}}
 [[ru:Material definition token]]