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 v0.31: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.
You are editing a page for an older version of Dwarf Fortress ("Main" is the current version, not "v0.31"). Please make sure you intend to do this. If you are here by mistake, see the current page instead.
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: | ||
− | + | {{av}} | |
+ | |||
+ | ==Material Tokens== | ||
+ | |||
+ | The following tokens can be used in material templates, as well as materials defined in other raw files. | ||
− | |||
− | |||
{| {{prettytable}} | {| {{prettytable}} | ||
− | |- bgcolor="# | + | |- bgcolor="#ddd" |
! Token | ! Token | ||
! Arguments | ! Arguments | ||
Line 11: | Line 13: | ||
|- | |- | ||
− | | | + | | MATERIAL_TEMPLATE |
− | | * | + | | |
− | | | + | *id |
+ | | The name of the material template. Used when defining a template in material template files; the id is used as an argument when calling for material templates elsewhere. | ||
+ | |||
+ | |- | ||
+ | | STATE_COLOR | ||
+ | | | ||
+ | *state | ||
+ | *color | ||
+ | | The state may be SOLID, LIQUID, GAS, POWDER, SOLID_POWDER, ALL_SOLID, or ALL. | ||
+ | Color comes from descriptor_color_standard.txt and is used to describe the color of the material. | ||
+ | [STATE_COLOR:ALL_SOLID:GREY] | ||
|- | |- | ||
− | | | + | | STATE_NAME |
− | | * | + | | |
− | | | + | *state |
+ | *name | ||
+ | | The name of the material as displayed in-game. | ||
+ | [STATE_COLOR:ALL_SOLID:stone] | ||
|- | |- | ||
− | | | + | | STATE_ADJ |
| | | | ||
− | * | + | *state |
− | * | + | *adjective |
− | + | | Like STATE_NAME, but used in different situations. Equipment made from the material uses the adjective. | |
− | | | ||
|- | |- | ||
− | | | + | | STATE_NAME_ADJ |
− | | | + | | |
− | * | + | *state |
− | | | + | *name/adjective |
+ | | Sets both STATE_NAME and STATE_ADJ at the same time. | ||
|- | |- | ||
− | | | + | | DISPLAY_COLOR |
− | | | + | | |
− | | | + | *foreground color |
+ | *background color | ||
+ | *forground brightness | ||
+ | | The on-screen color of the material. Uses a standard 3-digit {{L|Color token}} | ||
+ | [DISPLAY_COLOR:7:0:0] | ||
|- | |- | ||
− | | | + | | MATERIAL_VALUE |
− | | | + | | |
− | | | + | *value |
+ | | Value modifier for the material. | ||
|- | |- | ||
− | | | + | | SPEC_HEAT |
− | | | + | | |
− | | | + | *specific heat capacity |
+ | | See {{L|SPEC HEAT}} | ||
|- | |- | ||
− | | | + | | IGNITE_POINT |
| | | | ||
− | * | + | *temperature |
− | + | | Temperature at which the material will catch fire. May be set to NONE. | |
− | |||
− | | | ||
|- | |- | ||
− | | | + | | MELTING_POINT |
| | | | ||
− | * | + | *temperature |
− | + | | Temperature at which the material melts. May be set to NONE. | |
− | |||
− | | | ||
|- | |- | ||
− | | | + | | BOILING_POINT |
| | | | ||
− | * | + | *temperature |
− | + | | Temperature at which the material boils. May be set to NONE. | |
− | |||
− | | | ||
|- | |- | ||
− | | | + | | HEATDAM_POINT |
| | | | ||
− | * | + | *temperature |
− | + | | Temperature at which the material takes heat damage. May be set to NONE. If the material has an ignite point but no heatdam point it may burn for very long time.{{verify}} | |
− | | | ||
|- | |- | ||
− | | | + | | COLDDAM_POINT |
| | | | ||
− | * | + | *temperature |
− | + | | Temperature at which the material takes cold damage. May be set to NONE. | |
− | | | ||
− | |||
− | |||
|- | |- | ||
− | | | + | | MAT_FIXED_TEMP |
| | | | ||
− | * | + | *temperature |
− | + | | Constant temperature of the material. May be set to NONE. | |
− | | | ||
− | |||
|- | |- | ||
− | | | + | | SOLID_DENSITY |
| | | | ||
− | * | + | *density |
− | + | | Affects the weight of the material. Also affects combat calculations; affects blunt-force damage and ability of edged weapons to pierce tissue layers.{{verify}} | |
− | | | ||
|- | |- | ||
− | | | + | | LIQUID_DENSITY |
+ | | | ||
+ | *density | ||
| | | | ||
− | |||
− | |||
− | |||
|- | |- | ||
− | | | + | | MOLAR_MASS |
| | | | ||
− | * | + | *n |
− | | | + | | Supposedly not used. |
|- | |- | ||
| IMPACT_YIELD | | IMPACT_YIELD | ||
| | | | ||
− | * | + | *n |
− | | | + | | used for blunt-force combat. |
|- | |- | ||
| IMPACT_FRACTURE | | IMPACT_FRACTURE | ||
| | | | ||
− | * | + | *n |
− | | | + | | used for blunt-force combat. |
|- | |- | ||
− | | | + | | IMPACT_ELASTICITY |
| | | | ||
− | * | + | *n |
− | | | + | | used for blunt-force combat. |
|- | |- | ||
| COMPRESSIVE_YIELD | | COMPRESSIVE_YIELD | ||
| | | | ||
− | * | + | *n |
− | | | + | | Supposedly not used. |
|- | |- | ||
| COMPRESSIVE_FRACTURE | | COMPRESSIVE_FRACTURE | ||
| | | | ||
− | * | + | *n |
− | | | + | | Supposedly not used. |
|- | |- | ||
− | | | + | | COMPRESSIVE_ELASTICITY |
| | | | ||
− | * | + | *n |
− | | | + | | Supposedly not used. |
|- | |- | ||
| TENSILE_YIELD | | TENSILE_YIELD | ||
| | | | ||
− | * | + | *n |
− | | | + | | Supposedly not used. |
|- | |- | ||
| TENSILE_FRACTURE | | TENSILE_FRACTURE | ||
| | | | ||
− | * | + | *n |
− | | | + | | Supposedly not used. |
|- | |- | ||
− | | | + | | TENSILE_ELASTICITY |
| | | | ||
− | * | + | *n |
− | | | + | | Supposedly not used. |
|- | |- | ||
| TORSION_YIELD | | TORSION_YIELD | ||
| | | | ||
− | * | + | *n |
− | | | + | | Supposedly not used. |
|- | |- | ||
| TORSION_FRACTURE | | TORSION_FRACTURE | ||
| | | | ||
− | * | + | *n |
− | | | + | | Supposedly not used. |
|- | |- | ||
− | | | + | | TORSION_ELASTICITY |
| | | | ||
− | * | + | *n |
− | | | + | | Supposedly not used. |
|- | |- | ||
| SHEAR_YIELD | | SHEAR_YIELD | ||
| | | | ||
− | * | + | *n |
− | | | + | | Used for cutting calculations. |
|- | |- | ||
| SHEAR_FRACTURE | | SHEAR_FRACTURE | ||
| | | | ||
− | * | + | *n |
− | | | + | | Used for cutting calculations. |
|- | |- | ||
− | | | + | | SHEAR_ELASTICITY |
| | | | ||
− | * | + | *n |
− | | | + | | Used for cutting calculations. |
|- | |- | ||
− | | BENDING_YIELD | + | | BENDING_YIELD |
| | | | ||
− | * | + | *n |
− | | | + | | Supposedly not used. |
|- | |- | ||
| BENDING_FRACTURE | | BENDING_FRACTURE | ||
| | | | ||
− | * | + | *n |
− | | | + | | Supposedly not used. |
|- | |- | ||
− | | | + | | BENDING_ELASTICITY |
| | | | ||
− | * | + | *n |
− | | | + | | Supposedly not used. |
|- | |- | ||
| MAX_EDGE | | MAX_EDGE | ||
| | | | ||
− | * | + | *n |
− | | How sharp the material is. Used in cutting calculations. Applying a value of at least 10000 to a stone will allow weapons | + | | How sharp the material is. Used in cutting calculations. Applying a value of at least 10000 to a stone will allow weapons made from that stone. |
|- | |- | ||
− | | | + | | ABSORPTION |
| | | | ||
− | * | + | *n |
− | | | + | | Supposedly not used. |
|- | |- | ||
− | | | + | | ITEMS_HARD |
| | | | ||
− | |||
− | |||
|- | |- | ||
− | | | + | | ITEMS_QUERN |
| | | | ||
− | |||
− | |||
|- | |- | ||
− | | | + | | ITEMS_WEAPON |
| | | | ||
− | |||
− | |||
|- | |- | ||
− | | | + | | ITEMS_WEAPON_RANGED |
| | | | ||
− | |||
− | |||
|- | |- | ||
− | | | + | | ITEMS_AMMO |
| | | | ||
− | |||
− | |||
|- | |- | ||
− | | | + | | ITEMS_DIGGER |
| | | | ||
− | |||
− | |||
|- | |- | ||
− | | | + | | ITEMS_ANVIL |
| | | | ||
− | |||
− | |||
|- | |- | ||
− | | | + | | ITEMS_ARMOR |
| | | | ||
− | |||
− | |||
|- | |- | ||
− | | | + | | ITEMS_SIEGE_ENGINE |
| | | | ||
− | |||
− | |||
|- | |- | ||
− | | | + | | ITEMS_BARRED |
| | | | ||
− | |||
− | |||
|- | |- | ||
− | | | + | | ITEMS_SCALED |
| | | | ||
− | |||
− | |||
|- | |- | ||
− | | | + | | ITEMS_LEATHER |
| | | | ||
− | |||
− | |||
|- | |- | ||
− | | | + | | ITEMS_SOFT |
| | | | ||
− | |||
− | |||
|- | |- | ||
− | | | + | | ITEMS_DELICATE |
| | | | ||
− | |||
− | |||
|- | |- | ||
− | | | + | | IS_STONE |
| | | | ||
− | |||
− | |||
|- | |- | ||
− | | | + | | IS_METAL |
| | | | ||
− | |||
− | |||
|- | |- | ||
− | | | + | | IS_GLASS |
| | | | ||
− | |||
− | |||
|- | |- | ||
− | | | + | | IS_GEM |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
| | | | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| IMPLIES_ANIMAL_KILL | | IMPLIES_ANIMAL_KILL | ||
| | | | ||
− | | | + | | Makes the elves angry if you try to trade something made from this material |
|- | |- | ||
| ALCOHOL_PLANT | | ALCOHOL_PLANT | ||
| | | | ||
− | |||
|- | |- | ||
| ALCOHOL_CREATURE | | ALCOHOL_CREATURE | ||
| | | | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| CHEESE_PLANT | | CHEESE_PLANT | ||
| | | | ||
− | |||
|- | |- | ||
| CHEESE_CREATURE | | CHEESE_CREATURE | ||
| | | | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| POWDER_MISC_PLANT | | POWDER_MISC_PLANT | ||
| | | | ||
− | |||
|- | |- | ||
| POWDER_MISC_CREATURE | | POWDER_MISC_CREATURE | ||
| | | | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
− | | | + | | STOCKPILE_GLOB |
| | | | ||
− | |||
|- | |- | ||
| LIQUID_MISC_PLANT | | LIQUID_MISC_PLANT | ||
| | | | ||
− | |||
|- | |- | ||
| LIQUID_MISC_CREATURE | | LIQUID_MISC_CREATURE | ||
| | | | ||
− | |||
|- | |- | ||
| LIQUID_MISC_OTHER | | LIQUID_MISC_OTHER | ||
| | | | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| STRUCTURAL_PLANT_MAT | | STRUCTURAL_PLANT_MAT | ||
| | | | ||
− | |||
|- | |- | ||
| SEED_MAT | | SEED_MAT | ||
| | | | ||
− | |||
|- | |- | ||
| LEAF_MAT | | LEAF_MAT | ||
| | | | ||
− | |||
|- | |- | ||
| BONE | | BONE | ||
| | | | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| THREAD_PLANT | | THREAD_PLANT | ||
| | | | ||
− | |||
|- | |- | ||
| TOOTH | | TOOTH | ||
| | | | ||
− | |||
|- | |- | ||
| HORN | | HORN | ||
| | | | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| SHELL | | SHELL | ||
| | | | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| SILK | | SILK | ||
| | | | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| GENERATES_MIASMA | | GENERATES_MIASMA | ||
| | | | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| ROTS | | ROTS | ||
| | | | ||
− | |||
|- | |- | ||
| BLOOD_MAP_DESCRIPTOR | | BLOOD_MAP_DESCRIPTOR | ||
| | | | ||
− | |||
|- | |- | ||
| ICHOR_MAP_DESCRIPTOR | | ICHOR_MAP_DESCRIPTOR | ||
| | | | ||
− | |||
|- | |- | ||
| GOO_MAP_DESCRIPTOR | | GOO_MAP_DESCRIPTOR | ||
| | | | ||
− | |||
|- | |- | ||
| SLIME_MAP_DESCRIPTOR | | SLIME_MAP_DESCRIPTOR | ||
| | | | ||
− | |||
|- | |- | ||
| PUS_MAP_DESCRIPTOR | | PUS_MAP_DESCRIPTOR | ||
| | | | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
Line 610: | Line 441: | ||
|- | |- | ||
− | | | + | | CRYSTAL_GLASSABLE |
| | | | ||
− | | | + | | Can be used in the production of crystal glass |
|- | |- | ||
− | | | + | | STONE_NAME |
| | | | ||
− | | | + | | Name of stones mined out if material is a stone. |
|- | |- | ||
− | | | + | | LAVA |
| | | | ||
− | | | + | | Causes the material to seal magma pipes, be produced by the magma + water reaction and be used in the construction of Dark Fortresses |
|- | |- | ||
− | | | + | | OVERWRITE_SOLID |
| | | | ||
− | |||
|- | |- | ||
− | | | + | | TEMP_DIET_INFO |
| | | | ||
− | |||
|- | |- | ||
− | | | + | | SLIME |
| | | | ||
− | |||
|- | |- | ||
− | | | + | | ICHOR |
| | | | ||
− | |||
|- | |- | ||
− | | | + | | GOO |
| | | | ||
− | |||
|- | |- | ||
− | | | + | | FILTH |
| | | | ||
− | |||
|- | |- | ||
− | | | + | | POWDER_DYE |
− | | | + | | |
− | |||
|- | |- | ||
− | | | + | | ITEM_SYMBOL |
| | | | ||
− | |||
|- | |- | ||
− | | | + | | IF_EXISTS_SET_HEATDAM_POINT |
+ | | | ||
+ | *temperature | ||
| | | | ||
− | |||
|- | |- | ||
− | | | + | | IF_EXISTS_SET_COLDDAM_POINT |
+ | | | ||
+ | *temperature | ||
| | | | ||
− | |||
|- | |- | ||
− | | | + | | IF_EXISTS_SET_IGNITE_POINT |
+ | | | ||
+ | *temperature | ||
| | | | ||
− | |||
|- | |- | ||
− | | | + | | IF_EXISTS_SET_MELTING_POINT |
+ | | | ||
+ | *temperature | ||
| | | | ||
− | |||
|- | |- | ||
− | | | + | | IF_EXISTS_SET_BOILING_POINT |
+ | | | ||
+ | *temperature | ||
| | | | ||
− | |||
|- | |- | ||
− | | | + | | IF_EXISTS_SET_MAT_FIXED_TEMP |
− | | | + | | |
− | | | + | *temperature |
+ | | | ||
|- | |- | ||
− | | | + | | EXTRACT_STORAGE |
| | | | ||
− | |||
|- | |- | ||
− | | | + | | BUTCHER_SPECIAL |
| | | | ||
− | | [[ | + | *item type |
+ | *NONE | ||
+ | | All instances in the material templates have NONE as the second argument. Possibly subtype? | ||
+ | [BUTCHER_SPECIAL:MEAT:NONE] | ||
+ | [BUTCHER_SPECIAL:GLOB:NONE] | ||
|- | |- | ||
− | | | + | | MEAT_NAME |
| | | | ||
− | | | + | *prefix |
+ | *name | ||
+ | *adjective? | ||
+ | | When the creature is butchered, its organs will be named via this token. | ||
|- | |- | ||
− | | | + | | MATERIAL_REACTION_PRODUCT |
| | | | ||
− | | [ | + | *reaction reference |
+ | *LOCAL_CREATURE_MAT | ||
+ | *material | ||
+ | | Used with reaction raws to preserve material source from reagent to product. First argument comes from HAS_MATERIAL_REACTION_PRODUCT in reaction raws. Second argument is always LOCAL_CREATURE_MAT in templates but could be others. | ||
+ | [MATERIAL_REACTION_PRODUCT:TAN_MAT:LOCAL_CREATURE_MAT:LEATHER] | ||
|- | |- | ||
− | | | + | | HARDENS_WITH_WATER |
| | | | ||
− | |||
|- | |- | ||
− | | | + | | SOAP_LEVEL |
+ | | | ||
+ | *n | ||
| | | | ||
− | |||
|- | |- | ||
− | | | + | | MULTIPLY_VALUE |
| | | | ||
− | | | + | *value |
+ | | Multiplies the value of the selected material. Seen in local creature materials. | ||
|- | |- | ||
− | | | + | | SYNDROME |
| | | | ||
− | | | + | | Begins defining a {{L|Syndrome}}. Supposedly does not work with templates.{{verify}} |
− | |||
− | |||
− | |||
− | |||
− | { | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|} | |} | ||
− | |||
− | |||
− | |||
− | + | [[Category:Modding]] | |
− |