- 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.
Difference between revisions of "Plant token"
m (→Environment tokens: WET does not restrict, it allows (and can be combined with DRY to basically ignore the restriction), and you have to specify at least one of them or it won't grow anywhere) |
|||
Line 121: | Line 121: | ||
| {{text anchor|WET}} | | {{text anchor|WET}} | ||
| | | | ||
− | | | + | | Allows the plant to grow near natural water features. A plant with [WET] may be very common or very rare in an area, depending on how many water features that area has. Note that they will not grow next to dwarf-filled channels, since it explicitly checks the tile type (e.g. "River", "River Source", "Brook", "Murky Pool", and variants thereof). Can be combined with [DRY] to allow the plant to grow in any location, regardless of proximity to water. Plants without [WET] or [DRY] will not grow anywhere. |
|- | |- | ||
| {{text anchor|DRY}} | | {{text anchor|DRY}} | ||
− | | | + | | |
− | | Allows the plant to grow away from water features. | + | | Allows the plant to grow away from water features. Can be combined with [WET] to allow the plant to grow in any location, regardless of nearby water. Plants without [WET] or [DRY] will not grow anywhere. |
|- | |- |
Revision as of 13:44, 19 April 2024
v50.14 · v0.47.05 This article is about the current version of DF.Note that some content may still need to be updated. |
Modding |
---|
Tokens |
Audio · Biome · Graphics · Interaction · Mod info · Plant · Speech · Sphere · Syndrome · World |
Body tokens |
Body · Body detail plan · Bodygloss · Tissue |
Creature tokens |
Creature · Creature mannerism · Personality · Creature variation · Procedural graphics layer |
Descriptor tokens |
Descriptor color · Color · Descriptor pattern · Descriptor shape |
Entity tokens |
Entity · Ethic · Language · Value · Position |
Job tokens |
Building · Labor · Reaction · Skill · Unit type |
Item tokens |
Item type · Item definition · Ammo · Armor · Instrument · Tool · Trap component · Weapon |
Material tokens |
Material type · Material definition · Inorganic material definition |
The [OBJECT:PLANT]
token begins the definition of a plant raw file. Following this, each new plant definition begins with the [PLANT:plant_ID]
token, where plant_ID is a unique identifier for the plant, and that plant's properties are then defined using the tokens listed below.
Basic tokens
These tokens are specified for all plants and define their most basic characteristics.
Token | Arguments | Description |
---|---|---|
NAME |
|
The singular form of the plant's name as seen in-game. |
NAME_PLURAL |
|
The plural form of the plant's name as seen in-game. |
ADJ |
|
The word or phrase used to describe items made from this plant. |
ALL_NAMES |
|
Sets the NAME, NAME_PLURAL, and ADJ to the specified string. |
PREFSTRING |
|
What dwarves can like this object for (e.g. "Urist likes plump helmets for their rounded tops.") |
MATERIAL |
|
Starts defining a new local plant material with the given name. Must be followed with material definition tokens defining the material's properties. |
USE_MATERIAL |
|
Starts defining a new local plant material with the given name and using the properties of another local plant material. May be followed with material definition tokens to further define its properties or change the properties imported from the local plant material. |
USE_MATERIAL_TEMPLATE |
|
Starts defining a new local plant material with the name material_name and using the properties of the specified MATERIAL_TEMPLATE with the name template_name. May be followed with material definition tokens to further define its properties or change the properties imported from the template material. |
SELECT_MATERIALv51.01 |
|
Selects a previously defined local plant material for subsequent modification. Unlike with creature tokens, "ALL" cannot be specified here. |
BASIC_MAT | Sets the basic material of the plant. This defines what is harvested when the plant itself, rather than a growth, is picked. 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. The only way to remove the plant's basic material entry (e.g. "soybean plant") from every stockpile category is to remove this token, but this will cause problems with farming the plant in a farm plot and harvesting the whole wild plant if that's possible. |
Environment tokens
These tokens, also applicable to all plants, specify where the plants grow.
Token | Arguments | Description |
---|---|---|
UNDERGROUND_DEPTH |
|
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 are 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 |
|
How frequently this plant is generated in a particular area. Defaults to 50. Plants with valid biome tokens and [FREQUENCY:0] will not grow in the wild, but will still be available for entity use and farm plots. |
WET | Allows the plant to grow near natural water features. A plant with [WET] may be very common or very rare in an area, depending on how many water features that area has. Note that they will not grow next to dwarf-filled channels, since it explicitly checks the tile type (e.g. "River", "River Source", "Brook", "Murky Pool", and variants thereof). Can be combined with [DRY] to allow the plant to grow in any location, regardless of proximity to water. Plants without [WET] or [DRY] will not grow anywhere. | |
DRY | Allows the plant to grow away from water features. Can be combined with [WET] to allow the plant to grow in any location, regardless of nearby water. Plants without [WET] or [DRY] will not grow anywhere. | |
BIOME |
|
What biome this plant appears in. |
Growth tokens
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 definitions for proper stockpiling. This also lets them be collected from plant gathering and farming jobs.
Token | Arguments | Description |
---|---|---|
GROWTH |
|
Defines a plant growth. Takes the below tokens as arguments. |
SELECT_GROWTHv51.01 |
|
Selects a previously-defined plant growth. |
GROWTH_NAME |
|
The name of a plant growth. |
GROWTH_ITEM | Specifies what item this growth is and what it is made of. Generally, the item type should be PLANT_GROWTH:NONE. | |
GROWTH_HOST_TILE |
|
Specifies on which part of the plant or tree the growth appears, usually for multi-tile trees. Valid tokens are:
|
GROWTH_TRUNK_HEIGHT_PERC |
|
Controls the height on the trunk above which the growth begins to appear. The first value is the percent of the trunk height where the growth begins appearing: 0 will cause growths to appear along the entire trunk above the first tile; 100 will cause growths to appear only at the topmost trunk tile. Can be larger than 100 for trees that have growths on branches extending higher than the trunk.
The second integer currently must be -1, but might be intended to control whether it counts height starting from the bottom or top. |
GROWTH_DENSITY |
|
Currently has no effect. |
GROWTH_TIMING |
|
Specifies at which part of the year the growth appears. Default is all year round.
A single growth can only have one GROWTH_TIMING tag. If multiple are declared, the last one will be used. To make a growth appear multiple times during the year, you need to create a different growth for every GROWTH_TIMING interval. By using the same material for all of the duplicate growths, all of them will be stockpiled together and be eligible for the same reactions. Edible/brewable growths will have separate entries in the kitchen menu, though. There is no known way to declare a growth timing that lasts from winter into spring. Including numbers below 0 or above 403200 in the range will make the growth available at all times, as though you hadn't defined a growth timing at all. So will including a range for which the start time is later than the end time. This has no effect on farmed growths; all eligible growths that have [STOCKPILE_PLANT_GROWTH] in their materials will be harvested, regardless of if they are currently within their growth timing or not. |
GROWTH_PRINT |
|
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. Priority seems to control what to display when there would be multiple symbols on a tile.[Verify]
The GROWTH_PRINT tile will only be displayed when the growth in question is actually present, even if its timing parameter is ALL. |
GROWTH_HAS_SEED | The growth drops a seed if eaten raw. | |
GROWTH_DROPS_OFF | Growths drop from the plant, producing a cloud of items which fall on the ground, which herbalists can collect. | |
GROWTH_DROPS_OFF_NO_CLOUD | Growths drop collectable items from the plant without producing item clouds. |
Tree tokens
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. Setting the material to NONE will give no wood from this tree. |
TRUNK_NAME |
|
What the trunk of the tree is named. |
MAX_TRUNK_HEIGHT |
|
The maximum z-level height of a mature tree's trunk, starting from about two z-levels above ground and going up. |
MAX_TRUNK_DIAMETER |
|
Upper limit of trunk thickness, in tiles. Counted separately for all branching trunks. Has a geometric effect on log yield. |
TRUNK_PERIOD |
|
The number of years the trunk takes to grow one Z-level upward. |
TRUNK_WIDTH_PERIOD |
|
The number of years the trunk takes to grow another tile wider. |
LIGHT_BRANCHES_NAME |
|
What thin branches of the tree are named. |
BRANCH_DENSITY / LIGHT_BRANCHES_DENSITY |
|
How dense the branches grow on this tree. |
BRANCH_RADIUS / LIGHT_BRANCH_RADIUS |
|
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 values used in the game go from 0-3. Higher values than that can cause crashes. Bug:10419 |
HEAVY_BRANCHES_NAME / DIRECTED_BRANCHES_NAME |
|
What thick branches of the tree are named. |
HEAVY_BRANCH_DENSITY / DIRECTED_BRANCH_DENSITY |
|
Similar to BRANCH_DENSITY for thick branches. |
HEAVY_BRANCH_RADIUS / DIRECTED_BRANCH_RADIUS |
|
Similar as BRANCH_DENSITY for thick branches. Values outside 0-3 can cause crashes. Bug:10419 |
TRUNK_BRANCHING |
|
How much the trunk branches out. 0 makes the trunk straight. |
ROOT_NAME / ROOTS_NAME |
|
What the roots of the tree are named. |
ROOT_DENSITY |
|
Density of the root growth. |
ROOT_RADIUS |
|
How wide the roots reach out. |
TWIGS_NAME |
|
What the twigs of the tree are named. |
TWIGS_SIDE_BRANCHES |
|
Twigs appear on the side of branches. Defaults to 1. |
TWIGS_ABOVE_BRANCHES |
|
Twigs appear above branches. Defaults to 1. |
TWIGS_BELOW_BRANCHES |
|
Twigs appear below branches. Defaults to 0. |
TWIGS_SIDE_HEAVY_BRANCHES |
|
Twigs appear on the side of heavy branches. Defaults to 0. |
TWIGS_ABOVE_HEAVY_BRANCHES |
|
Twigs appear above heavy branches. Defaults to 0. |
TWIGS_BELOW_HEAVY_BRANCHES |
|
Twigs appear below heavy branches. Defaults to 0. |
TWIGS_SIDE_TRUNK |
|
Twigs appear on the side of the trunk. Defaults to 0. |
TWIGS_ABOVE_TRUNK |
|
Twigs appear above the trunk. Defaults to 0. |
TWIGS_BELOW_TRUNK |
|
Twigs appear below the trunk. Defaults to 0. |
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 bug report. | |
CAP_NAME |
|
What this mushroom-cap is called. Only makes sense with TREE_HAS_MUSHROOM_CAP. |
CAP_PERIOD |
|
Similar to the other PERIOD tags, influences the rate of the mushroom cap growth. Only makes sense with TREE_HAS_MUSHROOM_CAP. |
CAP_RADIUS |
|
The radius of a mushroom cap. Only makes sense with TREE_HAS_MUSHROOM_CAP. |
STANDARD_TILE_NAMES | Uses the standard names for the tree components (roots, trunk, branches, etc.) | |
TREE_TILE |
|
The tile used for trees of this type on the world map. Defaults to 24 (↑). |
DEAD_TREE_TILE |
|
The tile used for (un)dead trees and deciduous trees (generally in winter) of this type. Defaults to 198 (╞). |
SAPLING_TILE |
|
The tile used for saplings of this tree. Defaults to 231 (τ). |
DEAD_SAPLING_TILE |
|
The tile used for dead saplings of this tree. Defaults to 231 (τ). |
TREE_COLOR |
|
The color of the tree on the map. Defaults to 2:0:0 (dark green). |
DEAD_TREE_COLOR |
|
The color of the tree on the map when (un)dead. Defaults to 0:0:1 (dark gray). |
SAPLING_COLOR |
|
The color of saplings of this tree. Defaults to 2:0:0 (dark green). |
DEAD_SAPLING_COLOR |
|
The color of dead saplings of this tree. Defaults to 0:0:1 (dark gray). |
SAPLING_DROWN_LEVEL |
|
The sapling of this tree will drown once the water on its tile reaches this level. Defaults to 4. |
TREE_DROWN_LEVEL |
|
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]". |
Shrub tokens
These tokens are used for non-grass, non-tree plants.
Token | Arguments | Description |
---|---|---|
SPRING, SUMMER, AUTUMN, WINTER | Allows the plant to grow in farm plots during the given season.
If the plant is a surface plant, allows it to grow in the wild during this season; wild surface plants without this token will disappear at the beginning of the season. Underground plants grow wild in all seasons, regardless of their season tokens. | |
GROWDUR |
|
How long the plant takes to grow to harvest in a farm plot. Unit hundreds of ticks, See Time. There are 1008 GROWDUR units in a season. Defaults to 300. |
VALUE |
|
Has no known effect. Previously set the value of the harvested plant. |
PICKED_TILE |
|
The tile used when the plant is harvested whole, or is ready to be picked from a farm plot. May either be a cp437 tile number, or a character between single quotes. See character table. Defaults to 231 (τ). |
DEAD_PICKED_TILE |
|
The tile used when a plant harvested whole has wilted. Defaults to 169 (⌐). |
SHRUB_TILE |
|
The tile used to represent this plant when it is wild, alive, and has no growths. Defaults to 34 ("). |
DEAD_SHRUB_TILE |
|
The tile used to represent this plant when it is dead in the wild. Defaults to 34 ("). |
CLUSTERSIZE |
|
The maximum stack size collected when gathered via herbalism (possibly also from farm plots?). Defaults to 5. CLUSTERSIZE must be greater than or equal to 1+ the number of instances of [STOCKPILE_PLANT_GROWTH] in the plant's raws. For plants like vanilla cabbage, clustersize of 1, which is less than 1+[one instance]=2, will prevent citizens from gathering the plant. Best to set all cluster sizes to 2 or higher for safety. |
PICKED_COLOR |
|
The color of the plant when it has been picked whole, or when it is ready for harvest in a farm plot. Defaults to 2:0:0 (dark green). |
DEAD_PICKED_COLOR |
|
The color of the plant when it has been picked whole, but has wilted. Defaults to 0:0:1 (dark gray). |
SHRUB_COLOR |
|
The color of the plant when it is alive, wild, and has no growths. Defaults to 2:0:0 (dark green). |
DEAD_SHRUB_COLOR |
|
The color of the plant when it is dead in the wild. Defaults to 6:0:0 (brown). |
SHRUB_DROWN_LEVEL |
|
The shrub will drown once the water on its tile reaches this level. Defaults to 4. |
DRINK | Names a 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. Now, a MATERIAL_REACTION_PRODUCT of type DRINK_MAT should be used on the proper plant material. | |
MILL | 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. This token makes the whole plant harvestable regardless of which material is designated for milling. For plants with millable growths, use only MATERIAL_REACTION_PRODUCT or ITEM_REACTION_PRODUCT tokens to define the milling products. | |
THREAD | Permits processing the plant at a farmer's workshop to yield threads made of this material and allows its use in entity resources. Said material should have [THREAD_PLANT] to permit proper stockpiling. | |
SEED |
|
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. |
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
These tokens are used only for grasses.
Token | Arguments | Description |
---|---|---|
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.) | |
GRASS_TILES |
|
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 |
|
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 |
|
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 |
|
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). |