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.

Editing v0.34:Plant token

Jump to navigation Jump to search

Warning: You are not logged in.
Your IP address will be recorded in this page's edit history.

You are editing a page for an older version of Dwarf Fortress ("Main" is the current version, not "v0.34"). Please make sure you intend to do this. If you are here by mistake, see the current page instead.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

Latest revision Your text
Line 1: Line 1:
{{quality|Exceptional|21:01, 30 March 2011 (UTC)}}{{av}}
+
{{Quality|Tattered|16:03, 5 April 2012 (UTC)}}
The default plants are stored in the plant_standard.txt file, while grasses are stored in plant_grasses.txt.
+
{{av}}
 
 
==Basic Tokens==
 
These tokens are specified for all plants and define their most basic characteristics.
 
 
 
{| {{prettytable}}
 
|- style='background-color:#ddd'
 
! width="20%" | Token
 
! width="20%" | Arguments
 
! width="60%" | 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.
 
 
 
|-
 
| 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
 
|
 
* [[Material token|material]]
 
| 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==
 
These tokens, also applicable to all plants, specify where the plants grow.
 
 
 
{| {{prettytable}}
 
|- style='background-color:#ddd'
 
! width="20%" | Token
 
! width="20%" | Arguments
 
! width="60%" | Description
 
 
 
|-
 
| UNDERGROUND_DEPTH
 
|
 
*minimum
 
*maximum
 
| 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).
 
 
 
|-
 
| 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 token|biome]] this plant appears in.
 
 
 
|}
 
 
 
==Tree Tokens==
 
These tokens are used only for trees.
 
 
 
{| {{prettytable}}
 
|- style='background-color:#ddd'
 
! width="20%" | Token
 
! width="20%" | Arguments
 
! width="60%" | Description
 
 
 
|-
 
| TREE
 
|
 
* [[Material token|material]]
 
| 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==
 
These tokens are used only for plantable crops and harvestable shrubs.
 
 
 
{| {{prettytable}}
 
|- style='background-color:#ddd'
 
! width="20%" | Token
 
! width="20%" | Arguments
 
! 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.
 
 
 
|-
 
| GROWDUR
 
|
 
*time
 
| How long the plant takes to grow. Unit hundreds of ticks, See [[Time]]. There are 1008 GROWDUR units in a season. Defaults to 300.
 
 
 
|-
 
| VALUE
 
|
 
*value
 
| Has no effect as of version 0.34.11. Previously set the value of the harvested plant.
 
 
 
|-
 
| PICKED_TILE
 
|
 
*tile
 
| The tile used when harvested. May either be a number or letter within apostrophes(confirm?). See [[Main:character table|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
 
|
 
* [[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==
 
These tokens are used only for [[grass]]es.
 
 
 
{| {{prettytable}}
 
|- style='background-color:#ddd'
 
! width="20%" | Token
 
! width="20%" | Arguments
 
! width="60%" | 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).
 
|}
 
 
 
{{Category|Modding}}
 
{{Category|Tokens}}
 

Please note that all contributions to Dwarf Fortress Wiki are considered to be released under the GFDL & MIT (see Dwarf Fortress Wiki:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!

To protect the wiki against automated edit spam, we kindly ask you to solve the following CAPTCHA:

Cancel Editing help (opens in new window)