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
(→‎Basic Tokens: USE_MATERIAL has been used by modders, and it appears to make copies of existing local plant materials; making tentative guess as to what MATERIAL does)
m (Add defaults, determined by code analysis.)
Line 82: 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 {{L|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.
  
 
|-
 
|-
Line 103: 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 147: 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 153: 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 159: Line 159:
 
|  
 
|  
 
*tile
 
*tile
−
| The tile used for saplings of this tree.
+
| The tile used for saplings of this tree. Defaults to 231 (τ).
  
 
|-
 
|-
Line 165: 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 173: Line 173:
 
*background
 
*background
 
*bright
 
*bright
−
| The {{L|color}} of the tree on the map.
+
| The {{L|color}} of the tree on the map. Defaults to 2:0:0.
  
 
|-
 
|-
Line 181: Line 181:
 
*background
 
*background
 
*bright
 
*bright
−
| The {{L|color}} of the tree on the map when (un)dead.
+
| The {{L|color}} of the tree on the map when (un)dead. Defaults to 0:0:1.
  
 
|-
 
|-
Line 189: Line 189:
 
*background
 
*background
 
*bright
 
*bright
−
| The {{L|color}} of saplings of this tree.
+
| The {{L|color}} of saplings of this tree. Defaults to 2:0:0.
  
 
|-
 
|-
Line 197: Line 197:
 
*background
 
*background
 
*bright
 
*bright
−
| The {{L|color}} of dead saplings of this tree.
+
| The {{L|color}} of dead saplings of this tree. Defaults to 0:0:1.
  
 
|-
 
|-
Line 203: 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 209: 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]".
  
 
|}
 
|}
Line 251: Line 251:
 
|  
 
|  
 
*time
 
*time
−
| How long the plant takes to grow. See {{l|Time}}.
+
| How long the plant takes to grow. See {{l|Time}}. Defaults to 300.
  
 
|-
 
|-
Line 257: Line 257:
 
|  
 
|  
 
*value
 
*value
−
| Value of harvested plant.
+
| Value of harvested plant. Defaults to 1.
  
 
|-
 
|-
Line 263: 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 [[character table]]. Defaults to 231 (τ).
  
 
|-
 
|-
Line 269: 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 275: 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 281: 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 when the plant has withered. Can be either a number or a character inside apostrophes. Defaults to 34 (").
  
 
|-
 
|-
Line 287: Line 287:
 
|  
 
|  
 
*size
 
*size
−
| The maximum stack size collected when gathered via herbalism.
+
| The maximum stack size collected when gathered via herbalism. Defaults to 5.
  
 
|-
 
|-
Line 295: Line 295:
 
*background
 
*background
 
*bright
 
*bright
−
| The {{l|color}} of the plant in farms.
+
| The {{l|color}} of the plant in farms. Defaults to 2:0:0.
  
 
|-
 
|-
Line 303: Line 303:
 
*background
 
*background
 
*bright
 
*bright
−
| The {{l|color}} of the plant when wilted.
+
| The {{l|color}} of the plant when wilted. Defaults to 0:0:1.
  
 
|-
 
|-
Line 311: Line 311:
 
*background
 
*background
 
*bright
 
*bright
−
| The {{l|color}} of shrubs bearing this plant.
+
| The {{l|color}} of shrubs bearing this plant. Defaults to 2:0:0.
  
 
|-
 
|-
Line 319: Line 319:
 
*background
 
*background
 
*bright
 
*bright
−
|The {{l|color}} of dead shrubs that bore this plant.
+
|The {{l|color}} of dead shrubs that bore this plant. Defaults to 6:0:0.
  
 
|-
 
|-
Line 325: 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.
  
 
|-
 
|-
Line 412: Line 412:
 
*tile
 
*tile
 
*tile
 
*tile
−
| Specifies the 4 tiles used to represent grass of this type. If VARIED_GROUND_TILES is enabled in d_init.txt, only the first tile will be used.
+
| Specifies the 4 tiles used to represent grass of this type. If VARIED_GROUND_TILES is enabled in d_init.txt, these are seemingly ignored. Defaults to 46:44:96:39 (. , ` ').
  
 
|-
 
|-
Line 419: Line 419:
 
*period
 
*period
 
*offset
 
*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 "offst" 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.
+
| 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 "offst" 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 428: Line 428:
 
*tile
 
*tile
 
*tile
 
*tile
−
| When used with ALT_PERIOD, specifies the 4 alternate tiles used to represent grass of this type.
+
| 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 437: Line 437:
 
*dry color (fore:back:bright)
 
*dry color (fore:back:bright)
 
*dead color (fore:back:bright)
 
*dead color (fore:back:bright)
−
| Specifies the color of this grass. By default, the colors (in order) are bright green, dark green, yellow, and brown.
+
| 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}}

Revision as of 13:13, 11 April 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

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

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 Template:L is subterranean. Dwarven civilizations will only export (via the embark screen or caravans) things that available at depth 1. Defaults to 0:0.
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 Template:L this plant appears in.

Tree Tokens

These tokens are used only for trees.

Token Arguments Description
TREE Makes the plant into a Template:L. 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 Template:L of the tree on the map. Defaults to 2:0:0.
DEAD_TREE_COLOR
  • foreground
  • background
  • bright
 The Template:L of the tree on the map when (un)dead. Defaults to 0:0:1.
SAPLING_COLOR
  • foreground
  • background
  • bright
 The Template:L of saplings of this tree. Defaults to 2:0:0.
DEAD_SAPLING_COLOR
  • foreground
  • background
  • bright
 The Template:L of dead saplings of this tree. Defaults to 0:0:1.
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.

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 Template:L. Defaults to 300.
VALUE
  • value
 Value of harvested plant. Defaults to 1.
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 when the plant has withered. 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 Template:L of the plant in farms. Defaults to 2:0:0.
DEAD_PICKED_COLOR
  • foreground
  • background
  • bright
 The Template:L of the plant when wilted. Defaults to 0:0:1.
SHRUB_COLOR
  • foreground
  • background
  • bright
 The Template:L of shrubs bearing this plant. Defaults to 2:0:0.
DEAD_SHRUB_COLOR
  • foreground
  • background
  • bright
 The Template:L of dead shrubs that bore this plant. Defaults to 6:0:0.
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 Template:L made of this material. Said material should have [ALCOHOL_PLANT] to permit proper stockpiling.
MILL Permits milling the plant at a Template:L or Template:L 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 Template:L to yield threads made of this material. Said material should have [THREAD_PLANT] to permit proper stockpiling.
SEED
  • name
  • name_plural
  • foreground
  • background
  • bright
  • Template:L
 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
  • Template:L
 Permits processing the plant into a Template:L at a Template:L 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 Template:L at a Template:L to yield extract made of this material. Said material should have [EXTRACT_STORAGE:FLASK].
EXTRACT_VIAL Permits processing the plant into a Template:L at a Template:L to yield extract made of this material. Said material should have [EXTRACT_STORAGE:FLASK].
EXTRACT_BARREL Permits processing the plant into a Template:L at a Template:L to yield extract made of this material. Said material should have [EXTRACT_STORAGE:BARREL].

Grass Tokens

These tokens are used only for Template:Les.

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 enabled 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 "offst" 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=145576"