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 "v0.34:Material token"

From Dwarf Fortress Wiki
Jump to navigation Jump to search
(COAL doesn't accept NONE as a subtype)
m (better example)
 
(19 intermediate revisions by 4 users not shown)
Line 3: Line 3:
  
 
Material tokens are used to refer to various types of materials in a wide variety of places. They can take the following forms:
 
Material tokens are used to refer to various types of materials in a wide variety of places. They can take the following forms:
−
* '''BUILTIN''' (no subtype) specifies one of the hardcoded materials listed below.
+
 
−
** COAL takes a subtype, as noted below.
+
{| {{prettytable}}
−
* INORGANIC:'''NAME''' specifies a custom inorganic material, such as stone or metal. The material name can be substituted with USE_LAVA_STONE to automatically select the inorganic material having [[Inorganic material definition token|[LAVA]]], which is normally [[obsidian]].
+
|- bgcolor="#ddd"
−
** STONE and METAL are aliases for INORGANIC.
+
! width="20%" | Token
−
* CREATURE_MAT:'''CREATURE_ID''':'''MATERIAL_NAME''' specifies a material associated with a specific creature.
+
! width="30%" | Arguments
−
** LOCAL_CREATURE_MAT:'''MATERIAL_NAME''' can be used within a creature definition to refer to a material belonging to that same creature.
+
! width="50%" | Description
−
* PLANT_MAT:'''PLANT_ID''':'''MATERIAL_NAME''' specifies a material associated with a specific plant.
+
 
−
** LOCAL_PLANT_MAT:'''MATERIAL_NAME''' can be used within a plant definition to refer to a material belonging to that same plant.
+
|-
−
* 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.
+
| 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 automatically select the local [[Inorganic material definition token|lava stone]], which is normally [[obsidian]].
 +
 
 +
|-
 +
| STONE
 +
| MATERIAL_NAME
 +
| Alias for INORGANIC:MATERIAL_NAME, intended for backwards compatibility.
 +
 
 +
|-
 +
| METAL
 +
| MATERIAL_NAME
 +
| Alias for INORGANIC:MATERIAL_NAME, intended for backwards compatibility.
 +
 
 +
|-
 +
| CREATURE_MAT
 +
| CREATURE_ID:MATERIAL_NAME
 +
| Specifies a material associated with a specific creature. Examples: CREATURE_MAT:DWARF:SKIN refers to [[dwarf]] skin.
 +
 
 +
|-
 +
| LOCAL_CREATURE_MAT
 +
| MATERIAL_NAME
 +
| Alias for CREATURE_MAT:'''CREATURE_ID''':MATERIAL_NAME, 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.
 +
 
 +
|-
 +
| 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.
 +
 
 +
|-
 +
| 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
 +
| 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).
 +
 
 +
|-
 +
| 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, which matches charcoal, coke, and generic refined coal.
 +
|}
  
 
Several types of [[Item token|items]] expect a creature ID and caste ID (e.g. [[Ant|ANT:SOLDIER]]) in place of the material token. This currently does not work correctly{{bug|4973}}.
 
Several types of [[Item token|items]] expect a creature ID and caste ID (e.g. [[Ant|ANT:SOLDIER]]) in place of the material token. This currently does not work correctly{{bug|4973}}.
Line 21: Line 69:
 
! Information
 
! Information
 
|-   
 
|-   
−
| 0 || INORGANIC || Placeholder for rock, used in arena mode. When given a subtype, selects a user-defined inorganic material.
+
| 0 || INORGANIC || [[Magma]] when specified with subtype NONE or NO_MATGLOSS, otherwise a user-defined inorganic material.
 
|-   
 
|-   
 
| 1 || AMBER || [[Amber]]
 
| 1 || AMBER || [[Amber]]

Latest revision as of 14:05, 2 May 2020

xTATTEREDx  · +FINE+  · *SUPERIOR*  · ≡EXCEPTIONAL≡  · ☼MASTERWORK☼
v50.14 · v0.47 · v0.34.11 · v0.31 · v0.28 · v0.23
This article is about an older version of DF.
You may be looking for Material definition token.

Material tokens are used to refer to various types of materials in a wide variety of places. They can take the following forms:

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 automatically select the local lava stone, which is normally obsidian.
STONE MATERIAL_NAME Alias for INORGANIC:MATERIAL_NAME, intended for backwards compatibility.
METAL MATERIAL_NAME Alias for INORGANIC:MATERIAL_NAME, intended for backwards compatibility.
CREATURE_MAT CREATURE_ID:MATERIAL_NAME Specifies a material associated with a specific creature. Examples: CREATURE_MAT:DWARF:SKIN refers to dwarf skin.
LOCAL_CREATURE_MAT MATERIAL_NAME Alias for CREATURE_MAT:CREATURE_ID:MATERIAL_NAME, 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.
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.
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 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).
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, which matches charcoal, coke, and generic refined coal.

Several types of items expect a creature ID and caste ID (e.g. ANT:SOLDIER) in place of the material token. This currently does not work correctlyBug:4973.

# Token Information
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 (white, liquid)
18 GRIME Grime
Retrieved from "https://dwarffortresswiki.org/index.php?title=v0.34:Material_token&oldid=252617"