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.31: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.31"). 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| | + | {{quality|Fine|08:00, 22 May 2010 (UTC)}}{{av}} |
− | The default plants are stored in the plant_standard.txt file | + | The default plants are stored in the plant_standard.txt file. |
==Basic Tokens== | ==Basic Tokens== | ||
− | |||
− | |||
{| {{prettytable}} | {| {{prettytable}} | ||
|- style='background-color:#ddd' | |- style='background-color:#ddd' | ||
Line 10: | Line 8: | ||
! width="20%" | Arguments | ! width="20%" | Arguments | ||
! width="60%" | Description | ! width="60%" | Description | ||
+ | |- | ||
+ | | PLANT | ||
+ | | | ||
+ | *name | ||
+ | | The ID of this plant used by the game. <font color="red">Required</font>. | ||
|- | |- | ||
Line 15: | Line 18: | ||
| | | | ||
*name | *name | ||
− | | The singular form of the plants name as seen in game. | + | | The singular form of the plants name as seen in game. <font color="red">Required</font>. |
|- | |- | ||
Line 21: | Line 24: | ||
| | | | ||
*name | *name | ||
− | | The plural form of the plants name as seen in game. | + | | The plural form of the plants name as seen in game. <font color="red">Required</font>. |
|- | |- | ||
Line 30: | Line 33: | ||
|- | |- | ||
− | + | |PREFSTRING | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | | PREFSTRING | ||
| | | | ||
*reason | *reason | ||
Line 42: | Line 39: | ||
|- | |- | ||
− | | | + | | VALUE |
| | | | ||
− | * | + | *value |
− | | | + | | Value of harvested plant. |
|- | |- | ||
− | | | + | | PICKED_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]]. | |
− | | | ||
|- | |- | ||
− | | | + | | PICKED_COLOR |
| | | | ||
− | * | + | *foreground |
− | * | + | *background |
− | | | + | *bright |
+ | | The {{l|color}} of the plant in farms. | ||
|- | |- | ||
− | | | + | | SHRUB_TILE |
| | | | ||
− | * | + | *tile |
− | | | + | | What tile is used for shrubs bearing this plant. Can be either a number or a character inside apostrophes. |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
− | | | + | | DEAD_SHRUB_TILE |
| | | | ||
− | * | + | *tile |
− | + | | What tile is used when the plant has withered. Can be either a number or a character inside apostrophes. | |
− | | | ||
|- | |- | ||
− | | | + | | SHRUB_COLOR |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
| | | | ||
− | * | + | *foreground |
− | | | + | *background |
+ | *bright | ||
+ | | The [[color]] of shrubs bearing this plant. | ||
|- | |- | ||
− | | | + | | DEAD_SHRUB_COLOR |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
| | | | ||
− | * | + | *foreground |
− | | | + | *background |
+ | *bright | ||
+ | |The [[color]] of dead shrubs that bore this plant. | ||
|} | |} | ||
− | == | + | ==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}} | {| {{prettytable}} | ||
Line 131: | Line 96: | ||
! width="20%" | Arguments | ! width="20%" | Arguments | ||
! width="60%" | Description | ! width="60%" | Description | ||
+ | |- | ||
+ | | USE_MATERIAL_TEMPLATE | ||
+ | | | ||
+ | *material_name | ||
+ | *template_name | ||
+ | | 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 |
| | | | ||
− | * | + | *material_type |
− | | | + | *material name |
+ | | Sets the basic(structural) material of the plant. material_type is LOCAL_PLANT_MAT for materials defined inside 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. | ||
|- | |- | ||
− | | | + | | TREE |
| | | | ||
− | | | + | *material_type |
+ | *material_name | ||
+ | | The material to use for trees made of this plant. material_type is LOCAL_PLANT_MAT for materials defined in the plant. | ||
|- | |- | ||
− | | | + | | LEAVES |
| | | | ||
+ | *name | ||
+ | *name_plural | ||
*tile | *tile | ||
− | | The | + | *foreground |
+ | *background | ||
+ | *bright | ||
+ | *wilt_foreground | ||
+ | *wilt_background | ||
+ | *wilt_bright | ||
+ | *material_type | ||
+ | *material_name | ||
+ | | The material used by the leaves of this plant. material_type is LOCAL_PLANT_MAT for materials defined in the plant. | ||
|- | |- | ||
− | | | + | |SEED |
| | | | ||
− | * | + | *name |
− | | The | + | *name_plural |
+ | *foreground | ||
+ | *background | ||
+ | *bright | ||
+ | *material_type | ||
+ | *material_name | ||
+ | | The material used by the seeds of this plant, as well as the singular and plural forms of the name for the seeds and their color. material_type is LOCAL_PLANT_MAT for materials defined in the plant. | ||
|- | |- | ||
− | | | + | | DRINK |
| | | | ||
− | * | + | *material_type |
− | | The | + | *material_name |
+ | | The material to be used for drinks made from this plant. material_type is LOCAL_PLANT_MAT for materials defined in the plant. | ||
|- | |- | ||
− | | | + | | MILL |
| | | | ||
− | * | + | *material_type |
− | | The | + | *material_name |
+ | | The material to be used by the ground version of this plant. material_type is LOCAL_PLANT_MAT for materials defined in the plant. | ||
|- | |- | ||
− | | | + | |THREAD |
| | | | ||
− | * | + | *material_type |
− | * | + | *material_name |
− | + | | The material of threads made from this plant. material_type is LOCAL_PLANT_MAT for materials defined in the plant. | |
− | | The | ||
|- | |- | ||
− | | | + | |EXTRACT_BARREL |
| | | | ||
− | * | + | *material_type |
− | * | + | *material_name |
− | + | | The material that is used for the extract put into barrels. Should correspond to a material with the [EXTRACT_STORAGE:BARREL] token. material_type is LOCAL_PLANT_MAT for materials defined in the plant. | |
− | | The | ||
|- | |- | ||
− | | | + | | EXTRACT_VIAL |
| | | | ||
− | * | + | *material_type |
− | * | + | *material_name |
− | + | | The material that is used for the extract put into vials. Should correspond to a material with the [EXTRACT_STORAGE:FLASK] token. material_type is LOCAL_PLANT_MAT for materials defined in the plant. These are extracted at a {{L|Farmer's workshop}}, not a {{L|Still}}. | |
− | | The [ | ||
|- | |- | ||
− | | | + | | EXTRACT_STILL_VIAL |
| | | | ||
− | * | + | *material_type |
− | * | + | *material_name |
− | + | | The material that is used for the extract put into vials. Should correspond to a material with the [EXTRACT_STORAGE:FLASK] token. material_type is LOCAL_PLANT_MAT for materials defined in the plant. These are extracted at a {{L|Still}}, not a {{L|Farmer's workshop}}. | |
− | | The [ | ||
|- | |- | ||
− | | | + | | EXTRACT_STORAGE |
| | | | ||
− | * | + | *storage_type (BARREL or FLASK) |
− | | | + | | Used in material definitions, defines where the new material is stored. |
|- | |- | ||
− | | | + | | EDIBLE_VERMIN |
− | | | + | | |
− | + | | Used in material definitions, lets vermin eat this part of the plant. | |
− | | | + | |
+ | |- | ||
+ | | EDIBLE_RAW | ||
+ | | | ||
+ | | Used in material definitions, lets entities eat this part of the plant raw. Not mutually exclusive with EDIBLE_COOKED. | ||
|- | |- | ||
− | | | + | | EDIBLE_COOKED |
| | | | ||
− | | | + | | Used in material definition, allows entities to cook this part of the plant. Not mutually exclusive with EDIBLE_RAW. |
|} | |} | ||
− | == | + | ==Growing Tokens== |
− | |||
− | |||
{| {{prettytable}} | {| {{prettytable}} | ||
|- style='background-color:#ddd' | |- style='background-color:#ddd' | ||
Line 226: | Line 216: | ||
! width="20%" | Arguments | ! width="20%" | Arguments | ||
! width="60%" | Description | ! width="60%" | Description | ||
+ | |- | ||
+ | | GROWDUR | ||
+ | | | ||
+ | *time | ||
+ | | How long the plant takes to grow. See {{l|Time}}. | ||
+ | |||
+ | |- | ||
+ | | BIOME | ||
+ | | | ||
+ | *biome | ||
+ | | What {{L|biome token|biome}} this plant appears in. | ||
|- | |- | ||
| SPRING | | SPRING | ||
| | | | ||
− | | | + | | This plant may be planted and will grow in the spring. Not mutually exclusive with other season tokens. |
|- | |- | ||
| SUMMER | | SUMMER | ||
| | | | ||
− | | | + | | This plant may be planted and will grow during the summer. Not mutually exclusive with other season tokens. |
|- | |- | ||
| AUTUMN | | AUTUMN | ||
| | | | ||
− | | | + | | This plant may be planted and will grow during the autumn. Not mutually exclusive with other season tokens. |
|- | |- | ||
| WINTER | | WINTER | ||
| | | | ||
− | | | + | | This plant may be planted and will grow during the winter. Not mutually exclusive with other season tokens. |
|- | |- | ||
− | | | + | | WET |
− | | | + | | |
− | + | | This plant appears near water features. Not mutually exclusive with the DRY token. | |
− | | | ||
|- | |- | ||
− | | | + | | DRY |
− | | | + | | |
− | + | | This plant appears away from water features. Not mutually exclusive with the WET token. | |
− | | | ||
|- | |- | ||
− | | | + | | EVIL |
− | | | + | | |
− | + | | This plant appears only in evil biomes. Mutually exclusive with GOOD. | |
− | |||
|- | |- | ||
− | | | + | | GOOD |
− | | | + | | |
− | + | | This plant appears only in good biomes. Mutually exclusive with EVIL. | |
− | | | ||
|- | |- | ||
− | | | + | | SAVAGE |
− | | | + | | |
− | + | | This plant appears only in savage biomes. Not mutually exclusive with GOOD or EVIL. | |
− | | | ||
|- | |- | ||
− | | | + | | FREQUENCY |
| | | | ||
− | * | + | *freq (0-100) |
− | | | + | | How frequently shrubs of this plant are generated in a particular area. |
|- | |- | ||
Line 287: | Line 283: | ||
| | | | ||
*size | *size | ||
− | | The maximum stack size collected when gathered | + | | The maximum stack size collected when gathered or harvested. |
|- | |- | ||
− | | | + | | UNDERGROUND_DEPTH |
+ | | | ||
+ | *minimum | ||
+ | *maximum | ||
+ | | Designates the highest and lowest 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. | ||
+ | |||
+ | |} | ||
+ | |||
+ | ==Tree Tokens== | ||
+ | Trees cannot be used for seeds/food/drink/thread at this point, however, the structural material is designated in the same way. | ||
+ | Trees now appear under plant_standard instead of matgloss_wood. | ||
+ | {| {{prettytable}} | ||
+ | |- style='background-color:#ddd' | ||
+ | ! width="20%" | Token | ||
+ | ! width="20%" | Arguments | ||
+ | ! width="60%" | Description | ||
+ | |||
+ | |- | ||
+ | | AUTUMNCOLOR | ||
| | | | ||
*foreground | *foreground | ||
*background | *background | ||
*bright | *bright | ||
− | | The [[color]] | + | | The [[color]] that this tree turns in Autumn. |
|- | |- | ||
− | | | + | |TREE_TILE |
| | | | ||
− | * | + | *tile |
− | + | | The tile used for the tree on the map. May be a number or a character inside apostrophes. | |
− | |||
− | | The | ||
|- | |- | ||
− | | | + | | TREE_COLOR |
| | | | ||
*foreground | *foreground | ||
*background | *background | ||
*bright | *bright | ||
− | | The [[color]] of | + | | The [[color]] of the tree on the map. |
|- | |- | ||
− | | | + | | DEAD_TREE_COLOR |
| | | | ||
*foreground | *foreground | ||
*background | *background | ||
*bright | *bright | ||
− | |The [[color]] of dead | + | | The [[color]] of the tree on the map when dead. |
|- | |- | ||
− | | | + | | SAPLING |
− | | | + | | |
− | + | | Marks this tree as having a sapling stage(?). | |
− | | | ||
|- | |- | ||
− | | | + | | SAPLING_COLOR |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
| | | | ||
− | |||
− | |||
*foreground | *foreground | ||
*background | *background | ||
*bright | *bright | ||
− | + | | The [[color]] of the tree when it is a sapling. | |
− | |||
|- | |- | ||
− | | | + | | DEAD_SAPLING_COLOR |
| | | | ||
− | |||
− | |||
− | |||
*foreground | *foreground | ||
*background | *background | ||
*bright | *bright | ||
− | + | | The [[color]] of the tree when it is a dead sapling. | |
− | |||
− | |||
− | |||
− | | | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|} | |} | ||
==Grass Tokens== | ==Grass Tokens== | ||
− | |||
{| {{prettytable}} | {| {{prettytable}} | ||
Line 403: | Line 367: | ||
| GRASS | | GRASS | ||
| | | | ||
− | | | + | | Plant is a type of grass. |
− | |||
|- | |- | ||
| GRASS_TILES | | GRASS_TILES | ||
Line 412: | Line 375: | ||
*tile | *tile | ||
*tile | *tile | ||
− | | | + | |Tiles for a surface covered in grass. |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| ALT_GRASS_TILES | | ALT_GRASS_TILES | ||
Line 428: | Line 383: | ||
*tile | *tile | ||
*tile | *tile | ||
− | | | + | |Grass tiles will alternate between these and GRASS_TILES. Currently used for wormy tendrils and eyeballs. |
− | |||
|- | |- | ||
| GRASS_COLORS | | GRASS_COLORS | ||
| | | | ||
− | * | + | *foreground |
− | * | + | *background |
− | * | + | *bright |
− | * | + | *foreground |
− | | | + | *background |
+ | *bright | ||
+ | *foreground | ||
+ | *background | ||
+ | *bright | ||
+ | *foreground | ||
+ | *background | ||
+ | *bright | ||
+ | |Colors of grass tiles. | ||
+ | |- | ||
+ | | ALT_PERIOD | ||
+ | | | ||
+ | *number? | ||
+ | *number? | ||
+ | |How often the grass switches between alternate tiles? | ||
|} | |} | ||
+ | |||
{{Category|Modding}} | {{Category|Modding}} | ||
{{Category|Tokens}} | {{Category|Tokens}} |