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"
Jump to navigation
Jump to search
(Rating with review.js) |
|||
Line 2: | Line 2: | ||
The default plants are stored in the plant_standard.txt file. | The default plants are stored in the plant_standard.txt file. | ||
+ | ==Basic Tokens== | ||
{| {{prettytable}} | {| {{prettytable}} | ||
|- style='background-color:#ddd' | |- style='background-color:#ddd' | ||
− | ! Token | + | ! width="20%" | Token |
− | ! Description | + | ! width="20%" | Arguments |
+ | ! width="60%" | Description | ||
|- | |- | ||
− | | | + | | PLANT |
+ | | | ||
+ | *name | ||
+ | | The ID of this plant. <font color="red">Required</font>. | ||
+ | |||
|- | |- | ||
− | | | + | | NAME |
+ | | | ||
+ | *name | ||
+ | | The singular form of the plants name as seen in game. <font color="red">Required</font>. | ||
+ | |||
|- | |- | ||
− | | | + | | NAME_PLURAL |
+ | | | ||
+ | *name | ||
+ | | The plural form of the plants name as seen in game. <font color="red">Required</font>. | ||
+ | |||
|- | |- | ||
− | | | + | | ADJ |
+ | | | ||
+ | *adjective | ||
+ | | The word or phrase used to describe items made from this plant. | ||
+ | |||
|- | |- | ||
− | | | + | |PREFSTRING |
+ | | | ||
+ | *reason | ||
+ | | What dwarves can like this object for (e.g. "Urist likes plump helmets for their rounded tops.") | ||
+ | |||
|- | |- | ||
− | | | + | | 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 {{L|Tileset|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== | ||
+ | {| {{prettytable}} | ||
+ | |- style='background-color:#ddd' | ||
+ | ! width="20%" | Token | ||
+ | ! width="20%" | Arguments | ||
+ | ! 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. | ||
+ | |||
|- | |- | ||
− | | | + | | 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 | ||
+ | *num1(?) | ||
+ | *num2(?) | ||
+ | *num3(?) | ||
+ | *num4(?) | ||
+ | *num5(?) | ||
+ | *num6(?) | ||
+ | *num7(?) | ||
+ | *material_type | ||
+ | *material_name | ||
+ | | The material used by the leaves of this plant. Numbers are speculated to be colors, though there are 7 instead of 6. material_type is LOCAL_PLANT_MAT for materials defined in the plant. | ||
+ | |||
|- | |- | ||
− | | | + | |SEED |
+ | | | ||
+ | *name | ||
+ | *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 | ||
+ | *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 | ||
+ | *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 used by threads made from this plant. material_type is LOCAL_PLANT_MAT for materials defined in the plant. | ||
+ | |||
|- | |- | ||
− | | | + | |EXTRACT_BARREL |
+ | | | ||
+ | *material_type | ||
+ | *material_name | ||
+ | | The material that is used for the extract put into barrels. material_type is LOCAL_PLANT_MAT for materials defined in the plant. | ||
+ | |||
|- | |- | ||
− | | | + | | EXTRACT_STILL_VIAL |
+ | | | ||
+ | *material_type | ||
+ | *material_name | ||
+ | | The material that is used for the extract put into vials. material_type is LOCAL_PLANT_MAT for materials defined in the plant. | ||
+ | |||
|- | |- | ||
− | | | + | | EXTRACT_STORAGE |
+ | | | ||
+ | *storage_type | ||
+ | | Used in material definitions, possible values are BARREL and FLASK. | ||
+ | |||
|- | |- | ||
− | | | + | | 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}} | ||
+ | |- style='background-color:#ddd' | ||
+ | ! width="20%" | Token | ||
+ | ! width="20%" | Arguments | ||
+ | ! width="60%" | Description | ||
|- | |- | ||
− | | | + | | GROWDUR |
+ | | | ||
+ | *time | ||
+ | | How long the plant takes to grow. See {{l|Time}}. | ||
+ | |||
|- | |- | ||
− | |[ | + | | BIOME |
+ | | | ||
+ | *biome | ||
+ | | What [[biome tokens|biome]] this plant appears in. | ||
+ | |||
|- | |- | ||
− | | | + | | SPRING |
+ | | | ||
+ | | This plant may be planted and will grow in the spring. Not mutually exclusive with other season tokens. | ||
+ | |||
|- | |- | ||
− | | | + | | SUMMER |
+ | | | ||
+ | | This plant may be planted and will grow during the summer. Not mutually exclusive with other season tokens. | ||
+ | |||
|- | |- | ||
− | | | + | | AUTUMN |
+ | | | ||
+ | | This plant may be planted and will grow during the autumn. Not mutually exclusive with other season tokens. | ||
+ | |||
|- | |- | ||
− | | | + | | 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. | ||
+ | |||
|- | |- | ||
− | | | + | | FREQUENCY |
+ | | | ||
+ | *freq (0-100) | ||
+ | | The chance for this plant to be gathered with the herb gathering job. | ||
+ | |||
|- | |- | ||
− | | | + | | CLUSTERSIZE |
+ | | | ||
+ | *size | ||
+ | | 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 biome is subterranean. | |
− | + | ||
− | + | |} | |
− | + | ||
− | + | ==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 | ||
+ | *background | ||
+ | *bright | ||
+ | | 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. | ||
+ | |||
|- | |- | ||
− | |[ | + | | TREE_COLOR |
+ | | | ||
+ | *foreground | ||
+ | *background | ||
+ | *bright | ||
+ | | The [[color]] of the tree on the map. | ||
+ | |||
|- | |- | ||
− | | | + | | DEAD_TREE_COLOR |
+ | | | ||
+ | *foreground | ||
+ | *background | ||
+ | *bright | ||
+ | | The [[color]] of the tree on the map when dead. | ||
+ | |||
|- | |- | ||
− | | | + | | SAPLING |
+ | | | ||
+ | | Marks this tree as having a sapling stage(?). | ||
+ | |||
|- | |- | ||
− | |[ | + | | SAPLING_COLOR |
+ | | | ||
+ | *foreground | ||
+ | *background | ||
+ | *bright | ||
+ | | The [[color]] of the tree when it is a sapling. | ||
+ | |||
|- | |- | ||
− | |[ | + | | DEAD_SAPLING_COLOR |
+ | | | ||
+ | *foreground | ||
+ | *background | ||
+ | *bright | ||
+ | | The [[color]] of the tree when it is a dead sapling. | ||
+ | |||
|} | |} | ||
{{Category|Modding}} | {{Category|Modding}} | ||
{{Category|Tokens}} | {{Category|Tokens}} |
Revision as of 05:09, 11 June 2010
This article is about an older version of DF. |
The default plants are stored in the plant_standard.txt file.
Basic Tokens
Token | Arguments | Description |
---|---|---|
PLANT |
|
The ID of this plant. Required. |
NAME |
|
The singular form of the plants name as seen in game. Required. |
NAME_PLURAL |
|
The plural form of the plants name as seen in game. Required. |
ADJ |
|
The word or phrase used to describe items made from this plant. |
PREFSTRING |
|
What dwarves can like this object for (e.g. "Urist likes plump helmets for their rounded tops.") |
VALUE |
|
Value of harvested plant. |
PICKED_TILE |
|
The tile used when harvested. May either be a number or letter within apostrophes(confirm?).Required. See Template:L. |
PICKED_COLOR |
|
The Template:L of the plant in farms. |
SHRUB_TILE |
|
What tile is used for shrubs bearing this plant. Can be either a number or a character inside apostrophes. |
DEAD_SHRUB_TILE |
|
What tile is used when the plant has withered. Can be either a number or a character inside apostrophes. |
SHRUB_COLOR |
|
The color of shrubs bearing this plant. |
DEAD_SHRUB_COLOR |
|
The color of dead shrubs that bore this plant. |
Plant Materials
Token | Arguments | Description |
---|---|---|
USE_MATERIAL_TEMPLATE |
|
Starts defining a new local plant material with the given name using the specified template. |
BASIC_MAT |
|
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 |
|
The material to use for trees made of this plant. material_type is LOCAL_PLANT_MAT for materials defined in the plant. |
LEAVES |
|
The material used by the leaves of this plant. Numbers are speculated to be colors, though there are 7 instead of 6. material_type is LOCAL_PLANT_MAT for materials defined in the plant. |
SEED |
|
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 |
|
The material to be used for drinks made from this plant. material_type is LOCAL_PLANT_MAT for materials defined in the plant. |
MILL |
|
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 |
|
The material used by threads made from this plant. material_type is LOCAL_PLANT_MAT for materials defined in the plant. |
EXTRACT_BARREL |
|
The material that is used for the extract put into barrels. material_type is LOCAL_PLANT_MAT for materials defined in the plant. |
EXTRACT_STILL_VIAL |
|
The material that is used for the extract put into vials. material_type is LOCAL_PLANT_MAT for materials defined in the plant. |
EXTRACT_STORAGE |
|
Used in material definitions, possible values are BARREL and FLASK. |
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
Token | Arguments | Description |
---|---|---|
GROWDUR |
|
How long the plant takes to grow. See Template:L. |
BIOME |
|
What biome this plant appears in. |
SPRING | This plant may be planted and will grow in the spring. Not mutually exclusive with other season tokens. | |
SUMMER | This plant may be planted and will grow during the summer. Not mutually exclusive with other season tokens. | |
AUTUMN | This plant may be planted and will grow during the autumn. Not mutually exclusive with other season tokens. | |
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. | |
FREQUENCY |
|
The chance for this plant to be gathered with the herb gathering job. |
CLUSTERSIZE |
|
The maximum stack size collected when gathered or harvested. |
UNDERGROUND_DEPTH |
|
Designates the highest and lowest levels that the plant can appear in if its biome is subterranean. |
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.
Token | Arguments | Description |
---|---|---|
AUTUMNCOLOR |
|
The color that this tree turns in Autumn. |
TREE_TILE |
|
The tile used for the tree on the map. May be a number or a character inside apostrophes. |
TREE_COLOR |
|
The color of the tree on the map. |
DEAD_TREE_COLOR |
|
The color of the tree on the map when dead. |
SAPLING | Marks this tree as having a sapling stage(?). | |
SAPLING_COLOR |
|
The color of the tree when it is a sapling. |
DEAD_SAPLING_COLOR |
|
The color of the tree when it is a dead sapling. |