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.31:Plant token"

From Dwarf Fortress Wiki
Jump to navigation Jump to search
(add a bunch of missing tokens, reorganize, remove a few material tokens that didn't even belong here)
 
(18 intermediate revisions by 5 users not shown)
Line 1: Line 1:
−
{{quality|Fine|08:00, 22 May 2010 (UTC)}}{{av}}  
+
{{quality|Exceptional|21:01, 30 March 2011 (UTC)}}{{av}}  
 
The default plants are stored in the plant_standard.txt file, while grasses are stored in plant_grasses.txt.
 
The default plants are stored in the plant_standard.txt file, while grasses are stored in plant_grasses.txt.
  
 
==Basic Tokens==
 
==Basic Tokens==
 +
These tokens are specified for all plants and define their most basic characteristics.
 +
 
{| {{prettytable}}
 
{| {{prettytable}}
 
|- style='background-color:#ddd'
 
|- style='background-color:#ddd'
Line 13: Line 15:
 
|  
 
|  
 
*name
 
*name
−
| The singular form of the plants name as seen in game. <font color="red">Required</font>.
+
| The singular form of the plants name as seen in game.
  
 
|-
 
|-
Line 19: Line 21:
 
|  
 
|  
 
*name
 
*name
−
| The plural form of the plants name as seen in game. <font color="red">Required</font>.
+
| The plural form of the plants name as seen in game.
  
 
|-
 
|-
Line 25: Line 27:
 
|  
 
|  
 
*adjective
 
*adjective
−
| The word or phrase used to describe items made from this plant. <font color="red">Required</font>.
+
| The word or phrase used to describe items made from this plant.
  
 
|-
 
|-
Line 39: Line 41:
 
| What dwarves can like this object for (e.g. "Urist likes plump helmets for their rounded tops.")
 
| What dwarves can like this object for (e.g. "Urist likes plump helmets for their rounded tops.")
  
−
|}
 
−
 
−
==Plant Materials==
 
−
Materials defined within a plant can be modified by all valid material tokens and may only be accessed by the local plant.
 
−
 
−
{| {{prettytable}}
 
−
|- style='background-color:#ddd'
 
−
! width="20%" | Token
 
−
! width="20%" | Arguments
 
−
! width="60%" | Description
 
 
|-
 
|-
−
| USE_MATERIAL_TEMPLATE
+
| MATERIAL
 
|  
 
|  
 
*material_name
 
*material_name
−
*template_name
+
| Starts defining a new local plant material with the given name and '''no''' properties.{{verify}}
−
| Starts defining a new local plant material with the given name using the specified template. material_name is used to reference the newly created material from the same plant.
 
  
 
|-
 
|-
−
| BASIC_MAT
+
| USE_MATERIAL
 
|  
 
|  
−
* {{L|Material token|material}}
+
*material_name
−
| Sets the basic(structural) material of the plant. According to Toady, you can use other materials (for instance, iron) but the game may hiccup on plants that aren't structurally plants.
+
*old_material
 +
| Starts defining a new local plant material with the given name and using the properties of another local plant material.
  
 
|-
 
|-
−
| TREE
+
| USE_MATERIAL_TEMPLATE
 
|  
 
|  
−
* {{L|Material token|material}}
+
*material_name
−
| Makes the plant into a {{L|tree}} made of this material.
+
*template_name
 +
| Starts defining a new local plant material with the given name and using the properties of the specified material template.
  
 
|-
 
|-
−
| DRINK
+
| BASIC_MAT
−
|
 
−
* {{L|Material token|material}}
 
−
| Permits brewing the plant into {{L|alcohol}} made of this material.
 
−
 
 
−
|-
 
−
| MILL
 
−
|
 
−
* {{L|Material token|material}}
 
−
| Permits milling the plant at a {{L|quern}} or {{L|millstone}} into a powder made of this material.
 
−
 
 
−
|-
 
−
| THREAD
 
−
|
 
−
* {{L|Material token|material}}
 
−
| Permits processing the plant at a {{L|farmer's workshop}} to yield threads made of this material.
 
−
 
 
−
|-
 
−
| SEED
 
−
|
 
−
*name
 
−
*name_plural
 
−
*foreground
 
−
*background
 
−
*bright
 
−
*{{L|Material token|material}}
 
−
| Causes the plant to yield plantable seeds having these properties and made of this material.
 
−
 
 
−
|-
 
−
| LEAVES
 
−
|
 
−
*name
 
−
*name_plural
 
−
*tile
 
−
*foreground
 
−
*background
 
−
*bright
 
−
*wilt_foreground
 
−
*wilt_background
 
−
*wilt_bright
 
−
*{{L|Material token|material}}
 
−
| Permits processing the plant into a {{L|bag}} at a {{L|farmer's workshop}} to yield leaves having these properties and made of this material.
 
−
 
 
−
|-
 
−
| EXTRACT_STILL_VIAL
 
−
|
 
−
* {{L|Material token|material}}
 
−
| Permits processing the plant into a {{L|vial}} at a {{L|still}} to yield extract made of this material. Said material should have the [EXTRACT_STORAGE:FLASK] token.
 
−
 
 
−
|-
 
−
| EXTRACT_VIAL
 
 
|  
 
|  
−
*{{L|Material token|material}}
+
* [[Material token|material]]
−
| Permits processing the plant into a {{L|vial}} at a {{L|farmer's workshop}} to yield extract made of this material. Said material should have the [EXTRACT_STORAGE:FLASK] token.
+
| Sets the basic material of the plant. According to Toady, you can use other materials (for instance, iron) but the game may hiccup on plants that aren't structurally plants. For crops, said material should have [STRUCTURAL_PLANT_MAT] to permit proper stockpiling. Generally, this should be "LOCAL_PLANT_MAT:material_name", using a material defined using MATERIAL, USE_MATERIAL, or USE_MATERIAL_TEMPLATE.
−
 
 
−
|-
 
−
|EXTRACT_BARREL
 
−
|
 
−
* {{L|Material token|material}}
 
−
| Permits processing the plant into a {{L|barrel}} at a {{L|farmer's workshop}} to yield extract made of this material. Said material should have the [EXTRACT_STORAGE:BARREL] token.
 
 
|}
 
|}
  
 
==Environment Tokens==
 
==Environment Tokens==
 +
These tokens, also applicable to all plants, specify where the plants grow.
 +
 
{| {{prettytable}}
 
{| {{prettytable}}
 
|- style='background-color:#ddd'
 
|- style='background-color:#ddd'
Line 137: Line 76:
 
! width="20%" | Arguments
 
! width="20%" | Arguments
 
! width="60%" | Description
 
! width="60%" | Description
−
 
−
|-
 
−
| SPRING
 
−
| 
 
−
| Allows the plant to grow during spring.
 
−
 
−
|-
 
−
| SUMMER
 
−
| 
 
−
| Allows the plant to grow during summer.
 
−
 
−
|-
 
−
| AUTUMN
 
−
| 
 
−
| Allows the plant to grow during autumn.
 
−
 
−
|-
 
−
| WINTER
 
−
| 
 
−
| Allows the plant to grow during winter.
 
  
 
|-
 
|-
Line 163: Line 82:
 
*minimum
 
*minimum
 
*maximum
 
*maximum
−
| Designates the highest and lowest cavern levels that the plant can appear in if its {{L|biome token|biome}} is subterranean.  Dwarven civilizations will only export (via the embark screen or caravans) things that available at depth 1.
+
| Designates the highest and lowest cavern levels that the plant can appear in if its [[biome token|biome]] is subterranean.  Dwarven civilizations will only export (via the embark screen or caravans) things that available at depth 1. Defaults to 0:0 (surface only).
  
 
|-
 
|-
Line 184: Line 103:
 
|  
 
|  
 
*freq (0-100)
 
*freq (0-100)
−
| How frequently this plant is generated in a particular area.
+
| How frequently this plant is generated in a particular area. Defaults to 50.
  
 
|-
 
|-
Line 194: Line 113:
 
| DRY
 
| DRY
 
|   
 
|   
−
| Allows the plant to gruw away from water features.
+
| Allows the plant to grow away from water features.
  
 
|-
 
|-
Line 200: Line 119:
 
|  
 
|  
 
*biome
 
*biome
−
| What {{L|biome token|biome}} this plant appears in.
+
| What [[biome token|biome]] this plant appears in.
  
 
|}
 
|}
  
 
==Tree Tokens==
 
==Tree Tokens==
−
Trees cannot be used for seeds/food/drink/thread at this point, however, the structural material is designated in the same way.
+
These tokens are used only for trees.
−
Trees now appear under plant_standard instead of matgloss_wood.
+
 
 
{| {{prettytable}}
 
{| {{prettytable}}
 
|- style='background-color:#ddd'
 
|- style='background-color:#ddd'
Line 212: Line 131:
 
! width="20%" | Arguments
 
! width="20%" | Arguments
 
! width="60%" | Description
 
! width="60%" | Description
 +
 +
|-
 +
| TREE
 +
|
 +
* [[Material token|material]]
 +
| Makes the plant into a [[tree]]. Cutting down the tree will yield logs made of this material.
  
 
|-
 
|-
Line 222: Line 147:
 
|  
 
|  
 
*tile
 
*tile
−
| The tile used for the tree on the map. May be a number or a character inside apostrophes.
+
| The tile used for the tree on the map. May be a number or a character inside apostrophes. Defaults to 24 (↑).
  
 
|-
 
|-
Line 228: Line 153:
 
|  
 
|  
 
*tile
 
*tile
−
| The tile used for (un)dead trees of this type.
+
| The tile used for (un)dead trees of this type. Defaults to 198 (╞).
  
 
|-
 
|-
Line 234: Line 159:
 
|  
 
|  
 
*tile
 
*tile
−
| The tile used for saplings of this tree.
+
| The tile used for saplings of this tree. Defaults to 231 (τ).
  
 
|-
 
|-
Line 240: Line 165:
 
|  
 
|  
 
*tile
 
*tile
−
| The tile used for dead saplings of this tree.
+
| The tile used for dead saplings of this tree. Defaults to 231 (τ).
  
 
|-
 
|-
Line 248: Line 173:
 
*background
 
*background
 
*bright
 
*bright
−
| The {{L|color}} of the tree on the map.
+
| The [[color]] of the tree on the map. Defaults to 2:0:0 (dark green).
  
 
|-
 
|-
Line 256: Line 181:
 
*background
 
*background
 
*bright
 
*bright
−
| The {{L|color}} of the tree on the map when (un)dead.
+
| The [[color]] of the tree on the map when (un)dead. Defaults to 0:0:1 (dark gray).
  
 
|-
 
|-
Line 264: Line 189:
 
*background
 
*background
 
*bright
 
*bright
−
| The {{L|color}} of saplings of this tree.
+
| The [[color]] of saplings of this tree. Defaults to 2:0:0 (dark green).
  
 
|-
 
|-
Line 272: Line 197:
 
*background
 
*background
 
*bright
 
*bright
−
| The {{L|color}} of dead saplings of this tree.
+
| The [[color]] of dead saplings of this tree. Defaults to 0:0:1 (dark gray).
  
 
|-
 
|-
Line 278: Line 203:
 
|  
 
|  
 
*depth
 
*depth
−
| The water depth at which saplings of this tree will drown. Exact behavior is unknown.
+
| The water depth at which saplings of this tree will drown. Exact behavior is unknown. Defaults to 4.
  
 
|-
 
|-
Line 284: Line 209:
 
|  
 
|  
 
*depth
 
*depth
−
| The water depth at which this tree will drown. Exact behavior is unknown.
+
| The water depth at which this tree will drown. Exact behavior is unknown. Defaults to 7.
  
 
|-
 
|-
 
| SAPLING
 
| SAPLING
 
|   
 
|   
−
| Makes young versions of the tree be called "[tree name] sapling"; otherwise, they are called "young [tree name]"
+
| Makes young versions of the tree be called "[tree name] sapling"; otherwise, they are called "young [tree name]".
  
 
|}
 
|}
  
 
==Crop Tokens==
 
==Crop Tokens==
 +
These tokens are used only for plantable crops and harvestable shrubs.
  
 
{| {{prettytable}}
 
{| {{prettytable}}
Line 300: Line 226:
 
! width="20%" | Arguments
 
! width="20%" | Arguments
 
! width="60%" | Description
 
! width="60%" | Description
 +
 +
|-
 +
| SPRING
 +
| 
 +
| Allows the plant to grow during spring.
 +
 +
|-
 +
| SUMMER
 +
| 
 +
| Allows the plant to grow during summer.
 +
 +
|-
 +
| AUTUMN
 +
| 
 +
| Allows the plant to grow during autumn.
 +
 +
|-
 +
| WINTER
 +
| 
 +
| Allows the plant to grow during winter.
  
 
|-
 
|-
Line 305: Line 251:
 
|  
 
|  
 
*time
 
*time
−
| How long the plant takes to grow. See {{l|Time}}.
+
| How long the plant takes to grow. See [[Time]]. Defaults to 300.  There are 1008 GROWDUR units in a season.
  
 
|-
 
|-
Line 311: Line 257:
 
|  
 
|  
 
*value
 
*value
−
| Value of harvested plant.
+
| Value of harvested plant (default 1). Appears to have no effect in version 0.31.
  
 
|-
 
|-
Line 317: Line 263:
 
|  
 
|  
 
*tile
 
*tile
−
| The tile used when harvested. May either be a number or letter within apostrophes(confirm?).<font color="red">Required</font>. See [[character table]].
+
| The tile used when harvested. May either be a number or letter within apostrophes(confirm?). See [[Main:character table|character table]]. Defaults to 231 (τ).
  
 
|-
 
|-
Line 323: Line 269:
 
|  
 
|  
 
*tile
 
*tile
−
| The tile used when a harvested plant has wilted.
+
| The tile used when a harvested plant has wilted. Defaults to 169 (⌐).
  
 
|-
 
|-
Line 329: Line 275:
 
|  
 
|  
 
*tile
 
*tile
−
| What tile is used for shrubs bearing this plant. Can be either a number or a character inside apostrophes.
+
| What tile is used for shrubs bearing this plant. Can be either a number or a character inside apostrophes. Defaults to 34 (").
  
 
|-
 
|-
Line 335: Line 281:
 
|  
 
|  
 
*tile
 
*tile
−
| What tile is used when the plant has withered. Can be either a number or a character inside apostrophes.
+
| What tile is used for dead shrubs that once bore this plant. Can be either a number or a character inside apostrophes. Defaults to 34 (").
  
 
|-
 
|-
Line 341: Line 287:
 
|  
 
|  
 
*size
 
*size
−
| The maximum stack size collected when gathered or harvested.
+
| The maximum stack size collected when gathered via herbalism. Defaults to 5.
  
 
|-
 
|-
Line 349: Line 295:
 
*background
 
*background
 
*bright
 
*bright
−
| The {{l|color}} of the plant in farms.
+
| The [[color]] of the plant in farms. Defaults to 2:0:0 (dark green).
  
 
|-
 
|-
Line 357: Line 303:
 
*background
 
*background
 
*bright
 
*bright
−
| The {{l|color}} of the plant when wilted.
+
| The [[color]] of the plant when wilted. Defaults to 0:0:1 (dark gray).
  
 
|-
 
|-
Line 365: Line 311:
 
*background
 
*background
 
*bright
 
*bright
−
| The {{l|color}} of shrubs bearing this plant.
+
| The [[color]] of shrubs bearing this plant. Defaults to 2:0:0 (dark green).
  
 
|-
 
|-
Line 373: Line 319:
 
*background
 
*background
 
*bright
 
*bright
−
|The {{l|color}} of dead shrubs that bore this plant.
+
|The [[color]] of dead shrubs that bore this plant. Defaults to 6:0:0 (brown).
  
 
|-
 
|-
Line 379: Line 325:
 
|  
 
|  
 
*depth
 
*depth
−
| The water depth at which shrubs of this plant will drown. Exact behavior is unknown.
+
| The water depth at which shrubs of this plant will drown. Exact behavior is unknown. Defaults to 4.
 +
 
 +
|-
 +
| DRINK
 +
|
 +
* [[Material token|material]]
 +
| Permits brewing the plant into [[alcohol]] made of this material. Said material should have [ALCOHOL_PLANT] to permit proper stockpiling.
 +
 
 +
|-
 +
| MILL
 +
|
 +
* [[Material token|material]]
 +
| Permits milling the plant at a [[quern]] or [[millstone]] into a powder made of this material. Said material should have [POWDER_MISC_PLANT] to permit proper stockpiling.
 +
 
 +
|-
 +
| THREAD
 +
|
 +
* [[Material token|material]]
 +
| Permits processing the plant at a [[farmer's workshop]] to yield threads made of this material. Said material should have [THREAD_PLANT] to permit proper stockpiling.
 +
 
 +
|-
 +
| SEED
 +
|
 +
*name
 +
*name_plural
 +
*foreground
 +
*background
 +
*bright
 +
*[[Material token|material]]
 +
| Causes the plant to yield plantable seeds made of this material and having these properties. Said material should have [SEED_MAT] to permit proper stockpiling.
 +
 
 +
|-
 +
| LEAVES
 +
|
 +
*name
 +
*name_plural
 +
*tile
 +
*foreground
 +
*background
 +
*bright
 +
*wilt_foreground
 +
*wilt_background
 +
*wilt_bright
 +
*[[Material token|material]]
 +
| Permits processing the plant into a [[bag]] at a [[farmer's workshop]] to yield leaves made of this material and having these properties. Said material should have [LEAF_MAT] to permit proper stockpiling.
 +
 
 +
|-
 +
| EXTRACT_STILL_VIAL
 +
|
 +
* [[Material token|material]]
 +
| Permits processing the plant into a [[vial]] at a [[still]] to yield extract made of this material. Said material should have [EXTRACT_STORAGE:FLASK].
 +
 
 +
|-
 +
| EXTRACT_VIAL
 +
|
 +
*[[Material token|material]]
 +
| Permits processing the plant into a [[vial]] at a [[farmer's workshop]] to yield extract made of this material. Said material should have [EXTRACT_STORAGE:FLASK].
 +
 
 +
|-
 +
| EXTRACT_BARREL
 +
|
 +
* [[Material token|material]]
 +
| Permits processing the plant into a [[barrel]] at a [[farmer's workshop]] to yield extract made of this material. Said material should have [EXTRACT_STORAGE:BARREL].
  
 
|}
 
|}
  
 
==Grass Tokens==
 
==Grass Tokens==
 +
These tokens are used only for [[grass]]es.
  
 
{| {{prettytable}}
 
{| {{prettytable}}
Line 394: Line 403:
 
| GRASS
 
| GRASS
 
|  
 
|  
−
| Plant is a type of grass.
+
| Makes the plant behave as a type of grass.
  
 
|-
 
|-
Line 403: Line 412:
 
*tile
 
*tile
 
*tile
 
*tile
−
|Tiles for a surface covered in grass.
+
| Specifies the 4 tiles used to represent grass of this type. If VARIED_GROUND_TILES is disabled in d_init.txt, these are seemingly ignored. Defaults to 46:44:96:39 (.,`').
  
 
|-
 
|-
Line 409: Line 418:
 
|
 
|
 
*period
 
*period
−
*delay
+
*offset
−
| How often the grass switches between alternate tiles. Each tile has a counter which starts at the "period" value and decrements once per frame - when the counter reaches the "delay" value, the grass switches to the ALT tile, and when it reaches zero, it switches back to the original tile and restarts the counter. If the "delay" value is greater than or equal to the "period" value, the grass will not animate - instead, it will permanently display the ALT tile.{{bug|4151}}
+
| How often the grass switches between its main tiles and alternate tiles. The "period" value determines how quickly (in frames) the grass animates, and the "offset" value specifies how much of that time is spent displaying the alternate tiles. If the "offset" value is greater than or equal to the "period" value, the grass will only display using the alternate tiles.{{verify}} Defaults to 0:0.
  
 
|-
 
|-
Line 419: Line 428:
 
*tile
 
*tile
 
*tile
 
*tile
−
|Grass tiles will alternate between these and GRASS_TILES. Currently used for wormy tendrils and eyeballs.
+
| When used with ALT_PERIOD, specifies the 4 alternate tiles used to represent grass of this type. Defaults to 46:44:96:39 (.,`'). Dead grass does not animate.
  
 
|-
 
|-
Line 428: Line 437:
 
*dry color (fore:back:bright)
 
*dry color (fore:back:bright)
 
*dead color (fore:back:bright)
 
*dead color (fore:back:bright)
−
|Colors of grass tiles.
+
| Specifies the color of this grass. Defaults to 2:0:1:2:0:0:6:0:1:6:0:0 (light green, dark green, yellow, brown).
 
|}
 
|}
  
 
{{Category|Modding}}
 
{{Category|Modding}}
 
{{Category|Tokens}}
 
{{Category|Tokens}}

Latest revision as of 03:12, 30 December 2011

xTATTEREDx  · +FINE+  · *SUPERIOR*  · ≡EXCEPTIONAL≡  · ☼MASTERWORK☼
v50.14 · v0.47 · v0.34 · v0.31.25 · v0.28 · v0.23
This article is about an older version of DF.

The default plants are stored in the plant_standard.txt file, while grasses are stored in plant_grasses.txt.

Basic Tokens[edit]

These tokens are specified for all plants and define their most basic characteristics.

Token Arguments Description
NAME
  • name
 The singular form of the plants name as seen in game.
NAME_PLURAL
  • name
 The plural form of the plants name as seen in game.
ADJ
  • adjective
 The word or phrase used to describe items made from this plant.
ALL_NAMES
  • name
 Sets the NAME, NAME_PLURAL, and ADJ to the specified string.
PREFSTRING
  • reason
 What dwarves can like this object for (e.g. "Urist likes plump helmets for their rounded tops.")
MATERIAL
  • material_name
 Starts defining a new local plant material with the given name and no properties.[Verify]
USE_MATERIAL
  • material_name
  • old_material
 Starts defining a new local plant material with the given name and using the properties of another local plant material.
USE_MATERIAL_TEMPLATE
  • material_name
  • template_name
 Starts defining a new local plant material with the given name and using the properties of the specified material template.
BASIC_MAT Sets the basic material of the plant. According to Toady, you can use other materials (for instance, iron) but the game may hiccup on plants that aren't structurally plants. For crops, said material should have [STRUCTURAL_PLANT_MAT] to permit proper stockpiling. Generally, this should be "LOCAL_PLANT_MAT:material_name", using a material defined using MATERIAL, USE_MATERIAL, or USE_MATERIAL_TEMPLATE.

Environment Tokens[edit]

These tokens, also applicable to all plants, specify where the plants grow.

Token Arguments Description
UNDERGROUND_DEPTH
  • minimum
  • maximum
 Designates the highest and lowest cavern levels that the plant can appear in if its biome is subterranean. Dwarven civilizations will only export (via the embark screen or caravans) things that available at depth 1. Defaults to 0:0 (surface only).
GOOD Restricts the plant to growing in Good regions. Cannot be combined with [EVIL].
EVIL Restricts the plant to growing in Evil regions. Cannot be combined with [GOOD].
SAVAGE Restricts the plant to growing in Savage regions (regardless of alignment).
FREQUENCY
  • freq (0-100)
 How frequently this plant is generated in a particular area. Defaults to 50.
WET Allows the plant to grow near water features.
DRY Allows the plant to grow away from water features.
BIOME
  • biome
 What biome this plant appears in.

Tree Tokens[edit]

These tokens are used only for trees.

Token Arguments Description
TREE Makes the plant into a tree. Cutting down the tree will yield logs made of this material.
AUTUMNCOLOR Makes the tree turn yellow, orange, and red in Autumn, then lose its leaves in Winter.
TREE_TILE
  • tile
 The tile used for the tree on the map. May be a number or a character inside apostrophes. Defaults to 24 (↑).
DEAD_TREE_TILE
  • tile
 The tile used for (un)dead trees of this type. Defaults to 198 (╞).
SAPLING_TILE
  • tile
 The tile used for saplings of this tree. Defaults to 231 (τ).
DEAD_SAPLING_TILE
  • tile
 The tile used for dead saplings of this tree. Defaults to 231 (τ).
TREE_COLOR
  • foreground
  • background
  • bright
 The color of the tree on the map. Defaults to 2:0:0 (dark green).
DEAD_TREE_COLOR
  • foreground
  • background
  • bright
 The color of the tree on the map when (un)dead. Defaults to 0:0:1 (dark gray).
SAPLING_COLOR
  • foreground
  • background
  • bright
 The color of saplings of this tree. Defaults to 2:0:0 (dark green).
DEAD_SAPLING_COLOR
  • foreground
  • background
  • bright
 The color of dead saplings of this tree. Defaults to 0:0:1 (dark gray).
SAPLING_DROWN_LEVEL
  • depth
 The water depth at which saplings of this tree will drown. Exact behavior is unknown. Defaults to 4.
TREE_DROWN_LEVEL
  • depth
 The water depth at which this tree will drown. Exact behavior is unknown. Defaults to 7.
SAPLING Makes young versions of the tree be called "[tree name] sapling"; otherwise, they are called "young [tree name]".

Crop Tokens[edit]

These tokens are used only for plantable crops and harvestable shrubs.

Token Arguments Description
SPRING Allows the plant to grow during spring.
SUMMER Allows the plant to grow during summer.
AUTUMN Allows the plant to grow during autumn.
WINTER Allows the plant to grow during winter.
GROWDUR
  • time
 How long the plant takes to grow. See Time. Defaults to 300. There are 1008 GROWDUR units in a season.
VALUE
  • value
 Value of harvested plant (default 1). Appears to have no effect in version 0.31.
PICKED_TILE
  • tile
 The tile used when harvested. May either be a number or letter within apostrophes(confirm?). See character table. Defaults to 231 (τ).
DEAD_PICKED_TILE
  • tile
 The tile used when a harvested plant has wilted. Defaults to 169 (⌐).
SHRUB_TILE
  • tile
 What tile is used for shrubs bearing this plant. Can be either a number or a character inside apostrophes. Defaults to 34 (").
DEAD_SHRUB_TILE
  • tile
 What tile is used for dead shrubs that once bore this plant. Can be either a number or a character inside apostrophes. Defaults to 34 (").
CLUSTERSIZE
  • size
 The maximum stack size collected when gathered via herbalism. Defaults to 5.
PICKED_COLOR
  • foreground
  • background
  • bright
 The color of the plant in farms. Defaults to 2:0:0 (dark green).
DEAD_PICKED_COLOR
  • foreground
  • background
  • bright
 The color of the plant when wilted. Defaults to 0:0:1 (dark gray).
SHRUB_COLOR
  • foreground
  • background
  • bright
 The color of shrubs bearing this plant. Defaults to 2:0:0 (dark green).
DEAD_SHRUB_COLOR
  • foreground
  • background
  • bright
 The color of dead shrubs that bore this plant. Defaults to 6:0:0 (brown).
SHRUB_DROWN_LEVEL
  • depth
 The water depth at which shrubs of this plant will drown. Exact behavior is unknown. Defaults to 4.
DRINK Permits brewing the plant into alcohol made of this material. Said material should have [ALCOHOL_PLANT] to permit proper stockpiling.
MILL Permits milling the plant at a quern or millstone into a powder made of this material. Said material should have [POWDER_MISC_PLANT] to permit proper stockpiling.
THREAD Permits processing the plant at a farmer's workshop to yield threads made of this material. Said material should have [THREAD_PLANT] to permit proper stockpiling.
SEED
  • name
  • name_plural
  • foreground
  • background
  • bright
  • material
 Causes the plant to yield plantable seeds made of this material and having these properties. Said material should have [SEED_MAT] to permit proper stockpiling.
LEAVES
  • name
  • name_plural
  • tile
  • foreground
  • background
  • bright
  • wilt_foreground
  • wilt_background
  • wilt_bright
  • material
 Permits processing the plant into a bag at a farmer's workshop to yield leaves made of this material and having these properties. Said material should have [LEAF_MAT] to permit proper stockpiling.
EXTRACT_STILL_VIAL Permits processing the plant into a vial at a still to yield extract made of this material. Said material should have [EXTRACT_STORAGE:FLASK].
EXTRACT_VIAL Permits processing the plant into a vial at a farmer's workshop to yield extract made of this material. Said material should have [EXTRACT_STORAGE:FLASK].
EXTRACT_BARREL Permits processing the plant into a barrel at a farmer's workshop to yield extract made of this material. Said material should have [EXTRACT_STORAGE:BARREL].

Grass Tokens[edit]

These tokens are used only for grasses.

Token Arguments Description
GRASS Makes the plant behave as a type of grass.
GRASS_TILES
  • tile
  • tile
  • tile
  • tile
 Specifies the 4 tiles used to represent grass of this type. If VARIED_GROUND_TILES is disabled in d_init.txt, these are seemingly ignored. Defaults to 46:44:96:39 (.,`').
ALT_PERIOD
  • period
  • offset
 How often the grass switches between its main tiles and alternate tiles. The "period" value determines how quickly (in frames) the grass animates, and the "offset" value specifies how much of that time is spent displaying the alternate tiles. If the "offset" value is greater than or equal to the "period" value, the grass will only display using the alternate tiles.[Verify] Defaults to 0:0.
ALT_GRASS_TILES
  • tile
  • tile
  • tile
  • tile
 When used with ALT_PERIOD, specifies the 4 alternate tiles used to represent grass of this type. Defaults to 46:44:96:39 (.,`'). Dead grass does not animate.
GRASS_COLORS
  • color 1 (fore:back:bright)
  • color 2 (fore:back:bright)
  • dry color (fore:back:bright)
  • dead color (fore:back:bright)
 Specifies the color of this grass. Defaults to 2:0:1:2:0:0:6:0:1:6:0:0 (light green, dark green, yellow, brown).
Retrieved from "https://dwarffortresswiki.org/index.php?title=v0.31:Plant_token&oldid=159136"