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 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.
If you are creating a redirect to the current version's page, do not use any namespace. For example: use #REDIRECT [[Cat]], not #REDIRECT [[Main:Cat]] or #REDIRECT [[cv:Cat]]. See DF:Versions for more information.
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|Fine}} | + | {{Quality|Fine|11:40, 18 May 2015 (UTC)}} |
− | {{av | + | {{av}} |
− | + | The default plants are stored in the plant_standard.txt file, while grasses are stored in plant_grasses.txt. | |
− | The | ||
− | + | ==Basic Tokens== | |
− | |||
− | |||
− | |||
− | ==Basic | ||
These tokens are specified for all plants and define their most basic characteristics. | These tokens are specified for all plants and define their most basic characteristics. | ||
Line 18: | Line 13: | ||
|- | |- | ||
− | + | | NAME | |
| | | | ||
*name | *name | ||
− | | The singular form of the | + | | The singular form of the plants name as seen in game. |
|- | |- | ||
− | + | | NAME_PLURAL | |
| | | | ||
*name | *name | ||
− | | The plural form of the | + | | The plural form of the plants name as seen in game. |
|- | |- | ||
− | + | | ADJ | |
| | | | ||
*adjective | *adjective | ||
Line 36: | Line 31: | ||
|- | |- | ||
− | + | | ALL_NAMES | |
| | | | ||
*name | *name | ||
Line 42: | Line 37: | ||
|- | |- | ||
− | + | | PREFSTRING | |
| | | | ||
*reason | *reason | ||
Line 48: | Line 43: | ||
|- | |- | ||
− | + | | MATERIAL | |
| | | | ||
*material_name | *material_name | ||
− | | Starts defining a new local plant material with the given name | + | | Starts defining a new local plant material with the given name and '''no''' properties. |
|- | |- | ||
− | + | | USE_MATERIAL | |
| | | | ||
*material_name | *material_name | ||
− | * | + | *old_material |
− | | Starts defining a new local plant material with the given name and using the properties of another | + | | 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 | *material_name | ||
*template_name | *template_name | ||
− | | Starts defining a new local plant material with the 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]] | * [[Material token|material]] | ||
− | | Sets the basic material of the plant | + | | 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 | + | ==Environment Tokens== |
These tokens, also applicable to all plants, specify where the plants grow. | These tokens, also applicable to all plants, specify where the plants grow. | ||
Line 91: | Line 79: | ||
|- | |- | ||
− | + | | UNDERGROUND_DEPTH | |
| | | | ||
*minimum | *minimum | ||
Line 98: | Line 86: | ||
|- | |- | ||
− | + | | GOOD | |
| | | | ||
| Restricts the plant to growing in Good regions. Cannot be combined with [EVIL]. | | 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]. | | 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). | | Restricts the plant to growing in Savage regions (regardless of alignment). | ||
|- | |- | ||
− | + | | FREQUENCY | |
| | | | ||
*freq (0-100) | *freq (0-100) | ||
Line 119: | Line 107: | ||
|- | |- | ||
− | + | | WET | |
| | | | ||
− | | | + | | Allows the plant to grow near water features. |
|- | |- | ||
− | + | | DRY | |
− | | | + | | |
− | | | + | | Allows the plant to grow away from water features. |
|- | |- | ||
− | + | | BIOME | |
| | | | ||
*biome | *biome | ||
Line 136: | Line 124: | ||
|} | |} | ||
− | ==Growth | + | ==Growth Tokens== |
These tokens are used for all plants and specify growths growing on a plant. | These tokens are used for all plants and specify growths growing on a plant. | ||
− | Edible or otherwise usable growths should have [STOCKPILE_PLANT_GROWTH] in their [[material definition token|material definitions]] for proper stockpiling. This also lets them be collected from plant gathering and farming jobs. | + | Edible or otherwise usable growths should have [STOCKPILE_PLANT_GROWTH] in their [[material definition token|material definitions]] for proper stockpiling, and must have both [STOCKPILE_PLANT_GROWTH] and [STRUCTURAL_PLANT_MAT] to be picked in fortress mode. This also lets them be collected from plant gathering and farming jobs, unless the growth is linked to the plant itself through a [[reaction]], as in [[quarry bush]]es. |
{| {{prettytable}} | {| {{prettytable}} | ||
Line 148: | Line 136: | ||
|- | |- | ||
− | + | | GROWTH | |
| | | | ||
*name | *name | ||
Line 154: | Line 142: | ||
|- | |- | ||
− | + | | GROWTH_NAME | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
| | | | ||
*singular | *singular | ||
Line 167: | Line 149: | ||
|- | |- | ||
− | + | | GROWTH_ITEM | |
| | | | ||
* [[item token]] | * [[item token]] | ||
Line 174: | Line 156: | ||
|- | |- | ||
− | + | | GROWTH_HOST_TILE | |
| | | | ||
*plant part | *plant part | ||
Line 190: | Line 172: | ||
|- | |- | ||
− | + | | GROWTH_TRUNK_HEIGHT_PERC | |
| | | | ||
− | * | + | *integer:integer |
− | + | | | |
− | | | ||
− | |||
− | |||
|- | |- | ||
− | + | | GROWTH_DENSITY | |
| | | | ||
*integer | *integer | ||
− | | | + | | Specifies growth density. |
|- | |- | ||
− | + | | GROWTH_TIMING | |
| | | | ||
− | *[[time]] | + | *[[time]] ticks (0-403200) |
| Specifies at which part of the year the growth appears. Default is all year round. | | Specifies at which part of the year the growth appears. Default is all year round. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
− | + | | GROWTH_PRINT | |
| | | | ||
*overworld tile | *overworld tile | ||
*item tile | *item tile | ||
− | * | + | *colour |
− | * | + | *timing (0-403200), ALL or NONE |
*priority | *priority | ||
− | | Specifies the appearance of the growth. Can be specified more than once, for example for autumn leaves. Transitions between different timing periods will happen gradually over the course of 2000 ticks | + | | Specifies the appearance of the growth. Can be specified more than once, for example for autumn leaves. Transitions between different timing periods will happen gradually over the course of 2000 ticks. |
− | |||
− | |||
|- | |- | ||
− | + | | GROWTH_HAS_SEED | |
| | | | ||
− | | The growth | + | | The growth carries a seed, which is left when the growth is used or eaten. |
|- | |- | ||
− | + | | GROWTH_DROPS_OFF | |
| | | | ||
| Growths drop from the plant, producing a cloud of items which fall on the ground, which [[herbalist]]s can collect. | | Growths drop from the plant, producing a cloud of items which fall on the ground, which [[herbalist]]s can collect. | ||
|- | |- | ||
− | + | | GROWTH_DROPS_OFF_NO_CLOUD | |
| | | | ||
| Growths drop collectable items from the plant without producing item clouds. | | Growths drop collectable items from the plant without producing item clouds. | ||
Line 244: | Line 215: | ||
|} | |} | ||
− | ==Tree | + | ==Tree Tokens== |
These tokens are used only for trees. | These tokens are used only for trees. | ||
Line 254: | Line 225: | ||
|- | |- | ||
− | + | | TREE | |
| | | | ||
* [[Material token|material]] or NONE | * [[Material token|material]] or NONE | ||
Line 260: | Line 231: | ||
|- | |- | ||
− | + | | TRUNK_NAME | |
| | | | ||
*name | *name | ||
Line 266: | Line 237: | ||
|- | |- | ||
− | + | | MAX_TRUNK_HEIGHT | |
| | | | ||
*1-8 | *1-8 | ||
Line 272: | Line 243: | ||
|- | |- | ||
− | + | | MAX_TRUNK_DIAMETER | |
| | | | ||
*1-3 | *1-3 | ||
Line 278: | Line 249: | ||
|- | |- | ||
− | + | | TRUNK_PERIOD | |
| | | | ||
*integer | *integer | ||
Line 284: | Line 255: | ||
|- | |- | ||
− | + | | TRUNK_WIDTH_PERIOD | |
| | | | ||
*integer | *integer | ||
Line 290: | Line 261: | ||
|- | |- | ||
− | + | | LIGHT_BRANCHES_NAME | |
| | | | ||
*name | *name | ||
Line 296: | Line 267: | ||
|- | |- | ||
− | + | | BRANCH_DENSITY / LIGHT_BRANCHES_DENSITY | |
| | | | ||
*integer | *integer | ||
Line 302: | Line 273: | ||
|- | |- | ||
− | + | | BRANCH_RADIUS / LIGHT_BRANCH_RADIUS | |
| | | | ||
*integer | *integer | ||
− | | The radius to which branches can reach. Appears to never reach further than seven tiles from the centre. Does not depend on the trunk branching amount or where trunks are. | + | | The radius to which branches can reach. Appears to never reach further than seven tiles from the centre. Does not depend on the trunk branching amount or where trunks are. |
|- | |- | ||
− | + | | HEAVY_BRANCHES_NAME / DIRECTED_BRANCHES_NAME | |
| | | | ||
*name | *name | ||
Line 314: | Line 285: | ||
|- | |- | ||
− | + | | HEAVY_BRANCH_DENSITY / DIRECTED_BRANCH_DENSITY | |
| | | | ||
*integer | *integer | ||
− | | Similar to | + | | Similar to BRANCH_DENSITY for thick branches. |
|- | |- | ||
− | + | | HEAVY_BRANCH_RADIUS / DIRECTED_BRANCH_RADIUS | |
| | | | ||
*integer | *integer | ||
− | | Similar as | + | | Similar as BRANCH_RADIUS for thick branches. |
|- | |- | ||
− | + | | TRUNK_BRANCHING | |
| | | | ||
*integer | *integer | ||
Line 332: | Line 303: | ||
|- | |- | ||
− | + | | ROOT_NAME / ROOTS_NAME | |
| | | | ||
*name | *name | ||
Line 338: | Line 309: | ||
|- | |- | ||
− | + | | ROOT_DENSITY | |
| | | | ||
*integer | *integer | ||
Line 344: | Line 315: | ||
|- | |- | ||
− | + | | ROOT_RADIUS | |
| | | | ||
*integer | *integer | ||
Line 350: | Line 321: | ||
|- | |- | ||
− | + | | TWIGS_NAME | |
| | | | ||
*name | *name | ||
Line 356: | Line 327: | ||
|- | |- | ||
− | + | | TWIGS_SIDE_BRANCHES | |
| | | | ||
*boolean (0 or 1) | *boolean (0 or 1) | ||
Line 362: | Line 333: | ||
|- | |- | ||
− | + | | TWIGS_ABOVE_BRANCHES | |
| | | | ||
*boolean (0 or 1) | *boolean (0 or 1) | ||
Line 368: | Line 339: | ||
|- | |- | ||
− | + | | TWIGS_BELOW_BRANCHES | |
| | | | ||
*boolean (0 or 1) | *boolean (0 or 1) | ||
Line 374: | Line 345: | ||
|- | |- | ||
− | + | | TWIGS_SIDE_HEAVY_BRANCHES | |
| | | | ||
*boolean (0 or 1) | *boolean (0 or 1) | ||
Line 380: | Line 351: | ||
|- | |- | ||
− | + | | TWIGS_ABOVE_HEAVY_BRANCHES | |
| | | | ||
*boolean (0 or 1) | *boolean (0 or 1) | ||
Line 386: | Line 357: | ||
|- | |- | ||
− | + | | TWIGS_BELOW_HEAVY_BRANCHES | |
| | | | ||
*boolean (0 or 1) | *boolean (0 or 1) | ||
Line 392: | Line 363: | ||
|- | |- | ||
− | + | | TWIGS_SIDE_TRUNK | |
| | | | ||
*boolean (0 or 1) | *boolean (0 or 1) | ||
Line 398: | Line 369: | ||
|- | |- | ||
− | + | | TWIGS_ABOVE_TRUNK | |
| | | | ||
*boolean (0 or 1) | *boolean (0 or 1) | ||
Line 404: | Line 375: | ||
|- | |- | ||
− | + | | TWIGS_BELOW_TRUNK | |
| | | | ||
*boolean (0 or 1) | *boolean (0 or 1) | ||
Line 410: | Line 381: | ||
|- | |- | ||
− | + | | TREE_HAS_MUSHROOM_CAP | |
| | | | ||
− | | The tree has a rounded cap-hood like a giant mushroom. This severely stunts a tree's maximum height - see the [ | + | | The tree has a rounded cap-hood like a giant mushroom. This severely stunts a tree's maximum height - see the [http://www.bay12games.com/dwarves/mantisbt/view.php?id=7313#c26413 bug report.] |
|- | |- | ||
− | + | | CAP_NAME | |
| | | | ||
*name | *name | ||
Line 421: | Line 392: | ||
|- | |- | ||
− | + | | CAP_PERIOD | |
| | | | ||
*integer | *integer | ||
Line 427: | Line 398: | ||
|- | |- | ||
− | + | | CAP_RADIUS | |
| | | | ||
*integer | *integer | ||
Line 433: | Line 404: | ||
|- | |- | ||
− | + | | STANDARD_TILE_NAMES | |
| | | | ||
| Uses the standard names for the tree components (roots, trunk, branches, etc.) | | Uses the standard names for the tree components (roots, trunk, branches, etc.) | ||
|- | |- | ||
− | + | | TREE_TILE | |
| | | | ||
*tile | *tile | ||
Line 444: | Line 415: | ||
|- | |- | ||
− | + | | DEAD_TREE_TILE | |
| | | | ||
*tile | *tile | ||
Line 450: | Line 421: | ||
|- | |- | ||
− | + | | SAPLING_TILE | |
| | | | ||
*tile | *tile | ||
Line 456: | Line 427: | ||
|- | |- | ||
− | + | | DEAD_SAPLING_TILE | |
| | | | ||
*tile | *tile | ||
Line 462: | Line 433: | ||
|- | |- | ||
− | + | | TREE_COLOR | |
| | | | ||
*foreground | *foreground | ||
Line 470: | Line 441: | ||
|- | |- | ||
− | + | | DEAD_TREE_COLOR | |
| | | | ||
*foreground | *foreground | ||
Line 478: | Line 449: | ||
|- | |- | ||
− | + | | SAPLING_COLOR | |
| | | | ||
*foreground | *foreground | ||
Line 486: | Line 457: | ||
|- | |- | ||
− | + | | DEAD_SAPLING_COLOR | |
| | | | ||
*foreground | *foreground | ||
Line 494: | Line 465: | ||
|- | |- | ||
− | + | | SAPLING_DROWN_LEVEL | |
| | | | ||
*depth | *depth | ||
− | | The | + | | The water depth at which saplings of this tree will drown. Exact behavior is unknown. Defaults to 4. |
|- | |- | ||
− | + | | TREE_DROWN_LEVEL | |
| | | | ||
*depth | *depth | ||
Line 506: | Line 477: | ||
|- | |- | ||
− | + | | 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 512: | Line 483: | ||
|} | |} | ||
− | == | + | ==Crop Tokens== |
− | These tokens are used for | + | These tokens are used only for plantable crops and harvestable shrubs. |
{| {{prettytable}} | {| {{prettytable}} | ||
Line 522: | Line 493: | ||
|- | |- | ||
− | | | + | | SPRING |
+ | | | ||
+ | | Allows the plant to grow during spring. | ||
+ | |||
+ | |- | ||
+ | | SUMMER | ||
| | | | ||
− | | Allows the plant to grow | + | | 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 | *time | ||
− | | How long the plant takes to grow | + | | 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 | *value | ||
Line 541: | Line 525: | ||
|- | |- | ||
− | + | | PICKED_TILE | |
| | | | ||
*tile | *tile | ||
− | | The tile used when | + | | 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 | *tile | ||
− | | The tile used when a plant | + | | The tile used when a harvested plant has wilted. Defaults to 169 (⌐). |
|- | |- | ||
− | + | | SHRUB_TILE | |
| | | | ||
*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 | *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 | *size | ||
− | | The maximum stack size collected when gathered via herbalism | + | | The maximum stack size collected when gathered via herbalism. Defaults to 5. |
|- | |- | ||
− | + | | PICKED_COLOR | |
| | | | ||
*foreground | *foreground | ||
*background | *background | ||
*bright | *bright | ||
− | | The color of the plant | + | | The [[color]] of the plant in farms. Defaults to 2:0:0 (dark green). |
|- | |- | ||
− | + | | DEAD_PICKED_COLOR | |
| | | | ||
*foreground | *foreground | ||
*background | *background | ||
*bright | *bright | ||
− | | The [[color]] of the plant when | + | | The [[color]] of the plant when wilted. Defaults to 0:0:1 (dark gray). |
|- | |- | ||
− | + | | SHRUB_COLOR | |
| | | | ||
*foreground | *foreground | ||
*background | *background | ||
*bright | *bright | ||
− | | The [[color]] of | + | | The [[color]] of shrubs bearing this plant. Defaults to 2:0:0 (dark green). |
|- | |- | ||
− | + | | DEAD_SHRUB_COLOR | |
| | | | ||
*foreground | *foreground | ||
*background | *background | ||
*bright | *bright | ||
− | |The [[color]] of | + | |The [[color]] of dead shrubs that bore this plant. Defaults to 6:0:0 (brown). |
|- | |- | ||
− | + | | SHRUB_DROWN_LEVEL | |
| | | | ||
*depth | *depth | ||
− | | The | + | | The water depth at which shrubs of this plant will drown. Exact behavior is unknown. Defaults to 4. |
|- | |- | ||
− | + | | DRINK | |
| | | | ||
* [[Material token|material]] | * [[Material token|material]] | ||
− | | Names a [[alcohol|drink]] made from the plant, allowing it to be used in entity resources. Previously also permitted brewing the plant into [[alcohol]] made of this material. | + | | Names a [[alcohol|drink]] made from the plant, allowing it to be used in entity resources. Previously also permitted brewing the plant into [[alcohol]] made of this material. Instead, a MATERIAL_REACTION_PRODUCT of type DRINK_MAT should be used on the proper plant material. |
|- | |- | ||
− | + | | MILL | |
| | | | ||
* [[Material token|material]] | * [[Material token|material]] | ||
− | | Permits milling the plant at a [[quern]] or [[millstone]] into a powder made of this material and allows its use in entity resources. Said material should have [POWDER_MISC_PLANT] to permit proper stockpiling | + | | Permits milling the plant at a [[quern]] or [[millstone]] into a powder made of this material and allows its use in entity resources. Said material should have [POWDER_MISC_PLANT] to permit proper stockpiling. |
|- | |- | ||
− | + | | THREAD | |
| | | | ||
* [[Material token|material]] | * [[Material token|material]] | ||
Line 627: | Line 611: | ||
|- | |- | ||
− | + | | SEED | |
| | | | ||
*name | *name | ||
Line 638: | Line 622: | ||
|- | |- | ||
− | + | | EXTRACT_STILL_VIAL | |
| | | | ||
* [[Material token|material]] | * [[Material token|material]] | ||
Line 644: | Line 628: | ||
|- | |- | ||
− | + | | EXTRACT_VIAL | |
| | | | ||
*[[Material token|material]] | *[[Material token|material]] | ||
Line 650: | Line 634: | ||
|- | |- | ||
− | + | | EXTRACT_BARREL | |
| | | | ||
* [[Material token|material]] | * [[Material token|material]] | ||
Line 657: | Line 641: | ||
|} | |} | ||
− | ==Grass | + | ==Grass Tokens== |
These tokens are used only for [[grass]]es. | These tokens are used only for [[grass]]es. | ||
Line 667: | Line 651: | ||
|- | |- | ||
− | + | | GRASS | |
| | | | ||
| Makes the plant behave as a type of grass. This allows animals to graze on it, and prevents it and its growths from being picked by herbalists. (Grass growths can still be picked in adventure mode, however.) | | Makes the plant behave as a type of grass. This allows animals to graze on it, and prevents it and its growths from being picked by herbalists. (Grass growths can still be picked in adventure mode, however.) | ||
|- | |- | ||
− | + | | GRASS_TILES | |
| | | | ||
*tile | *tile | ||
Line 681: | Line 665: | ||
|- | |- | ||
− | + | | ALT_PERIOD | |
| | | | ||
*period | *period | ||
Line 688: | Line 672: | ||
|- | |- | ||
− | + | | ALT_GRASS_TILES | |
| | | | ||
*tile | *tile | ||
Line 697: | Line 681: | ||
|- | |- | ||
− | + | | GRASS_COLORS | |
| | | | ||
*color 1 (fore:back:bright) | *color 1 (fore:back:bright) | ||
Line 708: | Line 692: | ||
{{Category|Modding}} | {{Category|Modding}} | ||
{{Category|Tokens}} | {{Category|Tokens}} | ||
− |