Editing v0.34:Material token

{{quality|Exceptional|18:11, 28 April 2011 (UTC)}}{{av}}
:''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:

{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="30%" | Arguments
! width="50%" | Description

|-
| INORGANIC
| NAME
| specifies a raw-defined inorganic material, such as stone or metal. Example: INORGANIC:IRON refers to iron.

|-
| CREATURE_MAT
| CREATURE_ID:MATERIAL_NAME
| specifies a material associated with a specific creature. Example: CREATURE_MAT:DWARF:SKIN refers to dwarf skin; CREATURE_MAT:COLOSSUS_BRONZE:BRONZE refers to [[bronze colossus]] bronze. '''LOCAL_CREATURE_MAT''':'''MATERIAL_NAME''' can be used within a creature definition to refer to a material belonging to that same creature.

|-
| PLANT_MAT
| PLANT_ID:MATERIAL_NAME
| specifies a material associated with a specific plant. Example: PLANT_MAT:MUSHROOM_HELMET_PLUMP:STRUCTURAL specifies a plump helmet's main material (I.E what grows out of the ground).  '''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.
|-
| COAL
| CHARCOAL, COKE or NO_MATGLOSS
| specifies a material that can be used as fuel--charcoal, coke, and "refined coal", respectively.
|-
| MATERIAL
| NONE
| specifies one of the hardcoded materials listed below (use material name instead of MATERIAL)
|}

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}}.

{| {{prettytable}} class="sortable"
|- bgcolor="#ddd"
! #
! 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 [[bucket]]s 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]]
|}

{{Category|Modding}}
{{Category|Tokens}}
@@ Line 12: / Line 12: @@
 |-
 | INORGANIC
-| MATERIAL_NAME
+| 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]].
+| specifies a raw-defined inorganic material, such as stone or metal. Example: INORGANIC:IRON refers to iron.
-|-
-| 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.
+| specifies a material associated with a specific creature. Example: CREATURE_MAT:DWARF:SKIN refers to dwarf skin; CREATURE_MAT:COLOSSUS_BRONZE:BRONZE refers to [[bronze colossus]] bronze. '''LOCAL_CREATURE_MAT''':'''MATERIAL_NAME''' can be used within a creature definition to refer to a material belonging to that same creature.
-|-
-| 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.
+| specifies a material associated with a specific plant. Example: PLANT_MAT:MUSHROOM_HELMET_PLUMP:STRUCTURAL specifies a plump helmet's main material (I.E what grows out of the ground).  '''LOCAL_PLANT_MAT''':'''MATERIAL_NAME''' can be used within a plant definition to refer to a material belonging to that same plant.
-|-
-| 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.
+| 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.
+|-
+| COAL
+| CHARCOAL, COKE or NO_MATGLOSS
+| specifies a material that can be used as fuel--charcoal, coke, and "refined coal", respectively.
 |-
-| MATERIAL_NAME
+| MATERIAL
 | 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).
+| specifies one of the hardcoded materials listed below (use material name instead of MATERIAL)
-|-
-| 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.
 |}