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 "Inorganic material definition token"

From Dwarf Fortress Wiki
Jump to navigation Jump to search
(Modding experiments produced spires of generic rock, veins made of iron's metal form, Hell made of ice, etc.)
 
(19 intermediate revisions by 13 users not shown)
Line 1: Line 1:
−
{{Migrated_article}}
+
{{Quality|Superior}}
−
{{quality|unrated}}{{av}}
+
{{av}}
 +
{{Modding}}
  
−
The following tokens can be used in inorganic material definitions, generally those for stones, gems, and metals. They cannot be used with materials attached to plants or creatures.
+
The following tokens can be used in inorganic material definitions, generally for stones, gems, and metals, but not with materials attached to plants or creatures.
 +
{{clear}}
  
 
{| {{prettytable}}
 
{| {{prettytable}}
 
|- style='background-color:#ddd'
 
|- style='background-color:#ddd'
 
! Token
 
! Token
 +
! Arguments
 
! Description
 
! Description
 
|-
 
|-
−
|[WAFERS]||Used on metals, causes the metal to be made into wafers instead of [[bar]]s.
+
| {{text anchor|WAFERS}}|| ||Used on metals, causes the metal to be made into wafers instead of [[bar]]s.
 
|-
 
|-
−
|[DEEP_SPECIAL]||Causes the stone to form hollow tubes leading to Hell. Used for [[raw adamantine]]. When mined, stone has a 100% yield. If no material with this token exists, hollow veins will instead be made of the first available inorganic, usually [[iron]].
+
| {{text anchor|DEEP_SPECIAL}}|| || Causes the stone to form hollow tubes leading to the [[Underworld]]. Used for [[raw adamantine]]. When mined, stone has a 100% yield. If no material with this token exists, hollow veins will instead be made of the first available inorganic, usually [[iron]]. Implies {{token|SPECIAL|Inorganic}}.
 
|-
 
|-
−
|[METAL_ORE:metal:chance]||Allows the ore to be [[smelter|smelted]] into metal. Multiple tokens allow multiple types of metal to be smelted from a single ore.
+
| {{text anchor|METAL_ORE}}|| metal:chance || Allows the ore to be [[smelter|smelted]] into metal in the smelter. Each token with a non-zero chance causes the game to roll d100 four times, each time creating one bar of the type requested on success.
 
|-
 
|-
−
|[THREAD_METAL:metal:chance]||Allows strands to be extracted from the metal at a [[craftsdwarf's workshop]].
+
| {{text anchor|THREAD_METAL}}|| metal:chance ||Allows strands to be extracted from the metal at a [[craftsdwarf's workshop]].
 
|-
 
|-
−
|[DEEP_SURFACE]||Causes the stone to line the landscape of [[Hell]]. Used for [[slade]]. When mined (if it's mineable), stone has a 100% yield. If no material with this token exists, other materials will be used in place of slade. Underworld spires will still be referred to as a "spire of slade" in the world's history.
+
| {{text anchor|DEEP_SURFACE}}|| ||Causes the stone to line the landscape of the [[Underworld]]. Used for [[slade]]. When mined (if it's mineable), stone has a 100% yield. If no material with this token exists, other materials will be used in place of slade. Underworld spires will still be referred to as a "spire of slade" in the world's history.
 
|-
 
|-
−
|[AQUIFER]||Allows the stone to support an [[aquifer]].
+
| {{text anchor|AQUIFER}}|| ||Allows the stone to support an [[aquifer]].
 
|-
 
|-
−
|[METAMORPHIC]||Causes the material to form [[metamorphic layer]]s.
+
| {{text anchor|METAMORPHIC}}|| ||Causes the material to form [[metamorphic layer]]s.
 
|-
 
|-
−
|[SEDIMENTARY]||Causes the material to form [[sedimentary layer]]s.
+
| {{text anchor|SEDIMENTARY}}|| ||Causes the material to form [[sedimentary layer]]s.
 
|-
 
|-
−
|[SOIL]||Causes the material to form [[soil]] layers, allowing it to appear in (almost) any biome. Mining is faster and produces no stones.
+
| {{text anchor|SOIL}}|| ||Causes the material to form [[soil]] layers, allowing it to appear in (almost) any biome. Mining is faster and produces no stones.
 
|-
 
|-
−
|[SOIL_OCEAN]||Causes the material to form [[soil|pelagic sediment]] layers beneath deep oceans. Mining is faster and produces no stones.
+
| {{text anchor|SOIL_OCEAN}}|| ||Causes the material to form [[soil|pelagic sediment]] layers beneath deep oceans. Mining is faster and produces no stones.
 
|-
 
|-
−
|[SOIL_SAND]||Causes the material to form [[sand]] layers, allowing it to appear in [[sand desert]]s and shallow [[ocean]]s. Mining is faster and produces no stones. Sand layers can also be used used for making [[glass]]. Can be combined with [SOIL].
+
| {{text anchor|SOIL_SAND}}|| ||Causes the material to form [[sand]] layers, allowing it to appear in [[sand desert]]s and shallow [[ocean]]s. Mining is faster and produces no stones. Sand layers can also be used for making [[glass]]. Can be combined with [SOIL].
 
|-
 
|-
−
|[SEDIMENTARY_OCEAN_SHALLOW]||Permits an already [SEDIMENTARY] stone layer to appear underneath shallow ocean regions.
+
| {{text anchor|SEDIMENTARY_OCEAN_SHALLOW}}|| ||Permits an already [SEDIMENTARY] stone layer to appear underneath shallow ocean regions.
 
|-
 
|-
−
|[SEDIMENTARY_OCEAN_DEEP]||Permits an already [SEDIMENTARY] stone layer to appear underneath deep ocean regions.
+
| {{text anchor|SEDIMENTARY_OCEAN_DEEP}}|| ||Permits an already [SEDIMENTARY] stone layer to appear underneath deep ocean regions.
 
|-
 
|-
−
|[IGNEOUS_INTRUSIVE]||Causes the material to form [[igneous intrusive layer]]s.
+
| {{text anchor|IGNEOUS_INTRUSIVE}}|| || Causes the material to form [[igneous intrusive layer]]s.
 
|-
 
|-
−
|[IGNEOUS_EXTRUSIVE]||Causes the material to form [[igneous extrusive layer]]s.
+
| {{text anchor|IGNEOUS_EXTRUSIVE}}|| || Causes the material to form [[igneous extrusive layer]]s.
 
|-
 
|-
−
|[ENVIRONMENT:class:type:freq]||Specifies what types of layers will contain this mineral. See below.
+
| {{text anchor|ENVIRONMENT}}|| class:type:freq ||Specifies what types of layers will contain this mineral. Multiple instances of the same token segment will cause the rock type to occur more frequently, but won't increase its abundance in the specified environment. See below.
 
|-
 
|-
−
|[ENVIRONMENT_SPEC:stone:type:freq]||Specifies which specific minerals will contain this mineral. See below.
+
| {{text anchor|ENVIRONMENT_SPEC}}|| stone:type:freq ||Specifies which specific minerals will contain this mineral. See below.
 
|-
 
|-
−
|[LAVA]||Specifies that the stone is created when combining [[water]] and [[magma]], also causing it to line the edges of [[magma]] pools and volcanoes. If multiple minerals are marked as lava stones, a different one will be used in each biome or geological region.
+
| {{text anchor|LAVA}}|| ||Specifies that the stone is created when combining [[water]] and [[magma]], also causing it to line the edges of [[magma]] pools and volcanoes. If multiple minerals are marked as lava stones, a different one will be used in each biome or geological region.
 
|-
 
|-
−
|[SPECIAL]||Prevents the material from showing up in certain places. Explicitly set by all [[evil weather]] materials and implied by [DEEP_SURFACE] and [DEEP_SPECIAL].
+
| {{text anchor|SPECIAL}}|| ||Prevents the material from showing up in certain places. AI-controlled entities won't use the material to make items and don't bring it in caravans, though the player can use it as normal. Also, inorganic generated creatures (forgotten beasts, titans, demons) will never be composed of this material. Explicitly set by all [[evil weather]] materials and implied by {{token|DEEP_SURFACE|Inorganic}} and {{token|DEEP_SPECIAL|Inorganic}}.
 
|-
 
|-
−
|[GENERATED]||Indicates that this is a generated material. Cannot be specified in user-defined raws.
+
| {{text anchor|GENERATED}}|| ||Indicates that this is a generated material. Cannot be specified in user-defined raws.
 
|-
 
|-
−
|[DIVINE]||Found on random-generated metals and cloth.  Marks this material as usable by [[Deity]]-created generated entities.
+
| {{text anchor|DIVINE}}|| ||Found on random-generated metals and cloth.  Marks this material as usable by [[Deity]]-created generated entities.
 
|-
 
|-
−
|[SPHERE:sphere]||Found on divine materials.  Presumably links the material to a god of the same sphere.
+
| {{text anchor|SPHERE}}|| [[sphere]] ||Found on divine materials.  Presumably links the material to a god of the same sphere.
 
|}
 
|}
  
−
==ENVIROMENT and ENVIRONMENT_SPEC==
+
==ENVIRONMENT and ENVIRONMENT_SPEC==
  
 
Format:
 
Format:
Line 65: Line 68:
 
! Description
 
! Description
 
|-
 
|-
−
| ALL_STONE||Will appear in every stone.
+
| {{text anchor|ALL_STONE}}||Will appear in every stone.
 
|-
 
|-
−
| IGNEOUS_ALL, IGNEOUS_INTRUSIVE, IGNEOUS_EXTRUSIVE||Will appear in igneous layers, either [[igneous intrusive]], [[igneous extrusive]], or both.
+
| {{text anchor|IGNEOUS_ALL}}, {{text anchor|IGNEOUS_INTRUSIVE}}, {{text anchor|IGNEOUS_EXTRUSIVE}}||Will appear in igneous layers, either [[igneous intrusive]], [[igneous extrusive]], or both.
 
|-
 
|-
−
| SOIL, SOIL_OCEAN, SOIL_SAND||Will appear in soil. SOIL_OCEAN is oceans specifically and SOIL_SAND is sand specifically.
+
| {{text anchor|SOIL}}, {{text anchor|SOIL_OCEAN}}, {{text anchor|SOIL_SAND}}||Will appear in soil. SOIL_OCEAN is oceans specifically and SOIL_SAND is sand specifically.
 
|-
 
|-
−
| METAMORPHIC||Will appear in [[metamorphic]] layers.
+
| {{text anchor|METAMORPHIC}}||Will appear in [[metamorphic]] layers.
 
|-
 
|-
−
| SEDIMENTARY||Will appear in [[sedimentary]] layers.
+
| {{text anchor|SEDIMENTARY}}||Will appear in [[sedimentary]] layers.
 
|-
 
|-
−
| ALLUVIAL||Will appear in [[alluvial]] layers.  
+
| {{text anchor|ALLUVIAL}}||Will appear in [[alluvial]] layers.  
 
|}
 
|}
  
Line 84: Line 87:
 
! Description
 
! Description
 
|-
 
|-
−
| CLUSTER||Large ovoids that occupy their entire 48x48 embark tile. [[Microcline]] is an example. When mined, stone has a 25% yield (as with layer stones).
+
| {{text anchor|CLUSTER}}||Large ovoids that occupy their entire 48x48 embark tile. [[Microcline]] is an example. When mined, stone has a 25% yield (as with layer stones).
 
|-
 
|-
−
| CLUSTER_SMALL||Blobs of 3-9 tiles. Will always be successfully mined. [[Red pyrope]]s are an example. When mined, stone has a 100% yield.
+
| {{text anchor|CLUSTER_SMALL}}||Blobs of 3-9 tiles. Will always be successfully mined. [[Red pyrope]]s are an example. When mined, stone has a 100% yield.
 
|-
 
|-
−
| CLUSTER_ONE||Single tiles. Will always be successfully mined. [[Clear diamond]]s are an example. When mined, stone has a 100% yield.
+
| {{text anchor|CLUSTER_ONE}}||Single tiles. Will always be successfully mined. [[Clear diamond]]s are an example. When mined, stone has a 100% yield.
 
|-
 
|-
−
| VEIN||Large streaks of stone. [[Native gold]] is an example. When mined, stone has a 33% yield instead of the usual 25%.
+
| {{text anchor|VEIN}}||Large streaks of stone. [[Native gold]] is an example. When mined, stone has a 33% yield instead of the usual 25%.
 
|}
 
|}
  
Line 98: Line 101:
  
  
−
ENVIRONMENT_SPEC follows much the same format, but takes a specific stone material ID where ENVIRONMENT would take a class token. What you can use will depend on what inorganic raws are around.
+
ENVIRONMENT_SPEC follows much the same format, but takes a specific stone material ID where ENVIRONMENT would take a class token. What you can use will depend on what inorganic raws are around.
  
−
==See Also==
+
==See also==
 
* [[Material definition token]]
 
* [[Material definition token]]
  
 
{{Category|Modding}}
 
{{Category|Modding}}
 
{{Category|Tokens}}
 
{{Category|Tokens}}
 +
[[ru:Inorganic material definition token]]

Latest revision as of 16:18, 2 April 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.

Modding
Tokens
Audio · Biome · Graphics · Interaction · Mod info · Plant · Speech · Sphere · Syndrome · World
Body tokens
Body · Body detail plan · Bodygloss · Tissue
Creature tokens
Creature · Creature mannerism · Personality · 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
v · t · e


The following tokens can be used in inorganic material definitions, generally for stones, gems, and metals, but not with materials attached to plants or creatures.

Token Arguments Description
WAFERS Used on metals, causes the metal to be made into wafers instead of bars.
DEEP_SPECIAL Causes the stone to form hollow tubes leading to the Underworld. Used for raw adamantine. When mined, stone has a 100% yield. If no material with this token exists, hollow veins will instead be made of the first available inorganic, usually iron. Implies [SPECIAL].
METAL_ORE metal:chance Allows the ore to be smelted into metal in the smelter. Each token with a non-zero chance causes the game to roll d100 four times, each time creating one bar of the type requested on success.
THREAD_METAL metal:chance Allows strands to be extracted from the metal at a craftsdwarf's workshop.
DEEP_SURFACE Causes the stone to line the landscape of the Underworld. Used for slade. When mined (if it's mineable), stone has a 100% yield. If no material with this token exists, other materials will be used in place of slade. Underworld spires will still be referred to as a "spire of slade" in the world's history.
AQUIFER Allows the stone to support an aquifer.
METAMORPHIC Causes the material to form metamorphic layers.
SEDIMENTARY Causes the material to form sedimentary layers.
SOIL Causes the material to form soil layers, allowing it to appear in (almost) any biome. Mining is faster and produces no stones.
SOIL_OCEAN Causes the material to form pelagic sediment layers beneath deep oceans. Mining is faster and produces no stones.
SOIL_SAND Causes the material to form sand layers, allowing it to appear in sand deserts and shallow oceans. Mining is faster and produces no stones. Sand layers can also be used for making glass. Can be combined with [SOIL].
SEDIMENTARY_OCEAN_SHALLOW Permits an already [SEDIMENTARY] stone layer to appear underneath shallow ocean regions.
SEDIMENTARY_OCEAN_DEEP Permits an already [SEDIMENTARY] stone layer to appear underneath deep ocean regions.
IGNEOUS_INTRUSIVE Causes the material to form igneous intrusive layers.
IGNEOUS_EXTRUSIVE Causes the material to form igneous extrusive layers.
ENVIRONMENT class:type:freq Specifies what types of layers will contain this mineral. Multiple instances of the same token segment will cause the rock type to occur more frequently, but won't increase its abundance in the specified environment. See below.
ENVIRONMENT_SPEC stone:type:freq Specifies which specific minerals will contain this mineral. See below.
LAVA Specifies that the stone is created when combining water and magma, also causing it to line the edges of magma pools and volcanoes. If multiple minerals are marked as lava stones, a different one will be used in each biome or geological region.
SPECIAL Prevents the material from showing up in certain places. AI-controlled entities won't use the material to make items and don't bring it in caravans, though the player can use it as normal. Also, inorganic generated creatures (forgotten beasts, titans, demons) will never be composed of this material. Explicitly set by all evil weather materials and implied by [DEEP_SURFACE] and [DEEP_SPECIAL].
GENERATED Indicates that this is a generated material. Cannot be specified in user-defined raws.
DIVINE Found on random-generated metals and cloth. Marks this material as usable by Deity-created generated entities.
SPHERE sphere Found on divine materials. Presumably links the material to a god of the same sphere.

ENVIRONMENT and ENVIRONMENT_SPEC[edit]

Format:

  • [ENVIRONMENT:<class>:<inclusion type>:<frequency>]

Possible values for class:

Environment class token Description
ALL_STONE Will appear in every stone.
IGNEOUS_ALL, IGNEOUS_INTRUSIVE, IGNEOUS_EXTRUSIVE Will appear in igneous layers, either igneous intrusive, igneous extrusive, or both.
SOIL, SOIL_OCEAN, SOIL_SAND Will appear in soil. SOIL_OCEAN is oceans specifically and SOIL_SAND is sand specifically.
METAMORPHIC Will appear in metamorphic layers.
SEDIMENTARY Will appear in sedimentary layers.
ALLUVIAL Will appear in alluvial layers.

Possible values for inclusion type:

Inclusion type token Description
CLUSTER Large ovoids that occupy their entire 48x48 embark tile. Microcline is an example. When mined, stone has a 25% yield (as with layer stones).
CLUSTER_SMALL Blobs of 3-9 tiles. Will always be successfully mined. Red pyropes are an example. When mined, stone has a 100% yield.
CLUSTER_ONE Single tiles. Will always be successfully mined. Clear diamonds are an example. When mined, stone has a 100% yield.
VEIN Large streaks of stone. Native gold is an example. When mined, stone has a 33% yield instead of the usual 25%.

An inclusion may be contained within a larger inclusion. For example, diamond small clusters are found within kimberlite veins.

The frequency number varies from 1 to 100 and determines the relative frequency at which the stone will be chosen to appear - if all frequency values are the same, then all stones will be equally likely to appear.


ENVIRONMENT_SPEC follows much the same format, but takes a specific stone material ID where ENVIRONMENT would take a class token. What you can use will depend on what inorganic raws are around.

See also[edit]

Retrieved from "https://dwarffortresswiki.org/index.php?title=Inorganic_material_definition_token&oldid=298910"