v50 Steam/Premium information for editors
- v50 information can now be added to pages in the main namespace. v0.47 information can still be found in the DF2014 namespace. See here for more details on the new versioning policy.
- Use this page to report any issues related to the migration.
This notice may be cached—the current version can be found here.
Difference between revisions of "Material token"
Jump to navigation
Jump to search
m (→Hardcoded Materials: the token for unknown material is NONE) |
m (→Tokens: looking at the material parser logic right now, and USE_LAVA_STONE picks randomly, not looking at local geology; also, builtin) |
||
| Line 17: | Line 17: | ||
| {{text anchor|INORGANIC}} | | {{text anchor|INORGANIC}} | ||
| MATERIAL_NAME | | MATERIAL_NAME | ||
| − | | Specifies a standalone inorganic material defined in the raws, generally a stone or metal. For example, INORGANIC:IRON refers to [[iron]], and INORGANIC:CERAMIC_PORCELAIN refers to [[porcelain]]. The material name can be substituted with USE_LAVA_STONE to | + | | Specifies a standalone inorganic material defined in the raws, generally a stone or metal. For example, INORGANIC:IRON refers to [[iron]], and INORGANIC:CERAMIC_PORCELAIN refers to [[porcelain]]. The material name can be substituted with USE_LAVA_STONE to randomly select a suitable [[Inorganic material definition token|lava stone]], which is normally [[obsidian]]. Specify NONE or NO_MATGLOSS to instead select [[magma]]. |
|- | |- | ||
| Line 32: | Line 32: | ||
| {{text anchor|COAL}} | | {{text anchor|COAL}} | ||
| CHARCOAL, COKE, or NO_MATGLOSS | | CHARCOAL, COKE, or NO_MATGLOSS | ||
| − | | Specifies a material that can be used as fuel - charcoal or coke. Specifying NO_MATGLOSS ('''not''' NONE) will make it accept "refined coal" in general, | + | | Specifies a material that can be used as fuel - charcoal or coke. Specifying NO_MATGLOSS ('''not''' NONE) will make it accept "refined coal" in general, matching both charcoal and coke. |
|- | |- | ||
| Line 47: | Line 47: | ||
| {{text anchor|PLANT_MAT}} | | {{text anchor|PLANT_MAT}} | ||
| PLANT_ID:MATERIAL_NAME | | PLANT_ID:MATERIAL_NAME | ||
| − | | Specifies a material associated with a specific plant. Example: PLANT_MAT:BUSH_QUARRY:LEAF refers to [[quarry bush]] leaves. | + | | Specifies a material associated with a specific plant. Example: PLANT_MAT:BUSH_QUARRY:LEAF refers to [[quarry bush]] leaves. Unlike CREATURE_MAT, "INDEX###" is '''not''' permitted. |
|- | |- | ||
| {{text anchor|LOCAL_PLANT_MAT}} | | {{text anchor|LOCAL_PLANT_MAT}} | ||
| MATERIAL_NAME | | MATERIAL_NAME | ||
| − | | Alias for PLANT_MAT:'''PLANT_ID''':MATERIAL_NAME, where PLANT_ID is the plant currently being defined; as such, it can only be used in plant definitions. | + | | Alias for PLANT_MAT:'''PLANT_ID''':MATERIAL_NAME, where PLANT_ID is the plant currently being defined; as such, it can only be used in plant definitions. Unlike LOCAL_CREATURE_MAT, "INDEX###" is '''not''' permitted. |
|- | |- | ||
| Line 61: | Line 61: | ||
|- | |- | ||
| {{text anchor|MATERIAL_NAME}} | | {{text anchor|MATERIAL_NAME}} | ||
| − | | NONE | + | | NONE (ignored) |
| Specifies one of the hardcoded materials listed below. Note that this goes in the token itself, not arguments (i.e GLASS_GREEN:NONE, not MATERIAL_NAME:GLASS_GREEN). | | Specifies one of the hardcoded materials listed below. Note that this goes in the token itself, not arguments (i.e GLASS_GREEN:NONE, not MATERIAL_NAME:GLASS_GREEN). | ||
|} | |} | ||
Latest revision as of 14:23, 16 February 2026
v53.10 · v0.47.05 This article is about the current version of DF.Note that some content may still need to be updated. |
- For the tokens that define an individual material's properties, see Material definition token.
| Modding |
|---|
| Tokens |
| Audio · Biome · Graphics · Tile page · Interaction · Mod info · Plant · Speech · Sphere · Syndrome · World |
| Body tokens |
| Body · Body detail plan · Bodygloss · Tissue |
| Creature tokens |
| Creature · Creature mannerism · Personality facet · Creature variation · Procedural graphics layer |
| Descriptor tokens |
| Descriptor color · Color · Descriptor pattern · Descriptor shape |
| Entity tokens |
| Entity · Ethic · Language · Value · Position |
| Job tokens |
| Building · Labor · Reaction · Skill · Unit type |
| Item tokens |
| Item type · Item definition · Ammo · Armor · Instrument · Tool · Trap component · Weapon |
| Material tokens |
| Material type · Material definition · Inorganic material definition |
|
Lua |
| Scripting · Examples · Functions |
Material tokens are used to refer to various types of materials in a wide variety of places. They can take the following forms below.
Tokens[edit]
| Token | Arguments | Description |
|---|---|---|
| INORGANIC | MATERIAL_NAME | Specifies a standalone inorganic material defined in the raws, generally a stone or metal. For example, INORGANIC:IRON refers to iron, and INORGANIC:CERAMIC_PORCELAIN refers to porcelain. The material name can be substituted with USE_LAVA_STONE to randomly select a suitable lava stone, which is normally obsidian. Specify NONE or NO_MATGLOSS to instead select magma. |
| STONE | MATERIAL_NAME | Alias for INORGANIC:MATERIAL_NAME, intended for backwards compatibility. |
| METAL | MATERIAL_NAME | Alias for INORGANIC:MATERIAL_NAME, intended for backwards compatibility. |
| COAL | CHARCOAL, COKE, or NO_MATGLOSS | Specifies a material that can be used as fuel - charcoal or coke. Specifying NO_MATGLOSS (not NONE) will make it accept "refined coal" in general, matching both charcoal and coke. |
| CREATURE_MAT | CREATURE_ID:MATERIAL_NAME or CREATURE_ID:INDEX### | Specifies a material associated with a specific creature. Examples: CREATURE_MAT:DWARF:SKIN refers to dwarf skin. Can also specify "INDEX" followed by a 3-digit number to select a material by index instead of by name, where 000 is the first material in that creature. |
| LOCAL_CREATURE_MAT | MATERIAL_NAME or INDEX### | Alias for CREATURE_MAT:CREATURE_ID:MATERIAL_NAME (or CREATURE_MAT:CREATURE_ID:INDEX###), where CREATURE_ID is the creature currently being defined; as such, it can only be used in creature definitions. |
| PLANT_MAT | PLANT_ID:MATERIAL_NAME | Specifies a material associated with a specific plant. Example: PLANT_MAT:BUSH_QUARRY:LEAF refers to quarry bush leaves. Unlike CREATURE_MAT, "INDEX###" is not permitted. |
| LOCAL_PLANT_MAT | MATERIAL_NAME | Alias for PLANT_MAT:PLANT_ID:MATERIAL_NAME, where PLANT_ID is the plant currently being defined; as such, it can only be used in plant definitions. Unlike LOCAL_CREATURE_MAT, "INDEX###" is not permitted. |
| GET_MATERIAL_FROM_REAGENT | REAGENT_ID:REACTION_PRODUCT_ID | Specifies a material related to a reagent's material within a reaction. REAGENT_ID must match a [REAGENT], and REACTION_PRODUCT_ID must either match a [MATERIAL_REACTION_PRODUCT] belonging to the reagent's material or be equal to "NONE" to use the reagent's material itself. |
| MATERIAL_NAME | NONE (ignored) | Specifies one of the hardcoded materials listed below. Note that this goes in the token itself, not arguments (i.e GLASS_GREEN:NONE, not MATERIAL_NAME:GLASS_GREEN). |
Several types of items expect a creature ID and caste ID (e.g. ANT:SOLDIER) in place of the material token.
Hardcoded Materials[edit]
It should be noted when using the table below, that you do not place (MATERIAL_NAME:(Your material here)). For example, green glass will be (GLASS_GREEN:NONE).
| # | Token | Information |
|---|---|---|
| -1 | NONE | Unknown material (light gray, solid), acts as a placeholder for any material. |
| 0 | INORGANIC | Magma when specified with subtype NONE or NO_MATGLOSS, otherwise a user-defined inorganic material. |
| 1 | AMBER | Amber |
| 2 | CORAL | Coral |
| 3 | GLASS_GREEN | Green glass |
| 4 | GLASS_CLEAR | Clear glass |
| 5 | GLASS_CRYSTAL | Crystal glass |
| 6 | WATER | Water, when placed in buckets or when mining out ice. |
| 7 | COAL | Coal - subtype is either COKE or CHARCOAL (or NO_MATGLOSS to match either). |
| 8 | POTASH | Potash |
| 9 | ASH | Ash |
| 10 | PEARLASH | Pearlash |
| 11 | LYE | Lye |
| 12 | MUD | Mud |
| 13 | VOMIT | Vomit |
| 14 | SALT | Salt |
| 15 | FILTH_B | Filth (brown, solid) |
| 16 | FILTH_Y | Filth (yellow, liquid) |
| 17 | UNKNOWN_SUBSTANCE | Unknown substance (light gray, liquid) |
| 18 | GRIME | Grime |