Dwarf Fortress Wiki - User contributions [en]

Plant token

2018-05-05T23:41:18Z

I2amroy: /* Growth Tokens */

{{Quality|Fine|11:40, 18 May 2015 (UTC)}}
{{av}}
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.

{| {{prettytable}}
|- style='background-color:#ddd'
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| {{text anchor|NAME}}
|
*name
| The singular form of the plant's name as seen in-game.

|-
| {{text anchor|NAME_PLURAL}}
|
*name
| The plural form of the plant's name as seen in-game.

|-
| {{text anchor|ADJ}}
|
*adjective
| The word or phrase used to describe items made from this plant.

|-
| {{text anchor|ALL_NAMES}}
|
*name
| Sets the NAME, NAME_PLURAL, and ADJ to the specified string.

|-
| {{text anchor|PREFSTRING}}
|
*reason
| What dwarves can like this object for (e.g. "Urist likes plump helmets for their rounded tops.")

|-
| {{text anchor|MATERIAL}}
|
*material_name
| Starts defining a new local plant material with the given name and '''no''' properties.

|-
| {{text anchor|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.

|-
| {{text anchor|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.

|-
| {{text anchor|BASIC_MAT}}
|
* [[Material token|material]]
| 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.

{| {{prettytable}}
|- style='background-color:#ddd'
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| {{text anchor|UNDERGROUND_DEPTH}}
|
*minimum
*maximum
| Designates the highest and lowest cavern levels that the plant can appear in if its [[biome token|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).

|-
| {{text anchor|GOOD}}
|
| Restricts the plant to growing in Good regions. Cannot be combined with [EVIL].

|-
| {{text anchor|EVIL}}
|
| Restricts the plant to growing in Evil regions. Cannot be combined with [GOOD].

|-
| {{text anchor|SAVAGE}}
|
| Restricts the plant to growing in Savage regions (regardless of alignment).

|-
| {{text anchor|FREQUENCY}}
|
*freq (0-100)
| How frequently this plant is generated in a particular area. Defaults to 50. Plants with valid [[biome token]]s and [FREQUENCY:0] will not grow in the wild, but will still be available for entity use and farm plots.

|-
| {{text anchor|WET}}
|
| Allows the plant to grow near water features.

|-
| {{text anchor|DRY}}
|
| Allows the plant to grow away from water features.

|-
| {{text anchor|BIOME}}
|
*biome
| What [[biome token|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 definition token|material definitions]] for proper stockpiling. This also lets them be collected from plant gathering and farming jobs.

{| {{prettytable}}
|- style='background-color:#ddd'
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| {{text anchor|GROWTH}}
|
*name
| Defines a plant growth. Takes the below tokens as arguments.

|-
| {{text anchor|GROWTH_NAME}}
|
*singular
*plural (STP for standard plural)
| The name of a plant growth.

|-
| {{text anchor|GROWTH_ITEM}}
|
* [[item token]]
* [[material token]]
| Specifies what item this growth is and what it is made of. Generally, the item type should be PLANT_GROWTH:NONE.

|-
| {{text anchor|GROWTH_HOST_TILE}}
|
*plant part
| Specifies on which part of the plant or tree the growth appears, usually for multi-tile [[tree]]s. Valid tokens are:
*TWIGS
*BRANCHES_AND_TWIGS / LIGHT_BRANCHES_AND_TWIGS
*BRANCHES / LIGHT_BRANCHES
*ALL_BRANCHES_AND_TWIGS
*HEAVY_BRANCHES / DIRECTED_BRANCHES
*HEAVY_BRANCHES_AND_TRUNK / DIRECTED_BRANCHES_AND_TRUNK
*TRUNK
*ROOTS
*CAP
*SAPLING

|-
| {{text anchor|GROWTH_TRUNK_HEIGHT_PERC}}
|
*integer:integer
|

|-
| {{text anchor|GROWTH_DENSITY}}
|
*integer
| Currently has no effect.

|-
| {{text anchor|GROWTH_TIMING}}
|
*[[time]] ticks (0-403200)
| 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.

|-
| {{text anchor|GROWTH_PRINT}}
|
*overworld tile
*item tile
*colour
*timing (0-403200), ALL or NONE
*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.

The GROWTH_PRINT tile will only be displayed when the growth in question is actually present, even if its timing parameter is ALL.

|-
| {{text anchor|GROWTH_HAS_SEED}}
|
| The growth drops a seed if eaten raw.

|-
| {{text anchor|GROWTH_DROPS_OFF}}
|
| Growths drop from the plant, producing a cloud of items which fall on the ground, which [[herbalist]]s can collect.
|-
| {{text anchor|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.

{| {{prettytable}}
|- style='background-color:#ddd'
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| {{text anchor|TREE}}
|
* [[Material token|material]] or NONE
| 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.

|-
| {{text anchor|TRUNK_NAME}}
|
*name
| What the trunk of the tree is named.

|-
| {{text anchor|MAX_TRUNK_HEIGHT}}
|
*1-8
| The maximum z-level height of a mature tree's trunk, starting from about two z-levels above ground and going up.

|-
| {{text anchor|MAX_TRUNK_DIAMETER}}
|
*1-3
| Upper limit of trunk thickness, in tiles. Counted separately for all branching trunks. Has a geometric effect on log yield.

|-
| {{text anchor|TRUNK_PERIOD}}
|
*integer
| The number of years the trunk takes to grow one Z-level upward.

|-
| {{text anchor|TRUNK_WIDTH_PERIOD}}
|
*integer
| The number of years the trunk takes to grow another tile wider.

|-
| {{text anchor|LIGHT_BRANCHES_NAME}}
|
*name
| What thin branches of the tree are named.

|-
| {{text anchor|BRANCH_DENSITY}} / {{text anchor|LIGHT_BRANCHES_DENSITY}}
|
*integer
| How dense the branches grow on this tree.

|-
| {{text anchor|BRANCH_RADIUS}} / {{text anchor|LIGHT_BRANCH_RADIUS}}
|
*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.

|-
| {{text anchor|HEAVY_BRANCHES_NAME}} / {{text anchor|DIRECTED_BRANCHES_NAME}}
|
*name
| What thick branches of the tree are named.

|-
| {{text anchor|HEAVY_BRANCH_DENSITY}} / {{text anchor|DIRECTED_BRANCH_DENSITY}}
|
*integer
| Similar to BRANCH_DENSITY for thick branches.

|-
| {{text anchor|HEAVY_BRANCH_RADIUS}} / {{text anchor|DIRECTED_BRANCH_RADIUS}}
|
*integer
| Similar as BRANCH_RADIUS for thick branches.

|-
| {{text anchor|TRUNK_BRANCHING}}
|
*integer
| How much the trunk branches out. 0 makes the trunk straight.

|-
| {{text anchor|ROOT_NAME}} / {{text anchor|ROOTS_NAME}}
|
*name
| What the roots of the tree are named.

|-
| {{text anchor|ROOT_DENSITY}}
|
*integer
| Density of the root growth.

|-
| {{text anchor|ROOT_RADIUS}}
|
*integer
| How wide the roots reach out.

|-
| {{text anchor|TWIGS_NAME}}
|
*name
| What the twigs of the tree are named.

|-
| {{text anchor|TWIGS_SIDE_BRANCHES}}
|
*boolean (0 or 1)
| Twigs appear on the side of branches. Defaults to 1.

|-
| {{text anchor|TWIGS_ABOVE_BRANCHES}}
|
*boolean (0 or 1)
| Twigs appear above branches. Defaults to 1.

|-
| {{text anchor|TWIGS_BELOW_BRANCHES}}
|
*boolean (0 or 1)
| Twigs appear below branches. Defaults to 0.

|-
| {{text anchor|TWIGS_SIDE_HEAVY_BRANCHES}}
|
*boolean (0 or 1)
| Twigs appear on the side of heavy branches. Defaults to 0.

|-
| {{text anchor|TWIGS_ABOVE_HEAVY_BRANCHES}}
|
*boolean (0 or 1)
| Twigs appear above heavy branches. Defaults to 0.

|-
| {{text anchor|TWIGS_BELOW_HEAVY_BRANCHES}}
|
*boolean (0 or 1)
| Twigs appear below heavy branches. Defaults to 0.

|-
| {{text anchor|TWIGS_SIDE_TRUNK}}
|
*boolean (0 or 1)
| Twigs appear on the side of the trunk. Defaults to 0.

|-
| {{text anchor|TWIGS_ABOVE_TRUNK}}
|
*boolean (0 or 1)
| Twigs appear above the trunk. Defaults to 0.

|-
| {{text anchor|TWIGS_BELOW_TRUNK}}
|
*boolean (0 or 1)
| Twigs appear below the trunk. Defaults to 0.

|-
| {{text anchor|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 [http://www.bay12games.com/dwarves/mantisbt/view.php?id=7313#c26413 bug report.]

|-
| {{text anchor|CAP_NAME}}
|
*name
| What this mushroom-cap is called. Only makes sense with TREE_HAS_MUSHROOM_CAP.

|-
| {{text anchor|CAP_PERIOD}}
|
*integer
| Similar to the other PERIOD tags, influences the rate of the mushroom cap growth. Only makes sense with TREE_HAS_MUSHROOM_CAP.

|-
| {{text anchor|CAP_RADIUS}}
|
*integer
| The radius of a mushroom cap. Only makes sense with TREE_HAS_MUSHROOM_CAP.

|-
| {{text anchor|STANDARD_TILE_NAMES}}
|
| Uses the standard names for the tree components (roots, trunk, branches, etc.)

|-
| {{text anchor|TREE_TILE}}
|
*tile
| The tile used for trees of this type on the world map. Defaults to 24 (↑).

|-
| {{text anchor|DEAD_TREE_TILE}}
|
*tile
| The tile used for (un)dead trees and deciduous trees (generally in winter) of this type. Defaults to 198 (╞).

|-
| {{text anchor|SAPLING_TILE}}
|
*tile
| The tile used for saplings of this tree. Defaults to 231 (τ).

|-
| {{text anchor|DEAD_SAPLING_TILE}}
|
*tile
| The tile used for dead saplings of this tree. Defaults to 231 (τ).

|-
| {{text anchor|TREE_COLOR}}
|
*foreground
*background
*bright
| The [[color]] of the tree on the map. Defaults to 2:0:0 (dark green).

|-
| {{text anchor|DEAD_TREE_COLOR}}
|
*foreground
*background
*bright
| The [[color]] of the tree on the map when (un)dead. Defaults to 0:0:1 (dark gray).

|-
| {{text anchor|SAPLING_COLOR}}
|
*foreground
*background
*bright
| The [[color]] of saplings of this tree. Defaults to 2:0:0 (dark green).

|-
| {{text anchor|DEAD_SAPLING_COLOR}}
|
*foreground
*background
*bright
| The [[color]] of dead saplings of this tree. Defaults to 0:0:1 (dark gray).

|-
| {{text anchor|SAPLING_DROWN_LEVEL}}
|
*depth
| The sapling of this tree will drown once the water on its tile reaches this level. Defaults to 4.

|-
| {{text anchor|TREE_DROWN_LEVEL}}
|
*depth
| The water depth at which this tree will drown. Exact behavior is unknown. Defaults to 7.

|-
| {{text anchor|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.

{| {{prettytable}}
|- style='background-color:#ddd'
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| {{text anchor|SPRING}}, {{text anchor|SUMMER}}, {{text anchor|AUTUMN}}, {{text anchor|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.

|-
| {{text anchor|GROWDUR}}
|
*time
| 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.

|-
| {{text anchor|VALUE}}
|
*value
| Has no known effect. Previously set the value of the harvested plant.

|-
| {{text anchor|PICKED_TILE}}
|
*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 [[Main:character table|character table]]. Defaults to 231 (τ).

|-
| {{text anchor|DEAD_PICKED_TILE}}
|
*tile
| The tile used when a plant harvested whole has wilted. Defaults to 169 (⌐).

|-
| {{text anchor|SHRUB_TILE}}
|
*tile
| The tile used to represent this plant when it is wild, alive, and has no growths. Defaults to 34 (").

|-
| {{text anchor|DEAD_SHRUB_TILE}}
|
*tile
| The tile used to represent this plant when it is dead in the wild. Defaults to 34 (").

|-
| {{text anchor|CLUSTERSIZE}}
|
*size
| The maximum stack size collected when gathered via herbalism (possibly also from farm plots?). Defaults to 5.

|-
| {{text anchor|PICKED_COLOR}}
|
*foreground
*background
*bright
| 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).

|-
| {{text anchor|DEAD_PICKED_COLOR}}
|
*foreground
*background
*bright
| The [[color]] of the plant when it has been picked whole, but has wilted. Defaults to 0:0:1 (dark gray).

|-
| {{text anchor|SHRUB_COLOR}}
|
*foreground
*background
*bright
| The [[color]] of the plant when it is alive, wild, and has no growths. Defaults to 2:0:0 (dark green).

|-
| {{text anchor|DEAD_SHRUB_COLOR}}
|
*foreground
*background
*bright
|The [[color]] of the plant when it is dead in the wild. Defaults to 6:0:0 (brown).

|-
| {{text anchor|SHRUB_DROWN_LEVEL}}
|
*depth
| The shrub will drown once the water on its tile reaches this level. Defaults to 4.

|-
| {{text anchor|DRINK}}
|
* [[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. Now, a MATERIAL_REACTION_PRODUCT of type DRINK_MAT should be used on the proper plant material.

|-
| {{text anchor|MILL}}
|
* [[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.

|-
| {{text anchor|THREAD}}
|
* [[Material token|material]]
| 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.

|-
| {{text anchor|SEED}}
|
*name
*name_plural
*foreground
*background
*bright
*[[Material token|material]]
| 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.

|-
| {{text anchor|EXTRACT_STILL_VIAL}}
|
* [[Material token|material]]
| Permits processing the plant into a [[vial]] at a [[still]] to yield extract made of this material. Said material should have [EXTRACT_STORAGE:FLASK].

|-
| {{text anchor|EXTRACT_VIAL}}
|
*[[Material token|material]]
| 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].

|-
| {{text anchor|EXTRACT_BARREL}}
|
* [[Material token|material]]
| 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 [[grass]]es.

{| {{prettytable}}
|- style='background-color:#ddd'
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| {{text anchor|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.)

|-
| {{text anchor|GRASS_TILES}}
|
*tile
*tile
*tile
*tile
| 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 (.,`').

|-
| {{text anchor|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 "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.

|-
| {{text anchor|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.

|-
| {{text anchor|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).
|}

{{Category|Modding}}
{{Category|Tokens}}

v0.34:Armor token

2013-04-17T01:36:38Z

I2amroy: /* Tokens */

{{Quality|Exceptional|08:43, 9 June 2010 (UTC)}}{{av}}

The tokens for all types of [[armor]] on all slots, including [[shield]]s. Usage column gives information on what types of '''armor''' the token might be restricted to.

These tokens can only be placed within an ITEM_ARMOR, ITEM_GLOVES, ITEM_SHOES, ITEM_SHIELD, ITEM_HELM, or ITEM_PANTS object definition, most do not function in weapon objects.

==Tokens==
{| {{prettytable}}
|- bgcolor="#999999"
! Token
! Arguments
! Usage
! Description

|-
| NAME
| singular:plural
| All
| What this item will be called ingame.

|-
| PREPLURAL
| <phrase> of
| ITEM_ARMOR<br />ITEM_PANTS
| Changes the plural form of this item to "<phrase of> item". Primarily pertains to the stock screens. Example, "suits of" platemail, "pairs of" trousers, etc.

|-
| MATERIAL_PLACEHOLDER
| adjective
| ITEM_ARMOR<br />ITEM_PANTS
| If the item has no material associated with it (e.g. stockpile menus and trade negotiations), this will be displayed in its place. Used for leather armor.

|-
| VALUE
| num
| ITEM_ARMOR<br />ITEM_GLOVES<br />ITEM_SHOES<br />ITEM_SHIELD<br />ITEM_HELM
| Unused. Defaults to -1.

|-
| ARMORLEVEL
|
0 - clothing<br>
1 - leather<br>
2 - chain<br>
3 - plate
| All
| What category this item falls under. Defaults to 1 for shields, 0 for everything else. Clothing-category armor is subject to [[wear]] as well as being used as every-day clothing by dwarves.

|-
| UPSTEP
| value, MAX
| ITEM_GLOVES<br />ITEM_SHOES<br />ITEM_SHIELD
| This token functions exactly like LBSTEP but in reverse. How many steps up this item protects. 'Up'is defined as "Connected through a series of one or more body parts with the [LIMB] token to an UPPERBODY part. Gloves and shoes can not protect upper or lower bodies. Example, chausses with an upstep of MAX, protect the the foot and the entire leg, but not the lower body. The same effect could be achieved (on a humanoid) with UPSTEP>=2. Since toes and fingers lack the [LIMB] token, gloves and boots do not protect them. This may be a bug.

|-
| UBSTEP
| value, MAX
| ITEM_ARMOR
| How many steps away from upper body the armor protects. Only present on torso armor. When counting steps, ignore any steps through upper or lower body parts(UBSTEP:0 items protect the upper and lower bodies as a result of this). Currently bugged{{bug|1821}}, high values of UBSTEP will result in the item protecting facial features, fingers, and toes, while leaving those parts that it can not protect unprotected (but still counting them as steps). Torso armor can not protect hands, feet, or heads (parts with [GRASP],[STANCE], or [HEAD] tokens respectively) regardless of the UBSTEP value. UBSTEP can also not protect parts that can be protected by LBSTEP. Example, torso armor with [UBSTEP:1] will protect upper arms, wings, non-[STANCE] tails, the torso, and lower body. However, a torso armor with [UBSTEP:4] or higher will also cover lower arms, fingers, facial features, and toes.

|-
| LBSTEP
| value or MAX
| ITEM_ARMOR<br />ITEM_PANTS
| How many steps down the armor protects. 'Down' is defined as "Connected through a series of one or more body parts with the [LIMB] token to a body part with the [STANCE] token. [LBSTEP] can not protect feet (parts with the [STANCE] token). When counting steps, ignore any steps through upper or lower body parts. Example, torso armor with a LBSTEP:1 will protect both the lower body and the upper legs in addition to the torso(the lower body step is not counted). Leg armor with LBSTEP:MAX will protect the lower body, the entire legs, but not the feet or toes.

|-
| METAL_ARMOR_LEVELS
|
| ITEM_ARMOR<br />ITEM_GLOVES<br />ITEM_SHOES<br />ITEM_HELM<br />ITEM_PANTS
| Metal versions of this item count as one ARMORLEVEL higher.

|-
| BLOCKCHANCE
| value
| ITEM_SHIELD
| Affects the block chance of the shield. Defaults to 10.

|-
| MATERIAL_SIZE
| value
| All
| How much material is needed to make the item. Most important with bars. The number of bars required to make the item is the value divided by three. <font color="red">Required</font>.

|-
| SOFT
|
| All but ITEM_SHIELD
| Randomly generated equipped armor will have an equal probability of being made of leather or cloth, when this token is present and [METAL] is absent. Further uses of this tag are unknown.

|-
| HARD
|
| All but ITEM_SHIELD
| Allows armor to be made of wood.

|-
| METAL
|
| All but ITEM_SHIELD
| Item can be made with metal. Randomly generated equipped armor will always be made out of metal whenever possible.

|-
| BARRED
|
| All but ITEM_SHIELD
| Can be crafted out of bone. Randomly generated equipped armor will never be made out of bone.

|-
| SCALED
|
| All but ITEM_SHIELD
| Can be crafted from shell. Randomly generated equipped armor will never be made of shell.

|-
| LEATHER
|
| All but ITEM_SHIELD
| Item can be made from leather. Randomly generated equipped armor with [LEATHER] will not be made of cloth, unless [SOFT] is also present.

|-
| SHAPED
|
| All but ITEM_SHIELD
| Only one shaped piece of clothing can be worn on a single body slot at a time.

|-
| CHAIN_METAL_TEXT
|
| All but ITEM_SHIELD
| Metal versions of this item will have "chain" added between the material and item name.

|-
| STRUCTURAL_ELASTICITY_WOVEN_THREAD
|
| All but ITEM_SHIELD
| Makes the item behave much more elastic and flexible, but only when the object is made from woven thread.

|-
| STRUCTURAL_ELASTICITY_CHAIN_METAL
|
| All but ITEM_SHIELD
| Behaves the same as STRUCTURAL_ELASTICITY_CHAIN_ALL, but only when the object is made of metal.

|-
| STRUCTURAL_ELASTICITY_CHAIN_ALL
|
| All but ITEM_SHIELD
| Seems to make blunt attacks more damaging, while blunting any attack from inferior materials. Further testing is needed.

|-
| LAYER_SIZE
| value
| All but ITEM_SHIELD
| What the size of this item in question is, when it is put on. See [[Armor]] for more on item sizes and layering. Defaults to 10.

|-
| LAYER_PERMIT
| value
| All but ITEM_SHIELD
| The maximum number of items allowed on that body slot. If the body slot's layer value is over this, no more of this item can be put on. See [[Armor]] for more on item sizes and layering. Defaults to 10.

|-
| LAYER
| UNDER, OVER, ARMOR, COVER
| All but ITEM_SHIELD
| How this item is layered. The [LAYER_PERMIT:#] of a [LAYER:ARMOR] item overrides the [LAYER_PERMIT:#] of other items on the same ITEM_<name1>, unless it is a [LAYER:COVER] items. Defaults to UNDER.

|-
| COVERAGE
| % value
| All but ITEM_SHIELD
| Coverage determines how often attacks and contaminants get through clothes. Armor with a 5% coverage value, for example, will be near useless because 95% of attacks will bypass it completely. Temperature effects are also influenced by coverage. Defaults to 100.

|}

{{Category|Modding}}
{{Category|Tokens}}

v0.34:Armor token

2013-04-17T01:36:09Z

I2amroy: /* Tokens */

{{Quality|Exceptional|08:43, 9 June 2010 (UTC)}}{{av}}

The tokens for all types of [[armor]] on all slots, including [[shield]]s. Usage column gives information on what types of '''armor''' the token might be restricted to.

These tokens can only be placed within an ITEM_ARMOR, ITEM_GLOVES, ITEM_SHOES, ITEM_SHIELD, ITEM_HELM, or ITEM_PANTS object definition, most do not function in weapon objects.

==Tokens==
{| {{prettytable}}
|- bgcolor="#999999"
! Token
! Arguments
! Usage
! Description

|-
| NAME
| singular:plural
| All
| What this item will be called ingame.

|-
| PREPLURAL
| <phrase> of
| ITEM_ARMOR<br />ITEM_PANTS
| Changes the plural form of this item to "<phrase of> item". Primarily pertains to the stock screens. Example, "suits of" platemail, "pairs of" trousers, etc.

|-
| MATERIAL_PLACEHOLDER
| adjective
| ITEM_ARMOR<br />ITEM_PANTS
| If the item has no material associated with it (e.g. stockpile menus and trade negotiations), this will be displayed in its place. Used for leather armor.

|-
| VALUE
| num
| ITEM_ARMOR<br />ITEM_GLOVES<br />ITEM_SHOES<br />ITEM_SHIELD<br />ITEM_HELM
| Unused. Defaults to -1.

|-
| ARMORLEVEL
|
0 - clothing<br>
1 - leather<br>
2 - chain<br>
3 - plate
| All
| What category this item falls under. Defaults to 1 for shields, 0 for everything else. Clothing-category armor is subject to [[wear]] as well as being used as every-day clothing by dwarves.

|-
| UPSTEP
| value, MAX
| ITEM_GLOVES<br />ITEM_SHOES<br />ITEM_SHIELD
| This token functions exactly like LBSTEP but in reverse. How many steps up this item protects. 'Up'is defined as "Connected through a series of one or more body parts with the [LIMB] token to an UPPERBODY part. Gloves and shoes can not protect upper or lower bodies. Example, chausses with an upstep of MAX, protect the the foot and the entire leg, but not the lower body. The same effect could be achieved (on a humanoid) with UPSTEP>=2. Since toes and fingers lack the [LIMB] token, gloves and boots do not protect them. This may be a bug.

|-
| UBSTEP
| value, MAX
| ITEM_ARMOR
| How many steps away from upper body the armor protects. Only present on torso armor. When counting steps, ignore any steps through upper or lower body parts(UBSTEP:0 items protect the upper and lower bodies as a result of this). Currently bugged{{bug|1821}}, high values of UBSTEP will result in the item protecting facial features, fingers, and toes, while leaving those parts that it can not protect unprotected (but still counting them as steps). Torso armor can not protect hands, feet, or heads (parts with [GRASP],[STANCE], or [HEAD] tokens respectively) regardless of the UBSTEP value. UBSTEP can also not protect parts that can be protected by LBSTEP. Example, torso armor with [UBSTEP:1] will protect upper arms, wings, non-[STANCE] tails, the torso, and lower body. However, a torso armor with [UBSTEP:4] or higher will also cover lower arms, fingers, facial features, and toes.

|-
| LBSTEP
| value or MAX
| ITEM_ARMOR<br />ITEM_PANTS
| How many steps down the armor protects. 'Down' is defined as "Connected through a series of one or more body parts with the [LIMB] token to a body part with the [STANCE] token. [LBSTEP] can not protect feet (parts with the [STANCE] token). When counting steps, ignore any steps through upper or lower body parts. Example, torso armor with a LBSTEP:1 will protect both the lower body and the upper legs in addition to the torso(the lower body step is not counted). Leg armor with LBSTEP:MAX will protect the lower body, the entire legs, but not the feet or toes.

|-
| METAL_ARMOR_LEVELS
|
| ITEM_ARMOR<br />ITEM_GLOVES<br />ITEM_SHOES<br />ITEM_HELM<br />ITEM_PANTS
| Metal versions of this item count as one ARMORLEVEL higher.

|-
| BLOCKCHANCE
| value
| ITEM_SHIELD
| Affects the block chance of the shield. Defaults to 10.

|-
| MATERIAL_SIZE
| value
| All
| How much material is needed to make the item. Most important with bars. The number of bars required to make the item is the value divided by three. <font color="red">Required</font>.

|-
| SOFT
|
| All but ITEM_SHIELD
| Randomly generated equipped armor will have an equal probability of being made of leather or cloth, when this token is present and [METAL] is absent. Further uses of this tag are unknown.

|-
| HARD
|
| All but ITEM_SHIELD
| Allows armor to be made of wood

|-
| METAL
|
| All but ITEM_SHIELD
| Item can be made with metal. Randomly generated equipped armor will always be made out of metal whenever possible.

|-
| BARRED
|
| All but ITEM_SHIELD
| Can be crafted out of bone. Randomly generated equipped armor will never be made out of bone.

|-
| SCALED
|
| All but ITEM_SHIELD
| Can be crafted from shell. Randomly generated equipped armor will never be made of shell.

|-
| LEATHER
|
| All but ITEM_SHIELD
| Item can be made from leather. Randomly generated equipped armor with [LEATHER] will not be made of cloth, unless [SOFT] is also present.

|-
| SHAPED
|
| All but ITEM_SHIELD
| Only one shaped piece of clothing can be worn on a single body slot at a time.

|-
| CHAIN_METAL_TEXT
|
| All but ITEM_SHIELD
| Metal versions of this item will have "chain" added between the material and item name.

|-
| STRUCTURAL_ELASTICITY_WOVEN_THREAD
|
| All but ITEM_SHIELD
| Makes the item behave much more elastic and flexible, but only when the object is made from woven thread.

|-
| STRUCTURAL_ELASTICITY_CHAIN_METAL
|
| All but ITEM_SHIELD
| Behaves the same as STRUCTURAL_ELASTICITY_CHAIN_ALL, but only when the object is made of metal.

|-
| STRUCTURAL_ELASTICITY_CHAIN_ALL
|
| All but ITEM_SHIELD
| Seems to make blunt attacks more damaging, while blunting any attack from inferior materials. Further testing is needed.

|-
| LAYER_SIZE
| value
| All but ITEM_SHIELD
| What the size of this item in question is, when it is put on. See [[Armor]] for more on item sizes and layering. Defaults to 10.

|-
| LAYER_PERMIT
| value
| All but ITEM_SHIELD
| The maximum number of items allowed on that body slot. If the body slot's layer value is over this, no more of this item can be put on. See [[Armor]] for more on item sizes and layering. Defaults to 10.

|-
| LAYER
| UNDER, OVER, ARMOR, COVER
| All but ITEM_SHIELD
| How this item is layered. The [LAYER_PERMIT:#] of a [LAYER:ARMOR] item overrides the [LAYER_PERMIT:#] of other items on the same ITEM_<name1>, unless it is a [LAYER:COVER] items. Defaults to UNDER.

|-
| COVERAGE
| % value
| All but ITEM_SHIELD
| Coverage determines how often attacks and contaminants get through clothes. Armor with a 5% coverage value, for example, will be near useless because 95% of attacks will bypass it completely. Temperature effects are also influenced by coverage. Defaults to 100.

|}

{{Category|Modding}}
{{Category|Tokens}}

v0.34:Animal trainer

2013-04-12T21:01:31Z

I2amroy: /* Trainable war/hunting animals */

{{quality|Exceptional|03:36, 10 January 2012 (UTC)}}
{{Skill
| color = 2:0
| skill = Animal Trainer
| profession = [[Ranger]]
| job name = [[Animal training]]
| tasks =
* Train [[dog|war animal]]
* Train [[dog|hunting animal]]
* Tame large animal
* Tame small animal
| workshop = [[Kennel]]
| attributes =
* Agility
* Toughness
* Endurance
* Intuition
* Patience
* Empathy
}}
{{av}}

'''Animal trainer''' is the skill associated with the '''animal training''' [[labor]]. An animal trainer works with [[animal]]s, either taming wild ones, or training certain species for war or hunting.

An [[Activity_zone#Animal_Training|animal training zone]] is required for all training activities.

==Domesticating wild animals==

An animal trainer is needed in order to domesticate wild animals. To do so you will need an animal captured in a [[trap#Cage_Trap|cage trap]], an animal training zone, and some plants or meat depending on whether the animal is carnivorous or herbivorous. To have your animal trainer begin taming a wild animal, use {{k|z}} to open the status screen and select the animal menu. Scroll through the list until your captured wild animal is selected and use {{k|t}} to set a trainer to tame it.

A wild animal can be trained from a cage or on the loose. The trainer will bring food to the cage. Once the animal is no longer wild, it may be released from the cage (e.g. assigned to a [[pasture]] or [[restraint]]), and further training will take place wherever the animal is. Trained animals become immune to traps. However, if the animal reverts to the wild state it will retain its trap immunity, making it quite difficult to recapture. {{Bug|6002}}

Adult trained animals will slowly revert to their wild origins over time and must have a trainer permanently assigned to them to ensure they remain friendly. Trained animals have a quality associated to their training whose full effects are not yet fully known, but seems to include the time before they revert to a wild state. The last state before an animal becomes fully wild is 'semi-wild' which prompts a game announcement. Here are the known training quality levels:

{|
! style="padding-right: 35px;" | '''Designation''' || style="text-align: left;" | '''Description'''
|-
| Semi-wild || Semi-wild
|-
| Trained || Trained
|-
| -Trained- || Well-trained
|-
| +Trained+ || Skillfully trained
|-
| *Trained* ||Expertly trained
|-
| ≡Trained≡ || Exceptionally trained
|-
| ☼Trained☼ || Masterfully trained
|-
| Domesticated || Tame
|}

Animals who are trained while young may become fully domesticated and will remain forever tame. In addition, animals who are born from a trained animal will inherit the mother's trained status, including the training quality. It appears that this added training quality, with the addition of training reinforcement by assigning a trainer, allows for the progression to domestication.

Animals born from partially tamed parents will not revert to a wild state while they are still a child. For example, if a wild female wolf is captured and trained up to the +T+ level, and gives birth, the pups may forget any training they're put under as pups, but will never go lower than Semi-Wild while they're still pups. They can, and will, revert to a wild state when they become adult wolves, though going back to a fully wild state will still take some time after they've reached adulthood.

Finally, when training animals that your civilization has never domesticated before, successful training will result in some knowledge being transferred to your civilization every time the dwarven caravan returns to the mountainhomes. The effects of these are unknown but may result in easier or faster training by animal trainers in future fortresses established by that civilization.

{|class="wikitable" style="width:80%;"
! Announcement
! Training level in {{k|z}} screen
|-
| {{Gametext|The dwarves of (civ) now know a few facts about (animal) training.|cyan}}
| {{DFtext|A few facts|red}}
|-
| {{Gametext|The dwarves of (civ) have attained a general familiarity with (animal) training methods.|cyan}}
| {{DFtext|General familiarity|yellow}}
|-
| {{Gametext|The dwarves of (civ) are now quite knowledgeable (animal) trainers.|cyan}}
| {{DFtext|Knowledgeable|white}}
|-
| {{Gametext|The dwarves of (civ) are now expert (animal) trainers.|cyan}}
| {{DFtext|Expert|cyan}}
|-
| {{Gametext|?|red}}
|{{DFtext|Domesticated|lime}}
|}

==Bonding==
As animal trainers work with an animal, they may become bonded to it ("formed a bond with an animal training partner"), and this relationship is visible in the dwarf's relationships screen. This happens even if the dwarf is not specifically assigned to the animal and regardless of training quality. The death of a bonded animal results in a bad thought for the trainer ("has lost an animal training partner to tragedy"), whose exact severity is unknown but fairly significant. It is unknown whether working with a bonded animal gives a happy thought similar to the one gained from talking to a friend.

==Training Tasks==
To train an animal for Hunting or war, you need a [[Zone#Animal_Training|training zone]] ({{k|i}}, {{k|t}}) and a dwarf with the animal training labor enabled. Then you can go to your animal status screen ({{k|z}}, {{k|Enter}}) and find there a trainable animal. Trainable animals are those where you see you can press either {{k|w}} for war training or {{k|h}} for hunting training. If you wish you can also select a particular trainer {{k|t}} to perform this task.

===Train a Hunting Animal===
Requires: An [[Cage|uncaged]] '''tame''' animal with [TRAINABLE] or [TRAINABLE_HUNTING], an 'animal training' activity zone, and an [[animal trainer]]. Note that an animal that is in a pasture can only be trained if the zone is also in the same [[pasture]].

Hunting animals can be assigned ({{K|v}}-select dwarf-{{K|p}}-{{K|e}}) to follow a hunter and assist in the hunting process. They are faster and more agile than a regular tamed animal, but not as strong as a war animal and cannot be unassigned.

===Train a War Animal===
Requires: An [[Cage|uncaged]] '''tame''' animal with [TRAINABLE] (or [TRAINABLE_WAR], although no such animals exist), an 'animal training' activity zone, and an [[animal trainer]]. [[Pasture|Pastured]] animals can only be trained if the zone is located within their pasture.

A war animal is stronger than its untrained counterpart. War dogs make excellent companions when starting a fortress, when you can't spare many dwarves for fighting.

Like hunting animals, they can also be assigned to individual dwarves; combined with their strength, this makes them effective expendable bodyguards for any dwarf likely to see danger or who you feel is valuable enough to be worth protecting. Even if they fail to defeat an attacker, they can often buy their charge time to escape or for additional reinforcements to arrive.

==Notes==

Animal tab ({{k|z}} - {{k|Enter}}) has a list of all animals that are tame (and belong to your civilization) or are caged and can be tamed. Each animal on the list can be assigned a trainer, who will then tame (if needed) the animal, increase its tameness (if not born from tamed animals) or train it for war or hunting (if selected for hunting or training). Not all animals can be trained for war or hunting. Taming or increasing tameness requires an 'Animal Training' activity zone and food (edible [[crop|plant]] for herbivores, [[meat]] for carnivores), which the trainer will bring to the animals. If a caged animal is fed a plant, [[seed]]s will stay in the cage. This has no effect on training, but if you later release the animal, you will need to [[Activity zone#Garbage Dump|dump]] the seeds from the cage before it can be reused.

Certain animals are trivial to tame ([[domestic animal]]s are well known by dwarven civilizations), some are rather easy to tame (animals from [[Cavern]]s aren't alien to dwarves). Other creatures will require more attention, at least until your fortress manages to get familiar with them. Which animals are known and how well can be checked in the second sub-tab in "Animals" tab. Badly trained animals can revert to a wild state, resulting in [[fun|dragons rampaging through the fortress]].

Only wild animals can be trained while in a cage. This means that if you want your animal trainer to provide additional lessons, you must release the trained animal. Alternatively, with a difficult to train animal or a poor trainer, you may want to leave the animal in its cage. The Animal will eventually revert back to its wild state, at which point your trainer will train it again, safely giving your trainer experience and also more knowledge about the animal if it's exotic. (this probably won't work with grazing animals, as they'd starve to death in the cage)

Sadly, [[noble]]s cannot be trained, no matter how desperately they need it.

==Trainable war/hunting animals==
The following creatures can be trained into war animals or hunting animals:
If you trade for one of these animals, and they are already tame then they will remain tame when they become yours.

{| class="wikitable sortable"
! Animal
! Size
! Notes
|-
|[[Dog]]
|30,000
|† ♪
|-
|[[Mandrill]]
|20,000
|☼ †
|-
|[[Gorilla]]
|150,000
|☼ †
|-
|[[Grizzly bear]]
|200,000
|☼
|-
|[[Polar bear]]
|400,000
|☼
|-
|[[Gigantic panda]]
|1,160,900
|‼
|-
|[[Elephant]]
|5,000,000
|‼
|-
|[[Rhinoceros]]
|3,000,000
|‼
|-
|[[Giraffe]]
|1,000,000
|‼
|-
|[[Giant bat]]
|200,000
|♪ Hunting only
|-
|[[Giant cave swallow]]
|200,000
|♪ Hunting only
|-
|[[Jabberer]]
|4,500,000
|☼
|-
|[[Cheetah]]
|50,000
|♪
|-
|[[Leopard]]
|50,000
|♪
|-
|[[Jaguar]]
|75,000
|♪
|-
|[[Lion]]
|200,000
|† ♪
|-
|[[Tiger]]
|225,000
|† ♪
|-
|[[Bobcat]]
|8,000
| Too small
|-
|[[Ocelot]]
|25,000
|?
|-
|[[Lynx]]
|25,000
|?
|-
|[[Giant bobcat]]
|256,320
|♪
|-
|[[Giant ocelot]]
|377,750
|♪
|-
|[[Giant lynx]]
|377,750
|♪
|-
|[[Giant cheetah]]
|560,000
|♪
|-
|[[Giant leopard]]
|560,000
|♪
|-
|[[Giant jaguar]]
|750,000
|♪
|-
|[[Giant lion]]
|1,700,000
|♪
|-
|[[Giant tiger]]
|1,900,000
|☼ ♪
|-
|[[Cave dragon]]
|15,000,000
|☼
|-
|[[Roc]]
|20,000,000
|☼ ♪ [[Megabeast]]
|-
|[[Dragon]]
|25,000,000
|☼ [[Megabeast]]
|}

''☼ - These animals are a good choice for your army.''<br />
''† - These animals are good choices for protecting important civilians, attacking dangerous creatures so the dwarf can escape.''<br />
''♪ - These animals are good companions for hunters and marksdwarves.''<br />
''‼ - These animals are a poor choice for training due to their voracious appetites for [[grass]].''

Remember to keep a breeding pair out of harm's way around if you want more of a particular animal, in case the ones in service somehow die.

==Tame water creatures==
It is reportedly possible to capture and tame water creatures if special care is used. But it's unknown how to butcher them.
[http://www.bay12forums.com/smf/index.php?topic=75780.0]

{{skills}}

v0.34:Freezing

2013-04-12T17:35:07Z

I2amroy: /* Creature effects */

{{quality|Fine|17:25, 27 November 2010 (UTC)}}{{av}}

== Freezing of water ==
[[Water]] in Dwarf Fortress can freeze to become ice if the temperature is low enough and the water is exposed to the air. The tile must be tagged as 'Above Ground' in order for the temperature to get low enough, as all 'Subterranean' tiles remain at a consistent [[temperature]] of {{ct|10015}}. However, inside glaciers even 'Subterranean' tiles appear to be cold enough to freeze water.

Water at level 1/7 freezes to become an ice floor.
Water at level 2/7 or greater freezes to become an ice wall. Any ice wall will return 7/7 water when melted, or can be mined for 1 boulder of ice.

This may be useful if embarking on a location with limited water and seasonal freezing, as if collecting the spring melt-water. One could expand a lake to 3.5 times the original size (if 7/7 full) so it levels to 2/7, let it freeze then thaw, then drain the expansion to a deeper cistern. If the water in the original lake is preserved at 7/7, the process may be repeated each year.

=== Creature effects ===

Creatures on a water tile that freezes into an ice wall are instantly killed. Dwarves die with the message "<dwarf name> has been encased in ice". The ice wall must be melted or mined in order to regain the items/corpses. Note that due to a bug items that are in walls that melt will still be there, but will be invisible and unviewable except through the stocks screen. These items can be recovered if the tile ever becomes accessible again (through mining after the tile refreezes or by draining the water).

=== Building effects ===

Floor hatches will disassemble if covered by an ice wall. The hatches and any associated mechanisms survive the process, but will wash away once the ice melts.

=== Melting ===
Ice can melt when the temperature rises as part of the natural cycle of seasons. Some biomes may be frozen all year round and others may never freeze. Ice can also be melted by proximity to [[magma]]. An ice tile with magma above or beneath it, or within 2 tiles on the same z-level, will cause the ice to melt (or will prevent water freezing in the first place).

== Climate ==
Freezing [[climate]]s are the coldest, and water on them is typically in permafrost. Choosing to embark in one poses an interesting challenge and offers opportunities for substantial amounts of [[losing|fun]].

=== Settling ===
One of the first challenges presented by a freezing climate is the lack of [[water]] in any conveniently drinkable form. Along with trees, water may be the hardest resource to obtain. The ice chunks left behind while digging through ice cannot be melted into drinking water. There are several ways to approach a freezing area. One of them is embarking with a [[volcano]] in site, utilizing the natural obsidian surrounding it to create [[magma-safe]] floodgates and mechanisms to effectively melt ice. Another is to penetrate to the cavern levels, which may have water in liquid form. Note that [[ice]] can be used to create buildings and workshops, which may be melted by [[magma]] or other heat sources, and constructions, which will never melt.

Remember that staying outside too long can cause your livestock and dwarves to die from exposure if the temperature is low enough, although clothes and armour may help to stave it off.

=== Cautions ===
While channeling ice and magma, supervise your miners to ensure they are not encased in cooling magma or freezing ice.

v0.34:Macros and keymaps

2013-02-08T22:48:54Z

I2amroy: /* Tuning macros */

{{Quality|Exceptional|14:18, 4 April 2011 (UTC)}}
{{av}}
Playing Dwarf Fortress means lots of typing. The game has an internal macro/keymap system. Using it or any external program can save you a great deal of time when dumping, rewalling, designating, and so forth.

== DF macros ==
=== Creating macros ===
The controls for creating macros within DF are as follows:

*{{k|Ctrl}}+{{k|r}} = record (and finish recording)
*{{k|Ctrl}}+{{k|s}} = save
*{{k|Ctrl}}+{{k|l}} = load
*{{k|Ctrl}}+{{k|u}}+number = set to repeat [number] of times
*{{k|Ctrl}}+{{k|p}} = play

To create a macro, press {{k|Ctrl}}+{{k|r}} to begin recording your actions. When you have recorded all the actions that you want, stop recording by hitting {{k|Ctrl}}+{{k|r}} again and save ({{k|Ctrl}}+{{k|s}}) the macro. The macro is then added to your macro list. To load a macro from the list just press {{k|Ctrl}}+{{k|l}}. You can then play the macro by pressing {{k|Ctrl}}+{{k|p}} whenever you want. You can also set a macro to repeat by pressing {{k|Ctrl}}+{{k|u}}, typing a two digit number, and then pressing {{k|Ctrl}}+{{k|p}} to begin the playback session. Moving your mouse from the window{{verify}}, or otherwise losing focus on DwarfFortress, is <s>an annoying way</s> a good way to interrupt a macro session from continuing (also the only known method{{verify}}).

There is a directory data/init/macros for them. The macros are saved in .mak format. Even a recorded file for a simple macro - for example to create a 3 tiles wide ramp - may already consist of up to 50 commands listed. This is because every possible [[Key_bindings|binding of the key pressed]] is included in the macro and put in a block (and {{k|r}} for ramp has many by default).
<pre>
pressing_enter_recorded
SELECT
CLOSE_MEGA_ANNOUNCEMENT
WORLD_PARAM_ENTER_VALUE
SETUPGAME_SAVE_PROFILE_GO
D_BURROWS_DEFINE
D_MILITARY_ALERTS_SET
End of group
CUSTOM_CTRL_R
End of group
End of macro
</pre>
For this example the recording was started, enter was pressed and the recording was stopped. When using this macro every underlying command in the file will be called, if possible. If you are in the designation menu, it will react as a select, the other commands will be ignored. If you are in the burrow menu, it will work like pressing enter there. The macro alway ends with a block containing the end of its recording. But executing macros seems to ignore this command. If you have changed your key bindings you'll get another result, because the underlying commands are recorded, not the keys pressed.<br />
When creating or editing your own macros it is a good idea to use only those commands you really want.
<pre>
ramping_created
DESIGNATE_RAMP
End of group
CURSOR_DOWN_Z
End of group
SELECT
End of group
CURSOR_RIGHT
End of group
CURSOR_RIGHT
End of group
SELECT
End of group
CURSOR_LEFT
End of group
CURSOR_LEFT
End of group
CURSOR_UP
End of group
End of macro
</pre>
This selfmade example will designate a 3 tiles wide ramp one z-level below and place the cursor to make the next execution of the macro continue the way down. The first line has to be the name of the file. You can see that there are grouping tags for every single keypress. These are important for a working macro.<br />
It is unknown if there is the possibility of creationg loops/iterations, other programming features or comments.<br />

Changing, removing and adding macros while the game is running uses a counter-intuitive process. After editing the file, you must delete and reload the macro. Select Options>KeyBindings>Macros. Delete the macro and reload it with {{k|Ctrl}}+{{k|l}}.

=== Tuning macros ===
The fewer commands a macro consists of, the faster it runs. This means you should avoid unnecessary steps by optimizing the "path" of your designations.

The second and most effective way to increase speed is to remove all unnecessary commands DF recorded. These may be found in the init/macros folder and edited with any basic text editing program. The extra commands are ignored by the game but they still take time to be processed. To move a cursor 3 (up/down) or 4 (right/left) commands are recorded, most other keys are bound to more commands. Pressing {{k|d}} for example records more than 30 commands.

For example the code below is a simple macro that selects the digging designation, moves one square to the right, and then designates that tile to be dug.
<pre>
example
OPTION4
CUSTOM_D
WORLD_PARAM_DELETE
LEGENDS_EXPORT_DETAILED_MAP
A_COMBAT_DODGE
A_STATUS_DESC
A_SLEEP_DAWN
A_INV_DROP
SETUP_NOTES_DELETE_NOTE
BUILDJOB_TARGET_RIGHT
BUILDJOB_BED_DORMITORY
BUILDJOB_FARM_WINTER
BUILDJOB_RACKSTAND_KILL2
HOTKEY_BUILDING_DOOR
HOTKEY_BUILDING_CONSTRUCTION_STAIR_DOWN
HOTKEY_BUILDING_WORKSHOP_DYER
BUILDING_ORIENT_RIGHT
BUILDING_ADVANCE_STAGE
BUILDING_TRIGGER_MAX_SIZE_DOWN
BUILDING_TRACK_STOP_DUMP
HOTKEY_GLASS_DOOR
HOTKEY_CARPENTER_DOOR
HOTKEY_MASON_DOOR
HOTKEY_TRAP_DOOR
BUILDJOB_STOCKPILE_DELETE_CHILD
STOCKPILE_ARMOR
STOCKPILE_SETTINGS_DISABLE
STORES_DUMP
ORDERS_DYED_CLOTH
ORDERS_ZONE_DRINKING
D_DESIGNATE
D_HAULING_STOP_LC_DIR
D_BURROWS_DELETE
D_NOTE_DELETE
D_NOTE_ROUTE_DELETE
D_BITEM_DUMP
D_LOOK_DUMP
ARENA_CREATURE_SIDE_UP
ASSIGNTRADE_SORT
DESIGNATE_DUMP
DESIGNATE_DIG
ITEM_DUMP
D_MILITARY_DISBAND_SQUAD
D_MILITARY_ALERTS_DELETE
D_MILITARY_AMMUNITION_REMOVE_ITEM
D_MILITARY_DELETE_UNIFORM
STRING_A100
End of group
STANDARDSCROLL_RIGHT
CURSOR_RIGHT
WORLD_PARAM_INCREASE
A_MOVE_E
End of group
SELECT
CLOSE_MEGA_ANNOUNCEMENT
WORLD_PARAM_ENTER_VALUE
SETUPGAME_SAVE_PROFILE_GO
D_BURROWS_DEFINE
D_MILITARY_ALERTS_SET
End of group
SELECT
CLOSE_MEGA_ANNOUNCEMENT
WORLD_PARAM_ENTER_VALUE
SETUPGAME_SAVE_PROFILE_GO
D_BURROWS_DEFINE
D_MILITARY_ALERTS_SET
End of group
CUSTOM_CTRL_R
End of group
End of macro
</pre>
Here is the same code but optimized through removal of all the excess commands. Each macro also contains an addition CUSTOM_CTRL_R command at the end that may be removed as well.
<pre>
example
DESIGNATE_DIG
End of group
CURSOR_RIGHT
End of group
SELECT
End of group
SELECT
End of group
End of macro
</pre>

The third way is to change settings in the init-files. In the base init file (data/init/init.txt) you will find the follow lines:
<pre>
If you set KEY_REPEAT_ACCEL_LIMIT above one, then after KEY_REPEAT_ACCEL_START repetitions
the repetition delay will smoothly decrease until repetition is this number of times faster
than at the start.

[KEY_REPEAT_ACCEL_LIMIT:8]
[KEY_REPEAT_ACCEL_START:10]

This controls the number of milliseconds between macro instructions.

[MACRO_MS:15]

</pre>
This means that the speed between macro commands will gradually increase until it hits the limit. The secondary command is when the gradual increase in speed increases.

== External utilities ==

=== [http://joelpt.net/quickfort/ QuickFort] ===
A spreadsheet-driven construction tool for Dwarf Fortress. Converts CSV files containing a "graphical" (or at least two-dimensional) representation of what you want to build into efficient DF macros. Comes with a number of scripts to get you started, some of them quite complex.

=== AutoHotKey ===
# Go to [[Utilities#AutoHotKey]] and download AutoHotKey. Installation is simple and the program uses few system resources.
# Write macro scripts (file type .ahk), which may contain any number of commands. You activate scripts by double-clicking .ahk files and deactivate them by right-clicking the AutoHotKey icon on the task bar. Both of these can be done at any time - even right in the middle of a game. AutoHotKey also allows for automated activation of scripts.

=== Fluxbox + xvkbd ===
For linux, it's a quite cool solution. It's possible to create macros with outside tools, like fluxbox (linux window manager) + xvkbd (linux virtual keyboard for kiosks, with some macro capabilities). See the documentation [[Fluxbox_macros|here]].

*Pros
**Faster executations
**Easier script writing
**Portable code
*Cons
**Sometime needs timing
**Need xvkbd (Linux at least)
**Need some special key reservation

:'''Please see also the [[40d:Macros and Keymaps|40d macros page]], as much of what is there works perfectly fine. If you can verify it works, please move it to this page.'''

== Useful Macro Ideas ==

The following are macro ideas that other players have found useful, and may make management of your fort easier. For most macros it's highly recommended to '''pause the game''' before hitting the play button to avoid your dwarves causing unexpected behavior, i.e. a dwarf giving birth or anything else that auto-zooms to a different location.

=== Large Bedrooms ===

Bedrooms, especially larger ones or large blocks of identical ones, involve a lot of designations and build orders. These macros are designed to streamline the process. For all of these mass-building macros you may wish to temporarily forbid any of your artifact or masterwork furniture, to avoid giving overly-valuable items to your dwarf peasantry.

==== Placing Beds ====

So you've recorded a macro to dig out a series of bedrooms, and now you have to fill them. Bring up the {{k|b}}uild menu, select {{k|b}}ed, and go the first position you want to place a bed in.

Start a new macro ({{k|Ctrl}}+{{k|r}}) and place the bed (selecting the first bed from the list), then move to the next bedroom in sequence. Repeat this until you reach the end of the row. If you are placing beds into multiple long rows of bedrooms, move the cursor to the first bed in the next row to make things faster. Turn off macro recording ({{k|Ctrl}}+{{k|r}}), but don't exit the build menu. You can then save your macro if you wish, though it's not necessary. Play the macro ({{k|Ctrl}}+{{k|p}}), and you have just laid out another row. Repeat until you have enough bedrooms or you run out of beds.

==== Placing Other Furniture ====

You can make another macro similar to the above for placing cabinets / tables / chairs / doors. Select the proper item from build menu, go to the first bedroom position wherever you want it, and repeat the record/play process above.

==== Placing Coffers ====

Placing coffers (but ''not'' bags) requires an extra step. Pause the game (you ''did'' remember to pause before playing macros, didn't you?) and go to the Stocks menu. Forbid all bags, regardless of what's inside them or what they're being used for (this is temporary). Exit to main screen and repeat the steps above, this time placing containers in your rooms. You will end up placing only chests / coffers / boxes, ignoring any bags. Repeat and play back for the rest of your bedrooms, then un-forbid your bags before un-pausing the game.

==== Resizing Rooms ====

If the bedroom is finished (at least all the beds are hauled to place), you may want to create a new macro to designate each room as a bedroom. {{k|q}}uery the building and select the first bed. Start a new macro and press {{k|r}} to designate it as a bedroom, then press + a few times to fill the available space. If you are fine with the size of the bedroom you can press enter, move on to the next bed, and repeat this for the whole row. If you want bedrooms that fill all the room and not all your bedrooms are the same size, you may have to press + a bit more or less for the larger cases. Repeat this for the rest of the rows as above.

=== Mass Selector ===

With this macro you can select a lot of things at once. Extremely helpful if you want to sell a lot of junk to the caravans. Record {{k|enter}}, then {{k|down}} about 10-25 times in a row. (For some menus you may wish to use {{k|enter}}, then {{k|+}}) When the caravan arrives, your dwarves haul all the bins to your Trade Depot for sale as normal. At the trade menu, load the macro and play it as many times as you like. The macro will select all the items in your "for sale" list, saving the bins you carried them in for later use. Be sure to at least browse through the final list once you're done to avoid selling items you didn't wish to sell, i.e. items that were in the same bin as your trade goods that you wish to keep, or wood items if you're trading with the Elves.

=== Mass Trap Builder ===

It's basically just the same as building items in bedrooms, but for traps. Useful for populating entire hallways with weapon or stone-fall traps.

=== Custom Uniforms ===

Since custom uniforms are not saved from one fortress to another, it can be tedious to remake them after each new embark. Instead, you can record a few macros to create each of your custom uniforms (Axedwarves with full armor, Wrestlers with light armor, Archers, Civilians, etc.) It is recommended to start recording each macro from the main window, before entering the (m)ilitary screen, and to avoid naming the uniform as part of the macro. Because of the way the uniform menu is set up, you should also be careful not to move the cursor back into the uniform list during the recording of your macro, or problems may arise. As always, pause the game before you start recording or playback.

=== Digging in Odd Directions/Shapes ===

While it is very simple and fast to designate mining in any of the 6 possible linear directions (North, East, South, West, Up, and Down) in very long sections, specialized mining, such as diagonal hallways, circular rooms, etc., are more difficult. It may be worth, for example, recording 4 macros that dig a short section of 3-tile wide hallway in non-standard directions (NE, NW, SW, and SE). This way, when you want a hallway dug at a 45 degree angle you just load the appropriate macro and keep playing it until the hallway is the desired length.

=== Downshafts ===

Simple up/down stairs are easy to do, but if your standard fort layout includes stairs with empty spaces around them, like so...
<pre>
(rooms)

%%..%%
%....%
(more ..XX.. (still
rooms) ..XX.. more
%....% rooms)
%%..%%

(etc...)
</pre>
...it can be cumbersome to designate all of that for multiple Z-levels at once. Instead, create a macro from one reference point (say, the top-left staircase of the 2x2 shaft or some such) and hit record, then designate the staircase area as you see fit. Move the cursor back to your reference point and move down one Z-level, then stop recording. You can now load it up and play it wherever you need it.

For added awesomeness, trim out the extra commands in a text editor as described above. Then highlight the whole macro and copy/paste it into a new file, copying the commands 5 times or as many as you want. Then save the new macro as a separate file (be sure to rename it at the top of the macro text as well). In this way you can have easy-to-use macros for digging your own standard stairwell. Separate macros for 1 level, 5 levels, and 20 levels seem to work well.

== Troubleshooting Scripts ==
Users may experience some issues in getting external scripts to work, particularly when using looping scripts when experiencing low frame-rates.
* If experiencing low frame-rates, try adding delays ("Sleep 100" to pause for 100 milliseconds for example) within macros to allow the interface to keep up. If there are nested loops, sometimes adding a pause at the end of an inner loop is all that is needed to flush the keyboard buffer.
* Another way to add delay during and after each simulated key press is to put <B>SetKeyDelay, 40, 40</B> at the start of the macro.
* Make sure that Dwarf Fortress maintains focus. IM windows are the enemy! Who needs friends anyhow? You've got Dwarf Fortress.
* This may go without saying, but most macros assume standard key-mappings. If you're using non-standard ones, you may have to edit the macro to get it to work.
* Visiting liaisons can bring up screens that eat keystrokes, throwing a long-looping script out-of-phase with where it expects the game to be. Wait for the farewell screen before running a long script, or just pause the game beforehand.
* The <B>SendPlay</B> function supports keys that the <B>Send</B> function does not, for example {{key|Shift-Enter}}. According to the AutoHotKey documentation, <B>SendPlay</B> may also be better at preventing dropped keystrokes.

=== General Fortress Mode Hotkeys Script ===
An attempt at speeding up various designations. Includes an up/down stair builder, a fast move up/down, and some select-and-advance keys. Please see [[user:DDR#Dwarf_Fortress_General_AHK_Script]].

{{av}}

v0.34:Military design

2013-01-16T21:33:51Z

I2amroy: /* Training */

{{av}}
{{Quality|Fine}}
{{Timelessness Notice}}


:''This page is one of several inter-related articles on the broader topic of defending your fortress and your dwarves. '''Military design''' focuses on the training, organization and deployment of your military and how to prepare them for any situation. For a general overview of the threats that will challenge your fortress and things to consider when preparing a standard defence, see the '''[[defense guide]]'''. For tips on laying out your architecture to protect your military, see '''[[security design]]'''. For complex traps that are not a minor/optional part of a larger defensive plan (but might be adapted or plugged into one), see '''[[trap design]]'''.

The role of a military force in fortress defense can be extremely varied depending on the player's overall approach and strategy; it can be central, non-existent, or anywhere in between. One of their advantages is their mobility — they can go where no static defenses exist, to rescue or support other dwarves, or escort a caravan through unknown or deadly threats. Only military can take the fight to the enemy (doomsday devices excepted).

Unfortunately, they are also expensive to maintain compared to static traps, and can cost a lot of resources for the [[metal]], labor, as well as food, drink and accommodation for the military. Additionally, soldiers are almost constantly under high risk in their job defending the fortress, possibly draining the fortress of some otherwise useful dwarves. Finally, the military system can take a lot of time on the player's part to set up and get working. An efficient military design can offset some of these major issues.

==Training==
One of the important parts of a military is to have dwarves with high physical [[attribute]]s and decent [[experience]] in [[combat skill]]s, and that requires training them up. See [[cross-training]] for suggestions on various attribute training plans.

The [[danger room]] method is a quick and effective way of training [[shield user]], [[dodger]], and any [[weapon]] [[skill]]s. Another very effective way of training is sending the military to actively fight captured invaders or wildlife, especially with training weapons equipped so that the combat takes longer. Certain creatures, such as [[flesh ball]]s are more suitable for combat training than others. See [[mass pitting]].

For further information on how to better improve your dwarves training, see [[training]].

===Daylight training room===
Put a [[weapon rack]], [[armor stand]] or [[archery target]] on the surface near your entrance and make it a training room by designating it as a barracks. Training dwarves will be in position if there's trouble. A major reason for training in daylight is that it also helps prevent [[cave adaptation]] in your military.

==Archery==
Archers are deadly, but vulnerable to melee — crossbows as clubs just aren't the best. Additionally, it is impractical to have archer towers every 15 tiles across the map (it is possible, but that sometimes would be tedious). Sometimes, the only option is to take it directly to the enemy. Beyond that, mixing or matching is largely up to you.

[[Fortification]]s are crucial to any archery platform, even the tallest towers. If these are built improperly or do not exist, enemy archers will return fire, causing mammoth losses to any archery squads.

===Marksdwarf training===
A couple tips/troubleshooting for training your ranged military:
* If you use archery targets, make sure you have one for each dwarf in the squad and assign each target to the squad.
* If you use live captured targets, you dwarves are most likely to shoot if they have no path to the target.
* Force your dwarves to stand next to fortifications (touching them). You can use burrows or walls for this.
* Every marksdwarf needs a quiver.
* Make plenty of ammunition and assign 100-200 bolts per dwarf to each squad, instead of the default 200 or so per squad.

==== Live targets ====
Building a [[goblin]] shooting range where live goblins are shot at can increase the speed of ranged training. The caged prisoners, obtained from [[cage trap]]s, are dropped down a shaft 4-5 z-levels down, enough to break their legs but hopefully no more. Then have your marksdwarves shoot the stunned and immobile goblins from 14-18 steps away. The further away you place your marksdwarves, the higher probability that they might miss, thereby prolonging their target practice. Remember to add a lever and a bridge to enable retrieving the goblin corpses and items, and cleaning up the mess you just made. Sometimes, it might be necessary to send in meleedwarves to finish off a goblin. Therefore, place the lever to the bridge '''outside''' the shooting range as civilian dwarves will see the goblins and run away.

╔═══════════╗ four z-levels up:
║···········║ ╔═╦═╦═╦═╦═╗
║·+·+·g·+·+·║ ║·║·║·║·║·║
║···········║ ║+║+║+║+║+║
║▼·········▼║ ║+++++++++║
║+++++++++++║ ║+++++++++║
║+++++++++++║
║+++++++++++║ ║D║
║+++++++++++║ ║+║
║+++++++++++║ Locked tunnel
║+++++++++++║ one z-level down
║+++++++++++║ ║+║
║+++++++++++║ ║+║
║+++++++++++║ ║+║
║+++++++++++║ ╔════╝D╚════╗
║···········║ ║+++++++++++║
║▼▼▼▼▼▼▼▼▼▼▼║ ║▲▲▲▲▲▲▲▲▲▲▲║
║++☺+++☺++☺+║ ╚═══════════╝
║+☺++☺++☺+++║
║+++++++++++║
╚════++═════╝
ò Lever to bridge

==Squad management==
Ordering multiple [[squads]] around can become cumbersome after a while. It's best to set most of your dwarves to follow a good regimen of training, guarding important [[burrow]]s, and patrolling routes along the fort by programming their [[scheduling|schedules]]. By preparing a number of different alerts with different schedules, you can largely manage your military by swapping a few squads to different alerts. With the majority of your squads patrolling the fort, you're free to take one or two squads of your highest-trained soldiers out to [[thief|take]] [[snatcher|care]] [[ambush|of]] [[siege|some]] [[megabeast|business]].

Keep in mind that dwarves are bloodthirsty fiends. If a [[creature]] crosses their path, no matter the odds or whether they've been ordered to stand down, your dwarves will open pursuit and attack until either it or they are dead. Keep an eye on your dwarves, and if they're going to be in combat it's a good idea to make sure there's a few highly-trained melee dwarves in the squad with them.

If trained to (near-)legendary in [[dodger|dodging]], [[fighter|fighting]] and a weapon of choice, and armored up with [[steel]] or [[adamantine|better]], one lone hero can take out several squads of goblins without a scratch. But combat always has a random element — [[losing|Fun happens]].

=== Uniforms ===

:''Note that these uniforms are designed to simply "work", but they are not the best option. See the [[armor]] article for more about this.''

Use the starter outfits in the armor article. They are maxed out protection for their material. If you ''know'' you have full suits of armor for the recruits, use replace clothes and exact matches. This lets you wear the full set without a XXCave Spider Silk RobeXX leaving your military less protected.

==== Starter Uniform ====

# Leather shirts
# Leather trousers
# Leather gloves
# Leather caps
# Leather armor
# Leather low/high boots
# Bone gauntlets
# Bone helms
# Bone greaves
# Wooden shields
# Melee weapons (non-training) or Crossbows

==== Basic Uniform ====
# Leather shirt
# Leather trousers
# Leather caps
# Leather hoods
# Leather gloves
# Leather mittens
# Leather shoes
# Cloaks (6)
# Socks
# Metal helm
# Metal mail armor
# Metal gauntlets
# Metal greaves
# Metal shield
# Metal melee weapon (non-training)

You can order your dwarves to wear more than one piece of same type, typically you would want three suits of mail armor and six cloaks. The [[Armor]] article explains these possibilities in detail.

==Strategy & Tactics==
===Roughing it===
Always have your soldiers carry food. They will each need a [[backpack]] to carry it. This keeps your soldiers from wandering off to eat. You can also have them carry [[alcohol]] or [[water]] in [[waterskin]]s or [[flask]]s, though water isn't recommended for the long term, as it makes your soldiers sluggish - always remember to keep the booze stockpiles full. For an around the clock guard, have them sleep on the ground while on duty. Hopefully the sounds of combat will wake them up before they get killed. Note that sleeping on the floor also causes unhappy [[thought]]s; if floor sleeping is included in a military design, be sure to add counteracting thoughts.

===Wait for my signal...===
When ganging up on dangerous [[creature]]s (such as [[megabeast]]s), keep them far, far away until all your units are in position, and try to ambush the target in an area with no other creatures. If your dwarves get too close, they'll smell blood and charge in, regardless of what you do to try and stop them. Getting all your units into position, pausing the game, and then turning them loose at once, can achieve the desired advantage of numbers against formidable opponents.

When under [[siege]] or other attack, keep the entire squad far back from the exit until they are all armed and armored, and ready to roll as a unit. Having a good lockable front gate will also avoid this.

==Animals==

[[Animal training|War animals]] can also be assigned to dwarves who go outside frequently, whether military or civilian. Then, when the dwarf encounters danger, the war animal runs at the danger while the dwarf runs away from it. Unfortunately, war animals are slower than dwarves with high [[attribute|agility]], and do not shadow the dwarf perfectly. Try to not assign more than one or two war animals to a dwarf; the loss of happiness from an assigned animal dying (assigned War/Hunting animals are pets) can lead to a [[tantrum|tantrum spiral]]. Also, war animals cannot be reassigned once they are assigned; to get around this, have the dwarf you want to be guarded train the animal themself.

{{Military}}

{{Category|Guides}}
{{Category|Fortress defense}}
{{Category|Design}}

v0.34:Candy

2012-11-14T05:46:23Z

I2amroy: Redirected page to Adamantine

#REDIRECT [[Adamantine]]

v0.34:Item token

2012-11-09T16:20:30Z

I2amroy:

{{av}}{{Quality|Fine}}

Item tokens are the first part in defining the target item in reactions, containing the item type and subtype. They determine the most basic form of item, and made more specific by [[material token]]s. Most item tokens use NO_SUBTYPE or NONE for subtype.

Nearly all items are made of a [[Material token|material]], though several types expect a creature ID and caste ID (e.g. [[Ant|ANT:SOLDIER]]) instead. This currently does not work correctly{{bug|4973}}.

Actually defining an item in item raws is done with [[item definition token]]s.

Note: If the subtype is NONE then the correct format is ''item token:NONE:material tokens'', not ''item token:material tokens''.

==Standard Item Tokens==

{| {{prettytable}} class="sortable"
|- bgcolor="#ddd"
! # !! Token !! Subtype !! Description
|-
| 0 || BAR || NONE || [[Bar]]s, such as [[metal]], [[fuel]], or [[soap]].
|-
| 1 || SMALLGEM || NONE || Cut [[gem]]stones usable in [[jeweler's workshop]]
|-
| 2 || BLOCKS || NONE || [[Block]]s of any kind.
|-
| 3 || ROUGH || NONE || Rough [[gem]]stones or raw [[glass]].
|-
| 4 || BOULDER / STONE || NONE || Raw mined [[stone]].
|-
| 5 || WOOD || NONE || Wooden [[log]]s.
|-
| 6 || DOOR || NONE || [[Door]]s.
|-
| 7 || FLOODGATE || NONE || [[Floodgate]]s.
|-
| 8 || BED || NONE || [[Bed]]s.
|-
| 9 || CHAIR || NONE || [[Chair]]s and thrones.
|-
| 10 || CHAIN || NONE || [[Chain]]s and [[rope]]s.
|-
| 11 || FLASK || NONE || [[Flask]]s.
|-
| 12 || GOBLET || NONE || [[Goblet]]s.
|-
| 13 || INSTRUMENT || item_instrument.txt || Musical [[instrument]]s.
|-
| 14 || TOY || item_toy.txt || [[Toy]]s.
|-
| 15 || WINDOW || NONE || Glass [[window]]s.
|-
| 16 || CAGE || NONE || [[Cage]]s.
|-
| 17 || BARREL || NONE || [[Barrel]]s.
|-
| 18 || BUCKET || NONE || [[Bucket]]s.
|-
| 19 || ANIMALTRAP || NONE || [[Animal trap]]s.
|-
| 20 || TABLE || NONE || [[Table]]s.
|-
| 21 || COFFIN || NONE || [[Coffin]]s.
|-
| 22 || STATUE || NONE || [[Statue]]s.
|-
| 23 || CORPSE || NONE || [[Corpse]]s. Does not have a material that can be specified for reactions, but GET_MATERIAL_FROM_REAGENT will return the "dominant" material.
|-
| 24 || WEAPON || item_weapon.txt || [[Weapon]]s.
|-
| 25 || ARMOR || item_armor.txt || [[Armor]] and clothing worn on the upper body.
|-
| 26 || SHOES || item_shoes.txt || Armor and clothing worn on the feet.
|-
| 27 || SHIELD || item_shield.txt || [[Shield]]s and bucklers.
|-
| 28 || HELM || item_helm.txt || Armor and clothing worn on the head.
|-
| 29 || GLOVES || item_gloves.txt || Armor and clothing worn on the hands.
|-
| 30 || BOX || NONE || [[Container|Chest]]s (wood), coffers (stone), boxes (glass, default), and bags (cloth or leather).
|-
| 31 || BIN || NONE || [[Bin]]s.
|-
| 32 || ARMORSTAND || NONE || [[Armor stand]]s.
|-
| 33 || WEAPONRACK || NONE || [[Weapon rack]]s.
|-
| 34 || CABINET || NONE || [[Cabinet]]s.
|-
| 35 || FIGURINE || NONE || [[Figurine]]s.
|-
| 36 || AMULET || NONE || [[Jewelry|Amulet]]s.
|-
| 37 || SCEPTER || NONE || [[Finished_goods#Crafts|Scepter]]s.
|-
| 38 || AMMO || item_ammo.txt || [[Ammunition]] for hand-held weapons.
|-
| 39 || CROWN || NONE || [[Jewelry|Crown]]s.
|-
| 40 || RING || NONE || [[Jewelry|Ring]]s.
|-
| 41 || EARRING || NONE || [[Jewelry|Earring]]s.
|-
| 42 || BRACELET || NONE || [[Jewelry|Bracelet]]s.
|-
| 43 || GEM || NONE || Large [[gem]]s.
|-
| 44 || ANVIL || NONE || [[Anvil]]s.
|-
| 45 || CORPSEPIECE || NONE || [[Body part]]s. Does not have a material that can be specified for reactions, but GET_MATERIAL_FROM_REAGENT will return the "dominant" material.
|-
| 46 || REMAINS || NONE || Dead [[vermin]] bodies. Material is CREATURE_ID:CASTE.
|-
| 47 || MEAT || NONE || Butchered [[meat]].
|-
| 48 || FISH || NONE || Prepared [[fish]]. Material is CREATURE_ID:CASTE.
|-
| 49 || FISH_RAW || NONE || Unprepared [[fish]]. Material is CREATURE_ID:CASTE.
|-
| 50 || VERMIN || NONE || Live [[vermin]]. Material is CREATURE_ID:CASTE.
|-
| 51 || PET || NONE || Tame [[vermin]]. Material is CREATURE_ID:CASTE.
|-
| 52 || SEEDS || NONE || [[Seed]]s from plants.
|-
| 53 || PLANT || NONE || [[Plant]]s.
|-
| 54 || SKIN_TANNED || NONE || [[Leather]].
|-
| 55 || LEAVES || NONE || Leaves, usually from [[quarry bush]]es.
|-
| 56 || THREAD || NONE || [[Thread]] gathered from webs or made at the [[farmer's workshop]].
|-
| 57 || CLOTH || NONE || [[Cloth]] made at the [[loom]].
|-
| 58 || TOTEM || NONE || Skull [[totem]]s.
|-
| 59 || PANTS || item_pants.txt || Armor and clothing worn on the legs.
|-
| 60 || BACKPACK || NONE || [[Backpack]]s.
|-
| 61 || QUIVER || NONE || [[Quiver]]s.
|-
| 62 || CATAPULTPARTS || NONE || [[Catapult]] parts.
|-
| 63 || BALLISTAPARTS || NONE || [[Ballista]] parts.
|-
| 64 || SIEGEAMMO || item_siegeammo.txt || Siege engine ammunition.
|-
| 65 || BALLISTAARROWHEAD || NONE || Ballista arrow heads.
|-
| 66 || TRAPPARTS || NONE || [[Mechanism]]s.
|-
| 67 || TRAPCOMP || item_trapcomp.txt || [[Trap component]]s.
|-
| 68 || DRINK || NONE || [[Alcohol]]ic drinks.
|-
| 69 || POWDER_MISC || NONE || Powders such as [[flour]], [[gypsum plaster]], [[dye]], or [[sand]].
|-
| 70 || CHEESE || NONE || Pieces of [[cheese]].
|-
| 71 || FOOD || item_food.txt || [[Prepared meal]]s.
|-
| 72 || LIQUID_MISC || NONE || Liquids such as [[water]], [[lye]], and extracts.
|-
| 73 || COIN || NONE || [[Coin]]s.
|-
| 74 || GLOB || NONE || [[Fat]], [[tallow]], pastes/pressed objects, and small bits of molten rock/metal.
|-
| 75 || ROCK || NONE || Small rocks (usually [[Knapper|sharpened]] and/or [[Thrower|thrown]] in [[adventurer mode]]).
|-
| 76 || PIPE_SECTION || NONE || [[Pipe section]]s.
|-
| 77 || HATCH_COVER || NONE || [[Hatch cover]]s.
|-
| 78 || GRATE || NONE || [[Grate]]s.
|-
| 79 || QUERN || NONE || [[Quern]]s.
|-
| 80 || MILLSTONE || NONE || [[Millstone]]s.
|-
| 81 || SPLINT || NONE || [[Splint]]s.
|-
| 82 || CRUTCH || NONE || [[Crutch]]es.
|-
| 83 || TRACTION_BENCH || NONE || [[Traction bench]]es.
|-
| 84 || ORTHOPEDIC_CAST || NONE || [[Cast]]s.
|-
| 85 || TOOL || item_tool.txt || [[Tool]]s.
|-
| 86 || SLAB || NONE || [[Slab]]s.
|-
| 87 || EGG || NONE || [[Egg]]s. Material is CREATURE_ID:CASTE.
|-
| 88 || BOOK || NONE || [[Book]]s.
|}

==Limited/Special Use Item Tokens==

In several specific locations, the values below can be substituted for the item type and subtype (and be followed directly by the [[material token]]).

{| {{prettytable}}
|- style='background-color:#ddd'
! Token
! Subtype
! Valid Uses
! Description

|-
| ANY_CRAFT
| NONE
| [[Reaction]] [REAGENT]
| Matches FIGURINE, AMULET, SCEPTER, CROWN, RING, EARRING, or BRACELET.

|-
| ANY_RAW_MATERIAL
| NONE
| [[Reaction]] [REAGENT]
| Matches POWDER_MISC, BAR, BOULDER, or GLOB.

|-
| CRAFTS
| NONE
| [[Reaction]] [PRODUCT]
| Produces 1-3 items of type FIGURINE, AMULET, SCEPTER, CROWN, RING, EARRING, or BRACELET.

|}

==Related Tokens==

These tokens are not Item Tokens at all, but can take the place of them in some circumstances.

{| {{prettytable}}
|- style='background-color:#ddd'
! Token
! Subtype
! Valid Uses
! Description

|-
| METAL_ORE
| Metal
| [[Reaction]] [REAGENT]
| Matches a BOULDER item made of a material having [METAL_ORE:<Metal>:###].

|}

==See Also==
*[[Material token]]
*[[Reactions]]

{{Category|Tokens}}
{{Category|Modding}}

v0.34:Creature token

2012-11-08T21:08:17Z

I2amroy: /* N */

{{av}}{{Quality|Exceptional}}

A full list of all known creature tokens.

__NOTOC__

<div align="center">
{{alphabetical TOC}}
</div>

==A==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| ADOPTS_OWNER
| Caste
|
| Tame creature cannot be made available for adoption, instead automatically adopting whoever it wants. It appears that the basic requirements for adoption are intact; for example, the creature is more likely to adopt an owner which likes creatures of that species.{{verify}}

|-
| ALCOHOL_DEPENDENT
| Caste
|
| Creature needs alcohol to get through the working day.

|-
| ALL_ACTIVE
| Caste
|
| Sets if the creature is active in day, night, and twilight. Seems to be a separate value from DIURNAL/NOCTURNAL/CREPUSCULAR, rather than implying them.

|-
| ALTTILE
| Creature
|
| If set, the creature will blink between its [TILE] and its [ALTTILE].

|-
| AMBUSHPREDATOR
| Caste
|
| Instead of charging relentlessly at prey, a creature with this tag will wait till the prey is within a few squares before charging.{{verify}}

|-
| AMPHIBIOUS
| Caste
|
| Allows a creature to breathe with or without [[water]]. Implies [AQUATIC].

|-
| APP_MOD_DESC_RANGE
| Caste
|
*Range
| [http://www.bay12forums.com/smf/index.php?topic=60554.msg1766793#msg1766793 Forum post describing how description ranges work]

|-
| APP_MOD_GENETIC_MODEL
| Caste
|
*Model (Accepts DOMINANT_MORE, DOMINANT_LESS, and MIX)
| Defines a genetic model for the relevant appearance modifier(s). May or may not do anything significant at present.

|-
| APP_MOD_IMPORTANCE
| Caste
|
*number
| Determines how important the appearance modifier is, for determining whether it shows up in the creature description.{{verify}}

|-
| APP_MOD_NOUN
| Caste
|
*noun
*SINGULAR or PLURAL
| creates a noun for the appearance and whether it is singular or plural

|-
| APP_MOD_RATE
| Caste
|
*Rate (integer)
*Scale (DAILY, YEARLY)
*min:max of growth
*start year:start day
*end year:end day
| setting the growth rate of the modifier. The last two tokens can be replaced by NO_END to have growth continue indefinitely.

|-
| APPLY_CREATURE_VARIATION
| Special
|
*CV TEMPLATE NAME
| Loads the Creature Variation Template specified.

|-
| APPLY_CURRENT_CREATURE_VARIATION
| Special
|
| Applies loaded Creature Variation

|-
| AQUATIC
| Caste
|
| Allows a creature to breathe underwater, but causes it to "drown" out of [[water]].

|-
| ARENA_RESTRICTED
| Caste
|
| Does not appear in arena mode list

|-
| ARTIFICIAL_HIVEABLE
| Creature
|
| Can be kept in artificial hives by beekeepers.

|-
| AT_PEACE_WITH_WILDLIFE
| Caste
|
| Does not attack or frighten wildlife.

|-
| ATTACK
| Caste
|
*token
*bodypart
*selection criteria
*location
| Defines the attack name, and the body part used. See [[#Attack Tokens|below]] for valid subtokens
'''Example:'''<br />
[ATTACK:GORE:BODYPART:BY_CATEGORY:HORN]<br />
''GORE'' : name of the attack<br />
''BODYPART:BY_CATEGORY:HORN'' : the horn is used to attack (presuming the creature has one)

|-
| ATTACK_TRIGGER
| Caste
| pop:exported wealth:created wealth
| Specifies when a [[megabeast]] will attack the fortress.

|}

<div align="center">
{{alphabetical TOC}}
</div>

==B==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| BABY
| Caste
| integer
| Age at which creature is considered a child. Default is zero. One can think of this as the duration of the baby stage.

|-
| BABYNAME
| Caste
| singular:plural
| Defines a new name for a creature in baby state at the caste level. For non-caste-specific baby names, see GENERAL_BABY_NAME.

|-
| BEACH_FREQUENCY
| Caste
|
| [[Whale]]s and [[Sea nettle jellyfish|jellyfish]] have this. Controls the beaching frequency of the creature.

|-
| BENIGN
| Caste
|
| The creature will only show up in "tame" biomes. Such creatures will generally avoid dwarves, although they may chase and/or attack them if they get too close, notably including [[elephant]]s.

|-
| BIOME
| Creature
|
* [[biome token]]
| Select a [[Biome]] the creature may appear in.

|-
| BLOOD
| Caste
|
* [[material token]]
*matter state (LIQUID, GAS, SOLID)
| Specifies what the creature's blood is made of.

|-
| BLOODSUCKER
| Caste
|
| Seems to be required to make the creature denouncable as a creature of the night.

|-
| BODY
| Caste
| body parts
| Draws body parts from OBJECT:BODY files (such as body_default.txt)
'''Example:'''<br />
[BODY:BODY_WITH_HEAD_FLAG:HEART:GUTS:BRAIN:MOUTH] <br />
This is the body from a [[Purring maggot]]. It creates a body with head, a heart, some guts, a brain, and a mouth. Thats all a maggot needs.

|-
| BODY_APPEARANCE_MODIFIER
| Caste
|
*ATTRIBUTE
*lowest:lower:low:median:high:higher:highest
| These body modifiers give individual creatures different characteristics. In the case of HEIGHT, BROADNESS and LENGTH, the modifier is also a percentage change to the BODY_SIZE of the individual creature. The seven numbers afterward give a distribution of ranges. Each interval has an equal chance of occurring.
'''Example:'''<br />
[BODY_APPEARANCE_MODIFIER:HEIGHT:90:95:98:100:102:105:110] <br />
''HEIGHT'' : marks the height to be changed <br />
''90:95:98:100:102:105:110'' : sets the range from the shortest (90% of the average height) to the tallest (110% of the average height) creature variation.

|-
| BODY_DETAIL_PLAN
| Caste
| PlanName, PlanName:type:type:type:etc
| loads a plan listed OBJECT:BODY_DETAIL_PLAN files, such as b_detail_plan_default.txt. Mass applies USE_MATERIAL_TEMPLATE, mass alters RELSIZE, alters body part positions, and will allow tissue layers to be defined. Tissue layers are defined in order of skin to bone here.
'''Example:'''<br />
[BODY_DETAIL_PLAN:VERTEBRATE_TISSUE_LAYERS:SKIN:FAT:MUSCLE:BONE:CARTILAGE] <br />
This creates the detailed body of a [[fox]], the skin, fat, muscle, bones and cartilage out of the vertebrate tissues.<br />
A [[Purring maggot|maggot]] would only need:<br />
''[BODY_DETAIL_PLAN:EXOSKELETON_TISSUE_LAYERS:SKIN:FAT:MUSCLE]''

|-
| BODY_SIZE
| Caste
| years:days:size
| Sets size at a given age. Size is in cubic centimeters, and for normal body materials is roughly equal to the creature's average weight in grams.
'''Example:'''<br />
[BODY_SIZE:0:0:10000]<br />
[BODY_SIZE:1:168:50000]<br />
[BODY_SIZE:12:0:220000]<br />
This describes the size of a [[minotaur]]. His birth size would be 10,000 cm<sup>3</sup> (~10 kg). At 1 year and 168 days old he would be 50,000 cm<sup>3</sup> (~50 kg). And as an adult (at 12 years old) he would be 220,000 cm<sup>3</sup> and weigh roughly 220 kg.

|-
| BODYGLOSS
| Caste
| gloss
| Substitutes body part text with replacement text. Draws gloss information from OBJECT:BODY files (such as body_default.txt)

|-
| BONECARN
| Caste
|
| Creature eats bones. Implies CARNIVORE. Civilized creatures (e.g. Kobolds) with this tag tend to die out during world generation.

|-
| BP_APPEARANCE_MODIFIER
| Caste
|
*QUALITY
*lowest:lower:low:median:high:higher:highest
| sets up the breadth of possibilities for appearance qualities for a selected BP group. EG. Eyes (CLOSE_SET, DEEP_SET, ROUND_VS_NARROW, LARGE_IRIS),Lips (THICKNESS), Nose (BROADNESS, LENGTH, UPTURNED, CONVEX), Ear (SPLAYED_OUT, HANGING_LOBES, BROADNESS, HEIGHT), Tooth (GAPS), Skull (HIGH_CHEEKBONES, BROAD_CHIN, JUTTING CHIN, SQUARE_CHIN), Neck (DEEP_VOICE, RASPY_VOICE), Head (BROADNESS, HEIGHT)

|-
| BUILDINGDESTROYER
| Caste
| 1 or 2
| Allows a creature to destroy furniture and buildings. Value [1] targets mostly doors, hatches, furniture and the like. Value [2] targets anything not made with the b + C commands.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==C==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| CAN_DO_INTERACTION
| Caste
| interaction token
| The creature can perform an interaction. See [[interaction token]].

|-
| CAN_LEARN
| Caste
|
| The creature gets skills and professions. Note that this token makes the creature unable to be butchered by an adventurer so it is not recommended for uncivilized monsters. Adventurers lacking this token can allocate but not increase attributes and skills. skills allocated will disappear on start.

|-
| CAN_SPEAK
| Caste
|
| Can talk. Note that it is not necessary for a creature to gain social skills. If a member of a civilization (such as a pet) has this token, it'll need to eat and drink.{{verify}}

|-
| CANNOT_UNDEAD
| Caste
|
| Alias for NOT_LIVING

|-
| CANOPENDOORS
| Caste
|
| Allows the creature to open doors.

|-
| CARNIVORE
| Caste
|
| Creature ''only'' eats meat. If the creature goes on rampages in worldgen, it will often devour the people/animals it kills.

|-
| CASTE
| Creature
|
*name
| defines a caste

|-
| CASTE_ALTTILE
| Caste
|
*tile number or "letter"
| Caste-specific alternate tile. Requires CASTE_TILE.

|-
| CASTE_COLOR
| Caste
|
*fg
*bg
*brightness
| Creature tile color of the caste.

|-
| CASTE_GLOWCOLOR
| Caste
|
*fg
*bg
*brightness
| GLOWTILE color of the caste.

|-
| CASTE_GLOWTILE
| Caste
|
*tile value or "letter"
| Caste-specific glowtile

|-
| CASTE_NAME
| Caste
| singular:plural:adjective
| The name of the caste of the creature in the game.

|-
| CASTE_PROFESSION_NAME
| Caste
|
*[[Unit type token]] (Profession)
*singular
*plural
| alters the name of the given profession, caste-specific

|-
| CASTE_SOLDIER_ALTTILE
| Caste
| 'character' or tile number
| Creatures of this caste active in their civilization's military will blink between their default soldier tile and this one. Requires CASTE_SOLDIER_TILE.

|-
| CASTE_SOLDIER_TILE
| Caste
| 'character' or tile number
| Creatures of this caste active in their civilization's military will use this tile instead.

|-
| CASTE_SPEECH
| Caste
| speech file?
| Possibly a caste-specific instance of the SPEECH token

|-
| CASTE_TILE
| Caste
|
* tile number or "letter"
| Caste-specific creature tile.

|-
| CAVE_ADAPT
| Caste
|
| Gives the creature a bonus in caves. Also causes [[Cave adaptation]].

|-
| CDI
| Caste
| Varies
| Specifies details for the preceding CAN_DO_INTERACTION token. See [[Interaction token]].

|-
| CHANGE_BODY_SIZE_PERC
| Caste
|
|

|-
| CHILD
| Caste
| integer
| age at which creature is considered an adult. One can think of this as the duration of the child stage. Without this token, a creature will not reproduce in Fortress mode.

|-
| CHILDNAME
| Caste
| singular:plural
| Defines a new name for a creature in child state at the caste level. For non-caste-specific child names, see GENERAL_CHILD_NAME.

|-
| CLUSTER_NUMBER
| Creature
|
*min
*max
| The minimum/maximum numbers of how many creatures per spawned cluster. Certain vermin fish use this token in combination with temperate ocean and river biome tokens to perform seasonal migrations.
e.g. [CLUSTER_NUMBER:1:3]

|-
| CLUTCH_SIZE
| Caste
|
*min
*max
|Number of eggs laid in one sitting.

|-
| COLONY_EXTERNAL
| Caste
|
| Caste hovers around colony.

|-
| COLOR
| Creature
| foreground:background:brightness
| Color of the creature's tile.

|-
| COMMON_DOMESTIC
| Caste
|
| Allows the creature to be brought with immigrants and when creating a new fortress, as long as the creature also includes at least one of the following tokens: PET, PACK_ANIMAL, WAGON_PULLER, MOUNT. In addition, the creature must be NATURAL rather than FANCIFUL

|-
| CONVERTED_SPOUSE
| Caste
|
| Creatures of this caste's species with the SPOUSE_CONVERTER and NIGHT_CREATURE_HUNTER tokens will kidnap SPOUSE_CONVERSION_TARGETs of an appropriate sex and convert them into castes with CONVERTED_SPOUSE.

|-
| COOKABLE_LIVE
| Caste
|
| Set this to allow the creature to be cooked in meals without first being butchered / fishcleaned.

|-
| CRAZED
| Caste
|
| Creature is 'berserk' and will attack all other creatures, except members of its own species that ALSO have the CRAZED tag.

|-
| COPY_TAGS_FROM
| Special
|
*CREATURE NAME
| Copies tags from another specified creature.

|-
| CREATURE_CLASS
| Caste
|
*classname
| Creature class. Can be anything, but only existing use is GENERAL_POISON. Appears to only be used for Syndromes. Supposedly can also be used for entity positions.

|-
| CREATURE_SOLDIER_TILE
| Creature
| 'character' or tile number
| Creatures active in their civilization's military will use this tile instead.

|-
| CREATURE_TILE
| Creature
| 'character' or tile number
| The symbol of the creature in ASCII mode.

|-
| CREPUSCULAR
| Caste
|
| Sets if the creature is active at twilight.

|-
| CURIOUSBEAST_EATER
| Caste
|
| Allows a creature to steal and eat edible items from a site.

|-
| CURIOUSBEAST_GUZZLER
| Caste
|
| Allows a creature to (very quickly) drink your alcohol. Or spill the barrel to the ground. Also affects undead versions of the creature.

|-
| CURIOUSBEAST_ITEM
| Caste
|
| Allows a creature to steal things (apparently the highest value it can find). If the creature goes on rampages in worldgen, it will often steal items instead of attacking.

|-
| CV_ADD_TAG
| Special
|
*TAG NAME
| Adds a tag. Used in conjunction with creature variation templates.

|-
| CV_REMOVE_TAG
| Special
|
*TAG NAME
| Removes a tag. Used in conjunction with creature variation templates.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==D==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| DEMON
| Caste
|
| Found on generated [[demon]]s. Cannot be specified in user-defined raws.

|-
| DESCRIPTION
| Caste
| text
| A brief description of the creature type.

|-
| DIE_WHEN_VERMIN_BITE
| Caste
|
| Dies upon attacking. Used for bee stings.

|-
| DIFFICULTY
| Caste
| integer
| Toady: "Difficulty determines how deep it places them in adventure mode/reclaim caves, and the chance that they are wounded the first few river attacks." (Outdated? This particular quote referred to version .23a) Also increases experience gain during adventure mode.

|-
| DIURNAL
| Caste
|
| Sets if the creature is active in day.

|-
| DIVE_HUNTS_VERMIN
| Caste
|
| Found on [[peregrine falcon]]s. The creature hunts vermin by diving from the air. May be bugged due to fortress pets remaining earthbound.

|-
| DOES_NOT_EXIST
| Creature
|
| Creature does not actually exist; used for fanciful creatures.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==E==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| EBO_ITEM
| Caste
| [[item token]]:[[material token]] (ANY_HARD_STONE can be used for the material)
| Defines the item that the creature drops upon being butchered. Used with EXTRA_BUTCHER_OBJECT.

|-
| EBO_SHAPE
| Caste
| gem shape
| The shape of the extra item of the creature upon butchering. Used with EXTRA_BUTCHER_OBJECT.

|-
| EGG_MATERIAL
| Caste
|
* [[material token]]
*state (SOLID, LIQUID, or GAS)
| Egg material. Egg-laying creatures will define this 3 times, using LOCAL_CREATURE_MAT:EGGSHELL, LOCAL_CREATURE_MAT:EGG_WHITE, and then LOCAL_CREATURE_MAT:EGG_YOLK. Eggs will be made out of eggshell. Edibility is determined by tags on whites or yolk, but they otherwise do not exist.

|-
| EGG_SIZE
| Caste
|
*size
| Determines the size of eggs.

|-
| EQUIPMENT_WAGON
| Creature
|
| Makes the creature into a large 3x3 creature responsible for carrying trade goods, pulled by two [WAGON_PULLER]s and driven by a merchant.

|-
| EQUIPS
| Caste
|
| Allows the creature to wear or wield items.

|-
| EVIL
| Creature
|
| Creature is considered evil and will only show up in evil biomes. Has no effect on cavern creatures.

|-
| EXTRA_BUTCHER_OBJECT
| Caste
|
* BY_CATEGORY, BY_TYPE, BY_TOKEN
* TYPE, CATEGORY, or TOKEN
| The creature drops an additional object when butchered (typically a gizzard stone), defined by EBO_ITEM and EBO_SHAPE.

|-
| EXTRACT
| Caste
|
* [[material token]]
| Defines a creature extract which can be obtained via [[small animal dissection]].

|-
| EXTRAVISION
| Caste
|
| Creature can see regardless of whether it has working eyes.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==F==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| FANCIFUL
| Creature
|
| Makes every civilization know about the creature. The creature won't occur in regular material preference lists. The tag also adds some art value modifiers. Used for things like dragons and other legendary creatures. Conflicts with [COMMON_DOMESTIC]

|-
| FEATURE_ATTACK_GROUP
| Caste
|
| Found on subterranean animalmen.

|-
| FEATURE_BEAST
| Caste
|
| Found on [[forgotten beast]]s. Cannot be specified in user-defined raws.

|-
| FEMALE
| Caste
|
| Inside a female caste, sets femaleness. Outside of a caste, sets all individuals female unless overridden by caste.

|-
| FIREIMMUNE
| Caste
|
| Renders a creature immune to being damaged by FIREBREATH's short range cone attack.

|-
| FIREIMMUNE_SUPER
| Caste
|
| The creature is immune to DRAGONFIREBREATH. Implies FIREIMMUNE.

|-
| FISHITEM
| Caste
|
| Needs to be cleaned at a fishery

|-
| FIXED_TEMP
| Caste
| temperature
| The natural heat generated by the creature.

|-
| FLEEQUICK
| Caste
|
| Determines how soon a creature flees in a losing battle. Creatures with this tag will flee at the first sign of resistance.

|-
| FLIER
| Caste
|
| Allows a creature to fly. Fortress Mode pathfinding only partially incorporates pathfinding - flying dwarves need a land path to exist between them and an area in order to access it, but as long as one such path exists, they do not need to use it, instead being able to fly over intervening obstacles.

|-
| FREQUENCY
| Creature
|
*number, max 100
| Determines the chances of a creature appearing within its environment, with higher values resulting in more frequent appearance. The game effectively considers all creatures that can possibly appear and uses the FREQUENCY value as a ''weight'' - for example, if there are three creatures with frequencies 10/25/50, the creature with [FREQUENCY:50] will appear approximately 58.8% of the time. Defaults to 50 if not specified. Not to be confused with POP_RATIO.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==G==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| GENERAL_BABY_NAME
| Creature
| singular:plural
| name at creature level

|-
| GENERAL_CHILD_NAME
| Creature
| singular:plural
| name at creature level

|-
| GENERAL_MATERIAL_FORCE_MULTIPLIER
| Caste
| A:B
| Attacks against the creature have their force modified by A/B. For example, 1:2 will halve the force of an attack made against the creature. {{verify}}

|-
| GENERATED
| Creature
|
| Found on procedurally generated creatures like [[Forgotten beast]]s, (biome name) [[titan]]s, [[Demon]]s, and [[night creature]]s. Cannot be specified in user-defined raws.

|-
| GETS_INFECTIONS_FROM_ROT
| Caste
|
| Creature can get infections from necrotic tissue.

|-
| GETS_WOUND_INFECTIONS
| Caste
|
| Creature's wounds can become infected.

|-
| GLOWCOLOR
| Creature
|
*foreground
*background
*brightness
| The colour of the GLOWTILE of the creature.

|-
| GLOWTILE
| Creature
| ascii character
| If present, the being glows in the dark (generally used for Adventure Mode). The tile is what replaces the being's current tile when it is obscured from your sight by darkness. The default setting for kobolds (a yellow quotation mark) provides a nice "glowing eyes" effect. The game is also hardcoded to automatically convert quotation mark GLOWTILES into apostrophes if the creature has lost one eye. This works at the generic creature level - for caste-specific glow tiles, use CASTE_GLOWTILE instead.

|-
| GNAWER
| Caste
| verb
| The creature can and will gnaw its way out of [[animal trap]]s and [[cage]]s using the specified verb, depending on the material from which it is made. Due to a bug, however, they will only escape from [[artifact]]s.{{bug|6117}}

|-
| GOBBLE_VERMIN_CLASS
| Caste
| class
| The creature eats vermin of the specified class.

|-
| GOBBLE_VERMIN_CREATURE
| Caste
| creature:caste
| The creature eats a specified vermin.

|-
| GO_TO_END
| Special
|
| When using tags from an existing creature, inserts new tags at the end of the creature.

|-
| GO_TO_START
| Special
|
| When using tags from an existing creature, inserts new tags at the beginning of the creature.

|-
| GO_TO_TAG
| Special
|
| When using tags from an existing creature, inserts new tags after the specified tag.

|-
| GOOD
| Creature
|
| Creature is considered good and will only show up in good biomes, for example [[unicorn]]s. Presumably has no effect on cavern creatures.

|-
| GRASSTRAMPLE
| Caste
| value
| The value determines how rapidly grass is trampled when a creature steps on it - a value of 0 causes the creature to never damage grass, while a value of 100 causes grass to be trampled as rapidly as possible. Defaults to 5.

|-
| GRAVITATE_BODY_SIZE
| Caste
| target value
| Used in Creature Variants. This token changes the adult body size to the average of the old adult body size and the target value and scales all intermediate growth stages by the same factor.

|-
| GRAZER
| Caste
|
*number
| Animals is a grazer. The higher the number, the less frequently it needs to eat in order to survive.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==H==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| HABIT
| Caste
| type:probability
| Defines certain behaviors for the creature. The habit types are COLLECT_TROPHIES, COOK_PEOPLE, COOK_VERMIN, GRIND_VERMIN, COOK_BLOOD, GRIND_BONE_MEAL, EAT_BONE_PORRIDGE, USE_ANY_MELEE_WEAPON, GIANT_NEST, and COLLECT_WEALTH. These may require the creature to have a lair to work properly.

|-
| HABIT_NUM
| Caste
| number or TEST_ALL
| "If you set HABIT_NUM to a number, it should give you that exact number of habits according to the weights.".<sup>[[http://www.bay12forums.com/smf/index.php?topic=60554.msg1719248#msg1719248 source post]]</sup> All lists of HABITs are preceded by [HABIT_NUM:TEST_ALL]

|-
| HAS_NERVES
| Caste
|
| This makes the creature susceptible to severed motor and sensory nerves when muscles are torn in limb, grasp and stance parts. Some butchering yields nervous tissue.

|-
| HASSHELL
| Caste
|
| The creature has a shell. Seemingly no longer used - holdover from previous versions.

|-
| HIVE_PRODUCT
| Creature
|
*number
*[[time]]
*[[item token]]s
| What product is harvested from [[Beekeeping industry|beekeeping]].

|-
| HOMEOTHERM
| Caste
|
| Default 'NONE'. The creature's normal body [[temperature]]

|-
| HUNTS_VERMIN
| Caste
|
| Creature hunts and kills nearby vermin.

|}

<div align="center">
{{alphabetical TOC}}
</div>

==I==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| IMMOBILE
| Caste
|
| The creature cannot move. Found on [[sponge]]s. Will also stop a creature from breeding in Fortress Mode (MALE and FEMALE are effected, if one is IMMOBILE no breeding will happen)

|-
| IMMOBILE_LAND
| Caste
|
| The creature is immobile while on land. Only works on AQUATIC creatures which can't breathe on land.

|-
| IMMOLATE
| Caste
|
| Will ignite, and potentially completely destroy, items the creature is standing on. Keep booze away from critters with this tag. Also gives the vermin a high chance of escaping from [[animal trap]]s and [[cage]]s made of certain materials. Due to a bug, however, they will only escape from [[artifact]]s.{{bug|6117}}

|-
| INTELLIGENT
| Caste
|
| Shortcut for [CAN_SPEAK] + [CAN_LEARN].

|-
| ITEMCORPSE
| Caste
|
* [[item token]]
* [[material token]]
| Determines if the creature leaves behind a non-standard corpse (i.e. wood, statue, bars, ash from ghost etc).

|-
| ITEMCORPSE_QUALITY
| Caste
|
| The quality of an item-type corpse left behind; 5 is masterpiece-level.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==L==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| LAIR
| Caste
| type:probability
| Found on megabeasts, semimegabeasts, and night creatues. The creature will seek out sites of this type and take them as lairs. The lair types are SIMPLE_BURROW, SIMPLE_MOUND, WILDERNESS_LOCATION, SHRINE, and LABYRINTH.

|-
| LAIR_CHARACTERISTIC
| Caste
| characteristic:probability
| Defines certain features of the creature's lair. The only valid characteristic is HAS_DOORS.

|-
| LAIR_HUNTER
| Caste
|
| This creature will actively hunt adventurers in its lair.

|-
| LAIR_HUNTER_SPEECH
| Caste
| speech file
| What this creature says while hunting adventurers in its lair.

|-
| LARGE_PREDATOR
| Caste
|
| Will attack things that are smaller than it (like dwarves). Only one group of "large predators" will appear on any given map (possibly two groups on "savage" maps). In adventure mode, large predators will try to ambush and attack you (and your party will attack them back). When tamed, large predators tend to be much more aggressive to enemies than non-large predators, making them a good choice for an animal army. They may go on rampages in worldgen, and adventurers may receive quests to kill them. Also, they can be mentioned in the intro paragraph when starting a fortress e.g. "ere the wolves get hungry."

|-
| LARGE_ROAMING
| Creature
|
| In Fortress Mode, spawns outdoors and is not a vermin creature.

|-
| LAYS_EGGS
| Caste
|
| Creature lays eggs instead of giving birth to live young.

|-
| LAYS_UNUSUAL_EGGS
| Caste
|
* [[item token]]
* [[material token]]
| Creature lays a particular item instead of regular eggs.

|-
| LIGAMENTS
| Caste
|
* [[material token]]
*healing rate
| Defines the material and healing rate of ligaments.

|-
| LIGHT_GEN
| Caste
|
| The creature will generate light, such as in adventurer mode at night.

|-
| LIKES_FIGHTING
| Caste
|
| The creature will attack enemies rather than flee from them. This tag has the same effect on player-controlled creatures - included modded dwarves.

|-
| LISP
| Caste
|
| Creature uses "sssssnake talk" (multiplies 'S' when talking - "My name isss Recisssiz.")

|-
| LITTERSIZE
| Caste
|
* minumum
* maximum
| Determines the random chance of how many creatures are generated when giving birth. [LITTERSIZE:1:2]

|-
| LOCKPICKER
| Caste
|
| Lets a creature open doors that are set to forbidden in Fortress Mode.

|-
| LOOSE_CLUSTERS
| Creature
|
| The creatures will scatter if they have this tag, or form tight packs if they don't.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==M==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| MAGICAL
| Caste
|
| Unknown.

|-
| MAGMA_VISION
| Caste
|
| Creature's able to see while covered in magma.

|-
| MALE
| Caste
|
| The species or caste is all male.

|-
| MANNERISM_*
| Caste
|
*occasionally body part
| Adds a possible mannerism to the creature's profile.
Refer to [[Creature mannerism token]]s

|-
| MATERIAL
| Creature
|
*material id
| Begins defining a new material.{{verify}}

|-
| MATERIAL_FORCE_MULTIPLIER
| Caste
|
*[[Material token]]
*A:B
| Set the force multiplier of a specific material against the creature to A/B. For example, 10:1 multiplies the force by 10. {{verify}}

|-
| MATUTINAL
| Caste
|
| Sets if the creature is active in dawn.

|-
| MAXAGE
| Caste
| min:max
| Range of time in years in which death from old age may occur. Once a creature reaches the min value, it has a random chance each season of dying from old age. Unknown if the chance increases with further age.

|-
| MEANDERER
| Caste
|
| Gives a creature random movement.

|-
| MEGABEAST
| Caste
|
| A 'boss' creature. A small number of the creature are created during worldgen, their histories and descendants (if any) will be tracked in worldgen (as opposed to simply 'spawning'), and they will occasionally go on rampages, potentially leading to worship if they attack the same place multiple times. Their presence and number will also influence age names. When appearing in Fortress Mode, they will have a pop-up message announcing their arrival.

|-
|MENT_ATT_CAP_PERC
| Caste
|
*[[DF2012:Attribute|ATTRIBUTE]] Token
*Cap %
|Default is 200. This means you can increase your attribute to 200% of its starting value (or the average value + your starting value if that is higher).

|-
| MENT_ATT_RANGE
| Caste
|
*[[DF2012:Attribute|ATTRIBUTE]]
*lowest:lower:low:median:high:higher:highest
| Sets up a mental attribute's range of values (0-5000). All mental attribute ranges default to 200:800:900:1000:1100:1300:2000.

|-
| MENT_ATT_RATES
| Caste
|
*[[DF2012:Attribute|ATTRIBUTE]] Token
*cost to improve
*unused counter rate
*rust counter rate
*demotion counter rate
| Mental attribute gain/decay rates. Defaults are 500:4:5:4.

|-
| MILKABLE
| Caste
|
* [[material token]]
* frequency
| Allows the creature to be milked.

|-
| MISCHIEVIOUS
| Caste
|
| Alias for MISCHIEVOUS

|-
| MISCHIEVOUS
| Caste
|
| Will pull any levers it comes across. Also makes creature spawn invisible and with several ranks in Ambusher. "They go on little missions to mess with various fortress buildings, not just levers."

|-
| MODVALUE
| Caste
|
| Seemingly no longer used.

|-
| MOUNT
| Caste
|
| Creature may be used as a mount.

|-
| MOUNT_EXOTIC
| Caste
|
| ?

|-
| MULTIPLE_LITTER_RARE
| Caste
|
| Makes litters with more than one offspring rare.

|-
| MUNDANE
| Creature
|
| Marks if the creature is an actual real-life creature. Only used for age-names at present, and determining whether a creature will attack creatures with the AT_PEACE_WITH_WILDLIFE token.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==N==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| NAME
| Creature
| singular:plural:adjective
| The generic name for any creature of this type - will be used when distinctions between caste are unimportant. For names for specific castes, use CASTE_NAME instead. If left undefined, the creature will be labeled as "nothing" by the game.

|-
| NATURAL
| Caste
|
| Alias for NATURAL_ANIMAL

|-
| NATURAL_ANIMAL
| Caste
|
| Animal is considered to be natural.

|-
| NATURAL_SKILL
| Caste
| [[Skill_token|Skill token]]:value
| The creature possesses this skill at this level inherently. It begins with this skill at this level, and the skill may never rust below this level. Requires CAN_LEARN or INTELLIGENT to function in .25 or earlier.

|-
| NIGHT_CREATURE_BOGEYMAN
| Caste
|
| Found on bogeymen. Creatures with this tag will join other bogeymen in attacking adventurers at night, and will also adopt their other behaviors, such as vanishing in smoke upon being killed. This does not affect the creature's presence elsewhere, such as for generated megabeasts, normal creatures, entity members, etc. Setting the number of bogeyman types to zero in the world gen parameters will remove only the randomly-generated bogeymen.

|-
| NIGHT_CREATURE_HUNTER
| Caste
|
| A very small population of the creature will be created during worldgen (sometimes only a single individual will be created), and their histories will be tracked (that is, they will not spawn spontaneously later, they must either have children or convert other creatures to increase their numbers). The creature will settle in a lair and go on rampages during worldgen. If this creature has SPOUSE_CONVERTER, it will actively attempt to seek out potential conversion targets to abduct, convert, and have children with (if possible).

This tag causes the usual behaviour of [[werebeast]]s in worldgen, that is, fleeing towns upon being cursed and conducting raids from a lair. If this tag is absent from a deity curse, the accursed will simply be driven out of towns in a similar manner to [[vampire]]s.

|-
| NO_AUTUMN
| Caste
|
| This creature caste does not appear in [[Calendar|autumn]].

|-
| NO_CONNECTIONS_FOR_MOVEMENT
| Caste
|
| Creature doesn't require connected body parts to move{{verify}}; generally used on undead creatures with connections that have rotted away.

|-
| NO_DIZZINESS
| Caste
|
| Creature cannot become dizzy

|-
| NO_DRINK
| Caste
|
| Creature does not need to drink.

|-
| NO_EAT
| Caste
|
| Creature does not need to eat.

|-
| NO_FEVERS
| Caste
|
| Creature cannot suffer fevers

|-
| NO_GENDER
| Caste
|
| Creature has no gender.

|-
| NO_PHYS_ATT_GAIN
| Caste
|
| The affected caste cannot gain any physical skills.

|-
| NO_PHYS_ATT_RUST
| Caste
|
| The affected caste cannot lose any physical skills.

|-
| NO_SLEEP
| Caste
|
| Creature does not need to sleep.

|-
| NO_SPRING
| Caste
|
| This creature caste does not appear in [[Calendar|spring]].

|-
| NO_SUMMER
| Caste
|
| This creature caste does not appear in [[Calendar|summer]].

|-
| NO_THOUGHT_CENTER_FOR_MOVEMENT
| Caste
|
| Creature doesn't require an organ with the [THOUGHT] tag to survive or attack; generally used on creatures that don't have brains.

|-
| NO_WINTER
| Caste
|
| This creature caste does not appear in [[Calendar|winter]].

|-
| NOBONES
| Caste
|
| Creature has no bones.

|-
| NOBREATHE
| Caste
|
| Creature doesn't need to breathe or have [BREATHE] parts in body. Cannot drown or be strangled.

|-
| NOCTURNAL
| Caste
|
| Sets if the creature is active in night.

|-
| NOEMOTION
| Caste
|
| The creature has no emotions, and does not rage.

|-
| NOEXERT
| Caste
|
| Creature can't become tired or over-exerted.

|-
| NOFEAR
| Caste
|
| Creature doesn't feel fear and will never run away from battle.

|-
| NOMEAT
| Caste
|
| Creature will not drop meat on butcher.

|-
| NONAUSEA
| Caste
|
| Creature can't vomit.

|-
| NOPAIN
| Caste
|
| Creature doesn't feel pain.

|-
| NOSKIN
| Caste
|
| Creature will not drop skin on butcher.

|-
| NOSKULL
| Caste
|
| Creature will not drop skull on butcher, rot, or decay of severed head.

|-
| NOSMELLYROT
| Caste
|
| Does not produce miasma when rotting

|-
| NOSTUCKINS
| Caste
|
| Weapons can't be stuck in creature.

|-
| NOSTUN
| Caste
|
| Creature can't be stunned. Creatures with this tag never wake up from sleep in Fortress Mode and stay drowsy. If this creature must eat and drink while playing, it WILL die.

|-
| NOT_BUTCHERABLE
| Caste
|
| Cannot be butchered

|-
| NOT_LIVING
| Caste
|
| Cannot be raised from the dead.

|-
| NOTHOUGHT
| Caste
|
| Creature doesn't require a [THOUGHT] body part to survive. If it does not have NO_THOUGHT_CENTER_FOR_MOVEMENT as well, it will be unable to use any attacks other than the default 'push'.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==O==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| OPPOSED_TO_LIFE
| Caste
|
| Is hostile to all creatures except undead and other non-living ones. Used for [[Undead]].

|}

<div align="center">
{{alphabetical TOC}}
</div>

==P==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| PACK_ANIMAL
| Caste
|
| Allows the creature to be used as a pack animal. Currently only used by merchants. Also prevents creature from dropping hauled items on its own -- do not use for player-controllable creatures.

|-
| PARALYZEIMMUNE
| Caste
|
| The creature is immune to all paralyzing special attacks.

|-
| PATTERNFLIER
| Caste
|
|

|-
| PEARL
| Caste
|
| In earlier versions, creature would generate pearls. Does nothing in the current version.

|-
| PENETRATEPOWER
| Caste
| value
| Controls the ability of vermin to find a way into containers when they are eating food from your stockpiles.

|-
| PERSONALITY
| Caste
|
*ATTRIBUTE
*lowest:median:highest
| Determines the range and chance of personality traits. Standard is 0:50:100. See [[Personality trait]] for more info.

|-
| PET
| Caste
|
| Allows the creature to be tamed. Also allows all females of the species to breed regardless of marital status.

|-
| PET_EXOTIC
| Caste
|
| The creature can be tamed, but it is much harder to tame and most civilizations have limited knowledge.

|-
| PETVALUE
| Caste
| value
| How valuable a tamed animal/pet is. Actual cost in points in the embarking screen is (PETVALUE/2)+1 for an untrained animal, PETVALUE+1 for a trained(War or Hunting) one. Note that for an animal to be selectable in this screen, it must have the COMMON_DOMESTIC token.

|-
| PETVALUE_DIVISOR
| Caste
| value
| Divides the creature's PETVALUE by the specified number. Used for bees to prevent a single hive from being worth a fortune.

|-
|PHYS_ATT_CAP_PERC
| Caste
|
*[[DF2012:Attribute|ATTRIBUTE]] Token
*Cap %
|Default is 200. This means you can increase your attribute to 200% of its starting value (or the average value + your starting value if that is higher).

|-
| PHYS_ATT_RANGE
| Caste
|
*[[DF2012:Attribute|ATTRIBUTE]]
*lowest:lower:low:median:high:higher:highest
| Sets up a physical attribute's range of values (0-5000). All physical attribute ranges default to 200:700:900:1000:1100:1300:2000.

|-
| PHYS_ATT_RATES
| Caste
|
*[[DF2012:Attribute|ATTRIBUTE]] Token
*cost to improve
*unused counter rate
*rust counter rate
*demotion counter rate
| Physical attribute gain/decay rates. Defaults for STRENGTH, AGILITY, TOUGHNESS, and ENDURANCE are 500:3:4:3, while RECUPERATION and DISEASE_RESISTANCE default to 500:NONE:NONE:NONE.

|-
| PLUS_BP_GROUP
| Caste
|
*BY_TYPE, BY_CATEGORY, or BY_TOKEN
*body type, category, or token
| Adds a body part group to selected body part group. Presumably used immediately after SET_BP_GROUP.

|-
| PLUS_MATERIAL
| Creature
|
*material
| Adds a material to selected materials. Used immediately after SELECT_MATERIAL.

|-
| POP_RATIO
| Caste
|
| Weighted population of caste; Lower is rarer. Not to be confused with FREQUENCY.

|-
| POPULATION_NUMBER
| Creature
| min:max
| The minimum/maximum numbers of how many of these creatures are present in each world map tile of the appropriate region.

|-
| POWER
| Caste
|
| Allows the being to represent itself as a deity. Requires CAN_SPEAK to actually do anything more than settle at a location (e.g. write books, lead armies, profane temples). Doesn't appear to do anything for creatures that are already civilized.

|-
| PREFSTRING
| Creature
| string
| Sets what other creatures like about this creature. "Urist likes dwarves for their beards." Multiple entries will be chosen from at random

|-
| PROFESSION_NAME
| Creature
|
*[[Unit type token]] (Profession)
*singular
*plural
| The generic name for members of this profession, at the creature level. In order to give members of specific castes different names for professions, use CASTE_PROFESSION_NAME instead.

|-
| PRONE_TO_RAGE
| Caste
| number
| Small creatures with this tag will occasionally attack larger creatures on sight instead of running away; the number indicates how likely it is to do so. They are also more likely to enter a 'rage' state during combat, increasing their offensive power.

|-
| PUS
| Caste
|
* [[material token]]
*matter state (LIQUID, GAS, SOLID)
| Specifies what the creature's wounds will ooze when infected.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==R==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| RELSIZE
| Caste
|
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*body category, type, or token
*Relsize
| Specifies a new relative size for a part than what is stated in the body plan. For example, Dwarves have larger livers.

|-
| REMAINS
| Caste
| singular:plural
| What creature's remains are called.

|-
| REMAINS_COLOR
| Caste
|
| What color creature's remains are.

|-
| REMAINS_ON_VERMIN_BITE_DEATH
| Caste
|
| Goes with VERMIN_BITE and DIE_WHEN_VERMIN_BITE, the vermin creature will leave remains on death when biting. Leaving this tag out will cause the creature to disappear entirely after it bites.

|-
| REMAINS_UNDETERMINED
| Caste
|
| Unknown.

|-
| REMOVE_MATERIAL
| Creature
|
*material token
| Removes a material from a creature.

|-
| REMOVE_TISSUE
| Creature
|
*material token
| Removes a tissue from a creature.

|-
| RETRACT_INTO_BP
| Caste
|
*BY_TYPE, BY_CATEGORY or BY_TOKEN
*TYPE, CATEGORY or TOKEN
| The creature will retract a body part when threatened. It will be unable to move or attack, but enemies will only be able to attack the specified body part.

|-
| RETURNS_VERMIN_KILLS_TO_OWNER
|
|
| Used with HUNTS_VERMIN, causes the creature to return killed vermin to its owner.

|-
| ROOT_AROUND
| Caste
|
| Creature will occasionally root around in the grass, looking for insects. Used for flavor in Adventure Mode, no practical effect known.

|}

<div align="center">
{{alphabetical TOC}}
</div>

==S==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| SAVAGE
| Creature
|
| The creature will only show up in "savage" biomes.

|-
| SECRETION
| Caste
|
* [[material token]]
*Material State
*location secreted from (by_type, by_category, by_token)
*body part
*tissue layer
| creates a secreted material on given tissue on a given part of the body.

|-
| SELECT_ADDITIONAL_CASTE
| Creature
|
*caste name
| adds an additional previously defined caste to the selection. Used immediately after SELECT_CASTE.

|-
| SELECT_CASTE
| Creature
|
*caste name, or ALL
| selects a previously defined caste

|-
| SELECT_MATERIAL
| Creature
|
*Material token
| Selects a locally defined material. Can be ALL.

|-
| SEMIMEGABEAST
| Caste
|
| Essentially the same as MEGABEAST, but more of them are created during worldgen.

|-
| SET_BP_GROUP
| Caste
|
*selection criteria BY_TYPE, BY_CATEGORY, BY_TOKEN
*category, type, or token
| Begins a selection of body parts.

|-
| SET_TL_GROUP
| Caste
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
*tissue
| begins a selection of tissue layers

|-
| SHEARABLE_TISSUE_LAYER
| Caste
|
* tissue modifier
* required value
| Tissue layer can be sheared for its component material. The specified modifier must be at least of the desired value for shearing to be possible (a llama's wool must have a LENGTH of 300 before it is shearable).

|-
| SKILL_LEARN_RATE
| Caste
| [[skill_token]]:percentage
| The rate at which this creature learns this skill. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SKILL_LEARN_RATES
| Caste
| percentage
| The rate at which this creature learns all skills. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SKILL_RATE
| Caste
| [[skill_token]]:percentage:value:value:value
| As SKILL_RATES for individual skills. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SKILL_RATES
| Caste
|
*% of improvement points you get
*unused counter rate
*rust counter rate
*demotion counter rate
| Affects skill gain and decay. Lower numbers in the last three slots make decay occur faster ([SKILL_RATES:100:1:1:1] would cause rapid decay). The counter rates may also be replaced with NONE.
Default is [SKILL_RATES:100:8:16:16]. [SLOW_LEARNER] changes the 100 to a 50. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SKILL_RUST_RATE
| Caste
| [[skill_token]]:value:value:value
| The rate at which this skill decays. Lower values cause the skill to decay faster. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SKILL_RUST_RATES
| Caste
| value:value:value
| The rate at which all skills decay. Lower values cause the skills to decay faster. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SLOW_LEARNER
| Caste
|
| Similar to [CAN_LEARN], but slower; skills are gained at a fraction of the rate. Present in the entries for ogres and giants; can be applied to civ or player races.

|-
| SMALL_REMAINS
| Caste
|
| If a creature has this token, it'll leave "remains" instead of a corpse.

|-
| SOLDIER_ALTTILE
| Creature
| 'character' or tile number
| If this creature is active in its civilization's military, it will blink between its default tile and this one.

|-
| SOUND
| Caste
|
* Sound application (currently accepts ALERT or PEACEFUL_INTERMITTENT)
* Sound range (in tiles)
* Sound delay (lower values = sound is produced more often)
* VOCALIZATION or NONE (determines whether the sound requires breathing or not)
* First-person description
* Third-person description
* Description when out of sight
| Creature makes sounds periodically, which can be heard in Adventure mode.

|-
| SPECIFIC_FOOD
| Caste
|
* PLANT or CREATURE
* Plant/creature ID
| Indicates that the creature is only capable of eating a particular type of food.

|-
| SPEECH
| Creature
| speech file
| Boasting speeches relating to killing this creature. Examples include dwarf.txt and elf.txt in data\speech.

|-
| SPEECH_FEMALE
| Creature
| speech file
| Boasting speeches relating to killing females of this creature.

|-
| SPEECH_MALE
| Creature
| speech file
| Boasting speeches relating to killing males of this creature.

|-
| SPEED
| Caste
| value
| Sets the creatures' movement and work speed, 1000/[100 + SPEED X] is the resulting effect on creatures movement and work rates from default. See [[Speed]] for more information.

|-
| SPHERE
| Creature
|
*sphere name
| Sets what religious spheres the creature is aligned to, for purposes of being worshipped via the [POWER] token. Also affects the layout of hidden fun stuff, and the creature's name.

|-
| SPOUSE_CONVERSION_TARGET
| Caste
|
| This creature can be converted by a night creature with SPOUSE_CONVERTED.

|-
| SPOUSE_CONVERTER
| Caste
|
| If the creature has the NIGHT_CREATURE_HUNTER tag, it will kidnap SPOUSE_CONVERSION_TARGETs and transform them into the caste of its species with the CONVERTED_SPOUSE tag during worldgen. It may also start families this way.

|-
| SUPERNATURAL
| Caste
|
| Gives the creature knowledge of any secrets with SUPERNATURAL_LEARNING_POSSIBLE that match its spheres. Other effects are unknown.

|-
| SWIM_SPEED
| Caste
|
*speed
| How fast the creature swims. Typically 2500 (0.38 times the default speed).

|-
| SWIMS_INNATE
| Caste
|
| The creature naturally knows how to swim, as opposed to [SWIMS_LEARNED] below. Currently, an AI bug prevents this from being useful on PC races in fortress mode.

|-
| SWIMS_LEARNED
| Caste
|
| The creature doesn't know how to swim unless it has learned the skill. Requires [CAN_LEARN], obviously.

|}

<div align="center">
{{alphabetical TOC}}
</div>

==T==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| TENDONS
| Caste
|
* [[material token]]
*healing rate
| Defines the material and healing rate of tendons.

|-
| THICKWEB
| Caste
|
| The creature's webs can catch larger creatures.

|-
| TISSUE
| Creature
| name
| Begins defining a tissue in the creature file.

|-
| TITAN
| Caste
|
| Found on [[titan]]s. Cannot be specified in user-defined raws.

|-
| TL_COLOR_MODIFIER
| Caste
| COLOR:freq:COLOR:freq etc
| Creates a list of color patterns, giving each a frequency.

|-
| TLCM_GENETIC_MODEL
| Caste
|
| tissue layer color modifier is passed to offspring genetically?

|-
| TLCM_IMPORTANCE
| Caste
|
*number
| Presumably modifies the importance of the tissue layer color modifier, for description purposes.
HOWEVER using this appears to remove all mention of colour from creature descriptions. It does not appear in any default creatures.

|-
| TLCM_NOUN
| Caste
|
*name
*SINGULAR or PLURAL
| names the tissue layer color modifier, and determines the noun

|-
| TLCM_TIMING
| Caste
|
*ROOT
*start change window years:days:end change window years:days
| determines the point in the creature's life where the color change begins

|-
| TRADE_CAPACITY
| Caste
|
| How much the creature can carry when used by merchants.

|-
| TRAINABLE
| Caste
|
| Shortcut for [TRAINABLE_HUNTING] + [TRAINABLE_WAR].

|-
| TRAINABLE_HUNTING
| Caste
|
| Can be trained as hunting beasts by way of kennels.

|-
| TRAINABLE_WAR
| Caste
|
| Can be trained as war beasts by way of kennels.

|-
| TRANCES
| Caste
|
| Allows the creature to go into martial trances.

|-
| TRAPAVOID
| Caste
|
| The creature is immune to traps. Probably every procedurally generated megabeast has this.

|-
| TRIGGERABLE_GROUP
| Creature
| min:max
| A large swarm of vermin can be disturbed, usually in Adventure mode.{{verify}}

|-
| TSU_NOUN
| Caste
|
*noun
*SINGULAR or PLURAL
| Noun for the TISSUE_STYLE_UNIT, used in the description of the tissue layer's style.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==U==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| UBIQUITOUS
| Creature
|
| Creature will occur in every region with the correct biome. Does not apply to evil/good tags.

|-
| UNDERGROUND_DEPTH
| Creature
|
*mindepth
*maxdepth
| Depth the creature appears underground. Numbers can be from 0 to 5. 0 is actually 'above ground' and can be used if the creature is to appear both above and below ground. A single argument may be used instead of min and max. Only magma creatures use 4 or 5 in the default raws. Civilizations that can use underground plants or animals will only export (via the embark screen or caravans) things that available at depth 1.

|-
| UNDERSWIM
| Caste
|
| Creature swims under the water and can't be seen. Currently appears to have no effect as of 31.25.

|-
| UNIQUE_DEMON
| Caste
|
| Typically found on generated [[demon]]s; causes the game to create a single named instance of the demon which will emerge from the underworld and take over civilizations during worldgen. Cannot be specified in user-defined raws.

|-
| USE_CASTE
| Creature
|
*new caste token
*old caste token
| Defines a new caste derived directly from a previous caste. The new caste inherits all properties of the old one. The effect of this tag is automatic if one has not yet defined any castes: "Any caste-level tag that occurs before castes are explicitly declared is saved up and placed on any caste that is declared later, unless the caste is explicitly derived from another caste."

|-
| USE_MATERIAL
| Creature
|
*new material ID
*old material ID
| Defines a new local creature material and populates it with all properties defined in the specified local creature material.

|-
| USE_MATERIAL_TEMPLATE
| Creature
|
*new material token
*material template
| Defines a new local creature material and populates it with all properties defined in the specified template.

|-
| USE_TISSUE
| Creature
|
*new tissue token
*old tissue id
| Defines a new local creature tissue and populates it with all properties defined in the local tissue specified in the second argument.

|-
| USE_TISSUE_TEMPLATE
| Creature
|
*new tissue token
*tissue template
| Loads a tissue template listed in OBJECT:TISSUE_TEMPLATE files, such as tissue_template_default.txt.

|-
| UTTERANCES
| Caste
|
| Changes the language of the creature into unintelligible 'kobold-speak', which creatures of other species will be unable to understand. If a civilized creature has this and is not part of a SKULKING civ, it will tend to start wars with all nearby civilizations and will be unable to make peace treaties due to 'inability to communicate'.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==V==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| VEGETATION
| Caste
|
| unknown

|-
| VERMIN_BITE
| Caste
|
*chance of occurance{{verify}}
*verb (bitten, stung, etc)
* [[material token]]
| Vermin bites, and injects something.

|-
| VERMIN_EATER
| Creature
|
| The vermin creature will attempt to eat exposed food. See PENETRATEPOWER. Distict from VERMIN_ROTTER.

|-
| VERMIN_FISH
| Creature
|
| The vermin appears in water and will attempt to swim around.

|-
| VERMIN_GROUNDER
| Creature
|
| The creature appears in "general" surface ground locations. Note that this doesn't stop the creature from flying if it can (most vermin birds have this tag).

|-
| VERMIN_HATEABLE
| Caste
|
| Some dwarves will hate the creature and get unhappy thoughts when around it.

|-
| VERMIN_MICRO
| Caste
|
| This makes the creature move in a swarm of creatures of the same race as it. I.E. Swarm of flies, swarm of ants, etc.

|-
| VERMIN_NOFISH
| Caste
|
| The creature cannot be caught by fishing.

|-
| VERMIN_NOROAM
| Caste
|
| The creature will not be observed randomly roaming about the map.

|-
| VERMIN_NOTRAP
| Caste
|
| The creature cannot be caught in baited animal traps; however, a "catch live land animal" task may still be able to capture one if a dwarf finds one roaming around.

|-
| VERMIN_ROTTER
| Creature
|
| Present on flies, knuckle worms, acorn flies, and blood gnats. Probably means either the creature is attracted to rot, the creature speeds rotting, or both.

|-
| VERMIN_SOIL
| Creature
|
| The creature randomly appears near dirt or mud.

|-
| VERMIN_SOIL_COLONY
| Creature
|
| The vermin will appear in a single tile cluster of many vermin, such as a colony of ants.

|-
| VERMINHUNTER
| Caste
|
| Shortcut for [AT_PEACE_WITH_WILDLIFE] + [RETURNS_VERMIN_KILLS_TO_OWNER] + [HUNTS_VERMIN] + [ADOPTS_OWNER].

|-
| VESPERTINE
| Caste
|
| Sets if the creature is active in evening.

|-
| VIEWRANGE
| Caste
| value
| Value should determine how close you have to get to a critter before it attacks (or prevents adv mode travel etc.) Default is 20.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==W==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| WAGON_PULLER
| Caste
|
| Allows the creature to pull caravan wagons.

|-
| WEBBER
| Caste
|
* [[material token]]
| Allows the creature to create webs, and defines what the webs are made of.

|-
| WEBIMMUNE
| Caste
|
| The creature will not get caught in thick webs.
|}

==Attack Tokens==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| ATTACK_SKILL
| Caste
|
*skill used ([[Skill token]])
| defines the attack skill used

|-
| ATTACK_VERB
| Caste
| 2nd person:3rd person
| descriptive text for the attack

|-
| ATTACK_CONTACT_PERC
| Caste
|
*% value
| amount of available tissue used in attack, or possibly percent chance the attack makes contact

|-
| ATTACK_PENETRATION_PERC
| Caste
|
*% value
| probably amount of material that makes contact when penetration is done, or possibly percent chance the attack penetrates (as in sharp items. Default is 0, so it can be left out for blunt attacks, if this is what it does)

|-
| ATTACK_PRIORITY
| Caste
|
*MAIN or SECOND
| use of the attack in combat. Secondary attacks are only used if main attacks are impossible.

|-
| ATTACK_VELOCITY_MODIFIER
| Caste
| number
| Modifies the attack velocity. 1000 is normal, same as weapon velocity.

|-
| ATTACK_FLAG_CANLATCH
| Caste
|
| Enables an attacker to occasionally latch on with the bodypart used by an attack when an attack with this flag in its definition is made. It will then be able to 'shake' the body part for further damage.

|-
| ATTACK_FLAG_WITH
| Caste
|
| In adventure mode, displays the name of the body part used by an attack when announcing the attack.

|-
| ATTACK_FLAG_EDGE
| Caste
|
| The attack will deal edge-type damage.

|-
| SPECIALATTACK_INJECT_EXTRACT
| Caste
|
* [[material token]]
*state (SOLID, LIQUID, GAS)
*min:max
| attack type addition that injects a material into the victim.

|-
| SPECIALATTACK_INTERACTION
| Caste
| interaction
| When this attack lands successfully, an interaction with I_SOURCE:ATTACK will take effect on the target creature. The attack must break the target creature's skin in order to work. This will take effect in worldgen as well.

|-
| SPECIALATTACK_SUCK_BLOOD
| Caste
| min:max
| Successful attack draws out an amount of blood randomized between the min and max value.
|}

==Important Related Tokens==
These next groups of tokens include several tokens that are not technically classified as creature tokens in string dump, but bear mentioning in this as they are used frequently in creature raws. (Some regular creature tokens may also be reprinted for the sake of ease of navigation)

===Tissue Modification===
This next group of tokens deals setting and modifying tissue properties. (See also [[Tissue definition token]])

{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| PLUS_TISSUE_LAYER
| Caste
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
| Adds a tissue to those selected

|-
| PLUS_TL_GROUP
| Caste
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
*tissue
| continues a selection of tissue layers

|-
| SELECT_TISSUE
| Creature
|
*tissue token
| Selects a tissue for editing.

|-
| SELECT_TISSUE_LAYER
| Caste
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token | Selects a tissue at a location
* (optional) FRONT, BACK, LEFT, RIGHT, TOP, BOTTOM, AROUND.
| Selects a tissue layer for descriptor and cosmetic purposes.

|-
| SET_LAYER_TISSUE
| Caste
|
| Sets a tissue layer to be made of a different tissue.

|-
| TISSUE_LAYER
| Caste
|
*BY_TYPE, BY_CATEGORY, BY_TOKEN
*TYPE,CATEGORY, or TOKEN
*TISSUE
*LOCATION
| Adds the tissue layer to wherever it is required.
Non-argument Locations can be FRONT, RIGHT, LEFT, TOP, BOTTOM. Argument locations are AROUND and CLEANS, requiring a further body part and a % of coverage/cleansing

|-
| TISSUE_LAYER_OVER
| Caste
|
*BY_TYPE, BY_CATEGORY, BY_TOKEN
*TYPE,CATEGORY, or TOKEN
*TISSUE
*LOCATION
| Presumably a counterpart to TISSUE_LAYER_UNDER (see below).

|-
| TISSUE_LAYER_UNDER
| Caste
|
*BY_TYPE, BY_CATEGORY, BY_TOKEN
*TYPE,CATEGORY, or TOKEN
*TISSUE
| Adds the tissue layer under a given part.
For example an Iron Man has a gaseous poison within and this tissue (GAS is its name) has the token [TISSUE_LEAKS] and its state is GAS so when you puncture the iron outside and damage this tissue it leaks gas (can have a syndrome by using a previous one in the creature sample.) [TISSUE_LAYER_UNDER:BY_CATEGORY:ALL:{tissue}] {tissue} is what will be under the TISSUE_LAYER here is an example Tissue from Iron Man:<br>
[TISSUE:GAS] [TISSUE_NAME:gas:NP] [TISSUE_MATERIAL:LOCAL_CREATURE_MAT:GAS] [TISSUE_MAT_STATE:GAS] [RELATIVE_THICKNESS:50] [TISSUE_LEAKS] [TISSUE_SHAPE:LAYER]
|-
| TISSUE_LAYER_APPEARANCE_MODIFIER
| Caste
|
*QUALITY
*lowest:lower:low:median:high:higher:highest
| sets the range of qualities, including LENGTH, DENSE, HIGH_POSITION, CURLY, GREASY, WRINKLY

|-
| TISSUE_STYLE_UNIT
| Caste
|
*tissue
*shaping
| sets tissue to be in a certain shape, mostly used with tissues HAIR, BEARD, MOUSTACHE, SIDEBURNS.

|-
| TL_CONNECTS
| Caste
|
| Presumably gives the CONNECTS attribute to selected layers.

|-
| TL_HEALING_RATE
| Caste
|
| Presumably changes the HEALING_RATE of the selected tissue layers.

|-
| TL_MAJOR_ARTERIES
| Caste
|
| Gives Major Artery attribute to selected layers.

|-
| TL_PAIN_RECEPTORS
| Caste
|
| Seems to set new number of pain receptors for selected tissue layers.

|-
| TL_RELATIVE_THICKNESS
| Caste
|
| Seems to set new relative thickness for selected tissue layers.

|-
| TL_VASCULAR
| Caste
|
| Seems to set new a VASCULAR value (which modulates bleeding) for selected tissue layers.

|}

==See Also==
*[[Body detail plan token]]
*[[Body token]]
*[[Material definition token]]
*[[Syndrome]]
*[[Tissue definition token]]

{{Category|Modding}}
{{Category|Tokens}}

v0.34:Wood furnace

2012-11-08T19:19:21Z

I2amroy:

{{Furnace|name=Wood furnace|key=w|job=[[Wood burner]]
|construction=
* [[Fire-safe]] [[building material]] (non-[[economic]])
|construction_job=
* [[Architecture]]
* [[Masonry]] or [[Metalsmithing]]
|use=
* [[Wood]]
|production=
* [[Ash]]
* [[Charcoal]]}}
{{av}}{{Quality|Fine|05:48, 14 June 2010 (UTC)}}

A '''wood furnace''' is used to convert [[wood]] into [[ash]] or [[charcoal]]. It must be built out of [[fire-safe]] materials.

Operating a wood furnace requires the [[Wood burner|wood burning]] [[labor]] enabled.

Building a wood furnace requires the [[architecture]] skill and a skill relevant to the material used to make the furnace ([[masonry]] for [[stone]] or stone, [[glass]] or [[soap]] [[block]]s, or any of the [[Metalsmith#Metalsmith_profession|metalworking]] skills for metal bars or metal blocks).

[[Wood]], [[charcoal]], and [[coke]] are not an option as building materials for this workshop, as these are not [[fire-safe]] materials.

As with all other buildings that require an architect, Dwarves will admire wood furnaces and receive a good [[thought]] if the architect had a high skill.

{{Workshops}}

v0.34:Creature token

2012-11-05T17:52:20Z

I2amroy: /* E */

{{av}}{{Quality|Exceptional}}

A full list of all known creature tokens.

__NOTOC__

<div align="center">
{{alphabetical TOC}}
</div>

==A==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| ADOPTS_OWNER
| Caste
|
| Tame creature cannot be made available for adoption, instead automatically adopting whoever it wants. It appears that the basic requirements for adoption are intact; for example, the creature is more likely to adopt an owner which likes creatures of that species.{{verify}}

|-
| ALCOHOL_DEPENDENT
| Caste
|
| Creature needs alcohol to get through the working day.

|-
| ALL_ACTIVE
| Caste
|
| Sets if the creature is active in day, night, and twilight. Seems to be a separate value from DIURNAL/NOCTURNAL/CREPUSCULAR, rather than implying them.

|-
| ALTTILE
| Creature
|
| If set, the creature will blink between its [TILE] and its [ALTTILE].

|-
| AMBUSHPREDATOR
| Caste
|
| Instead of charging relentlessly at prey, a creature with this tag will wait till the prey is within a few squares before charging.{{verify}}

|-
| AMPHIBIOUS
| Caste
|
| Allows a creature to breathe with or without [[water]]. Implies [AQUATIC].

|-
| APP_MOD_DESC_RANGE
| Caste
|
*Range
| [http://www.bay12forums.com/smf/index.php?topic=60554.msg1766793#msg1766793 Forum post describing how description ranges work]

|-
| APP_MOD_GENETIC_MODEL
| Caste
|
*Model (Accepts DOMINANT_MORE, DOMINANT_LESS, and MIX)
| Defines a genetic model for the relevant appearance modifier(s). May or may not do anything significant at present.

|-
| APP_MOD_IMPORTANCE
| Caste
|
*number
| Determines how important the appearance modifier is, for determining whether it shows up in the creature description.{{verify}}

|-
| APP_MOD_NOUN
| Caste
|
*noun
*SINGULAR or PLURAL
| creates a noun for the appearance and whether it is singular or plural

|-
| APP_MOD_RATE
| Caste
|
*Rate (integer)
*Scale (DAILY, YEARLY)
*min:max of growth
*start year:start day
*end year:end day
| setting the growth rate of the modifier. The last two tokens can be replaced by NO_END to have growth continue indefinitely.

|-
| APPLY_CREATURE_VARIATION
| Special
|
*CV TEMPLATE NAME
| Loads the Creature Variation Template specified.

|-
| APPLY_CURRENT_CREATURE_VARIATION
| Special
|
| Applies loaded Creature Variation

|-
| AQUATIC
| Caste
|
| Allows a creature to breathe underwater, but causes it to "drown" out of [[water]].

|-
| ARENA_RESTRICTED
| Caste
|
| Does not appear in arena mode list

|-
| ARTIFICIAL_HIVEABLE
| Creature
|
| Can be kept in artificial hives by beekeepers.

|-
| AT_PEACE_WITH_WILDLIFE
| Caste
|
| Does not attack or frighten wildlife.

|-
| ATTACK
| Caste
|
*token
*bodypart
*selection criteria
*location
| Defines the attack name, and the body part used. See [[#Attack Tokens|below]] for valid subtokens
'''Example:'''<br />
[ATTACK:GORE:BODYPART:BY_CATEGORY:HORN]<br />
''GORE'' : name of the attack<br />
''BODYPART:BY_CATEGORY:HORN'' : the horn is used to attack (presuming the creature has one)

|-
| ATTACK_TRIGGER
| Caste
| pop:exported wealth:created wealth
| Specifies when a [[megabeast]] will attack the fortress.

|}

<div align="center">
{{alphabetical TOC}}
</div>

==B==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| BABY
| Caste
| integer
| Age at which creature is considered a child. Default is zero. One can think of this as the duration of the baby stage.

|-
| BABYNAME
| Caste
| singular:plural
| Defines a new name for a creature in baby state at the caste level. For non-caste-specific baby names, see GENERAL_BABY_NAME.

|-
| BEACH_FREQUENCY
| Caste
|
| [[Whale]]s and [[Sea nettle jellyfish|jellyfish]] have this. Controls the beaching frequency of the creature.

|-
| BENIGN
| Caste
|
| The creature will only show up in "tame" biomes. Such creatures will generally avoid dwarves, although they may chase and/or attack them if they get too close, notably including [[elephant]]s.

|-
| BIOME
| Creature
|
* [[biome token]]
| Select a [[Biome]] the creature may appear in.

|-
| BLOOD
| Caste
|
* [[material token]]
*matter state (LIQUID, GAS, SOLID)
| Specifies what the creature's blood is made of.

|-
| BLOODSUCKER
| Caste
|
| Seems to be required to make the creature denouncable as a creature of the night.

|-
| BODY
| Caste
| body parts
| Draws body parts from OBJECT:BODY files (such as body_default.txt)
'''Example:'''<br />
[BODY:BODY_WITH_HEAD_FLAG:HEART:GUTS:BRAIN:MOUTH] <br />
This is the body from a [[Purring maggot]]. It creates a body with head, a heart, some guts, a brain, and a mouth. Thats all a maggot needs.

|-
| BODY_APPEARANCE_MODIFIER
| Caste
|
*ATTRIBUTE
*lowest:lower:low:median:high:higher:highest
| These body modifiers give individual creatures different characteristics. In the case of HEIGHT, BROADNESS and LENGTH, the modifier is also a percentage change to the BODY_SIZE of the individual creature. The seven numbers afterward give a distribution of ranges. Each interval has an equal chance of occurring.
'''Example:'''<br />
[BODY_APPEARANCE_MODIFIER:HEIGHT:90:95:98:100:102:105:110] <br />
''HEIGHT'' : marks the height to be changed <br />
''90:95:98:100:102:105:110'' : sets the range from the shortest (90% of the average height) to the tallest (110% of the average height) creature variation.

|-
| BODY_DETAIL_PLAN
| Caste
| PlanName, PlanName:type:type:type:etc
| loads a plan listed OBJECT:BODY_DETAIL_PLAN files, such as b_detail_plan_default.txt. Mass applies USE_MATERIAL_TEMPLATE, mass alters RELSIZE, alters body part positions, and will allow tissue layers to be defined. Tissue layers are defined in order of skin to bone here.
'''Example:'''<br />
[BODY_DETAIL_PLAN:VERTEBRATE_TISSUE_LAYERS:SKIN:FAT:MUSCLE:BONE:CARTILAGE] <br />
This creates the detailed body of a [[fox]], the skin, fat, muscle, bones and cartilage out of the vertebrate tissues.<br />
A [[Purring maggot|maggot]] would only need:<br />
''[BODY_DETAIL_PLAN:EXOSKELETON_TISSUE_LAYERS:SKIN:FAT:MUSCLE]''

|-
| BODY_SIZE
| Caste
| years:days:size
| Sets size at a given age. Size is in cubic centimeters, and for normal body materials is roughly equal to the creature's average weight in grams.
'''Example:'''<br />
[BODY_SIZE:0:0:10000]<br />
[BODY_SIZE:1:168:50000]<br />
[BODY_SIZE:12:0:220000]<br />
This describes the size of a [[minotaur]]. His birth size would be 10,000 cm<sup>3</sup> (~10 kg). At 1 year and 168 days old he would be 50,000 cm<sup>3</sup> (~50 kg). And as an adult (at 12 years old) he would be 220,000 cm<sup>3</sup> and weigh roughly 220 kg.

|-
| BODYGLOSS
| Caste
| gloss
| Substitutes body part text with replacement text. Draws gloss information from OBJECT:BODY files (such as body_default.txt)

|-
| BONECARN
| Caste
|
| Creature eats bones. Implies CARNIVORE. Civilized creatures (e.g. Kobolds) with this tag tend to die out during world generation.

|-
| BP_APPEARANCE_MODIFIER
| Caste
|
*QUALITY
*lowest:lower:low:median:high:higher:highest
| sets up the breadth of possibilities for appearance qualities for a selected BP group. EG. Eyes (CLOSE_SET, DEEP_SET, ROUND_VS_NARROW, LARGE_IRIS),Lips (THICKNESS), Nose (BROADNESS, LENGTH, UPTURNED, CONVEX), Ear (SPLAYED_OUT, HANGING_LOBES, BROADNESS, HEIGHT), Tooth (GAPS), Skull (HIGH_CHEEKBONES, BROAD_CHIN, JUTTING CHIN, SQUARE_CHIN), Neck (DEEP_VOICE, RASPY_VOICE), Head (BROADNESS, HEIGHT)

|-
| BUILDINGDESTROYER
| Caste
| 1 or 2
| Allows a creature to destroy furniture and buildings. Value [1] targets mostly doors, hatches, furniture and the like. Value [2] targets anything not made with the b + C commands.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==C==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| CAN_DO_INTERACTION
| Caste
| interaction token
| The creature can perform an interaction. See [[interaction token]].

|-
| CAN_LEARN
| Caste
|
| The creature gets skills and professions. Note that this token makes the creature unable to be butchered by an adventurer so it is not recommended for uncivilized monsters. Adventurers lacking this token can allocate but not increase attributes and skills. skills allocated will disappear on start.

|-
| CAN_SPEAK
| Caste
|
| Can talk. Note that it is not necessary for a creature to gain social skills. If a member of a civilization (such as a pet) has this token, it'll need to eat and drink.{{verify}}

|-
| CANNOT_UNDEAD
| Caste
|
| Alias for NOT_LIVING

|-
| CANOPENDOORS
| Caste
|
| Allows the creature to open doors.

|-
| CARNIVORE
| Caste
|
| Creature ''only'' eats meat. If the creature goes on rampages in worldgen, it will often devour the people/animals it kills.

|-
| CASTE
| Creature
|
*name
| defines a caste

|-
| CASTE_ALTTILE
| Caste
|
*tile number or "letter"
| Caste-specific alternate tile. Requires CASTE_TILE.

|-
| CASTE_COLOR
| Caste
|
*fg
*bg
*brightness
| Creature tile color of the caste.

|-
| CASTE_GLOWCOLOR
| Caste
|
*fg
*bg
*brightness
| GLOWTILE color of the caste.

|-
| CASTE_GLOWTILE
| Caste
|
*tile value or "letter"
| Caste-specific glowtile

|-
| CASTE_NAME
| Caste
| singular:plural:adjective
| The name of the caste of the creature in the game.

|-
| CASTE_PROFESSION_NAME
| Caste
|
*[[Unit type token]] (Profession)
*singular
*plural
| alters the name of the given profession, caste-specific

|-
| CASTE_SOLDIER_ALTTILE
| Caste
| 'character' or tile number
| Creatures of this caste active in their civilization's military will blink between their default soldier tile and this one. Requires CASTE_SOLDIER_TILE.

|-
| CASTE_SOLDIER_TILE
| Caste
| 'character' or tile number
| Creatures of this caste active in their civilization's military will use this tile instead.

|-
| CASTE_SPEECH
| Caste
| speech file?
| Possibly a caste-specific instance of the SPEECH token

|-
| CASTE_TILE
| Caste
|
* tile number or "letter"
| Caste-specific creature tile.

|-
| CAVE_ADAPT
| Caste
|
| Gives the creature a bonus in caves. Also causes [[Cave adaptation]].

|-
| CDI
| Caste
| Varies
| Specifies details for the preceding CAN_DO_INTERACTION token. See [[Interaction token]].

|-
| CHANGE_BODY_SIZE_PERC
| Caste
|
|

|-
| CHILD
| Caste
| integer
| age at which creature is considered an adult. One can think of this as the duration of the child stage. Without this token, a creature will not reproduce in Fortress mode.

|-
| CHILDNAME
| Caste
| singular:plural
| Defines a new name for a creature in child state at the caste level. For non-caste-specific child names, see GENERAL_CHILD_NAME.

|-
| CLUSTER_NUMBER
| Creature
|
*min
*max
| The minimum/maximum numbers of how many creatures per spawned cluster. Certain vermin fish use this token in combination with temperate ocean and river biome tokens to perform seasonal migrations.
e.g. [CLUSTER_NUMBER:1:3]

|-
| CLUTCH_SIZE
| Caste
|
*min
*max
|Number of eggs laid in one sitting.

|-
| COLONY_EXTERNAL
| Caste
|
| Caste hovers around colony.

|-
| COLOR
| Creature
| foreground:background:brightness
| Color of the creature's tile.

|-
| COMMON_DOMESTIC
| Caste
|
| Allows the creature to be brought with immigrants and when creating a new fortress, as long as the creature also includes at least one of the following tokens: PET, PACK_ANIMAL, WAGON_PULLER, MOUNT. In addition, the creature must be NATURAL rather than FANCIFUL

|-
| CONVERTED_SPOUSE
| Caste
|
| Creatures of this caste's species with the SPOUSE_CONVERTER and NIGHT_CREATURE_HUNTER tokens will kidnap SPOUSE_CONVERSION_TARGETs of an appropriate sex and convert them into castes with CONVERTED_SPOUSE.

|-
| COOKABLE_LIVE
| Caste
|
| Set this to allow the creature to be cooked in meals without first being butchered / fishcleaned.

|-
| CRAZED
| Caste
|
| Creature is 'berserk' and will attack all other creatures, except members of its own species that ALSO have the CRAZED tag.

|-
| COPY_TAGS_FROM
| Special
|
*CREATURE NAME
| Copies tags from another specified creature.

|-
| CREATURE_CLASS
| Caste
|
*classname
| Creature class. Can be anything, but only existing use is GENERAL_POISON. Appears to only be used for Syndromes. Supposedly can also be used for entity positions.

|-
| CREATURE_SOLDIER_TILE
| Creature
| 'character' or tile number
| Creatures active in their civilization's military will use this tile instead.

|-
| CREATURE_TILE
| Creature
| 'character' or tile number
| The symbol of the creature in ASCII mode.

|-
| CREPUSCULAR
| Caste
|
| Sets if the creature is active at twilight.

|-
| CURIOUSBEAST_EATER
| Caste
|
| Allows a creature to steal and eat edible items from a site.

|-
| CURIOUSBEAST_GUZZLER
| Caste
|
| Allows a creature to (very quickly) drink your alcohol. Or spill the barrel to the ground. Also affects undead versions of the creature.

|-
| CURIOUSBEAST_ITEM
| Caste
|
| Allows a creature to steal things (apparently the highest value it can find). If the creature goes on rampages in worldgen, it will often steal items instead of attacking.

|-
| CV_ADD_TAG
| Special
|
*TAG NAME
| Adds a tag. Used in conjunction with creature variation templates.

|-
| CV_REMOVE_TAG
| Special
|
*TAG NAME
| Removes a tag. Used in conjunction with creature variation templates.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==D==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| DEMON
| Caste
|
| Found on generated [[demon]]s. Cannot be specified in user-defined raws.

|-
| DESCRIPTION
| Caste
| text
| A brief description of the creature type.

|-
| DIE_WHEN_VERMIN_BITE
| Caste
|
| Dies upon attacking. Used for bee stings.

|-
| DIFFICULTY
| Caste
| integer
| Toady: "Difficulty determines how deep it places them in adventure mode/reclaim caves, and the chance that they are wounded the first few river attacks." (Outdated? This particular quote referred to version .23a) Also increases experience gain during adventure mode.

|-
| DIURNAL
| Caste
|
| Sets if the creature is active in day.

|-
| DIVE_HUNTS_VERMIN
| Caste
|
| Found on [[peregrine falcon]]s. The creature hunts vermin by diving from the air. May be bugged due to fortress pets remaining earthbound.

|-
| DOES_NOT_EXIST
| Creature
|
| Creature does not actually exist; used for fanciful creatures.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==E==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| EBO_ITEM
| Caste
| [[item token]]:[[material token]] (ANY_HARD_STONE can be used for the material)
| Defines the item that the creature drops upon being butchered. Used with EXTRA_BUTCHER_OBJECT.

|-
| EBO_SHAPE
| Caste
| gem shape
| The shape of the extra item of the creature upon butchering. Used with EXTRA_BUTCHER_OBJECT.

|-
| EGG_MATERIAL
| Caste
|
* [[material token]]
*state (SOLID, LIQUID, or GAS)
| Egg material. Egg-laying creatures will define this 3 times, using LOCAL_CREATURE_MAT:EGGSHELL, LOCAL_CREATURE_MAT:EGG_WHITE, and then LOCAL_CREATURE_MAT:EGG_YOLK. Eggs will be made out of eggshell. Edibility is determined by tags on whites or yolk, but they otherwise do not exist.

|-
| EGG_SIZE
| Caste
|
*size
| Determines the size of eggs.

|-
| EQUIPMENT_WAGON
| Creature
|
| Makes the creature into a large 3x3 creature responsible for carrying trade goods, pulled by two [WAGON_PULLER]s and driven by a merchant.

|-
| EQUIPS
| Caste
|
| Allows the creature to wear or wield items.

|-
| EVIL
| Creature
|
| Creature is considered evil and will only show up in evil biomes. Has no effect on cavern creatures.

|-
| EXTRA_BUTCHER_OBJECT
| Caste
|
* BY_CATEGORY, BY_TYPE, BY_TOKEN
* TYPE, CATEGORY, or TOKEN
| The creature drops an additional object when butchered (typically a gizzard stone), defined by EBO_ITEM and EBO_SHAPE.

|-
| EXTRACT
| Caste
|
* [[material token]]
| Defines a creature extract which can be obtained via [[small animal dissection]].

|-
| EXTRAVISION
| Caste
|
| Creature can see regardless of whether it has working eyes.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==F==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| FANCIFUL
| Creature
|
| Makes every civilization know about the creature. The creature won't occur in regular material preference lists. The tag also adds some art value modifiers. Used for things like dragons and other legendary creatures. Conflicts with [COMMON_DOMESTIC]

|-
| FEATURE_ATTACK_GROUP
| Caste
|
| Found on subterranean animalmen.

|-
| FEATURE_BEAST
| Caste
|
| Found on [[forgotten beast]]s. Cannot be specified in user-defined raws.

|-
| FEMALE
| Caste
|
| Inside a female caste, sets femaleness. Outside of a caste, sets all individuals female unless overridden by caste.

|-
| FIREIMMUNE
| Caste
|
| Renders a creature immune to being damaged by FIREBREATH's short range cone attack.

|-
| FIREIMMUNE_SUPER
| Caste
|
| The creature is immune to DRAGONFIREBREATH. Implies FIREIMMUNE.

|-
| FISHITEM
| Caste
|
| Needs to be cleaned at a fishery

|-
| FIXED_TEMP
| Caste
| temperature
| The natural heat generated by the creature.

|-
| FLEEQUICK
| Caste
|
| Determines how soon a creature flees in a losing battle. Creatures with this tag will flee at the first sign of resistance.

|-
| FLIER
| Caste
|
| Allows a creature to fly. Fortress Mode pathfinding only partially incorporates pathfinding - flying dwarves need a land path to exist between them and an area in order to access it, but as long as one such path exists, they do not need to use it, instead being able to fly over intervening obstacles.

|-
| FREQUENCY
| Creature
|
*number, max 100
| Determines the chances of a creature appearing within its environment, with higher values resulting in more frequent appearance. The game effectively considers all creatures that can possibly appear and uses the FREQUENCY value as a ''weight'' - for example, if there are three creatures with frequencies 10/25/50, the creature with [FREQUENCY:50] will appear approximately 58.8% of the time. Defaults to 50 if not specified. Not to be confused with POP_RATIO.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==G==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| GENERAL_BABY_NAME
| Creature
| singular:plural
| name at creature level

|-
| GENERAL_CHILD_NAME
| Creature
| singular:plural
| name at creature level

|-
| GENERAL_MATERIAL_FORCE_MULTIPLIER
| Caste
| A:B
| Attacks against the creature have their force modified by A/B. For example, 1:2 will halve the force of an attack made against the creature. {{verify}}

|-
| GENERATED
| Creature
|
| Found on procedurally generated creatures like [[Forgotten beast]]s, (biome name) [[titan]]s, [[Demon]]s, and [[night creature]]s. Cannot be specified in user-defined raws.

|-
| GETS_INFECTIONS_FROM_ROT
| Caste
|
| Creature can get infections from necrotic tissue.

|-
| GETS_WOUND_INFECTIONS
| Caste
|
| Creature's wounds can become infected.

|-
| GLOWCOLOR
| Creature
|
*foreground
*background
*brightness
| The colour of the GLOWTILE of the creature.

|-
| GLOWTILE
| Creature
| ascii character
| If present, the being glows in the dark (generally used for Adventure Mode). The tile is what replaces the being's current tile when it is obscured from your sight by darkness. The default setting for kobolds (a yellow quotation mark) provides a nice "glowing eyes" effect. The game is also hardcoded to automatically convert quotation mark GLOWTILES into apostrophes if the creature has lost one eye. This works at the generic creature level - for caste-specific glow tiles, use CASTE_GLOWTILE instead.

|-
| GNAWER
| Caste
| verb
| The creature can and will gnaw its way out of [[animal trap]]s and [[cage]]s using the specified verb, depending on the material from which it is made. Due to a bug, however, they will only escape from [[artifact]]s.{{bug|6117}}

|-
| GOBBLE_VERMIN_CLASS
| Caste
| class
| The creature eats vermin of the specified class.

|-
| GOBBLE_VERMIN_CREATURE
| Caste
| creature:caste
| The creature eats a specified vermin.

|-
| GO_TO_END
| Special
|
| When using tags from an existing creature, inserts new tags at the end of the creature.

|-
| GO_TO_START
| Special
|
| When using tags from an existing creature, inserts new tags at the beginning of the creature.

|-
| GO_TO_TAG
| Special
|
| When using tags from an existing creature, inserts new tags after the specified tag.

|-
| GOOD
| Creature
|
| Creature is considered good and will only show up in good biomes, for example [[unicorn]]s. Presumably has no effect on cavern creatures.

|-
| GRASSTRAMPLE
| Caste
| value
| The value determines how rapidly grass is trampled when a creature steps on it - a value of 0 causes the creature to never damage grass, while a value of 100 causes grass to be trampled as rapidly as possible. Defaults to 5.

|-
| GRAVITATE_BODY_SIZE
| Caste
| target value
| Used in Creature Variants. This token changes the adult body size to the average of the old adult body size and the target value and scales all intermediate growth stages by the same factor.

|-
| GRAZER
| Caste
|
*number
| Animals is a grazer. The higher the number, the less frequently it needs to eat in order to survive.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==H==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| HABIT
| Caste
| type:probability
| Defines certain behaviors for the creature. The habit types are COLLECT_TROPHIES, COOK_PEOPLE, COOK_VERMIN, GRIND_VERMIN, COOK_BLOOD, GRIND_BONE_MEAL, EAT_BONE_PORRIDGE, USE_ANY_MELEE_WEAPON, GIANT_NEST, and COLLECT_WEALTH. These may require the creature to have a lair to work properly.

|-
| HABIT_NUM
| Caste
| number or TEST_ALL
| "If you set HABIT_NUM to a number, it should give you that exact number of habits according to the weights.".<sup>[[http://www.bay12forums.com/smf/index.php?topic=60554.msg1719248#msg1719248 source post]]</sup> All lists of HABITs are preceded by [HABIT_NUM:TEST_ALL]

|-
| HAS_NERVES
| Caste
|
| This makes the creature susceptible to severed motor and sensory nerves when muscles are torn in limb, grasp and stance parts. Some butchering yields nervous tissue.

|-
| HASSHELL
| Caste
|
| The creature has a shell. Seemingly no longer used - holdover from previous versions.

|-
| HIVE_PRODUCT
| Creature
|
*number
*[[time]]
*[[item token]]s
| What product is harvested from [[Beekeeping industry|beekeeping]].

|-
| HOMEOTHERM
| Caste
|
| Default 'NONE'. The creature's normal body [[temperature]]

|-
| HUNTS_VERMIN
| Caste
|
| Creature hunts and kills nearby vermin.

|}

<div align="center">
{{alphabetical TOC}}
</div>

==I==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| IMMOBILE
| Caste
|
| The creature cannot move. Found on [[sponge]]s. Will also stop a creature from breeding in Fortress Mode (MALE and FEMALE are effected, if one is IMMOBILE no breeding will happen)

|-
| IMMOBILE_LAND
| Caste
|
| The creature is immobile while on land. Only works on AQUATIC creatures which can't breathe on land.

|-
| IMMOLATE
| Caste
|
| Will ignite, and potentially completely destroy, items the creature is standing on. Keep booze away from critters with this tag. Also gives the vermin a high chance of escaping from [[animal trap]]s and [[cage]]s made of certain materials. Due to a bug, however, they will only escape from [[artifact]]s.{{bug|6117}}

|-
| INTELLIGENT
| Caste
|
| Shortcut for [CAN_SPEAK] + [CAN_LEARN].

|-
| ITEMCORPSE
| Caste
|
* [[item token]]
* [[material token]]
| Determines if the creature leaves behind a non-standard corpse (i.e. wood, statue, bars, ash from ghost etc).

|-
| ITEMCORPSE_QUALITY
| Caste
|
| The quality of an item-type corpse left behind; 5 is masterpiece-level.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==L==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| LAIR
| Caste
| type:probability
| Found on megabeasts, semimegabeasts, and night creatues. The creature will seek out sites of this type and take them as lairs. The lair types are SIMPLE_BURROW, SIMPLE_MOUND, WILDERNESS_LOCATION, SHRINE, and LABYRINTH.

|-
| LAIR_CHARACTERISTIC
| Caste
| characteristic:probability
| Defines certain features of the creature's lair. The only valid characteristic is HAS_DOORS.

|-
| LAIR_HUNTER
| Caste
|
| This creature will actively hunt adventurers in its lair.

|-
| LAIR_HUNTER_SPEECH
| Caste
| speech file
| What this creature says while hunting adventurers in its lair.

|-
| LARGE_PREDATOR
| Caste
|
| Will attack things that are smaller than it (like dwarves). Only one group of "large predators" will appear on any given map (possibly two groups on "savage" maps). In adventure mode, large predators will try to ambush and attack you (and your party will attack them back). When tamed, large predators tend to be much more aggressive to enemies than non-large predators, making them a good choice for an animal army. They may go on rampages in worldgen, and adventurers may receive quests to kill them. Also, they can be mentioned in the intro paragraph when starting a fortress e.g. "ere the wolves get hungry."

|-
| LARGE_ROAMING
| Creature
|
| In Fortress Mode, spawns outdoors and is not a vermin creature.

|-
| LAYS_EGGS
| Caste
|
| Creature lays eggs instead of giving birth to live young.

|-
| LAYS_UNUSUAL_EGGS
| Caste
|
* [[item token]]
* [[material token]]
| Creature lays a particular item instead of regular eggs.

|-
| LIGAMENTS
| Caste
|
* [[material token]]
*healing rate
| Defines the material and healing rate of ligaments.

|-
| LIGHT_GEN
| Caste
|
| The creature will generate light, such as in adventurer mode at night.

|-
| LIKES_FIGHTING
| Caste
|
| The creature will attack enemies rather than flee from them. This tag has the same effect on player-controlled creatures - included modded dwarves.

|-
| LISP
| Caste
|
| Creature uses "sssssnake talk" (multiplies 'S' when talking - "My name isss Recisssiz.")

|-
| LITTERSIZE
| Caste
|
* minumum
* maximum
| Determines the random chance of how many creatures are generated when giving birth. [LITTERSIZE:1:2]

|-
| LOCKPICKER
| Caste
|
| Lets a creature open doors that are set to forbidden in Fortress Mode.

|-
| LOOSE_CLUSTERS
| Creature
|
| The creatures will scatter if they have this tag, or form tight packs if they don't.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==M==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| MAGICAL
| Caste
|
| Unknown.

|-
| MAGMA_VISION
| Caste
|
| Creature's able to see while covered in magma.

|-
| MALE
| Caste
|
| The species or caste is all male.

|-
| MANNERISM_*
| Caste
|
*occasionally body part
| Adds a possible mannerism to the creature's profile.
Refer to [[Creature mannerism token]]s

|-
| MATERIAL
| Creature
|
*material id
| Begins defining a new material.{{verify}}

|-
| MATERIAL_FORCE_MULTIPLIER
| Caste
|
*[[Material token]]
*A:B
| Set the force multiplier of a specific material against the creature to A/B. For example, 10:1 multiplies the force by 10. {{verify}}

|-
| MATUTINAL
| Caste
|
| Sets if the creature is active in dawn.

|-
| MAXAGE
| Caste
| min:max
| Range of time in years in which death from old age may occur. Once a creature reaches the min value, it has a random chance each season of dying from old age. Unknown if the chance increases with further age.

|-
| MEANDERER
| Caste
|
| Gives a creature random movement.

|-
| MEGABEAST
| Caste
|
| A 'boss' creature. A small number of the creature are created during worldgen, their histories and descendants (if any) will be tracked in worldgen (as opposed to simply 'spawning'), and they will occasionally go on rampages, potentially leading to worship if they attack the same place multiple times. Their presence and number will also influence age names. When appearing in Fortress Mode, they will have a pop-up message announcing their arrival.

|-
|MENT_ATT_CAP_PERC
| Caste
|
*[[DF2012:Attribute|ATTRIBUTE]] Token
*Cap %
|Default is 200. This means you can increase your attribute to 200% of its starting value (or the average value + your starting value if that is higher).

|-
| MENT_ATT_RANGE
| Caste
|
*[[DF2012:Attribute|ATTRIBUTE]]
*lowest:lower:low:median:high:higher:highest
| Sets up a mental attribute's range of values (0-5000). All mental attribute ranges default to 200:800:900:1000:1100:1300:2000.

|-
| MENT_ATT_RATES
| Caste
|
*[[DF2012:Attribute|ATTRIBUTE]] Token
*cost to improve
*unused counter rate
*rust counter rate
*demotion counter rate
| Mental attribute gain/decay rates. Defaults are 500:4:5:4.

|-
| MILKABLE
| Caste
|
* [[material token]]
* frequency
| Allows the creature to be milked.

|-
| MISCHIEVIOUS
| Caste
|
| Alias for MISCHIEVOUS

|-
| MISCHIEVOUS
| Caste
|
| Will pull any levers it comes across. Also makes creature spawn invisible and with several ranks in Ambusher. "They go on little missions to mess with various fortress buildings, not just levers."

|-
| MODVALUE
| Caste
|
| Seemingly no longer used.

|-
| MOUNT
| Caste
|
| Creature may be used as a mount.

|-
| MOUNT_EXOTIC
| Caste
|
| ?

|-
| MULTIPLE_LITTER_RARE
| Caste
|
| Makes litters with more than one offspring rare.

|-
| MUNDANE
| Creature
|
| Marks if the creature is an actual real-life creature. Only used for age-names at present, and determining whether a creature will attack creatures with the AT_PEACE_WITH_WILDLIFE token.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==N==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| NAME
| Creature
| singular:plural:adjective
| The generic name for any creature of this type - will be used when distinctions between caste are unimportant. For names for specific castes, use CASTE_NAME instead. If left undefined, the creature will be labeled as "nothing" by the game.

|-
| NATURAL
| Caste
|
| Alias for NATURAL_ANIMAL

|-
| NATURAL_ANIMAL
| Caste
|
| Animal is considered to be natural.

|-
| NATURAL_SKILL
| Caste
| [[Skill_token|Skill token]]:value
| The creature possesses this skill at this level inherently. It begins with this skill at this level, and the skill may never rust below this level. Requires CAN_LEARN or INTELLIGENT to function (changed in .25 or earlier that CAN_LEARN is no longer required).

|-
| NIGHT_CREATURE_BOGEYMAN
| Caste
|
| Found on bogeymen. Creatures with this tag will join other bogeymen in attacking adventurers at night, and will also adopt their other behaviors, such as vanishing in smoke upon being killed. This does not affect the creature's presence elsewhere, such as for generated megabeasts, normal creatures, entity members, etc. Setting the number of bogeyman types to zero in the world gen parameters will remove only the randomly-generated bogeymen.

|-
| NIGHT_CREATURE_HUNTER
| Caste
|
| A very small population of the creature will be created during worldgen (sometimes only a single individual will be created), and their histories will be tracked (that is, they will not spawn spontaneously later, they must either have children or convert other creatures to increase their numbers). The creature will settle in a lair and go on rampages during worldgen. If this creature has SPOUSE_CONVERTER, it will actively attempt to seek out potential conversion targets to abduct, convert, and have children with (if possible).

This tag causes the usual behaviour of [[werebeast]]s in worldgen, that is, fleeing towns upon being cursed and conducting raids from a lair. If this tag is absent from a deity curse, the accursed will simply be driven out of towns in a similar manner to [[vampire]]s.

|-
| NO_AUTUMN
| Caste
|
| This creature caste does not appear in [[Calendar|autumn]].

|-
| NO_CONNECTIONS_FOR_MOVEMENT
| Caste
|
| Creature doesn't require connected body parts to move{{verify}}; generally used on undead creatures with connections that have rotted away.

|-
| NO_DIZZINESS
| Caste
|
| Creature cannot become dizzy

|-
| NO_DRINK
| Caste
|
| Creature does not need to drink.

|-
| NO_EAT
| Caste
|
| Creature does not need to eat.

|-
| NO_FEVERS
| Caste
|
| Creature cannot suffer fevers

|-
| NO_GENDER
| Caste
|
| Creature has no gender.

|-
| NO_PHYS_ATT_GAIN
| Caste
|
| The affected caste cannot gain any physical skills.

|-
| NO_PHYS_ATT_RUST
| Caste
|
| The affected caste cannot lose any physical skills.

|-
| NO_SLEEP
| Caste
|
| Creature does not need to sleep.

|-
| NO_SPRING
| Caste
|
| This creature caste does not appear in [[Calendar|spring]].

|-
| NO_SUMMER
| Caste
|
| This creature caste does not appear in [[Calendar|summer]].

|-
| NO_THOUGHT_CENTER_FOR_MOVEMENT
| Caste
|
| Creature doesn't require an organ with the [THOUGHT] tag to survive or attack; generally used on creatures that don't have brains.

|-
| NO_WINTER
| Caste
|
| This creature caste does not appear in [[Calendar|winter]].

|-
| NOBONES
| Caste
|
| Creature has no bones.

|-
| NOBREATHE
| Caste
|
| Creature doesn't need to breathe or have [BREATHE] parts in body. Cannot drown or be strangled.

|-
| NOCTURNAL
| Caste
|
| Sets if the creature is active in night.

|-
| NOEMOTION
| Caste
|
| The creature has no emotions, and does not rage.

|-
| NOEXERT
| Caste
|
| Creature can't become tired or over-exerted.

|-
| NOFEAR
| Caste
|
| Creature doesn't feel fear and will never run away from battle.

|-
| NOMEAT
| Caste
|
| Creature will not drop meat on butcher.

|-
| NONAUSEA
| Caste
|
| Creature can't vomit.

|-
| NOPAIN
| Caste
|
| Creature doesn't feel pain.

|-
| NOSKIN
| Caste
|
| Creature will not drop skin on butcher.

|-
| NOSKULL
| Caste
|
| Creature will not drop skull on butcher, rot, or decay of severed head.

|-
| NOSMELLYROT
| Caste
|
| Does not produce miasma when rotting

|-
| NOSTUCKINS
| Caste
|
| Weapons can't be stuck in creature.

|-
| NOSTUN
| Caste
|
| Creature can't be stunned. Creatures with this tag never wake up from sleep in Fortress Mode and stay drowsy. If this creature must eat and drink while playing, it WILL die.

|-
| NOT_BUTCHERABLE
| Caste
|
| Cannot be butchered

|-
| NOT_LIVING
| Caste
|
| Cannot be raised from the dead.

|-
| NOTHOUGHT
| Caste
|
| Creature doesn't require a [THOUGHT] body part to survive. If it does not have NO_THOUGHT_CENTER_FOR_MOVEMENT as well, it will be unable to use any attacks other than the default 'push'.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==O==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| OPPOSED_TO_LIFE
| Caste
|
| Is hostile to all creatures except undead and other non-living ones. Used for [[Undead]].

|}

<div align="center">
{{alphabetical TOC}}
</div>

==P==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| PACK_ANIMAL
| Caste
|
| Allows the creature to be used as a pack animal. Currently only used by merchants. Also prevents creature from dropping hauled items on its own -- do not use for player-controllable creatures.

|-
| PARALYZEIMMUNE
| Caste
|
| The creature is immune to all paralyzing special attacks.

|-
| PATTERNFLIER
| Caste
|
|

|-
| PEARL
| Caste
|
| In earlier versions, creature would generate pearls. Does nothing in the current version.

|-
| PENETRATEPOWER
| Caste
| value
| Controls the ability of vermin to find a way into containers when they are eating food from your stockpiles.

|-
| PERSONALITY
| Caste
|
*ATTRIBUTE
*lowest:median:highest
| Determines the range and chance of personality traits. Standard is 0:50:100. See [[Personality trait]] for more info.

|-
| PET
| Caste
|
| Allows the creature to be tamed. Also allows all females of the species to breed regardless of marital status.

|-
| PET_EXOTIC
| Caste
|
| The creature can be tamed, but it is much harder to tame and most civilizations have limited knowledge.

|-
| PETVALUE
| Caste
| value
| How valuable a tamed animal/pet is. Actual cost in points in the embarking screen is (PETVALUE/2)+1 for an untrained animal, PETVALUE+1 for a trained(War or Hunting) one. Note that for an animal to be selectable in this screen, it must have the COMMON_DOMESTIC token.

|-
| PETVALUE_DIVISOR
| Caste
| value
| Divides the creature's PETVALUE by the specified number. Used for bees to prevent a single hive from being worth a fortune.

|-
|PHYS_ATT_CAP_PERC
| Caste
|
*[[DF2012:Attribute|ATTRIBUTE]] Token
*Cap %
|Default is 200. This means you can increase your attribute to 200% of its starting value (or the average value + your starting value if that is higher).

|-
| PHYS_ATT_RANGE
| Caste
|
*[[DF2012:Attribute|ATTRIBUTE]]
*lowest:lower:low:median:high:higher:highest
| Sets up a physical attribute's range of values (0-5000). All physical attribute ranges default to 200:700:900:1000:1100:1300:2000.

|-
| PHYS_ATT_RATES
| Caste
|
*[[DF2012:Attribute|ATTRIBUTE]] Token
*cost to improve
*unused counter rate
*rust counter rate
*demotion counter rate
| Physical attribute gain/decay rates. Defaults for STRENGTH, AGILITY, TOUGHNESS, and ENDURANCE are 500:3:4:3, while RECUPERATION and DISEASE_RESISTANCE default to 500:NONE:NONE:NONE.

|-
| PLUS_BP_GROUP
| Caste
|
*BY_TYPE, BY_CATEGORY, or BY_TOKEN
*body type, category, or token
| Adds a body part group to selected body part group. Presumably used immediately after SET_BP_GROUP.

|-
| PLUS_MATERIAL
| Creature
|
*material
| Adds a material to selected materials. Used immediately after SELECT_MATERIAL.

|-
| POP_RATIO
| Caste
|
| Weighted population of caste; Lower is rarer. Not to be confused with FREQUENCY.

|-
| POPULATION_NUMBER
| Creature
| min:max
| The minimum/maximum numbers of how many of these creatures are present in each world map tile of the appropriate region.

|-
| POWER
| Caste
|
| Allows the being to represent itself as a deity. Requires CAN_SPEAK to actually do anything more than settle at a location (e.g. write books, lead armies, profane temples). Doesn't appear to do anything for creatures that are already civilized.

|-
| PREFSTRING
| Creature
| string
| Sets what other creatures like about this creature. "Urist likes dwarves for their beards." Multiple entries will be chosen from at random

|-
| PROFESSION_NAME
| Creature
|
*[[Unit type token]] (Profession)
*singular
*plural
| The generic name for members of this profession, at the creature level. In order to give members of specific castes different names for professions, use CASTE_PROFESSION_NAME instead.

|-
| PRONE_TO_RAGE
| Caste
| number
| Small creatures with this tag will occasionally attack larger creatures on sight instead of running away; the number indicates how likely it is to do so. They are also more likely to enter a 'rage' state during combat, increasing their offensive power.

|-
| PUS
| Caste
|
* [[material token]]
*matter state (LIQUID, GAS, SOLID)
| Specifies what the creature's wounds will ooze when infected.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==R==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| RELSIZE
| Caste
|
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*body category, type, or token
*Relsize
| Specifies a new relative size for a part than what is stated in the body plan. For example, Dwarves have larger livers.

|-
| REMAINS
| Caste
| singular:plural
| What creature's remains are called.

|-
| REMAINS_COLOR
| Caste
|
| What color creature's remains are.

|-
| REMAINS_ON_VERMIN_BITE_DEATH
| Caste
|
| Goes with VERMIN_BITE and DIE_WHEN_VERMIN_BITE, the vermin creature will leave remains on death when biting. Leaving this tag out will cause the creature to disappear entirely after it bites.

|-
| REMAINS_UNDETERMINED
| Caste
|
| Unknown.

|-
| REMOVE_MATERIAL
| Creature
|
*material token
| Removes a material from a creature.

|-
| REMOVE_TISSUE
| Creature
|
*material token
| Removes a tissue from a creature.

|-
| RETRACT_INTO_BP
| Caste
|
*BY_TYPE, BY_CATEGORY or BY_TOKEN
*TYPE, CATEGORY or TOKEN
| The creature will retract a body part when threatened. It will be unable to move or attack, but enemies will only be able to attack the specified body part.

|-
| RETURNS_VERMIN_KILLS_TO_OWNER
|
|
| Used with HUNTS_VERMIN, causes the creature to return killed vermin to its owner.

|-
| ROOT_AROUND
| Caste
|
| Creature will occasionally root around in the grass, looking for insects. Used for flavor in Adventure Mode, no practical effect known.

|}

<div align="center">
{{alphabetical TOC}}
</div>

==S==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| SAVAGE
| Creature
|
| The creature will only show up in "savage" biomes.

|-
| SECRETION
| Caste
|
* [[material token]]
*Material State
*location secreted from (by_type, by_category, by_token)
*body part
*tissue layer
| creates a secreted material on given tissue on a given part of the body.

|-
| SELECT_ADDITIONAL_CASTE
| Creature
|
*caste name
| adds an additional previously defined caste to the selection. Used immediately after SELECT_CASTE.

|-
| SELECT_CASTE
| Creature
|
*caste name, or ALL
| selects a previously defined caste

|-
| SELECT_MATERIAL
| Creature
|
*Material token
| Selects a locally defined material. Can be ALL.

|-
| SEMIMEGABEAST
| Caste
|
| Essentially the same as MEGABEAST, but more of them are created during worldgen.

|-
| SET_BP_GROUP
| Caste
|
*selection criteria BY_TYPE, BY_CATEGORY, BY_TOKEN
*category, type, or token
| Begins a selection of body parts.

|-
| SET_TL_GROUP
| Caste
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
*tissue
| begins a selection of tissue layers

|-
| SHEARABLE_TISSUE_LAYER
| Caste
|
* tissue modifier
* required value
| Tissue layer can be sheared for its component material. The specified modifier must be at least of the desired value for shearing to be possible (a llama's wool must have a LENGTH of 300 before it is shearable).

|-
| SKILL_LEARN_RATE
| Caste
| [[skill_token]]:percentage
| The rate at which this creature learns this skill. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SKILL_LEARN_RATES
| Caste
| percentage
| The rate at which this creature learns all skills. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SKILL_RATE
| Caste
| [[skill_token]]:percentage:value:value:value
| As SKILL_RATES for individual skills. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SKILL_RATES
| Caste
|
*% of improvement points you get
*unused counter rate
*rust counter rate
*demotion counter rate
| Affects skill gain and decay. Lower numbers in the last three slots make decay occur faster ([SKILL_RATES:100:1:1:1] would cause rapid decay). The counter rates may also be replaced with NONE.
Default is [SKILL_RATES:100:8:16:16]. [SLOW_LEARNER] changes the 100 to a 50. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SKILL_RUST_RATE
| Caste
| [[skill_token]]:value:value:value
| The rate at which this skill decays. Lower values cause the skill to decay faster. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SKILL_RUST_RATES
| Caste
| value:value:value
| The rate at which all skills decay. Lower values cause the skills to decay faster. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SLOW_LEARNER
| Caste
|
| Similar to [CAN_LEARN], but slower; skills are gained at a fraction of the rate. Present in the entries for ogres and giants; can be applied to civ or player races.

|-
| SMALL_REMAINS
| Caste
|
| If a creature has this token, it'll leave "remains" instead of a corpse.

|-
| SOLDIER_ALTTILE
| Creature
| 'character' or tile number
| If this creature is active in its civilization's military, it will blink between its default tile and this one.

|-
| SOUND
| Caste
|
* Sound application (currently accepts ALERT or PEACEFUL_INTERMITTENT)
* Sound range (in tiles)
* Sound delay (lower values = sound is produced more often)
* VOCALIZATION or NONE (determines whether the sound requires breathing or not)
* First-person description
* Third-person description
* Description when out of sight
| Creature makes sounds periodically, which can be heard in Adventure mode.

|-
| SPECIFIC_FOOD
| Caste
|
* PLANT or CREATURE
* Plant/creature ID
| Indicates that the creature is only capable of eating a particular type of food.

|-
| SPEECH
| Creature
| speech file
| Boasting speeches relating to killing this creature. Examples include dwarf.txt and elf.txt in data\speech.

|-
| SPEECH_FEMALE
| Creature
| speech file
| Boasting speeches relating to killing females of this creature.

|-
| SPEECH_MALE
| Creature
| speech file
| Boasting speeches relating to killing males of this creature.

|-
| SPEED
| Caste
| value
| Sets the creatures' movement and work speed, 1000/[100 + SPEED X] is the resulting effect on creatures movement and work rates from default. See [[Speed]] for more information.

|-
| SPHERE
| Creature
|
*sphere name
| Sets what religious spheres the creature is aligned to, for purposes of being worshipped via the [POWER] token. Also affects the layout of hidden fun stuff, and the creature's name.

|-
| SPOUSE_CONVERSION_TARGET
| Caste
|
| This creature can be converted by a night creature with SPOUSE_CONVERTED.

|-
| SPOUSE_CONVERTER
| Caste
|
| If the creature has the NIGHT_CREATURE_HUNTER tag, it will kidnap SPOUSE_CONVERSION_TARGETs and transform them into the caste of its species with the CONVERTED_SPOUSE tag during worldgen. It may also start families this way.

|-
| SUPERNATURAL
| Caste
|
| Gives the creature knowledge of any secrets with SUPERNATURAL_LEARNING_POSSIBLE that match its spheres. Other effects are unknown.

|-
| SWIM_SPEED
| Caste
|
*speed
| How fast the creature swims. Typically 2500 (0.38 times the default speed).

|-
| SWIMS_INNATE
| Caste
|
| The creature naturally knows how to swim, as opposed to [SWIMS_LEARNED] below. Currently, an AI bug prevents this from being useful on PC races in fortress mode.

|-
| SWIMS_LEARNED
| Caste
|
| The creature doesn't know how to swim unless it has learned the skill. Requires [CAN_LEARN], obviously.

|}

<div align="center">
{{alphabetical TOC}}
</div>

==T==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| TENDONS
| Caste
|
* [[material token]]
*healing rate
| Defines the material and healing rate of tendons.

|-
| THICKWEB
| Caste
|
| The creature's webs can catch larger creatures.

|-
| TISSUE
| Creature
| name
| Begins defining a tissue in the creature file.

|-
| TITAN
| Caste
|
| Found on [[titan]]s. Cannot be specified in user-defined raws.

|-
| TL_COLOR_MODIFIER
| Caste
| COLOR:freq:COLOR:freq etc
| Creates a list of color patterns, giving each a frequency.

|-
| TLCM_GENETIC_MODEL
| Caste
|
| tissue layer color modifier is passed to offspring genetically?

|-
| TLCM_IMPORTANCE
| Caste
|
*number
| Presumably modifies the importance of the tissue layer color modifier, for description purposes.
HOWEVER using this appears to remove all mention of colour from creature descriptions. It does not appear in any default creatures.

|-
| TLCM_NOUN
| Caste
|
*name
*SINGULAR or PLURAL
| names the tissue layer color modifier, and determines the noun

|-
| TLCM_TIMING
| Caste
|
*ROOT
*start change window years:days:end change window years:days
| determines the point in the creature's life where the color change begins

|-
| TRADE_CAPACITY
| Caste
|
| How much the creature can carry when used by merchants.

|-
| TRAINABLE
| Caste
|
| Shortcut for [TRAINABLE_HUNTING] + [TRAINABLE_WAR].

|-
| TRAINABLE_HUNTING
| Caste
|
| Can be trained as hunting beasts by way of kennels.

|-
| TRAINABLE_WAR
| Caste
|
| Can be trained as war beasts by way of kennels.

|-
| TRANCES
| Caste
|
| Allows the creature to go into martial trances.

|-
| TRAPAVOID
| Caste
|
| The creature is immune to traps. Probably every procedurally generated megabeast has this.

|-
| TRIGGERABLE_GROUP
| Creature
| min:max
| A large swarm of vermin can be disturbed, usually in Adventure mode.{{verify}}

|-
| TSU_NOUN
| Caste
|
*noun
*SINGULAR or PLURAL
| Noun for the TISSUE_STYLE_UNIT, used in the description of the tissue layer's style.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==U==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| UBIQUITOUS
| Creature
|
| Creature will occur in every region with the correct biome. Does not apply to evil/good tags.

|-
| UNDERGROUND_DEPTH
| Creature
|
*mindepth
*maxdepth
| Depth the creature appears underground. Numbers can be from 0 to 5. 0 is actually 'above ground' and can be used if the creature is to appear both above and below ground. A single argument may be used instead of min and max. Only magma creatures use 4 or 5 in the default raws. Civilizations that can use underground plants or animals will only export (via the embark screen or caravans) things that available at depth 1.

|-
| UNDERSWIM
| Caste
|
| Creature swims under the water and can't be seen. Currently appears to have no effect as of 31.25.

|-
| UNIQUE_DEMON
| Caste
|
| Typically found on generated [[demon]]s; causes the game to create a single named instance of the demon which will emerge from the underworld and take over civilizations during worldgen. Cannot be specified in user-defined raws.

|-
| USE_CASTE
| Creature
|
*new caste token
*old caste token
| Defines a new caste derived directly from a previous caste. The new caste inherits all properties of the old one. The effect of this tag is automatic if one has not yet defined any castes: "Any caste-level tag that occurs before castes are explicitly declared is saved up and placed on any caste that is declared later, unless the caste is explicitly derived from another caste."

|-
| USE_MATERIAL
| Creature
|
*new material ID
*old material ID
| Defines a new local creature material and populates it with all properties defined in the specified local creature material.

|-
| USE_MATERIAL_TEMPLATE
| Creature
|
*new material token
*material template
| Defines a new local creature material and populates it with all properties defined in the specified template.

|-
| USE_TISSUE
| Creature
|
*new tissue token
*old tissue id
| Defines a new local creature tissue and populates it with all properties defined in the local tissue specified in the second argument.

|-
| USE_TISSUE_TEMPLATE
| Creature
|
*new tissue token
*tissue template
| Loads a tissue template listed in OBJECT:TISSUE_TEMPLATE files, such as tissue_template_default.txt.

|-
| UTTERANCES
| Caste
|
| Changes the language of the creature into unintelligible 'kobold-speak', which creatures of other species will be unable to understand. If a civilized creature has this and is not part of a SKULKING civ, it will tend to start wars with all nearby civilizations and will be unable to make peace treaties due to 'inability to communicate'.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==V==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| VEGETATION
| Caste
|
| unknown

|-
| VERMIN_BITE
| Caste
|
*chance of occurance{{verify}}
*verb (bitten, stung, etc)
* [[material token]]
| Vermin bites, and injects something.

|-
| VERMIN_EATER
| Creature
|
| The vermin creature will attempt to eat exposed food. See PENETRATEPOWER. Distict from VERMIN_ROTTER.

|-
| VERMIN_FISH
| Creature
|
| The vermin appears in water and will attempt to swim around.

|-
| VERMIN_GROUNDER
| Creature
|
| The creature appears in "general" surface ground locations. Note that this doesn't stop the creature from flying if it can (most vermin birds have this tag).

|-
| VERMIN_HATEABLE
| Caste
|
| Some dwarves will hate the creature and get unhappy thoughts when around it.

|-
| VERMIN_MICRO
| Caste
|
| This makes the creature move in a swarm of creatures of the same race as it. I.E. Swarm of flies, swarm of ants, etc.

|-
| VERMIN_NOFISH
| Caste
|
| The creature cannot be caught by fishing.

|-
| VERMIN_NOROAM
| Caste
|
| The creature will not be observed randomly roaming about the map.

|-
| VERMIN_NOTRAP
| Caste
|
| The creature cannot be caught in baited animal traps; however, a "catch live land animal" task may still be able to capture one if a dwarf finds one roaming around.

|-
| VERMIN_ROTTER
| Creature
|
| Present on flies, knuckle worms, acorn flies, and blood gnats. Probably means either the creature is attracted to rot, the creature speeds rotting, or both.

|-
| VERMIN_SOIL
| Creature
|
| The creature randomly appears near dirt or mud.

|-
| VERMIN_SOIL_COLONY
| Creature
|
| The vermin will appear in a single tile cluster of many vermin, such as a colony of ants.

|-
| VERMINHUNTER
| Caste
|
| Shortcut for [AT_PEACE_WITH_WILDLIFE] + [RETURNS_VERMIN_KILLS_TO_OWNER] + [HUNTS_VERMIN] + [ADOPTS_OWNER].

|-
| VESPERTINE
| Caste
|
| Sets if the creature is active in evening.

|-
| VIEWRANGE
| Caste
| value
| Value should determine how close you have to get to a critter before it attacks (or prevents adv mode travel etc.) Default is 20.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==W==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| WAGON_PULLER
| Caste
|
| Allows the creature to pull caravan wagons.

|-
| WEBBER
| Caste
|
* [[material token]]
| Allows the creature to create webs, and defines what the webs are made of.

|-
| WEBIMMUNE
| Caste
|
| The creature will not get caught in thick webs.
|}

==Attack Tokens==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| ATTACK_SKILL
| Caste
|
*skill used ([[Skill token]])
| defines the attack skill used

|-
| ATTACK_VERB
| Caste
| 2nd person:3rd person
| descriptive text for the attack

|-
| ATTACK_CONTACT_PERC
| Caste
|
*% value
| amount of available tissue used in attack, or possibly percent chance the attack makes contact

|-
| ATTACK_PENETRATION_PERC
| Caste
|
*% value
| probably amount of material that makes contact when penetration is done, or possibly percent chance the attack penetrates (as in sharp items. Default is 0, so it can be left out for blunt attacks, if this is what it does)

|-
| ATTACK_PRIORITY
| Caste
|
*MAIN or SECOND
| use of the attack in combat. Secondary attacks are only used if main attacks are impossible.

|-
| ATTACK_VELOCITY_MODIFIER
| Caste
| number
| Modifies the attack velocity. 1000 is normal, same as weapon velocity.

|-
| ATTACK_FLAG_CANLATCH
| Caste
|
| Enables an attacker to occasionally latch on with the bodypart used by an attack when an attack with this flag in its definition is made. It will then be able to 'shake' the body part for further damage.

|-
| ATTACK_FLAG_WITH
| Caste
|
| In adventure mode, displays the name of the body part used by an attack when announcing the attack.

|-
| ATTACK_FLAG_EDGE
| Caste
|
| The attack will deal edge-type damage.

|-
| SPECIALATTACK_INJECT_EXTRACT
| Caste
|
* [[material token]]
*state (SOLID, LIQUID, GAS)
*min:max
| attack type addition that injects a material into the victim.

|-
| SPECIALATTACK_INTERACTION
| Caste
| interaction
| When this attack lands successfully, an interaction with I_SOURCE:ATTACK will take effect on the target creature. The attack must break the target creature's skin in order to work. This will take effect in worldgen as well.

|-
| SPECIALATTACK_SUCK_BLOOD
| Caste
| min:max
| Successful attack draws out an amount of blood randomized between the min and max value.
|}

==Important Related Tokens==
These next groups of tokens include several tokens that are not technically classified as creature tokens in string dump, but bear mentioning in this as they are used frequently in creature raws. (Some regular creature tokens may also be reprinted for the sake of ease of navigation)

===Tissue Modification===
This next group of tokens deals setting and modifying tissue properties. (See also [[Tissue definition token]])

{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| PLUS_TISSUE_LAYER
| Caste
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
| Adds a tissue to those selected

|-
| PLUS_TL_GROUP
| Caste
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
*tissue
| continues a selection of tissue layers

|-
| SELECT_TISSUE
| Creature
|
*tissue token
| Selects a tissue for editing.

|-
| SELECT_TISSUE_LAYER
| Caste
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token | Selects a tissue at a location
* (optional) FRONT, BACK, LEFT, RIGHT, TOP, BOTTOM, AROUND.
| Selects a tissue layer for descriptor and cosmetic purposes.

|-
| SET_LAYER_TISSUE
| Caste
|
| Sets a tissue layer to be made of a different tissue.

|-
| TISSUE_LAYER
| Caste
|
*BY_TYPE, BY_CATEGORY, BY_TOKEN
*TYPE,CATEGORY, or TOKEN
*TISSUE
*LOCATION
| Adds the tissue layer to wherever it is required.
Non-argument Locations can be FRONT, RIGHT, LEFT, TOP, BOTTOM. Argument locations are AROUND and CLEANS, requiring a further body part and a % of coverage/cleansing

|-
| TISSUE_LAYER_OVER
| Caste
|
*BY_TYPE, BY_CATEGORY, BY_TOKEN
*TYPE,CATEGORY, or TOKEN
*TISSUE
*LOCATION
| Presumably a counterpart to TISSUE_LAYER_UNDER (see below).

|-
| TISSUE_LAYER_UNDER
| Caste
|
*BY_TYPE, BY_CATEGORY, BY_TOKEN
*TYPE,CATEGORY, or TOKEN
*TISSUE
| Adds the tissue layer under a given part.
For example an Iron Man has a gaseous poison within and this tissue (GAS is its name) has the token [TISSUE_LEAKS] and its state is GAS so when you puncture the iron outside and damage this tissue it leaks gas (can have a syndrome by using a previous one in the creature sample.) [TISSUE_LAYER_UNDER:BY_CATEGORY:ALL:{tissue}] {tissue} is what will be under the TISSUE_LAYER here is an example Tissue from Iron Man:<br>
[TISSUE:GAS] [TISSUE_NAME:gas:NP] [TISSUE_MATERIAL:LOCAL_CREATURE_MAT:GAS] [TISSUE_MAT_STATE:GAS] [RELATIVE_THICKNESS:50] [TISSUE_LEAKS] [TISSUE_SHAPE:LAYER]
|-
| TISSUE_LAYER_APPEARANCE_MODIFIER
| Caste
|
*QUALITY
*lowest:lower:low:median:high:higher:highest
| sets the range of qualities, including LENGTH, DENSE, HIGH_POSITION, CURLY, GREASY, WRINKLY

|-
| TISSUE_STYLE_UNIT
| Caste
|
*tissue
*shaping
| sets tissue to be in a certain shape, mostly used with tissues HAIR, BEARD, MOUSTACHE, SIDEBURNS.

|-
| TL_CONNECTS
| Caste
|
| Presumably gives the CONNECTS attribute to selected layers.

|-
| TL_HEALING_RATE
| Caste
|
| Presumably changes the HEALING_RATE of the selected tissue layers.

|-
| TL_MAJOR_ARTERIES
| Caste
|
| Gives Major Artery attribute to selected layers.

|-
| TL_PAIN_RECEPTORS
| Caste
|
| Seems to set new number of pain receptors for selected tissue layers.

|-
| TL_RELATIVE_THICKNESS
| Caste
|
| Seems to set new relative thickness for selected tissue layers.

|-
| TL_VASCULAR
| Caste
|
| Seems to set new a VASCULAR value (which modulates bleeding) for selected tissue layers.

|}

==See Also==
*[[Body detail plan token]]
*[[Body token]]
*[[Material definition token]]
*[[Syndrome]]
*[[Tissue definition token]]

{{Category|Modding}}
{{Category|Tokens}}

v0.34:Maximizing framerate

2012-09-01T01:55:17Z

I2amroy: /* Game Settings */

{{quality|Fine|02:47, 21 May 2012 (UTC)}}
{{av}}

[[File:Frames_Per_Second_Meter.png|300px|thumb|bottom|A picture of Dwarf Fortress with Frames Per Second displayed.]]

[[Frames per second|Framerate]] is used in Dwarf Fortress to measure the speed at which the game is running. It is measured in "frames per second", or FPS for short. To check your FPS in Dwarf Fortress, simply change [FPS:NO] to [FPS:YES] in [[init.txt]], and your FPS will be displayed on the top row of the screen. The first number is the current frame rate, while the number in parentheses is the current graphical frame refresh rate.

==Increasing your Framerate==
In general, the more stuff the game has to keep track of, the slower the game will run. So, reducing the amount of stuff active keeps your game running fast. The below lists separate ways to improve FPS into two categories: things that don't change the game in any fundamental way, and things that do.

===Without Game Alterations===
Fortress design is specific ways of building and planning, game setting changes are changes mostly in the init and init_d files that don't actually change how the game plays out.

====Fortress Design====
*Using the 'dwarf drops item when the path disappears' technique pioneered by Nil Eyeglazed [http://dwarffortresswiki.org/index.php/User:Vasiln/Undump link] it is possible to eliminate bins and most stockpiles from a fort. This 'allows for near infinite item storage with almost zero impact on fps' as shown [http://dffd.wimbli.com/file.php?id=6316 here] and discussed [http://www.bay12forums.com/smf/index.php?topic=92241.msg3271945#msg3271945 forum].
* Fewer items inside a fort means fewer items to be [[stockpile]]d, checked for [[wear]], and so on and so forth.
** Use a [[Dwarven atom smasher]] to remove items, or donate them to [[Trading|passing caravans]] to be taken away.
** Don't dig out so much of the ground, don't build such large [[Farming|farm plot]]s, just don't generate so many items in the first place.
* Flowing [[water]] slows the game down.
** Don't build [[mist]] generators, [[Screw pump|pump stacks]], or other major water-moving projects. If you do build them, build a [[Lever|way to switch them off]].
** Don't embark on a [[river]] or [[ocean]]. Rivers aren't too bad in their natural state, because the game only needs to calculate at where the water enters and where the water leaves, more-or-less skipping the water in between. Then you start damming them and pumping water out, and it gets worse.
** [[Aquifer]]s don't impose load until you start digging around in them.
**[[Water wheel#Perpetual motion|Dwarven water reactors]] also slow down the game, often significantly.
* Proper use of [[traffic]] designations will help.
** Setting corridors to "high" traffic, and dead-end workshop rooms next to them to "low" traffic, means the pathfinder algorithm will search more quickly along the corridor, and waste less time searching in the rooms.
** Changing the normal traffic weight to 1 in d_init.txt will optimize the pathfinder at the cost of High traffic zones not making a difference ([http://www.bay12forums.com/smf/index.php?topic=97763.msg2841109#msg2841109 source])
* Closing off unused areas with raised [[bridge]]s and locked [[door]]s can help.
** Reducing the area which the pathfinder algorithm has to search lets it run faster.
** In general the pathfinder algorithm is good about not searching irrelevant areas. Caverns are probably the worst offender.
* The size of your embark site increases the amount of terrain which DF needs to keep track of.
** If you don't mind going vertical, try reducing your embark site from the default 4x4 squares to 3x3 or even 2x2.
** World size probably doesn't matter except for the size of the save files, but reducing the number of cavern layers (default of 3) will help. You need at least 1 cavern layer to get underground [[crop|plants]], and 2 caverns to get all the underground [[tree]]s.
* Encountering [[HFS]] will dramatically reduce FPS AFTER you seal the breach ({{bug|1340}}). Either avoid doing so or use the work around posted in the bug report.

====Game Settings====
* G_FPS is a setting in the [[init.txt]] file. It controls how often Dwarf Fortress redraws the screen. It also controls how often the game checks for keyboard or mouse input.
** Reducing G_FPS can speed up the rest of the game. The default choice of 50 works well, but many people reduce it down to 20 with no ill effect.
** Reducing G_FPS too far can make the game unresponsive and glitchy. Some people can cope with 5; most cannot.
* PRINT_MODE is another init setting. It controls the method Dwarf Fortress uses to draw the screen.
** More advanced methods allow DF to make more use of OpenGL features and therefore your graphics card. STANDARD and VBO are good starting points.
** More advanced methods may still have bugs. 2D is more likely to be reliable.
* Using creature graphics may reduce FPS. (Using a custom ASCII tileset should have no effect)
*PRIORITY represents how much importance the game is given when it makes a request of the CPU. From [[init.txt]]:
**"Change this to make the dwarfort.exe process have a different priority. From highest to lowest, the options are REALTIME, HIGH, ABOVE_NORMAL, NORMAL, BELOW_NORMAL and IDLE."
**While it's best to run DF with no other programs in the background if FPS is an issue, giving the priority a bump or two can help speed things up regardless.
*TEXTURE_PARAM controls how the graphics are displayed, specifically how the color value of each pixel is smoothed. It is LINEAR by default. Turning this off gives the CPU one less thing to do, though the improvement in performance is so far unquantified.
**From [[init.txt]]: "Change this to NEAREST if you want the texture values to use the nearest pixel without averaging. Change this to LINEAR if you want the texture values to be averaged over the adjacent pixels."

===With Game Alterations===
All changes in this area have some effect on the game itself, use at your own discretion.

====Game Settings====
*Consider running an older version of DF. 40d should run better than 2010 or 2012, and 23a, while severely lacking, should be significantly faster. *Disputed*
* [[Temperature]] and [[Weather]] are two more features which users may or may not notice.
** Disabling them, using the settings in d_init.txt, can speed things up.
** But then rain won't refill [[murky pool]]s, [[magma]] won't melt [[goblin]]s, etc.
** Disabling temperature also results in obsidian farms being unusable; as they never cool down, dwarves refuse to step on the obsidian floor, preventing the access of hauling dwarves.
** One user [http://www.bay12forums.com/smf/index.php?topic=86761.msg2352509#msg2352509 reported] an FPS boost from 35 to 90 upon disabling temperature. (User note: Confirmed, went from 15 FPS to 70 FPS)
* Each dwarf needs to keep track of where he's going.
** Limit the number of dwarves by setting the population cap.
* Each animal needs to pathfind, too.
** Tame animals can be put into [[cage]]s, keeping them from having anywhere to go. Or you can butcher them.
* Invaders also need to pathfind.
** Turn off invasions using the option in [[D_init.txt]]. Or you can kill them all.

====Mods====
* Disabling your Dwarven civ from wearing clothing as a mod (required regen of world) may help maintain higher fps later in the game{{bug|3942}}, if you don't mind naked dwarves running around. Alternatively, finding a way to dump excess/worn out clothing might help restore fps on existing fortresses. Requires research.

==Mac OS X Specific==
Spotlight indexes files on your mac. Since DF constantly changes files, spotlight will keep indexing them using 60-70% of your CPU. Exclude DF in system preferences: spotlight's privacy settings and you can get a factor of two in FPS. This can easily provide benefits of over 30 FPS, even on multicore computers that do not need to worry about CPU.

{{Category|Guides}}

v0.34:Plant token

2012-08-30T07:46:58Z

I2amroy: /* Crop Tokens */

{{quality|Exceptional|21:01, 30 March 2011 (UTC)}}{{av}}
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.

{| {{prettytable}}
|- style='background-color:#ddd'
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | 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
|
* [[Material token|material]]
| 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.

{| {{prettytable}}
|- style='background-color:#ddd'
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| UNDERGROUND_DEPTH
|
*minimum
*maximum
| Designates the highest and lowest cavern levels that the plant can appear in if its [[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 (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
|
*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 [[biome token|biome]] this plant appears in.

|}

==Tree Tokens==
These tokens are used only for trees.

{| {{prettytable}}
|- style='background-color:#ddd'
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| TREE
|
* [[Material token|material]]
| Makes the plant into a [[tree]]. 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 [[color]] of the tree on the map. Defaults to 2:0:0 (dark green).

|-
| DEAD_TREE_COLOR
|
*foreground
*background
*bright
| The [[color]] of the tree on the map when (un)dead. Defaults to 0:0:1 (dark gray).

|-
| SAPLING_COLOR
|
*foreground
*background
*bright
| The [[color]] of saplings of this tree. Defaults to 2:0:0 (dark green).

|-
| DEAD_SAPLING_COLOR
|
*foreground
*background
*bright
| The [[color]] of dead saplings of this tree. Defaults to 0:0:1 (dark gray).

|-
| 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.

{| {{prettytable}}
|- style='background-color:#ddd'
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | 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 [[Time]]. Defaults to 300. There are 1008 GROWDUR units in a season.

|-
| VALUE
|
*value
| Has no effect as of version 34.11. Previously set the value of the harvested plant.

|-
| PICKED_TILE
|
*tile
| 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
| 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 for dead shrubs that once bore this plant. 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 [[color]] of the plant in farms. Defaults to 2:0:0 (dark green).

|-
| DEAD_PICKED_COLOR
|
*foreground
*background
*bright
| The [[color]] of the plant when wilted. Defaults to 0:0:1 (dark gray).

|-
| SHRUB_COLOR
|
*foreground
*background
*bright
| The [[color]] of shrubs bearing this plant. Defaults to 2:0:0 (dark green).

|-
| DEAD_SHRUB_COLOR
|
*foreground
*background
*bright
|The [[color]] of dead shrubs that bore this plant. Defaults to 6:0:0 (brown).

|-
| SHRUB_DROWN_LEVEL
|
*depth
| The water depth at which shrubs of this plant will drown. Exact behavior is unknown. Defaults to 4.

|-
| DRINK
|
* [[Material token|material]]
| Permits brewing the plant into [[alcohol]] made of this material. Said material should have [ALCOHOL_PLANT] to permit proper stockpiling.

|-
| MILL
|
* [[Material token|material]]
| Permits milling the plant at a [[quern]] or [[millstone]] into a powder made of this material. Said material should have [POWDER_MISC_PLANT] to permit proper stockpiling.

|-
| THREAD
|
* [[Material token|material]]
| Permits processing the plant at a [[farmer's workshop]] to yield threads made of this material. Said material should have [THREAD_PLANT] to permit proper stockpiling.

|-
| SEED
|
*name
*name_plural
*foreground
*background
*bright
*[[Material token|material]]
| 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
*[[Material token|material]]
| Permits processing the plant into a [[bag]] at a [[farmer's workshop]] to yield leaves made of this material and having these properties. Said material should have [LEAF_MAT] to permit proper stockpiling.

|-
| EXTRACT_STILL_VIAL
|
* [[Material token|material]]
| 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
|
*[[Material token|material]]
| 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
|
* [[Material token|material]]
| 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 [[grass]]es.

{| {{prettytable}}
|- style='background-color:#ddd'
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | 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 disabled 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 "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
|
*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).
|}

{{Category|Modding}}
{{Category|Tokens}}

v0.34:Body token

2012-04-28T03:54:20Z

I2amroy: Alphabetized tokens by first letter.

{{quality|Fine|00:14, 23 November 2010 (UTC)}}{{av}}

'''Body tokens''' are one of the fundamental parts of creatures, and determine their bodily structure. There are two major types of body tokens: ''body templates'' (BODY) and ''body parts'' (BP).

A creature uses the [[creature token#B|BODY creature token]] to list all of the body templates it includes. Each part listed in each template is then included in the creature. In other words: a creature lists the ''body templates'' it is made of. Each ''body template'' contains a set of ''body parts''. Each ''body part'' specifies which other body part it is attached to.

Body parts can connect specifically to another body part, or generally to any body part of a certain category. These connections are handled by the CON and CONTYPE body part tokens respectively.

Body parts can be renamed with a bodygloss, allowing someone to reuse an existing template instead of defining a similar template with only the names of the body parts changed.

{| {{prettytable}}
|- bgcolor="#999999"
! Token
! Arguments
! Description

|-
| APERTURE
|
| Marks body part as an opening in the body. This body part cannot be destroyed except by destroying the part it is attached to.

|-
| BP
|
*ID
*name
*pluralized name
| "STP stands for "Standard Plural" and it just adds an 's' to the singular word to save some typing. If you don't add something in that slot, the body part won't even load." --Toady. Note that this can cause confusing issues when porting from 40d to 2010. Make sure you add your pluralizations!

|-
| BREATHE
|
| Body part is used to breathe. If all body parts with [BREATHE] are damaged or destroyed, the creature will suffocate unless it has the NOBREATHE tag in its creature def.

|-
| CON
|
*value
| Connects the body part to a specific other body part

|-
| CON_CAT
|
*value
| Connects the body part to all other body parts having the specified CATEGORY

|-
| CONTYPE
|
*value
| Connects the body part to all other body parts having the specified type token. Valid values are UPPERBODY, LOWERBODY, HEAD, GRASP, or STANCE.

|-
| CIRCULATION
|
| Body part is responsible for blood circulation. Exact effects not known.

|-
| CONNECTOR
|
| Body part is used to connect other body parts together. Used for the neck and lower spine.

|-
| CATEGORY
|
*ID
| Assigns the body part to a user-defined category. Used by CON_CAT to attach to other body parts.

|-
| DEFAULT_RELSIZE
|
*Size
| This command establishes the relative size of body parts within a creature. The numbers have no absolute meaning or units.

|-
| DIGIT
|
|

|-
| EMBEDDED
|
| Body part with this tag is on the surface of parent body part. ie: eye and mouth on head. It can be gouged.

|-
| FLIER
|
| Flags the body part as being need for flight. Damage to a certain number of FLIER body parts will prevent the creature from flying. Note that a creature can only fly if the creature has the FLIER tag in its creature definition, and that a flying creature does not actually need any FLIER body parts. This tags only purpose is to identify body parts which will cause a creature to '''lose''' the ability to fly, if they are damaged.

|-
| GRASP
|
| Creature can wield a picked-up weapon with body part, and can use the part to initiate a wider variety of wrestling moves. When creatures are spawned with a weapon and shield, one GRASP part will hold a weapon while '''all others''' will hold shields.

|-
| GUTS
|
| Body parts marked with this tag make the creature nauseous and vomit when hit.

|-
| HEAD
|
| Flags the body part as being able to wear head clothing like hats, helms, etc. If all heads are chopped off, the creature dies. Multiple heads '''are''' redundant - for example, [[hydra]]s can survive with several missing heads.

|-
| HEAR
|
| Body part is used to hear. No known effects.

|-
| INDIVIDUAL_NAME
|
*name
*plural
| Adding individual names tells the game what to call each individual part in a NUMBERed bodypart. This command replaces "first upper front tooth" for example.

|-
| INTERNAL
|
| Marks the body part as inside the body. Needs [SMALL] tag as well to not be targetable by attacks.

|-
| JOINT
|
| Body part is a joint that may be broken by wrestling.

|-
| LIMB
|
| Body part is a limb. It can be used to initiate certain types of wrestling moves. If it is located between an UPPERBODY part and a GRASP body part, it is eligible to be covered by certain types of armor (body armors and gauntlets). If it is located between a LOWERBODY part and a STANCE body part, it is eligible to be covered by other types of armor (Leg armors like pants, etc; trailing body armors like mail shirts and robes; and high boots).

|-
| LOWERBODY
|
| Flags the body part as being able to wear lower body clothing like skirts, pants, etc. If a lower body is chopped off, the creature dies. Multiple lowerbody parts aren't redundant.

|-
| LEFT
|
| Marks body part as on the left side of the body and vulnerable to attacks from the left. Used in conjunction with tags in the b_detail_plan_default raw.

|-
| MOUTH
|
|

|-
| NUMBER
|
*value
| In theory, the number lets you stack identical body parts. These can be individually damaged by wounds, but you don't have to define them explicitly one by one. If you don't give them individual names (see teeth) they'll be preceded by ordinal numbers (first, second, etc).
HOWEVER, this tag appears to be non-functional.

|-
| NERVOUS
|
| Body part is necessary for motor function. Damage will impair movement and also disallow creature from sparring in Fortress mode.

|-
| RIGHT
|
| Marks body part as on the right side of the body and vulnerable to attacks from the right. Used in conjunction with tags in the b_detail_plan_default raw.

|-
| SKELETON
|
| Body part is part of the creature's skeleton.

|-
| STANCE
|
| Allows the creature to stand. Damage or loss of these body parts will cause creature to fall over.

|-
| SIGHT
|
| Body part is used to see with. If the creature has no SIGHT body parts, or if all its sight body parts are damaged or destroyed, it can't see unless it has the EXTRAVISION tag in its creature def.

|-
| SMELL
|
| Body part is used to smell. No known function. (could possibly control reactions to miasma in fortress mode?)

|-
| SMALL
|
| "SMALL means that the part isn't displayed as part of the overall displayed body part lists. They can't be splinted. They are more often targeted for torture (although those situations might not occur anymore). They are removed in skeletons if they aren't specifically skeletons/joints/digits/apertures. They are more easily lost in world gen duels. They are the only gougable/pinchable parts. SMALL is an old tag, so it has accumulated some weird functions which'll get split off over time. " --Toady

|-
| SOCKET
|
| Allows the body part to be easily knocked out. Used on teeth.

|-
| THROAT
|
| Body part can be strangled.

|-
| THOUGHT
|
| Most creatures die if all bodyparts with this tag have sustained damage to a FUNCTIONAL tissue or been outright destroyed (chopped off). Creatures will not die if they have NO_THOUGHT_CENTER_FOR_MOVEMENT (and/or NOTHOUGHT?)

|-
| TOTEMABLE
|
| Makes the body part makeable into totems at a craftsdwarf's workshop.

|-
| UPPERBODY
|
| Flags the body part as being able to wear upper body clothing like coats, breastplates etc. If an upper body is chopped off, the creature dies. Multiple upperbody parts aren't redundant. All default creatures with bodies have the upperbody as the root of the body tree, making it impossible to chop off.

|-
| UNDER_PRESSURE
|
| Makes the body part pop out of edge attack wounds. Used on guts. Body part shows up as "~" when spilled/popped out.

|-
| VERMIN_BUTCHER_ITEM
|
| Allows the item to be obtained from butchered or rotted vermin.

|}

{{Category|Modding}}
{{Category|Tokens}}

v0.34:Creature token

2012-03-27T18:35:30Z

I2amroy: /* D */

{{av}}{{Quality|Exceptional}}

A full list of all known creature tokens.

__NOTOC__

<div align="center">
{{alphabetical TOC}}
</div>

==A==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| ADOPTS_OWNER
| Caste
|
| Tame creature cannot be made available for adoption, instead automatically adopting whoever it wants. It appears that the basic requirements for adoption are intact; for example, the creature is more likely to adopt an owner which likes creatures of that species.{{verify}}

|-
| ALCOHOL_DEPENDENT
| Caste
|
| Creature needs alcohol to get through the working day.

|-
| ALL_ACTIVE
| Caste
|
| Sets if the creature is active in day, night, and twilight. Seems to be a separate value from DIURNAL/NOCTURNAL/CREPUSCULAR, rather than implying them.

|-
| ALTTILE
| Creature
|
| If set, the creature will blink between its [TILE] and its [ALTTILE].

|-
| AMBUSHPREDATOR
| Caste
|
| Instead of charging relentlessly at prey, a creature with this tag will wait till the prey is within a few squares before charging.{{verify}}

|-
| AMPHIBIOUS
| Caste
|
| Allows a creature to breathe with or without [[water]]. Implies [AQUATIC].

|-
| APP_MOD_DESC_RANGE
| Caste
|
*Range
| [http://www.bay12forums.com/smf/index.php?topic=60554.msg1766793#msg1766793 Forum post describing how description ranges work]

|-
| APP_MOD_GENETIC_MODEL
| Caste
|
*Model (Accepts DOMINANT_MORE, DOMINANT_LESS, and MIX)
| Defines a genetic model for the relevant appearance modifier(s). May or may not do anything significant at present.

|-
| APP_MOD_IMPORTANCE
| Caste
|
*number
| Determines how important the appearance modifier is, for determining whether it shows up in the creature description.{{verify}}

|-
| APP_MOD_NOUN
| Caste
|
*noun
*SINGULAR or PLURAL
| creates a noun for the appearance and whether it is singular or plural

|-
| APP_MOD_RATE
| Caste
|
*Rate (integer)
*Scale (DAILY, YEARLY)
*min:max of growth
*start year:start day
*end year:end day
| setting the growth rate of the modifier. The last two tokens can be replaced by NO_END to have growth continue indefinitely.

|-
| APPLY_CREATURE_VARIATION
| Special
|
*CV TEMPLATE NAME
| Loads the Creature Variation Template specified.

|-
| APPLY_CURRENT_CREATURE_VARIATION
| Special
|
| Applies loaded Creature Variation

|-
| AQUATIC
| Caste
|
| Allows a creature to breathe underwater, but causes it to "drown" out of [[water]].

|-
| ARENA_RESTRICTED
| Caste
|
| Does not appear in arena mode list

|-
| ARTIFICIAL_HIVEABLE
| Creature
|
| Can be kept in artificial hives by beekeepers.

|-
| AT_PEACE_WITH_WILDLIFE
| Caste
|
| Does not attack or frighten wildlife.

|-
| ATTACK
| Caste
|
*token
*bodypart
*selection criteria
*location
| Defines the attack name, and the body part used. See [[#Attack Tokens|below]] for valid subtokens
'''Example:'''<br />
[ATTACK:GORE:BODYPART:BY_CATEGORY:HORN]<br />
''GORE'' : name of the attack<br />
''BODYPART:BY_CATEGORY:HORN'' : the horn is used to attack (presuming the creature has one)

|-
| ATTACK_TRIGGER
| Caste
| pop:exported wealth:created wealth
| Specifies when a [[megabeast]] will attack the fortress.

|}

<div align="center">
{{alphabetical TOC}}
</div>

==B==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| BABY
| Caste
| integer
| Age at which creature is considered a child. Default is zero. One can think of this as the duration of the baby stage.

|-
| BABYNAME
| Caste
| singular:plural
| Defines a new name for a creature in baby state at the caste level. For non-caste-specific baby names, see GENERAL_BABY_NAME.

|-
| BEACH_FREQUENCY
| Caste
|
| [[Whale]]s and [[Sea nettle jellyfish|jellyfish]] have this. Controls the beaching frequency of the creature.

|-
| BENIGN
| Caste
|
| The creature will only show up in "tame" biomes. Such creatures will generally avoid dwarves, although they may chase and/or attack them if they get too close, notably including [[elephant]]s.

|-
| BIOME
| Creature
|
* [[biome token]]
| Select a [[Biome]] the creature may appear in.

|-
| BLOOD
| Caste
|
* [[material token]]
*matter state (LIQUID, GAS, SOLID)
| Specifies what the creature's blood is made of.

|-
| BLOODSUCKER
| Caste
|
| ?

|-
| BODY
| Caste
| body parts
| Draws body parts from OBJECT:BODY files (such as body_default.txt)
'''Example:'''<br />
[BODY:BODY_WITH_HEAD_FLAG:HEART:GUTS:BRAIN:MOUTH] <br />
This is the body from a [[Purring maggot]]. It creates a body with head, a heart, some guts, a brain, and a mouth. Thats all a maggot needs.

|-
| BODY_APPEARANCE_MODIFIER
| Caste
|
*ATTRIBUTE
*lowest:lower:low:median:high:higher:highest
| These body modifiers give individual creatures different characteristics. In the case of HEIGHT, BROADNESS and LENGTH, the modifier is also a percentage change to the BODY_SIZE of the individual creature. The seven numbers afterward give a distribution of ranges. Each interval has an equal chance of occurring.
'''Example:'''<br />
[BODY_APPEARANCE_MODIFIER:HEIGHT:90:95:98:100:102:105:110] <br />
''HEIGHT'' : marks the height to be changed <br />
''90:95:98:100:102:105:110'' : sets the range from the shortest (90% of the average height) to the tallest (110% of the average height) creature variation.

|-
| BODY_DETAIL_PLAN
| Caste
| PlanName, PlanName:type:type:type:etc
| loads a plan listed OBJECT:BODY_DETAIL_PLAN files, such as b_detail_plan_default.txt. Mass applies USE_MATERIAL_TEMPLATE, mass alters RELSIZE, alters body part positions, and will allow tissue layers to be defined. Tissue layers are defined in order of skin to bone here.
'''Example:'''<br />
[BODY_DETAIL_PLAN:VERTEBRATE_TISSUE_LAYERS:SKIN:FAT:MUSCLE:BONE:CARTILAGE] <br />
This creates the detailed body of a [[fox]], the skin, fat, muscle, bones and cartilage out of the vertebrate tissues.<br />
A [[Purring maggot|maggot]] would only need:<br />
''[BODY_DETAIL_PLAN:EXOSKELETON_TISSUE_LAYERS:SKIN:FAT:MUSCLE]''

|-
| BODY_SIZE
| Caste
| years:days:size
| sets up size at a given time. Size is in cubic centimeters (milliliters), and for normal body materials is roughly equal to the creature's average weight in grams.
'''Example:'''<br />
[BODY_SIZE:0:0:10000]<br />
[BODY_SIZE:1:168:50000]<br />
[BODY_SIZE:12:0:220000]<br />
This describes the size of a [[minotaur]]. His birth size would be 10000 (10000 mL, ~10 kg). With 1 year and 168 days he would be 50000 tall (~50 kg). As an adult (with 12 years) he would weight roughly 220 kg

|-
| BODYGLOSS
| Caste
| gloss
| Substitutes body part text with replacement text. Draws gloss information from OBJECT:BODY files (such as body_default.txt)

|-
| BONECARN
| Caste
|
| Creature 'eats' bones. Eating bones makes their happiness go up, but can cause death (suffocation){{verify}}. Implies CARNIVORE. Civilized creatures (ex. Kobolds) with this tag tend to die out during world generation.

|-
| BP_APPEARANCE_MODIFIER
| Caste
|
*QUALITY
*lowest:lower:low:median:high:higher:highest
| sets up the breadth of possibilities for appearance qualities for a selected BP group. EG. Eyes (CLOSE_SET, DEEP_SET, ROUND_VS_NARROW, LARGE_IRIS),Lips (THICKNESS), Nose (BROADNESS, LENGTH, UPTURNED, CONVEX), Ear (SPLAYED_OUT, HANGING_LOBES, BROADNESS, HEIGHT), Tooth (GAPS), Skull (HIGH_CHEEKBONES, BROAD_CHIN, JUTTING CHIN, SQUARE_CHIN), Neck (DEEP_VOICE, RASPY_VOICE), Head (BROADNESS, HEIGHT)

|-
| BUILDINGDESTROYER
| Caste
| 1 or 2
| Allows a creature to destroy furniture and buildings. Value [1] targets mostly doors, hatches, furniture and the like. Value [2] targets anything not made with the b + C commands.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==C==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| CAN_DO_INTERACTION
| Caste
| interaction token
| The creature can perform an interaction. See [[interaction token]].

|-
| CAN_LEARN
| Caste
|
| The creature gets skills and professions. Note that this token makes the creature unable to be butchered by an adventurer so it is not recommended for uncivilized monsters. Adventurers lacking this token can allocate but not increase attributes and skills. skills allocated will disappear on start.

|-
| CAN_SPEAK
| Caste
|
| Can talk. Note that it is not necessary for a creature to gain social skills. If a member of a civilization (such as a pet) has this token, it'll need to eat and drink.{{verify}}

|-
| CANNOT_UNDEAD
| Caste
|
| Alias for NOT_LIVING

|-
| CANOPENDOORS
| Caste
|
| Allows the creature to open doors.

|-
| CARNIVORE
| Caste
|
| Creature ''only'' eats meat. Note that carnivorous species will not be able to survive worldgen if they do not also have NO_EAT.

|-
| CASTE
| Creature
|
*name
| defines a caste

|-
| CASTE_ALTTILE
| Caste
|
*tile number or "letter"
| Caste-specific alternate tile. Expects CASTE_TILE

|-
| CASTE_COLOR
| Caste
|
*fg
*bg
*brightness
| Creature tile color of the caste.

|-
| CASTE_GLOWCOLOR
| Caste
|
*fg
*bg
*brightness
| GLOWTILE color of the caste.

|-
| CASTE_GLOWTILE
| Caste
|
*tile value or "letter"
| Caste-specific glowtile

|-
| CASTE_NAME
| Caste
| singular:plural:adjective
| The name of the caste of the creature in the game.

|-
| CASTE_PROFESSION_NAME
| Caste
|
*[[Unit type token]] (Profession)
*singular
*plural
| alters the name of the given profession, caste-specific

|-
| CASTE_SOLDIER_ALTTILE
| Caste
| 'character' or tile number
| Creatures of this caste active in their civilization's military will blink between their default tile and this one.

|-
| CASTE_SOLDIER_TILE
| Caste
| 'character' or tile number
| Creatures of this caste active in their civilization's military will use this tile instead.

|-
| CASTE_SPEECH
| Caste
| speech file?
| Possibly a caste-specific instance of the SPEECH token

|-
| CASTE_TILE
| Caste
|
* tile number or "letter"
| Caste-specific creature tile.

|-
| CAVE_ADAPT
| Caste
|
| Gives the creature a bonus in caves. Also causes [[Cave adaptation]].

|-
| CDI
| Caste
| Varies
| Specifies details for the preceding CAN_DO_INTERACTION token. See [[Interaction token]].

|-
| CHANGE_BODY_SIZE_PERC
| Caste
|
|

|-
| CHILD
| Caste
| integer
| age at which creature is considered an adult. One can think of this as the duration of the child stage. Without this token, a creature will not reproduce in Fortress mode.

|-
| CHILDNAME
| Caste
| singular:plural
| Defines a new name for a creature in child state at the caste level. For non-caste-specific child names, see GENERAL_CHILD_NAME.

|-
| CLUSTER_NUMBER
| Creature
|
*min
*max
| The minimum/maximum numbers of how many creatures per spawned cluster. Certain vermin fish use this token in combination with temperate ocean and river biome tokens to perform seasonal migrations.
e.g. [CLUSTER_NUMBER:1:3]

|-
| CLUTCH_SIZE
| Caste
|
*min
*max
|Number of eggs laid in one sitting.

|-
| COLONY_EXTERNAL
| Caste
|
| Caste hovers around colony.

|-
| COLOR
| Creature
| foreground:background:brightness
| Color of the creature's tile.

|-
| COMMON_DOMESTIC
| Caste
|
| Allows the creature to be brought with immigrants and when creating a new fortress, as long as the creature also includes at least one of the following tokens: PET, PACK_ANIMAL, WAGON_PULLER, MOUNT. In addition, the creature must be NATURAL rather than FANCIFUL

|-
| CONVERTED_SPOUSE
| Caste
|
| Creatures of this caste's species with the SPOUSE_CONVERTER and NIGHT_CREATURE_HUNTER tokens will kidnap SPOUSE_CONVERSION_TARGETs of an appropriate sex and convert them into castes with CONVERTED_SPOUSE.

|-
| COOKABLE_LIVE
| Caste
|
| Set this to allow the creature to be cooked in meals without first being butchered / fishcleaned.

|-
| CRAZED
| Caste
|
| Attacks all creatures, including undead and inorganic ones.

|-
| COPY_TAGS_FROM
| Special
|
*CREATURE NAME
| Copies tags from another specified creature.

|-
| CREATURE_CLASS
| Caste
|
*classname
| Creature class. Can be anything, but only existing use is GENERAL_POISON. Appears to only be used for Syndromes. Supposedly can also be used for entity positions.

|-
| CREATURE_SOLDIER_TILE
| Creature
| 'character' or tile number
| Creatures active in their civilization's military will use this tile instead.

|-
| CREATURE_TILE
| Creature
| 'character' or tile number
| The symbol of the creature in ASCII mode.

|-
| CREPUSCULAR
| Caste
|
| Sets if the creature is active at twilight.

|-
| CURIOUSBEAST_EATER
| Caste
|
| Allows a creature to steal and eat edible items from a site.

|-
| CURIOUSBEAST_GUZZLER
| Caste
|
| Allows a creature to (very quickly) drink your alcohol. Or spill the barrel to the ground. Also affects undead versions of the creature.

|-
| CURIOUSBEAST_ITEM
| Caste
|
| Allows a creature to steal things (apparently the highest value it can find). Semimegabeast thievery is in Legends mode. Lightweight creatures can probably steal heavy items.

|-
| CV_ADD_TAG
| Special
|
*TAG NAME
| Adds a tag. Used in conjunction with creature variation templates.

|-
| CV_REMOVE_TAG
| Special
|
*TAG NAME
| Removes a tag. Used in conjunction with creature variation templates.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==D==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| DEMON
| Caste
|
| Found on generated [[demon]]s. Cannot be specified in user-defined raws.

|-
| DESCRIPTION
| Caste
| text
| A brief description of the creature type.

|-
| DIE_WHEN_VERMIN_BITE
| Caste
|
| Dies upon attacking. Used for bee stings.

|-
| DIFFICULTY
| Caste
| integer
| Toady: "Difficulty determines how deep it places them in adventure mode/reclaim caves, and the chance that they are wounded the first few river attacks." (Outdated? This particular quote referred to version .23a) Also increases experience gain during adventure mode.

|-
| DIURNAL
| Caste
|
| Sets if the creature is active in day.

|-
| DIVE_HUNTS_VERMIN
| Caste
|
| Found on [[peregrine falcons]]. The creature hunts vermin by diving from the air. May be bugged due to fortress pets remaining earthbound.

|-
| DOES_NOT_EXIST
| Creature
|
| Creature does not actually exist; used for fanciful creatures.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==E==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| EBO_ITEM
| Caste
| [[item token]]:[[material token]] (ANY_HARD_STONE can be used for the material)
| Defines the item that the creature drops upon being butchered. Used with EXTRA_BUTCHER_OBJECT.

|-
| EBO_SHAPE
| Caste
| gem shape
| The shape of the extra item of the creature upon butchering. Used with EXTRA_BUTCHER_OBJECT.

|-
| EGG_MATERIAL
| Caste
|
* [[material token]]
*state (SOLID, LIQUID, or GAS)
| Egg material. Egg-laying creatures will define this 3 times, using LOCAL_CREATURE_MAT:EGGSHELL, LOCAL_CREATURE_MAT:EGG_WHITE, and then LOCAL_CREATURE_MAT:EGG_YOLK. Eggs will be made out of eggshell. Edibility is determined by tags on whites or yolk, but they otherwise do not exist.

|-
| EGG_SIZE
| Caste
|
*size
| Determines how long it takes for eggs to hatch{{verify}}. The larger the number, the longer it takes.

|-
| EQUIPMENT_WAGON
| Creature
|
| Makes the creature into a large 3x3 creature responsible for carrying trade goods, pulled by two [WAGON_PULLER]s and driven by a merchant.

|-
| EQUIPS
| Caste
|
| Allows the creature to wear or wield items.

|-
| EVIL
| Creature
|
| Creature is considered evil and will only show up in evil biomes. Has no effect on cavern creatures.

|-
| EXTRA_BUTCHER_OBJECT
| Caste
|
* BY_CATEGORY, BY_TYPE, BY_TOKEN
* TYPE, CATEGORY, or TOKEN
| The creature drops an additional object when butchered (typically a gizzard stone), defined by EBO_ITEM and EBO_SHAPE.

|-
| EXTRACT
| Caste
|
* [[material token]]
| Defines a creature extract which can be obtained via [[small animal dissection]].

|-
| EXTRAVISION
| Caste
|
| Creature can see regardless of whether it has working eyes.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==F==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| FANCIFUL
| Creature
|
| Makes every civilization know about the creature. The creature won't occur in regular material preference lists. The tag also adds some art value modifiers. Used for things like dragons and other legendary creatures. Conflicts with [COMMON_DOMESTIC]

|-
| FEATURE_ATTACK_GROUP
| Caste
|
| Found on subterranean animalmen.

|-
| FEATURE_BEAST
| Caste
|
| Found on [[forgotten beast]]s. Cannot be specified in user-defined raws.

|-
| FEMALE
| Caste
|
| Inside a female caste, sets femaleness. Outside of a caste, sets all individuals female unless overridden by caste.

|-
| FIREIMMUNE
| Caste
|
| Renders a creature immune to being damaged by FIREBREATH's short range cone attack.

|-
| FIREIMMUNE_SUPER
| Caste
|
| The creature is immune to DRAGONFIREBREATH. Implies FIREIMMUNE.

|-
| FISHITEM
| Caste
|
| Needs to be cleaned at a fishery

|-
| FIXED_TEMP
| Caste
| temperature
| The natural heat generated by the creature.

|-
| FLEEQUICK
| Caste
|
| Determines how soon a creature flees in a losing battle. Creatures with this tag will flee at the first sign of resistance.

|-
| FLIER
| Caste
|
| Allows a creature to fly. Fortress Mode pathfinding only partially incorporates pathfinding - flying dwarves need a land path to exist between them and an area in order to access it, but as long as one such path exists, they do not need to use it, instead being able to fly over intervening obstacles.

|-
| FREQUENCY
| Creature
|
*number, max 100
| Determines the time between creature spawns in Fortress Mode. Higher is more occurrences per time unit. Creatures without a frequency statement default to 50. Almost all others have either [FREQUENCY:5] or [FREQUENCY:100]. Not to be confused with POP_RATIO
|}

<div align="center">
{{alphabetical TOC}}
</div>

==G==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| GENERAL_BABY_NAME
| Creature
| singular:plural
| name at creature level

|-
| GENERAL_CHILD_NAME
| Creature
| singular:plural
| name at creature level

|-
| GENERAL_MATERIAL_FORCE_MULTIPLIER
| Caste
| A:B
| Attacks against the creature have their force modified by A/B. For example, 1:2 will halve the force of an attack made against the creature. {{verify}}

|-
| GENERATED
| Creature
|
| Found on procedurally generated creatures like [[Forgotten beast]]s, (biome name) [[titan]]s, [[Demon]]s, and [[night creature]]s. Cannot be specified in user-defined raws.

|-
| GETS_INFECTIONS_FROM_ROT
| Caste
|
| Creature can get infections from necrotic tissue.

|-
| GETS_WOUND_INFECTIONS
| Caste
|
| Creature's wounds can become infected.

|-
| GLOWCOLOR
| Creature
|
*foreground
*background
*brightness
| The colour of the GLOWTILE of the creature.

|-
| GLOWTILE
| Creature
| ascii character
| If present, the being glows in the dark (generally used for Adventure Mode). The tile is what replaces the being's current tile when it is obscured from your sight by darkness. The default setting for kobolds (a yellow quotation mark) provides a nice "glowing eyes" effect. The game is also hardcoded to automatically convert quotation mark GLOWTILES into apostrophes if the creature has lost one eye. This works at the generic creature level - for caste-specific glow tiles, use CASTE_GLOWTILE instead.

|-
| GNAWER
| Caste
| verb
| The creature chews on food barrels and bags. The verb is past tense, for example [GNAWER:gnawed].

|-
| GOBBLE_VERMIN_CLASS
| Caste
| class
| The creature eats vermin of the specified caste.

|-
| GOBBLE_VERMIN_CREATURE
| Caste
| creature:caste
| The creature eats a specified vermin.

|-
| GO_TO_END
| Special
|
| When using tags from an existing creature, inserts new tags at the end of the creature.

|-
| GO_TO_START
| Special
|
| When using tags from an existing creature, inserts new tags at the beginning of the creature.

|-
| GO_TO_TAG
| Special
|
| When using tags from an existing creature, inserts new tags after the specified tag.

|-
| GOOD
| Creature
|
| Creature is considered good and will only show up in good biomes, for example [[unicorn]]s. Presumably has no effect on cavern creatures.

|-
| GRASSTRAMPLE
| Caste
| value
| The value determines how rapidly grass is trampled when a creature steps on it - a value of 0 causes the creature to never damage grass, while a value of 100 causes grass to be trampled as rapidly as possible. Defaults to 5.

|-
| GRAVITATE_BODY_SIZE
| Caste
| target value
| Used in Creature Variants. This token changes the adult body size to the average of the old adult body size and the target value and scales all intermediate growth stages by the same factor.

|-
| GRAZER
| Caste
|
*number
| Animals is a grazer. The higher the number, the less frequently it needs to eat in order to survive.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==H==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| HABIT
| Caste
| type:probability
| Defines certain behaviors for the creature. The habit types are COLLECT_TROPHIES, COOK_PEOPLE, COOK_VERMIN, GRIND_VERMIN, COOK_BLOOD, GRIND_BONE_MEAL, EAT_BONE_PORRIDGE, USE_ANY_MELEE_WEAPON, GIANT_NEST, and COLLECT_WEALTH. These may require the creature to have a lair to work properly.

|-
| HABIT_NUM
| Caste
| number or TEST_ALL
| "If you set HABIT_NUM to a number, it should give you that exact number of habits according to the weights.".<sup>[[http://www.bay12forums.com/smf/index.php?topic=60554.msg1719248#msg1719248 source post]]</sup> All lists of HABITs are preceded by [HABIT_NUM:TEST_ALL]

|-
| HAS_NERVES
| Caste
|
| This makes the creature susceptible to severed motor and sensory nerves when muscles are torn in limb, grasp and stance parts. Some butchering yields nervous tissue.

|-
| HASSHELL
| Caste
|
| The creature has a shell. Seemingly no longer used - holdover from previous versions.

|-
| HIVE_PRODUCT
| Creature
|
*number
*[[time]]
*[[item token]]s
| What product is harvested from [[Beekeeping industry|beekeeping]].

|-
| HOMEOTHERM
| Caste
|
| Default 'NONE'. The creature's normal body [[temperature]]

|-
| HUNTS_VERMIN
| Caste
|
| Creature hunts and kills nearby vermin.

|}

<div align="center">
{{alphabetical TOC}}
</div>

==I==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| IMMOBILE
| Caste
|
| The creature cannot move. Found on [[sponge]]s.

|-
| IMMOBILE_LAND
| Caste
|
| The creature is immobile while on land. Only works on AQUATIC creatures which can't breathe on land.

|-
| IMMOLATE
| Caste
|
| Will ignite, and potentially completely destroy, items the creature is standing on. Keep booze away from critters with this tag.

|-
| INTELLIGENT
| Caste
|
| Shortcut for [CAN_SPEAK] + [CAN_LEARN].

|-
| ITEMCORPSE
| Caste
|
* [[item token]]
* [[material token]]
| Determines if the creature leaves behind a non-standard corpse (i.e. wood, statue, bars, ash from ghost etc).

|-
| ITEMCORPSE_QUALITY
| Caste
|
| The quality of an item-type corpse left behind; 5 is masterpiece-level.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==L==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| LAIR
| Caste
| type:probability
| Found on megabeasts, semimegabeasts, and night creatues. The creature will seek out sites of this type and take them as lairs. The lair types are SIMPLE_BURROW, SIMPLE_MOUND, WILDERNESS_LOCATION, SHRINE, and LABYRINTH.

|-
| LAIR_CHARACTERISTIC
| Caste
| characteristic:probability
| Defines certain features of the creature's lair. The only valid characteristic is HAS_DOORS.

|-
| LAIR_HUNTER
| Caste
|
| This creature will actively hunt adventurers in its lair.

|-
| LAIR_HUNTER_SPEECH
| Caste
| speech file
| What this creature says while hunting adventurers in its lair.

|-
| LARGE_PREDATOR
| Caste
|
| Will attack things that are smaller than it (like dwarves). Only one group of "large predators" will appear on any given map (possibly two groups on "savage" maps). In adventure mode, large predators will try to ambush and attack you (and your party will attack them back). Also, they can be mentioned in the intro paragraph when starting a fortress e.g. "ere the wolves get hungry."

|-
| LARGE_ROAMING
| Creature
|
| In Fortress Mode, spawns outdoors and is not a vermin creature.

|-
| LAYS_EGGS
| Caste
|
| Creature lays eggs instead of giving birth to live young.

|-
| LAYS_UNUSUAL_EGGS
| Caste
|
* [[item token]]
* [[material token]]
| Creature lays a particular item instead of regular eggs.

|-
| LIGAMENTS
| Caste
|
* [[material token]]
*healing rate
| Defines the material and healing rate of ligaments.

|-
| LIGHT_GEN
| Caste
|
| The creature will generate light, such as in adventurer mode at night.

|-
| LIKES_FIGHTING
| Caste
|
| The creature will attack enemies rather than flee from them. This tag has the same effect on player-controlled creatures - included modded dwarves.

|-
| LISP
| Caste
|
| Creature uses "sssssnake talk" (multiplies 'S' when talking - "My name isss Recisssiz.")

|-
| LITTERSIZE
| Caste
|
* minumum
* maximum
| Determines the random chance of how many creatures are generated when giving birth. [LITTERSIZE:1:2]

|-
| LOCKPICKER
| Caste
|
| Lets a creature open doors that are set to forbidden in Fortress Mode.

|-
| LOOSE_CLUSTERS
| Creature
|
| The creatures will scatter if they have this tag, or form tight packs if they don't.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==M==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| MAGICAL
| Caste
|
| Unknown.

|-
| MAGMA_VISION
| Caste
|
| Creature's able to see while covered in magma.

|-
| MALE
| Caste
|
| The species or caste is all male.

|-
| MANNERISM_*
| Caste
|
*occasionally body part
| Adds a possible mannerism to the creature's profile.
Refer to [[Creature mannerism token]]s

|-
| MATERIAL
| Creature
|
*material id
| Begins defining a new material.{{verify}}

|-
| MATERIAL_FORCE_MULTIPLIER
| Caste
| *[[Material token]]
*A:B
| Set the force multiplier of a specific material against the creature to A/B. For example, 10:1 multiplies the force by 10. {{verify}}

|-
| MATUTINAL
| Caste
|
| Sets if the creature is active in dawn.

|-
| MAXAGE
| Caste
| min:max
| Range of time in years in which death from old age may occur. Once a creature reaches the min value, it has a random chance each season of dying from old age. Unknown if the chance increases with further age.

|-
| MEANDERER
| Caste
|
| Gives a creature random movement.

|-
| MEGABEAST
| Caste
|
| Appears on fortress territory in Fortress Mode occasionally. Can also be worshipped.

|-
|MENT_ATT_CAP_PERC
| Caste
|
*ATTRIBUTE Token
*Cap %
|Default is 200. This means you can increase your attribute to 200% of its starting value (or the average value + your starting value if that is higher).

|-
| MENT_ATT_RANGE
| Caste
|
*ATTRIBUTE
*lowest:lower:low:median:high:higher:highest
| Sets up a mental attribute's range of values (0-5000). All mental attribute ranges default to 200:800:900:1000:1100:1300:2000.

|-
| MENT_ATT_RATES
| Caste
|
*ATTRIBUTE Token
*cost to improve
*unused counter rate
*rust counter rate
*demotion counter rate
| Mental attribute gain/decay rates. Defaults are 500:4:5:4.

|-
| MILKABLE
| Caste
|
* [[material token]]
* frequency
| Allows the creature to be milked.

|-
| MISCHIEVIOUS
| Caste
|
| Alias for MISCHIEVOUS

|-
| MISCHIEVOUS
| Caste
|
| Will pull any levers it comes across. Also makes creature spawn invisible and with several ranks in Ambusher. "They go on little missions to mess with various fortress buildings, not just levers."

|-
| MODVALUE
| Caste
|
| Seemingly no longer used - holdover from previous versions.

|-
| MOUNT
| Caste
|
| Creature may be used as a mount.

|-
| MOUNT_EXOTIC
| Caste
|
| You need the Dungeon master noble to mount the creature.

|-
| MULTIPLE_LITTER_RARE
| Caste
|
| Makes litters with more than one offspring rare.

|-
| MUNDANE
| Creature
|
| Marks if the creature is an actual real-life creature. Only used for age-names at present, and determining whether a creature will attack creatures with the AT_PEACE_WITH_WILDLIFE token.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==N==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| NAME
| Creature
| singular:plural:adjective
| The generic name for any creature of this type - will be used when distinctions between caste are unimportant. For names for specific castes, use CASTE_NAME instead.

|-
| NATURAL
| Caste
|
| Alias for NATURAL_ANIMAL

|-
| NATURAL_ANIMAL
| Caste
|
| Animal is considered to be natural.

|-
| NATURAL_SKILL
| Caste
| skill:value
| The creature possesses this skill at this level inherently. It begins with this skill at this level, and the skill may never rust below this level. Requires CAN_LEARN or INTELLIGENT to function (changed in .25 or earlier that CAN_LEARN is no longer required).

|-
| NIGHT_CREATURE_BOGEYMAN
| Caste
|
| Found on bogeymen. Creatures with this tag will join other bogeymen in attacking adventurers at night, and will also adopt their other behaviors, such as vanishing in smoke upon being killed. This does not affect the creature's presence elsewhere, such as for generated megabeasts, normal creatures, entity members, etc. Setting the number of night creatures to zero in the world gen parameters will remove only the randomly-generated bogeymen.

|-
| NIGHT_CREATURE_HUNTER
| Caste
|
| If this creature has SPOUSE_CONVERTER, it will actively attempt to seek out potential conversion targets, abduct them, and convert them. Night creatures will seek out one SPOUSE_CONVERSION_TARGET <s>of the opposite sex</s>(seems to choose anyone of any sex of the caste/s that have the CONVERTED_SPOUSE tag), convert them, and then have children with them(if possible). NIGHT_CREATURE_HUNTERs without SPOUSE_CONVERTER will not be placed. Setting the number of night creatures to zero in the world gen parameters will remove only the randomly-generated night creatures.

|-
| NO_AUTUMN
| Caste
|
| does not appear this season.

|-
| NO_CONNECTIONS_FOR_MOVEMENT
| Caste
|
| Creature doesn't require connected body parts to move{{verify}}; generally used on undead creatures with connections that have rotted away.

|-
| NO_DIZZINESS
| Caste
|
| Creature cannot become dizzy

|-
| NO_DRINK
| Caste
|
| Creature does not need to drink.

|-
| NO_EAT
| Caste
|
| Creature does not need to eat.

|-
| NO_FEVERS
| Caste
|
| Creature cannot suffer fevers

|-
| NO_GENDER
| Caste
|
| Creature has no gender.

|-
| NO_PHYS_ATT_GAIN
| Caste
| ?
| ?

|-
| NO_PHYS_ATT_RUST
| Caste
| ?
| ?

|-
| NO_SLEEP
| Caste
|
| Creature does not need to sleep.

|-
| NO_SPRING
| Caste
|
| does not appear this season.

|-
| NO_SUMMER
| Caste
|
| does not appear this season.

|-
| NO_THOUGHT_CENTER_FOR_MOVEMENT
| Caste
|
| Creature doesn't require an organ with the [THOUGHT] tag to survive; generally used on creatures that don't have brains.

|-
| NO_WINTER
| Caste
|
| does not appear this season.

|-
| NOBONES
| Caste
|
| Creature has no bones.

|-
| NOBREATHE
| Caste
|
| Creature doesn't need to breathe or have [BREATHE] parts in body. Cannot drown or be strangled.

|-
| NOCTURNAL
| Caste
|
| Sets if the creature is active in night.

|-
| NOEMOTION
| Caste
|
| The creature has no emotions, and does not rage.

|-
| NOEXERT
| Caste
|
| Creature can't become tired or over-exerted.

|-
| NOFEAR
| Caste
|
| Creature doesn't feel fear and will never run away from battle.

|-
| NOMEAT
| Caste
|
| Creature will not drop meat on butcher.

|-
| NONAUSEA
| Caste
|
| Creature can't vomit.

|-
| NOPAIN
| Caste
|
| Creature doesn't feel pain.

|-
| NOSKIN
| Caste
|
| Creature will not drop skin on butcher.

|-
| NOSKULL
| Caste
|
| Creature will not drop skull on butcher, rot, or decay of severed head.

|-
| NOSMELLYROT
| Caste
|
| Does not produce miasma when rotting

|-
| NOSTUCKINS
| Caste
|
| Weapons can't be stuck in creature.

|-
| NOSTUN
| Caste
|
| Creature can't be stunned. Creatures with this tag never wake up from sleep in Fortress Mode and stay drowsy. If this creature must eat and drink while playing, it WILL die.

|-
| NOT_BUTCHERABLE
| Caste
|
| Cannot be butchered

|-
| NOT_LIVING
| Caste
|
| Cannot be raised from the dead.

|-
| NOTHOUGHT
| Caste
|
| Creature doesn't think, or doesn't require a [BRAIN] body part.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==O==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| OPPOSED_TO_LIFE
| Caste
|
| Is hostile to all creatures except undead and other non-living ones. Used for [[Undead]].

|}

<div align="center">
{{alphabetical TOC}}
</div>

==P==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| PACK_ANIMAL
| Caste
|
| Allows the creature to be used as a pack animal. Currently only used by merchants. Also prevents creature from dropping hauled items on its own -- do not use for player-controllable creatures.

|-
| PARALYZEIMMUNE
| Caste
|
| The creature is immune to all paralyzing special attacks.

|-
| PATTERNFLIER
| Caste
|
|

|-
| PEARL
| Caste
|
| Creature will generate pearls.

|-
| PENETRATEPOWER
| Caste
| value
| Controls the ability of vermin to find a way into containers when they are eating food from your stockpiles. Wood and cloth objects roll a 0-9 and if it's greater than the penetrate power, their contents escape for the time being. Other objects roll a 0-99.

|-
| PERSONALITY
| Caste
|
*ATTRIBUTE
*lowest:median:highest
| Determines the range and chance of personality traits. Standard is 0:50:100. See [[Personality trait]] for more info.

|-
| PET
| Caste
|
| Allows the creature to be tamed. Also allows all females of the species to breed regardless of marital status.

|-
| PET_EXOTIC
| Caste
|
| You need a Dungeon master noble in your fortress for the creature to be tamable (but any Animal trainer can do the taming).

|-
| PETVALUE
| Caste
| value
| How valuable a tamed animal/pet is. Actual cost in points in the embarking screen is (PETVALUE/2)+1 for an untrained animal, PETVALUE+1 for a trained(War or Hunting) one. Note that for an animal to be selectable in this screen, it must have the COMMON_DOMESTIC token.

|-
| PETVALUE_DIVISOR
| Caste
| value
| Divides the creature's PETVALUE by the specified number. Used for bees to prevent a single hive from being worth a fortune.

|-
|PHYS_ATT_CAP_PERC
| Caste
|
*ATTRIBUTE Token
*Cap %
|Default is 200. This means you can increase your attribute to 200% of its starting value (or the average value + your starting value if that is higher).

|-
| PHYS_ATT_RANGE
| Caste
|
*ATTRIBUTE
*lowest:lower:low:median:high:higher:highest
| Sets up a physical attribute's range of values (0-5000). All physical attribute ranges default to 200:700:900:1000:1100:1300:2000.

|-
| PHYS_ATT_RATES
| Caste
|
*ATTRIBUTE Token
*cost to improve
*unused counter rate
*rust counter rate
*demotion counter rate
| Physical attribute gain/decay rates. Defaults for STRENGTH, AGILITY, TOUGHNESS, and ENDURANCE are 500:3:4:3, while RECUPERATION and DISEASE_RESISTANCE default to 500:NONE:NONE:NONE.

|-
| PLUS_BP_GROUP
| Caste
|
*BY_TYPE, BY_CATEGORY, or BY_TOKEN
*body type, category, or token
| Adds a body part group to selected body part group. Presumably used immediately after SET_BP_GROUP.

|-
| PLUS_MATERIAL
| Creature
|
*material
| Adds a material to selected materials. Used immediately after SELECT_MATERIAL.

|-
| POP_RATIO
| Caste
|
| Weighted population of caste; Lower is rarer. Not to be confused with FREQUENCY.

|-
| POPULATION_NUMBER
| Creature
| min:max
| old guess: "The minimum/maximum numbers of how many of these creatures can show up on a map per year."<br>Toady: "Pop number is the number per square of the region, I think."

|-
| POWER
| Caste
|
|Allows the being to represent itself as a deity. Requires CAN_SPEAK to actually do anything more than settle at a location.

|-
| PREFSTRING
| Creature
| string
| Sets what other creatures like about this creature. "Urist likes dwarves for their beards." Multiple entries will be chosen from at random

|-
| PROFESSION_NAME
| Creature
|
*[[Unit type token]] (Profession)
*singular
*plural
| The generic name for members of this profession, at the creature level. In order to give members of specific castes different names for professions, use CASTE_PROFESSION_NAME instead.

|-
| PRONE_TO_RAGE
| Caste
| number
| Untested effect, though it clearly affects how likely a creature is to become enraged. Number may be percentage chance of becoming enraged during combat. As described in file_changes.txt, creatures with this token "follow its normal behavior, but flip out on occasion, higher rate = more flipping out".

|-
| PUS
| Caste
|
* [[material token]]
*matter state (LIQUID, GAS, SOLID)
| Specifies what the creature's wounds will ooze when infected.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==R==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| RELSIZE
| Caste
|
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*body category, type, or token
*Relsize
| Specifies a new relative size for a part than what is stated in the body plan. For example, Dwarves have larger livers.

|-
| REMAINS
| Caste
| singular:plural
| What creature's remains are called.

|-
| REMAINS_COLOR
| Caste
|
| What color creature's remains are.

|-
| REMAINS_ON_VERMIN_BITE_DEATH
| Caste
|
| Leaves remains when its attack causes it to die? Seems to go with DIE_WHEN_VERMIN_BITE.

|-
| REMAINS_UNDETERMINED
| Caste
|
| Unknown.

|-
| REMOVE_MATERIAL
| Creature
|
*material token
| Removes a material from a creature.

|-
| REMOVE_TISSUE
| Creature
|
*material token
| Removes a tissue from a creature.

|-
| RETRACT_INTO_BP
| Caste
|
*BY_TYPE, BY_CATEGORY or BY_TOKEN
*TYPE, CATEGORY or TOKEN
| The creature will retract a body part when threatened.

|-
| RETURNS_VERMIN_KILLS_TO_OWNER
|
| Used with HUNTS_VERMIN, causes the creature to return killed vermin to its owner.

|-
| ROOT_AROUND
| Caste
| ?
| ?

|}

<div align="center">
{{alphabetical TOC}}
</div>

==S==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| SAVAGE
| Creature
|
| The creature will only show up in "savage" biomes.

|-
| SECRETION
| Caste
|
* [[material token]]
*Material State
*location secreted from (by_type, by_category, by_token)
*body part
*tissue layer
| creates a secreted material on given tissue on a given part of the body.

|-
| SELECT_ADDITIONAL_CASTE
| Creature
|
*caste name
| adds an additional previously defined caste to the selection. Used immediately after SELECT_CASTE.

|-
| SELECT_CASTE
| Creature
|
*caste name, or ALL
| selects a previously defined caste

|-
| SELECT_MATERIAL
| Creature
|
*Material token
| Selects a locally defined material. Can be ALL.

|-
| SEMIMEGABEAST
| Caste
|
| Appears as boss creature in quests. Makes history by rampaging around towns. Appears on fortress territory in Fortress Mode occasionally. Possibly inhabits non-mountain caves.

|-
| SET_BP_GROUP
| Caste
|
*selection criteria BY_TYPE, BY_CATEGORY, BY_TOKEN
*category, type, or token
| Begins a selection of body parts.

|-
| SET_TL_GROUP
| Caste
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
*tissue
| begins a selection of tissue layers

|-
| SHEARABLE_TISSUE_LAYER
| Caste
|
* tissue modifier
* required value
| Tissue layer can be sheared for its component material. The specified modifier must be at least of the desired value for shearing to be possible (a llama's wool must have a LENGTH of 300 before it is shearable).

|-
| SKILL_LEARN_RATE
| Caste
| [[skill_token]]:percentage
| The rate at which this creature learns this skill. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SKILL_LEARN_RATES
| Caste
| percentage
| The rate at which this creature learns all skills. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SKILL_RATE
| Caste
| [[skill_token]]:percentage:value:value:value
| As SKILL_RATES for individual skills. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SKILL_RATES
| Caste
|
*% of improvement points you get
*unused counter rate
*rust counter rate
*demotion counter rate
| Affects skill gain and decay. Lower numbers in the last three slots make decay occur faster ([SKILL_RATES:100:1:1:1] would cause rapid decay). The counter rates may also be replaced with NONE.
Default is [SKILL_RATES:100:8:16:16]. [SLOW_LEARNER] changes the 100 to a 50. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SKILL_RUST_RATE
| Caste
| [[skill_token]]:value:value:value
| The rate at which this skill decays. Lower values cause the skill to decay faster. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SKILL_RUST_RATES
| Caste
| value:value:value
| The rate at which all skills decay. Lower values cause the skills to decay faster. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SLOW_LEARNER
| Caste
|
| Similar to [CAN_LEARN], but slower; skills are gained at a fraction of the rate. Present in the entries for ogres and giants; can be applied to civ or player races.

|-
| SMALL_REMAINS
| Caste
|
| If a creature has this token, it'll leave "remains" instead of a corpse.

|-
| SOLDIER_ALTTILE
| Creature
| 'character' or tile number
| If this creature is active in its civilization's military, it will blink between its default tile and this one.

|-
| SOUND
| Caste
|
* Sound application (currently accepts ALERT or PEACEFUL_INTERMITTENT)
* Sound range (in tiles)
* Sound delay (lower values = sound is produced more often)
* VOCALIZATION or NONE (determines whether the sound requires breathing or not)
* First-person description
* Third-person description
* Description when out of sight
| Creature makes sounds periodically, which can be heard in Adventure mode.

|-
| SPECIFIC_FOOD
| Caste
|
* PLANT or CREATURE
* Plant/creature ID
| Indicates that the creature is only capable of eating a particular type of food.

|-
| SPEECH
| Creature
| speech file
| Boasting speeches relating to killing this creature. Examples include dwarf.txt and elf.txt in data\speech.

|-
| SPEECH_FEMALE
| Creature
| speech file
| Boasting speeches relating to killing females of this creature.

|-
| SPEECH_MALE
| Creature
| speech file
| Boasting speeches relating to killing males of this creature.

|-
| SPEED
| Caste
| value
| Sets the creatures' movement and work speed, 1000/[100 + SPEED X] is the resulting effect on creatures movement and work rates from default. See [[Speed]] for more information.

|-
| SPHERE
| Creature
|
*sphere name
| Sets what religious spheres the creature is aligned to, for purposes of being worshipped via the [POWER] token. Also affects the layout of hidden fun stuff, and the creature's name.

|-
| SPOUSE_CONVERSION_TARGET
| Caste
|
| This creature can be converted by a night creature with SPOUSE_CONVERTED.

|-
| SPOUSE_CONVERTER
| Caste
|
| Enables the creature to convert SPOUSE_CONVERSION_TARGETs into CONVERTED_SPOUSE castes of its species. The creature won't actually actively do this unless it also has NIGHT_CREATURE_HUNTER, however.

|-
| SUPERNATURAL
| Caste
| ?
| ?

|-
| SWIM_SPEED
| Caste
|
*speed
| How fast the creature swims. Typically 2500 (0.38 times the default speed).

|-
| SWIMS_INNATE
| Caste
|
| The creature naturally knows how to swim, as opposed to [SWIMS_LEARNED] below. Currently, an AI bug prevents this from being useful on PC races in fortress mode.

|-
| SWIMS_LEARNED
| Caste
|
| The creature doesn't know how to swim unless it has learned the skill. Requires [CAN_LEARN], obviously.

|}

<div align="center">
{{alphabetical TOC}}
</div>

==T==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| TENDONS
| Caste
|
* [[material token]]
*healing rate
| Defines the material and healing rate of tendons.

|-
| THICKWEB
| Caste
|
| The creature's webs can catch larger creatures.

|-
| TISSUE
| Creature
| name
| Begins defining a tissue in the creature file.

|-
| TITAN
| Caste
|
| Found on [[titan]]s. Cannot be specified in user-defined raws.

|-
| TL_COLOR_MODIFIER
| Caste
| COLOR:freq:COLOR:freq etc
| Creates a list of color patterns, giving each a frequency.

|-
| TLCM_GENETIC_MODEL
| Caste
|
| tissue layer color modifier is passed to offspring genetically?

|-
| TLCM_IMPORTANCE
| Caste
|
*number
| Presumably modifies the importance of the tissue layer color modifier, for description purposes.
HOWEVER using this appears to remove all mention of colour from creature descriptions. It does not appear in any default creatures.

|-
| TLCM_NOUN
| Caste
|
*name
*SINGULAR or PLURAL
| names the tissue layer color modifier, and determines the noun

|-
| TLCM_TIMING
| Caste
|
*ROOT
*start change window years:days:end change window years:days
| determines the point in the creature's life where the color change begins

|-
| TRADE_CAPACITY
| Caste
|
| How much the creature can carry when used by merchants.

|-
| TRAINABLE
| Caste
|
| Shortcut for [TRAINABLE_HUNTING] + [TRAINABLE_WAR].

|-
| TRAINABLE_HUNTING
| Caste
|
| Can be trained as hunting beasts by way of kennels.

|-
| TRAINABLE_WAR
| Caste
|
| Can be trained as war beasts by way of kennels.

|-
| TRANCES
| Caste
|
| Allows the creature to go into martial trances.

|-
| TRAPAVOID
| Caste
|
| The creature is immune to traps. Probably every procedurally generated megabeast has this.

|-
| TRIGGERABLE_GROUP
| Creature
| min:max
| A large swarm of vermin can be disturbed, usually in Adventure mode.{{verify}}

|-
| TSU_NOUN
| Caste
|
*noun
*SINGULAR or PLURAL
| Noun for the TISSUE_STYLE_UNIT, used in the description of the tissue layer's style.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==U==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| UBIQUITOUS
| Creature
|
| Creature will occur in every region with the correct biome. Does not apply to evil/good tags.

|-
| UNDERGROUND_DEPTH
| Creature
|
*mindepth
*maxdepth
| Depth the creature appears underground. Numbers can be from 1 to 5. Only magma creatures use 4 or 5 in the default raws. A single argument may be used instead of min and max. Dwarven civilizations will only export (via the embark screen or caravans) things that available at depth 1.

|-
| UNDERSWIM
| Caste
|
| Creature swims under the water and can't be seen. Currently appears to have no effect as of 31.25.

|-
| UNIQUE_DEMON
| Caste
|
| Typically found on generated [[demon]]s; causes the game to create a single named instance of the demon which will emerge from the underworld and take over civilizations during worldgen. Cannot be specified in user-defined raws.

|-
| USE_CASTE
| Creature
|
*new caste token
*old caste token
| Defines a new caste derived directly from a previous caste. The new caste inherits all properties of the old one. The effect of this tag is automatic if one has not yet defined any castes: "Any caste-level tag that occurs before castes are explicitly declared is saved up and placed on any caste that is declared later, unless the caste is explicitly derived from another caste."

|-
| USE_MATERIAL
| Creature
|
*new material ID
*old material ID
| Defines a new local creature material and populates it with all properties defined in the specified local creature material.

|-
| USE_MATERIAL_TEMPLATE
| Creature
|
*new material token
*material template
| Defines a new local creature material and populates it with all properties defined in the specified template.

|-
| USE_TISSUE
| Creature
|
*new tissue token
*old tissue id
| Defines a new local creature tissue and populates it with all properties defined in the local tissue specified in the second argument.

|-
| USE_TISSUE_TEMPLATE
| Creature
|
*new tissue token
*tissue template
| Loads a tissue template listed in OBJECT:TISSUE_TEMPLATE files, such as tissue_template_default.txt.

|-
| UTTERANCES
| Caste
|
| Changes the language of the creature into an unintelligible mess.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==V==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| VEGETATION
| Caste
|
| unknown

|-
| VERMIN_BITE
| Caste
|
*chance of occurance{{verify}}
*verb (bitten, stung, etc)
* [[material token]]
| Vermin bites, and injects something.

|-
| VERMIN_EATER
| Creature
|
| The vermin creature will attempt to eat exposed food. See PENETRATEPOWER. Distict from VERMIN_ROTTER.

|-
| VERMIN_FISH
| Creature
|
| The vermin appears in water and will attempt to swim around.

|-
| VERMIN_GROUNDER
| Creature
|
| The creature appears in "general" surface ground locations. Note that this doesn't stop the creature from flying if it can (most vermin birds have this tag).

|-
| VERMIN_HATEABLE
| Caste
|
| Some dwarves will hate the creature and get unhappy thoughts when around it.

|-
| VERMIN_MICRO
| Caste
|
| This makes the creature move in a swarm of creatures of the same race as it. I.E. Swarm of flies, swarm of ants, etc.

|-
| VERMIN_NOFISH
| Caste
|
| The creature cannot be caught by fishing.

|-
| VERMIN_NOROAM
| Caste
|
| The creature will not be observed randomly roaming about the map.

|-
| VERMIN_NOTRAP
| Caste
|
| The creature cannot be caught in baited animal traps; however, a "catch live land animal" task may still be able to capture one if a dwarf finds one roaming around.

|-
| VERMIN_ROTTER
| Creature
|
| Present on flies, knuckle worms, acorn flies, and blood gnats. Probably means either the creature is attracted to rot, the creature speeds rotting, or both.

|-
| VERMIN_SOIL
| Creature
|
| The creature randomly appears near dirt or mud.

|-
| VERMIN_SOIL_COLONY
| Creature
|
| The vermin will appear in a single tile cluster of many vermin, such as a colony of ants.

|-
| VERMINHUNTER
| Caste
|
| Shortcut for [AT_PEACE_WITH_WILDLIFE] + [RETURNS_VERMIN_KILLS_TO_OWNER] + [HUNTS_VERMIN] + [ADOPTS_OWNER].

|-
| VESPERTINE
| Caste
|
| Sets if the creature is active in evening.

|-
| VIEWRANGE
| Caste
| value
| Value should determine how close you have to get to a critter before it attacks (or prevents adv mode travel etc.) Default is 20.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==W==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| WAGON_PULLER
| Caste
|
| Allows the creature to pull caravan wagons.

|-
| WEBBER
| Caste
|
* [[material token]]
| Allows the creature to create webs, and defines what the webs are made of.

|-
| WEBIMMUNE
| Caste
|
| The creature will not get caught in thick webs.
|}

==Attack Tokens==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| ATTACK_SKILL
| Caste
|
*skill used ([[Skill token]])
| defines the attack skill used

|-
| ATTACK_VERB
| Caste
| 2nd person:3rd person
| descriptive text for the attack

|-
| ATTACK_CONTACT_PERC
| Caste
|
*% value
| amount of available tissue used in attack, or possibly percent chance the attack makes contact

|-
| ATTACK_PENETRATION_PERC
| Caste
|
*% value
| probably amount of material that makes contact when penetration is done, or possibly percent chance the attack penetrates (as in sharp items. Default is 0, so it can be left out for blunt attacks, if this is what it does)

|-
| ATTACK_PRIORITY
| Caste
|
*MAIN or SECOND
| use of the attack in combat. Secondary attacks are only used if main attacks are impossible.

|-
| ATTACK_VELOCITY_MODIFIER
| Caste
| number
| Modifies the attack velocity. Almost certainly based on a scale where 1000 is normal, same as weapon velocity.

|-
| ATTACK_FLAG_CANLATCH
| Caste
|
| Enables an attacker to occasionally latch on with the bodypart used by an attack when an attack with this flag in its definition is made.

|-
| ATTACK_FLAG_WITH
| Caste
|
| In adventure mode, displays the name of the body part used by an attack when announcing the attack.

|-
| ATTACK_FLAG_EDGE
| Caste
|
| attack type

|-
| SPECIALATTACK_INJECT_EXTRACT
| Caste
|
* [[material token]]
*state (SOLID, LIQUID, GAS)
*min:max
| attack type addition that injects a material into the victim.

|-
| SPECIALATTACK_INTERACTION
| Caste
| ?
| ?

|-
| SPECIALATTACK_SUCK_BLOOD
| Caste
| min:max
| Successful attack draws out an amount of blood randomized between the min and max value.
|}

==Important Related Tokens==
These next groups of tokens include several tokens that are not technically classified as creature tokens in string dump, but bear mentioning in this as they are used frequently in creature raws. (Some regular creature tokens may also be reprinted for the sake of ease of navigation)

===Tissue Modification===
This next group of tokens deals setting and modifying tissue properties. (See also [[Tissue definition token]])

{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="10%" | Type
! width="20%" | Arguments
! width="50%" | Description

|-
| PLUS_TISSUE_LAYER
| Caste
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
| Adds a tissue to those selected

|-
| PLUS_TL_GROUP
| Caste
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
*tissue
| continues a selection of tissue layers

|-
| SELECT_TISSUE
| Creature
|
*tissue token
| Selects a tissue for editing.

|-
| SELECT_TISSUE_LAYER
| Caste
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token | Selects a tissue at a location
* (optional) FRONT, BACK, LEFT, RIGHT, TOP, BOTTOM, AROUND.
| Selects a tissue layer for descriptor and cosmetic purposes.

|-
| SET_LAYER_TISSUE
| Caste
|
| Sets a tissue layer to be made of a different tissue.

|-
| TISSUE_LAYER
| Caste
|
*BY_TYPE, BY_CATEGORY, BY_TOKEN
*TYPE,CATEGORY, or TOKEN
*TISSUE
*LOCATION
| Adds the tissue layer to wherever it is required.
Non-argument Locations can be FRONT, RIGHT, LEFT, TOP, BOTTOM. Argument locations are AROUND and CLEANS, requiring a further body part and a % of coverage/cleansing

|-
| TISSUE_LAYER_OVER
| Caste
|
*BY_TYPE, BY_CATEGORY, BY_TOKEN
*TYPE,CATEGORY, or TOKEN
*TISSUE
*LOCATION
| Presumably a counterpart to TISSUE_LAYER_UNDER (see below).

|-
| TISSUE_LAYER_UNDER
| Caste
|
*BY_TYPE, BY_CATEGORY, BY_TOKEN
*TYPE,CATEGORY, or TOKEN
*TISSUE
| Adds the tissue layer under a given part.
For example an Iron Man has a gaseous poison within and this tissue (GAS is its name) has the token [TISSUE_LEAKS] and its state is GAS so when you puncture the iron outside and damage this tissue it leaks gas (can have a syndrome by using a previous one in the creature sample.) [TISSUE_LAYER_UNDER:BY_CATEGORY:ALL:{tissue}] {tissue} is what will be under the TISSUE_LAYER here is an example Tissue from Iron Man
[TISSUE:GAS]
[TISSUE_NAME:gas:NP] [TISSUE_MATERIAL:LOCAL_CREATURE_MAT:GAS] [TISSUE_MAT_STATE:GAS] [RELATIVE_THICKNESS:50] [TISSUE_LEAKS] [TISSUE_SHAPE:LAYER]

|-
| TISSUE_LAYER_APPEARANCE_MODIFIER
| Caste
|
*QUALITY
*lowest:lower:low:median:high:higher:highest
| sets the range of qualities, including LENGTH, DENSE, HIGH_POSITION, CURLY, GREASY, WRINKLY

|-
| TISSUE_STYLE_UNIT
| Caste
|
*tissue
*shaping
| sets tissue to be in a certain shape, mostly used with tissues HAIR, BEARD, MOUSTACHE, SIDEBURNS.

|-
| TL_CONNECTS
| Caste
|
| Presumably gives the CONNECTS attribute to selected layers.

|-
| TL_HEALING_RATE
| Caste
|
| Presumably changes the HEALING_RATE of the selected tissue layers.

|-
| TL_MAJOR_ARTERIES
| Caste
|
| Gives Major Artery attribute to selected layers.

|-
| TL_PAIN_RECEPTORS
| Caste
|
| Seems to set new number of pain receptors for selected tissue layers.

|-
| TL_RELATIVE_THICKNESS
| Caste
|
| Seems to set new relative thickness for selected tissue layers.

|-
| TL_VASCULAR
| Caste
|
| Seems to set new a VASCULAR value (which modulates bleeding) for selected tissue layers.

|}

==See Also==
*[[Body detail plan token]]
*[[Body token]]
*[[Material definition token]]
*[[Syndrome]]
*[[Tissue definition token]]

{{Category|Modding}}
{{Category|Tokens}}

v0.34:Syndrome

2012-03-24T21:04:03Z

I2amroy: /* Special Syndromes */

{{quality|Masterwork|21:09, 26 April 2011 (UTC)}}{{av}}

A '''syndrome''' is a disease or effect that a poor hapless creature might get through encountering certain creatures, extracts or vindictive modders. They generally cause unpleasant and frequently fatal [[symptoms]] over a short to long period of time, but some will clear up over time or with the assistance of a [[doctor]]. A [[Health care|Hospital]] is required to diagnose and potentially treat the syndrome. [[File:Snakebite.png|200px|thumb|right|An example of a syndrome in effect. This hippo did not ultimately survive the encounter despite one bite being the only injury sustained.]]

==List of syndromes==
{| {{prettytable}}
|- bgcolor="#dddddd"
! Syndrome
! Venom
! Acquired
! Short-term Symptoms
! Long-term Symptoms
! Chronic Symptoms
|-
| Adder bite
| adder venom (injected)
| Being bitten by an [[adder]], [[giant adder]] or [[adder man]]
| Strong pain
| Swelling<br>Blisters<br>Nausea
|
|-
| Bark scorpion sting
| bark scorpion venom (injected)
| Being stung by a [[bark scorpion]], [[giant bark scorpion]] or [[bark scorpion man]]
| Strong pain
| none
| none
|-
| Black mamba bite
| black mamba venom (injected)
| Being bitten by a [[black mamba]], [[giant black mamba]] or [[black mamba man]]
| Dizziness<br>Drowsiness<br>Strong pain<br>Fever<br>Unconsciousness<br>Complete paralysis<sup>1</sup>
|
|
|-
| Blob blisters
| cave blob fluid<br />(contact or ingested)
| Touching a [[cave blob]]
| Mild pain<br/>Mild blisters
| None
| None
|-
| Brown recluse spider bite
| brown recluse spider venom (injected)
| Being bitten by a [[brown recluse spider]], [[giant brown recluse spider]] or [[brown recluse spider man]]
| Nausea<br>Fever<br>Pain<br>
| Severe localised necrosis
|
|-
| Bumblebee sting
| bumblebee venom (injected)
| Being stung by a [[bumblebee]] worker
| Pain<br>Strong swelling
|
|
|-
| Bushmaster bite
| bushmaster venom (injected)
| Being bitten by a [[bushmaster]], [[giant bushmaster]] or [[bushmaster man]]
| Strong pain<br>Mild bleeding<br>Dizziness<br>Nausea<br>Unconsciousness<br>Complete paralysis<sup>1</sup>
|
|
|-
| Cave floater sickness
| cave floater gas<br />(inhaled or ingested)
| Expelled from [[cave floater]]
| Mild nausea
| Fever<br/>Strong drowsiness (delayed)<br/>Strong dizziness (delayed)
| None
|-
| Cave spider bite
| cave spider venom<br />(injected)
| Being bitten by a [[cave spider]]
| None
| None
| Very mild dizziness
|-
| Copperhead snake bite
| copperhead snake venom (injected)
| Being bitten by a [[copperhead snake]], [[giant copperhead snake]] or [[copperhead snake man]]
| Pain<br>Swelling<br>Nausea
|
|
|-
| Giant cave spider bite
| giant cave spider venom<br />(injected)
| Being bitten by a [[giant cave spider]]
| Complete paralysis<sup>1</sup><br/>'''Being eaten by the GCS'''
| None, not that it really matters.
| None
|-
| Gila monster bite
| gila monster venom (injected)
| Being bitten by a [[gila monster]], [[giant gila monster]] or [[gila monster man]]
| Pain<br>Mild swelling
|
|
|-
| Gnomeblight
| [[gnomeblight]]<br />(contact, inhaled, injected, or ingested)
| Unknown. Affects gnomes only
| None
| Severe systemic necrosis<sup>2</sup>
| None
|-
| Giant desert scorpion sting
| giant desert scorpion<br />(injected)
| Being stung by a [[giant desert scorpion]]
|
| Necrosis of the brain and nervous system<sup>2</sup>
| '''Unavoidable death'''
|-
| Helmet snake bite
| helmet snake venom<br />(injected)
| Being bitten by a [[helmet snake]]
| Minor bleeding
| Fever<br/>Nausea<br/>Dizziness<br/>Localized swelling<br/>Localized oozing<br/>Localized bruising<br/>Strong pain<br/>Intense localized necrosis<br/>Possible loss of limb
| None
|-
| Honey bee sting
| honey bee venom (injected)
| Being stung by a [[honey bee]] worker
| Pain<br>Strong swelling
|
|
|-
| Iron man cough
| iron man gas<br />(inhaled)
| Expelled by [[iron man]]
| Coughing blood
| None
| None
|-
| King cobra bite
| king cobra venom<br />(injected)
| Being bitten by a [[king cobra]]
| Complete paralysis<sup>1</sup><br/>Pain, dizziness, drowsiness
| None
| None
|-
| Phantom spider bite
| phantom spider venom<br />(injected)
| Being bitten by a [[phantom spider]]
| None
| Numbness and mild dizziness
| None
|-
| Platypus sting
| platypus venom<br />(injected)
| Being kicked by a [[platypus]], [[giant platypus]] or [[platypus man]]
| Pain and swelling
| Extreme pain, swelling possibly to the point of necrosis
| None
|-
| Rattlesnake bite
| rattlesnake venom<br />(injected)
| Being bitten by a [[rattlesnake]], [[giant rattlesnake]] or [[rattlesnake man]]
| Pain, nausea, blisters, swelling, bruising
| Severe localized necrosis
| None
|-
| Serpent man bite
| serpent man venom<br />(injected)
| Being bitten by a [[serpent man]]
| Complete paralysis<sup>1</sup>
| None
| None
|-
| [evil rain] sickness<sup>3</sup>
| random
| Being caught outside in freakish weather in an evil biome
| random
| random
| random
|-
| [evil cloud] sickness<sup>4</sup>
| random
| Being caught in a creeping cloud in an evil biome
| random
| random
| random
|-
| beast sickness<sup>5</sup>
| random
| Encounters with [[forgotten beast]]s
| random
| random
| random
|-
| titan sickness<sup>5</sup>
| random
| Encounters with [[titan]]s
| random
| random
| random
|-
| demon sickness<sup>5</sup>
| random
| Encounters with [[demon]]s
| random
| random
| random
|}
:<small>1. For small creatures such as humans and dwarves, paralysis tends to result in suffocation.</small>
:<small>2. Necrosis of the brain will eventually result in instant death once the brain rots away completely.</small>
:<small>3. Evil rain typically only causes minor symptoms such as blisters, bruising, coughing blood, dizziness, fever, nausea, oozing, and pain.</small>
:<small>4. Evil clouds either cause major symptoms (as with beast/titan/demon sicknesses) or permanently transform creatures into [[Undead|zombie-like]] forms.</small>
:<small>5. [[Titan]]s, [[forgotten beast]]s, and [[demon]]s have a chance to have a randomized syndrome. These range from pointless (mild blisters from inhaling boiling blood) to instantly deadly (Severe necrosis from a contact poison attached to a breath weapon/creature made of blood.</small>

==The anatomy of a syndrome==
Mechanically, syndromes are bundles of tokens attached to a material - they're confined to creature materials in vanilla DF, but it's a simple matter to add them to inorganic materials. When the material is injected, touched, inhaled, or ingested (depending on the syndrome), the creature suffers the predations of a nasty disease or poison. Here's an example syndrome, taken from the Giant Cave Spider raws.

If you are having troubles getting the syndromes to work (ie, in combat reports, getting "'''supersnake''' n/a splatters~etc"), then simply throw the venom template into the actual creature's raw, which is what the LOCAL_CREATURE_MAT actually calls on; the venom being in the same file.

[USE_MATERIAL_TEMPLATE:POISON:CREATURE_EXTRACT_TEMPLATE]
[STATE_NAME:ALL_SOLID:frozen giant cave spider venom]
[STATE_ADJ:ALL_SOLID:frozen giant cave spider venom]
[STATE_NAME:LIQUID:giant cave spider venom]
[STATE_ADJ:LIQUID:giant cave spider venom]
[STATE_NAME:GAS:boiling giant cave spider venom]
[STATE_ADJ:GAS:boiling giant cave spider venom]
[PREFIX:NONE]
[ENTERS_BLOOD]
[SYNDROME]
[SYN_NAME:giant cave spider bite]
[SYN_AFFECTED_CLASS:GENERAL_POISON]
[SYN_IMMUNE_CREATURE:SPIDER_CAVE:ALL]
[SYN_INJECTED]
[CE_PARALYSIS:SEV:100:PROB:100:RESISTABLE:SIZE_DILUTES:START:5:PEAK:10:END:20]

The first line, USE_MATERIAL_TEMPLATE, is creating a new material, called POISON, using the CREATURE_EXTRACT_TEMPLATE as the basis. After this, the STATE_NAME and STATE_ADJ tokens are used to define the names and adjectives assigned to different states of the material - GAS, LIQUID and ALL_SOLID, in this case, though ALL is also a valid token. At this stage, you can use any material tags like MAT_FIXED_TEMP or similar to set further material properties, though this usually isn't necessary.

ENTERS_BLOOD
This tag determines whether a poison enters the blood or not. If it is not included, the poison will splatter (if liquid) or flow (if gas) over the affected body part instead when injected. If you're using a contact poison, leave this out. Necessary for injected poisons.
SYNDROME
This tag ends the material details and begins the definition of the actual syndrome.
SYN_NAME
This one is self-explanatory - the name of the syndrome as it will appear in-game.
SYN_AFFECTED_CLASS
This token defines what CREATURE_CLASS will be affected by the syndrome. Most creatures are classed under GENERAL_POISON. Multiple tokens can be used in a single syndrome.
SYN_IMMUNE_CLASS
As above, but makes class immune.
SYN_IMMUNE_CREATURE
This token defines which creatures CANNOT be affected by the syndrome - useful for addressing specific instances within a population, such as a specific caste or an individual creature that falls under GENERAL_POISON. Syntax is [SYN_IMMUNE_CREATURE:creature:caste]. ALL can be used for the caste.
SYN_AFFECTED_CREATURE
As above, but makes creature or caste susceptible.

SYN_INJECTED, SYN_CONTACT, SYN_INHALED, SYN_INGESTED
This token determines the method of infection - injected syndromes must be injected via a creature attack, while contact syndromes result from any contamination of a creature by material splatter (such as blood), inhaled syndromes must be inhaled in gaseous form (such as from boiling or a creature breath attack), and ingestion syndromes must be eaten or drunk. Any combination of these tags can be used. A fun variation on the usual creature injection routine is to create a material with a SYN_CONTACT syndrome and have a creature use it for blood - this tends to end poorly for any predator that chooses to attack them.

[SPECIALATTACK_INJECT_EXTRACT:LOCAL_CREATURE_MAT:VENOM:LIQUID:100:100]
This is one method for getting a poison into a creature. If [ENTERS_BLOOD] is applied, it will be injected into the bloodstream. Otherwise, it will just splatter over the area. Put this on a creature attack. Substance type (gas, liquid, solid) does not appear to have an effect. The numbers on the end are minimum and maximum.

CE_X, or creature effect tokens, are the real meat and bones of your syndrome. They're detailed below.

==Creature effect tokens==
Each and every syndrome has a number of creature effect tokens, represented by CE_X - these lovely little beauties determine exactly how the poor creature suffering from the syndrome is affected. An example CE token is as follows:

[CE_NECROSIS:SEV:100:PROB:100:LOCALIZED:VASCULAR_ONLY:RESISTABLE:START:50:PEAK:1000:END:2000]

In this example, we have an effect that will always cause severe necrosis in whichever bodypart it touches, so long as that bodypart is vascular and that the creature is not able to resist it in some manner. The effect begins shortly after the syndrome is contracted, peaks 1000 [[time|time units]] afterwards, and finally ceases another 1000 time units later.

As a general rule of thumb, so long as CE_X starts the string and START/PEAK/END end it, the order of the intervening tokens isn't important.

*CE_X
The effect type. This can be a number of different tokens, as detailed in the table below this list.
*SEV:X
The severity of the effect. Higher values appear to be worse, with SEV:1000 CE_NECROSIS causing a part to near-instantly become rotten.
*PROB:X
The probability of the effect actually manifesting in the victim, as a percentage. 100 means always, 1 means a 1 in 100 chance.
*LOCALIZED (Overwrites BP tokens)
This tag causes an effect to ignore all BP tokens and then forces the game to attempt to apply the effect to the limb that came into contact with the contagion - i.e. the part that was bitten by the creature injecting the syndrome material, or the one that was splattered by a contact contagion. If an effect can not be applied to the contacted limb (such as IMPAIR_FUNCTION on a non-organ) then this token makes the syndrome have no effect. This token also makes inhaled syndromes have no effect.
*BP:BODY_PART:TISSUE (Overwritten by LOCALIZED)
Specifies which body parts and tissues are to be affected by the syndrome. BODY_PART can be BY_CATEGORY:x to target body parts with a matching [CATEGORY:x] [[body token]] (or ALL to affect everything), BY_TYPE:x to target body parts having a particular type (UPPERBODY, LOWERBODY, HEAD, GRASP, or STANCE), or BY_TOKEN:x to target individual body parts by their ID (as specified in the [BP] token). For example, if you wanted to target the lungs of a creature, you would use BP:BY_CATEGORY:LUNG:ALL. The syndrome would act on all bodyparts within the creature with the CATEGORY tag LUNG and affect all tissue layers. For another example, say you wanted to cause the skin to rot off a creature - you could use BP:BY_CATEGORY:ALL:SKIN, targeting the SKIN tissue on all bodyparts. Multiple targets can be given in one syndrome by placing the BP tokens end to end. This is one of the most powerful and useful aspects of the syndrome system, as it allows you to selectively target bodyparts relevant to the contagion, like lungs for coal dust inhalation, or the eyes for exposure to an acid gas. Not everything takes a target!
*VASCULAR_ONLY (Optional)
This syndrome only affects tissue layers with the VASCULAR token.
*MUSCULAR_ONLY (Optional)
This syndrome only affects tissue layers with the MUSCULAR token. Are you seeing a trend here?
*SIZE_DILUTES (Optional)
This token presumably causes the effects of the syndrome to scale with the size of the creature compared to the size of the dose of contagion they received, but has yet to be extensively tested.
*SIZE_DELAYS (Optional)
As above, this token has yet to be tested but presumably delays the onset of a syndrome according to the size of the victim.

The details of this table are still being thrashed out by modders, so if you have anything to add, please don't hesitate to hit the edit button!

Non-targeted syndromes will ignore any BP tokens and LOCALIZED tokens.
{| {{prettytable}}
|- bgcolor="Bisque"
! Token
! Accepts Target
! Description
|-
| CE_BLEEDING
| Yes
| Causes the targeted bodypart to start bleeding, with heavy enough bleeding resulting in the death of the sufferer. Some conditions seem to cause bleeding to be fatal no matter how weak.
|-
| CE_BLISTERS
| Yes
| Covers the targeted bodypart with blisters.
|-
| CE_BRUISING
| Yes
| Causes the targeted bodypart to undergo bruising.
|-
| CE_IMPAIR_FUNCTION
| Yes
| An organ afflicted with this CE is rendered inoperable - for example, if both lungs are impaired the creature can't breathe and will suffocate. This token only affects organs, not limbs.
|-
| CE_NECROSIS
| Yes
| Causes the targeted bodypart to rot, with associated tissue damage and miasma. Badly necrotic limbs will require amputation and heavy rot will eventually result in bleeding. Necrosis has some strange behavior involving bleeding to death that isn't fully understood; a 100% necrotic creature can survive fine with no non-yellow bodyparts but will die of bleeding as soon as they end a round of combat, even if they never take a hit. Because of this, fairly useless unless targeting the lungs or eyes.
|-
| CE_NUMBNESS
| Yes
| Causes numbness in the affected body part, blocking pain. Extreme numbness may lead to sensory nerve damage.
|-
| CE_OOZING
| Yes
| Causes pus to ooze from the afflicted bodypart.
|-
| CE_PAIN
| Yes
| Afflicts the targeted bodypart with intense pain.
|-
| CE_PARALYSIS
| Yes
| Causes paralysis in the affected body part. Targeted causes sluggishness and significantly reduces speed. Untargeted paralysis is 'complete paralysis' and will cause suffocation in smaller creatures.
|-
| CE_SWELLING
| Yes
| Causes the targeted bodypart to swell up. Extreme swelling may lead to necrosis.
|-
| CE_COUGH_BLOOD
| No
| This effect results in the sufferer periodically coughing blood, which stains the tile they're on and requires cleanup. It doesn't appear to be lethal, but may cause minor bleeding damage.
|-
| CE_DIZZINESS
| No
| Inflicts the Dizziness condition, occasional fainting and a general slowdown in movement and work speed.
|-
| CE_DROWSINESS
| No
| Causes the Drowsiness condition.
|-
| CE_FEVER
| No
| Causes the Fever condition.
|-
| CE_NAUSEA
| No
| Causes the Nausea condition, and heavy vomiting. Can eventually lead to dehydration and death.
|-
| CE_UNCONSCIOUSNESS
| No
| Renders unconscious.
|-
| CE_VOMIT_BLOOD
| No
| This effect results in the sufferer periodically vomiting blood, which stains the tile they're on and requires cleanup. It doesn't appear to be lethal, but may cause minor bleeding damage.
|}

==Special Syndromes==
v0.34 has added several special syndrome tags that take different arguments than the above. These are used for generated interactions in unmodded games, but may be used as well for any substance or custom interaction.

{| {{prettytable}}
|- bgcolor="Bisque"
! Token
! Arguments
! Description
|-
| CE_ADD_TAG
| tags:START:number(:END:number)
| Adds a tag to the affected creature. Many arguments can be used sequentially within one syndrome token. See the [[Interaction token]] '''IT_REQUIRES''' for valid tags.
|-
| CE_REMOVE_TAG
| tags:START:number(:END:number)
| Removes a tag from a creature. Supported arguments are the same as CE_ADD_TAG.
|-
| CE_DISPLAY_TILE
| TILE:tile number:colour:START:number(:END:number)
| The creature displays the specified tile and colour instead of its normal one.
|-
| CE_DISPLAY_NAME
| NAME:singular:plural:adjective:START:number(:END:number)
| Attaches a specified name to the creature's normal name.
|-
| CE_FLASH_TILE
| TILE:tile number:colour:FREQUENCY:?:?:START:number(:END:number)
| The creature flashes between its normal tile and the one specified here.
|-
| CE_PHYS_ATT_CHANGE
| [[Attribute]]:percentage:fixed boost(?):START:number(:END:number)
| Alters the physical [[attribute]]s of a creature.
|-
| CE_MENT_ATT_CHANGE
| [[Attribute]]:percentage:fixed boost(?):START:number(:END:number)
| Alters the mental [[attribute]]s of a creature.
|-
| CE_BODY_APPEARANCE_MODIFIER
|
|
|-
| CE_BP_APPEARANCE_MODIFIER
| START:number(:END:number):body part:APPEARANCE_MODIFIER:attribute:number]
| Alters the characteristics (height, width etc.) of a body part.
|-
| CE_MATERIAL_FORCE_MULTIPLIER
|
|
|-
| CE_BODY_MAT_INTERACTION
|
|
|-
| CE_SPEED_CHANGE
| speed modifier:START:number(:END:number) (might be more arguments existing in the first part?)
| Changes the speed of a creature.
Speed modifier contains one or both:
* SPEED_PERC:percentage (this modifies a creature's in-game speed, so higher numbers are faster)
* SPEED_ADD:number (this modifies a creature's [SPEED:XX] token, so higher numbers are slower. Negative numbers are accepted though will only reduce a creature's speed to zero)
The minimum and maximum speeds able to be created by CE_SPEED_CHANGE are 99 and 10,000 respectively.
|-
| CE_CAN_DO_INTERACTION
| START:number(:END:number)
| Makes the creature able to perform an interaction. See [[Interaction token]]. To specify the interaction, use the argument:
* CDI:INTERACTION:interaction name
|-
| CE_BODY_TRANSFORMATION
| START:number(:END:number)
| Transforms into another creature. The target creature is specified with:
* CE:CREATURE:creature name:caste name<br>
Note that any wounds the creature has suffered will instantly heal upon transforming, both into and out of the target form. [[Undead]] limbs of a creature with this token will grow into a full instance of that creature.
|-
| CE_SKILL_ROLL_ADJUST
| PERC:percentage:PERC_ON:percentage:START:number(:END:number)
| Alters the skill level(?) of a creature. The argument PERC specifies a percentage of the creature's current skill, and PERC_ON the probability of the effect being applied.
|}

==Inorganic syndromes and you!==
It's perfectly possible - and quite simple - to add a nasty syndrome to a type of rock or metal - you simply add the syndrome tokens to the material definition in the same manner that you would add them to a creature material definition. The only catch is that since your hapless dwarves will only normally encounter the material in metal, gem or boulder form, a bit of creativity must be used to actually get them inside your citizens - that is, you need to make them 'explosively boil' as soon as they're mined or produced. This has the sad side effect of destroying the actual item - sorry, no highly radioactive uranium this release.

The easiest way to accomplish this is to assign the material a low boiling point, usually just under room temperature, and make sure its temperature is fixed to a point above it.
[MAT_FIXED_TEMP:9001]
[BOILING_POINT:9000]
Now, as soon as this substance hits the open air - by being mined, smelted or reaction-produced at a custom workshop - it will EXPLOSIVELY BOIL, flooding a small area with delicious syndrome-rich gas. Creatures who inhale the gas will be immediately hit with the syndrome you thoughtfully attached to the material definition earlier!

There are a number of other tokens you can use to control the colour and naming conventions of your syndrome material, referred to as MATERIAL tokens.

==Breath attacks==
Breath attacks have been changed to use Interactions as of 0.34.01. Instead of [MATERIAL_BREATH_ATTACK], you would now use the MATERIAL_EMISSION interaction, like so:

[CAN_DO_INTERACTION:MATERIAL_EMISSION]
[CDI:ADV_NAME:Breath custom material]
[CDI:USAGE_HINT:ATTACK]
[CDI:BP_REQUIRED:BY_CATEGORY:MOUTH]
[CDI:MATERIAL:LOCAL_CREATURE_MAT:CUSTOMMATERIAL:TRAILING_VAPOR_FLOW]
[CDI:TARGET:C:LINE_OF_SIGHT]
[CDI:TARGET_RANGE:C:15]
[CDI:MAX_TARGET_NUMBER:C:1]
[CDI:WAIT_PERIOD:50]

The most important part is this line:

[CDI:MATERIAL:LOCAL_CREATURE_MAT:CUSTOMMATERIAL:TRAILING_VAPOR_FLOW]

The CDI refers to CAN_DO_INTERACTION; the MATERIAL states that this line shows what the material is. LOCAL_CREATURE_MAT:CUSTOMMATERIAL is your material, and TRAILING_VAPOR_FLOW refers to the breath attack type. Other types are seen below. Also important is this line:

[CDI:TARGET:C:LINE_OF_SIGHT]

LINE_OF_SIGHT refers to where the target C may be; others include SELF_ALLOWED (presumably like LINE_OF_SIGHT, but with the creature allowed to target itself), SELF_ONLY (preferable for undirected attacks and TOUCHABLE (for up-close attacks, as trailing flows tend to be).

===Breath Attack Types===

{| {{prettytable}}
|- bgcolor="#ddd"
! Token
! Description
|-
| TRAILING_DUST_FLOW
| Lets out a cloud of solid dust. Appears to use cave-in dust physics, causing this to fling around anything it comes in contact with, making it capable of smashing creatures into the ground and flinging them over walls. Creature will attack as normal.
|-
| TRAILING_VAPOR_FLOW
| Similar to the trailing gas, but easier to breathe in, and condensed, so it will collect on creatures. Creature will attack as normal.
|-
| TRAILING_GAS_FLOW
| Shoots a trail of gas substance at the creature. Fairly easy to dodge. Creature will attack as normal.
|-
| SOLID_GLOB
| Shoots a solid glob of spinning substance at the creature, leaving symbols similar to broken arrows. Essentially a projectile weapon. Some creatures with this breath attack will not move, preferring instead to stay and shoot globs at you, even when you are literally right next to them.
|-
| LIQUID_GLOB
| Shoots a '''solid''' glob of spinning substance at the creature. Essentially the same as SOLID_GLOB. May do less damage.
|-
| SPATTER_POWDER
|
|-
| SPATTER_LIQUID
|
|-
| UNDIRECTED_GAS
| Creature occasionally releases a cloud of substance. Similar to TRAILING_GAS_FLOW, but undirected, thus affecting a larger area but losing the distance. Creature will attack as normal.
|-
| UNDIRECTED_VAPOR
| Creature occasionally releases a cloud of substance. Similar to TRAILING_VAPOR_FLOW, but undirected, thus affecting a larger area but losing the distance. Creature will attack as normal.
|-
| UNDIRECTED_DUST
| Creature occasionally releases a large cloud of substance, which will spread and dissipate. Similar to TRAILING_DUST_FLOW, but undirected, thus affecting a larger area but losing the distance - range is roughly the same as that of a cave-in. Creature will attack as normal. <s>DO NOT USE THIS TAG UNLESS YOU WANT TO KILL THE CREATURE AND EVERYTHING NEAR IT AND SEND PEOPLE FLYING.</s> You know you want to.
|-
| WEB_SPRAY
| Emits a burst of [[web]]s that entangle target creatures.
|-
| DRAGONFIRE
| Emits a wide cone of [[fire]] that burns target creatures.
|-
| FIREJET
| Emits a narrow cone of [[fire]] that burns target creatures.
|-
| FIREBALL
| Emits a fireball that burns the target creature.
|-
| WEATHER_CREEPING_GAS
| Creates a slowly expanding cloud of gas, similar to miasma.
|-
| WEATHER_CREEPING_VAPOR
| Creates a slowly expanding cloud of vapor.
|-
| WEATHER_CREEPING_DUST
| Creates a slowly expanding cloud of dust.
|-
| WEATHER_FALLING_MATERIAL
| Causes it to start raining a particular material.
|}

Keep in mind that you can use multiple breath attacks, which appears to make the creature choose between them at random.

{{Category|Modding}}
[[ru:DF2012:Syndrome]]

v0.34:Syndrome

2012-03-24T20:47:49Z

I2amroy: /* Special Syndromes */

{{quality|Masterwork|21:09, 26 April 2011 (UTC)}}{{av}}

A '''syndrome''' is a disease or effect that a poor hapless creature might get through encountering certain creatures, extracts or vindictive modders. They generally cause unpleasant and frequently fatal [[symptoms]] over a short to long period of time, but some will clear up over time or with the assistance of a [[doctor]]. A [[Health care|Hospital]] is required to diagnose and potentially treat the syndrome. [[File:Snakebite.png|200px|thumb|right|An example of a syndrome in effect. This hippo did not ultimately survive the encounter despite one bite being the only injury sustained.]]

==List of syndromes==
{| {{prettytable}}
|- bgcolor="#dddddd"
! Syndrome
! Venom
! Acquired
! Short-term Symptoms
! Long-term Symptoms
! Chronic Symptoms
|-
| Adder bite
| adder venom (injected)
| Being bitten by an [[adder]], [[giant adder]] or [[adder man]]
| Strong pain
| Swelling<br>Blisters<br>Nausea
|
|-
| Bark scorpion sting
| bark scorpion venom (injected)
| Being stung by a [[bark scorpion]], [[giant bark scorpion]] or [[bark scorpion man]]
| Strong pain
| none
| none
|-
| Black mamba bite
| black mamba venom (injected)
| Being bitten by a [[black mamba]], [[giant black mamba]] or [[black mamba man]]
| Dizziness<br>Drowsiness<br>Strong pain<br>Fever<br>Unconsciousness<br>Complete paralysis<sup>1</sup>
|
|
|-
| Blob blisters
| cave blob fluid<br />(contact or ingested)
| Touching a [[cave blob]]
| Mild pain<br/>Mild blisters
| None
| None
|-
| Brown recluse spider bite
| brown recluse spider venom (injected)
| Being bitten by a [[brown recluse spider]], [[giant brown recluse spider]] or [[brown recluse spider man]]
| Nausea<br>Fever<br>Pain<br>
| Severe localised necrosis
|
|-
| Bumblebee sting
| bumblebee venom (injected)
| Being stung by a [[bumblebee]] worker
| Pain<br>Strong swelling
|
|
|-
| Bushmaster bite
| bushmaster venom (injected)
| Being bitten by a [[bushmaster]], [[giant bushmaster]] or [[bushmaster man]]
| Strong pain<br>Mild bleeding<br>Dizziness<br>Nausea<br>Unconsciousness<br>Complete paralysis<sup>1</sup>
|
|
|-
| Cave floater sickness
| cave floater gas<br />(inhaled or ingested)
| Expelled from [[cave floater]]
| Mild nausea
| Fever<br/>Strong drowsiness (delayed)<br/>Strong dizziness (delayed)
| None
|-
| Cave spider bite
| cave spider venom<br />(injected)
| Being bitten by a [[cave spider]]
| None
| None
| Very mild dizziness
|-
| Copperhead snake bite
| copperhead snake venom (injected)
| Being bitten by a [[copperhead snake]], [[giant copperhead snake]] or [[copperhead snake man]]
| Pain<br>Swelling<br>Nausea
|
|
|-
| Giant cave spider bite
| giant cave spider venom<br />(injected)
| Being bitten by a [[giant cave spider]]
| Complete paralysis<sup>1</sup><br/>'''Being eaten by the GCS'''
| None, not that it really matters.
| None
|-
| Gila monster bite
| gila monster venom (injected)
| Being bitten by a [[gila monster]], [[giant gila monster]] or [[gila monster man]]
| Pain<br>Mild swelling
|
|
|-
| Gnomeblight
| [[gnomeblight]]<br />(contact, inhaled, injected, or ingested)
| Unknown. Affects gnomes only
| None
| Severe systemic necrosis<sup>2</sup>
| None
|-
| Giant desert scorpion sting
| giant desert scorpion<br />(injected)
| Being stung by a [[giant desert scorpion]]
|
| Necrosis of the brain and nervous system<sup>2</sup>
| '''Unavoidable death'''
|-
| Helmet snake bite
| helmet snake venom<br />(injected)
| Being bitten by a [[helmet snake]]
| Minor bleeding
| Fever<br/>Nausea<br/>Dizziness<br/>Localized swelling<br/>Localized oozing<br/>Localized bruising<br/>Strong pain<br/>Intense localized necrosis<br/>Possible loss of limb
| None
|-
| Honey bee sting
| honey bee venom (injected)
| Being stung by a [[honey bee]] worker
| Pain<br>Strong swelling
|
|
|-
| Iron man cough
| iron man gas<br />(inhaled)
| Expelled by [[iron man]]
| Coughing blood
| None
| None
|-
| King cobra bite
| king cobra venom<br />(injected)
| Being bitten by a [[king cobra]]
| Complete paralysis<sup>1</sup><br/>Pain, dizziness, drowsiness
| None
| None
|-
| Phantom spider bite
| phantom spider venom<br />(injected)
| Being bitten by a [[phantom spider]]
| None
| Numbness and mild dizziness
| None
|-
| Platypus sting
| platypus venom<br />(injected)
| Being kicked by a [[platypus]], [[giant platypus]] or [[platypus man]]
| Pain and swelling
| Extreme pain, swelling possibly to the point of necrosis
| None
|-
| Rattlesnake bite
| rattlesnake venom<br />(injected)
| Being bitten by a [[rattlesnake]], [[giant rattlesnake]] or [[rattlesnake man]]
| Pain, nausea, blisters, swelling, bruising
| Severe localized necrosis
| None
|-
| Serpent man bite
| serpent man venom<br />(injected)
| Being bitten by a [[serpent man]]
| Complete paralysis<sup>1</sup>
| None
| None
|-
| [evil rain] sickness<sup>3</sup>
| random
| Being caught outside in freakish weather in an evil biome
| random
| random
| random
|-
| [evil cloud] sickness<sup>4</sup>
| random
| Being caught in a creeping cloud in an evil biome
| random
| random
| random
|-
| beast sickness<sup>5</sup>
| random
| Encounters with [[forgotten beast]]s
| random
| random
| random
|-
| titan sickness<sup>5</sup>
| random
| Encounters with [[titan]]s
| random
| random
| random
|-
| demon sickness<sup>5</sup>
| random
| Encounters with [[demon]]s
| random
| random
| random
|}
:<small>1. For small creatures such as humans and dwarves, paralysis tends to result in suffocation.</small>
:<small>2. Necrosis of the brain will eventually result in instant death once the brain rots away completely.</small>
:<small>3. Evil rain typically only causes minor symptoms such as blisters, bruising, coughing blood, dizziness, fever, nausea, oozing, and pain.</small>
:<small>4. Evil clouds either cause major symptoms (as with beast/titan/demon sicknesses) or permanently transform creatures into [[Undead|zombie-like]] forms.</small>
:<small>5. [[Titan]]s, [[forgotten beast]]s, and [[demon]]s have a chance to have a randomized syndrome. These range from pointless (mild blisters from inhaling boiling blood) to instantly deadly (Severe necrosis from a contact poison attached to a breath weapon/creature made of blood.</small>

==The anatomy of a syndrome==
Mechanically, syndromes are bundles of tokens attached to a material - they're confined to creature materials in vanilla DF, but it's a simple matter to add them to inorganic materials. When the material is injected, touched, inhaled, or ingested (depending on the syndrome), the creature suffers the predations of a nasty disease or poison. Here's an example syndrome, taken from the Giant Cave Spider raws.

If you are having troubles getting the syndromes to work (ie, in combat reports, getting "'''supersnake''' n/a splatters~etc"), then simply throw the venom template into the actual creature's raw, which is what the LOCAL_CREATURE_MAT actually calls on; the venom being in the same file.

[USE_MATERIAL_TEMPLATE:POISON:CREATURE_EXTRACT_TEMPLATE]
[STATE_NAME:ALL_SOLID:frozen giant cave spider venom]
[STATE_ADJ:ALL_SOLID:frozen giant cave spider venom]
[STATE_NAME:LIQUID:giant cave spider venom]
[STATE_ADJ:LIQUID:giant cave spider venom]
[STATE_NAME:GAS:boiling giant cave spider venom]
[STATE_ADJ:GAS:boiling giant cave spider venom]
[PREFIX:NONE]
[ENTERS_BLOOD]
[SYNDROME]
[SYN_NAME:giant cave spider bite]
[SYN_AFFECTED_CLASS:GENERAL_POISON]
[SYN_IMMUNE_CREATURE:SPIDER_CAVE:ALL]
[SYN_INJECTED]
[CE_PARALYSIS:SEV:100:PROB:100:RESISTABLE:SIZE_DILUTES:START:5:PEAK:10:END:20]

The first line, USE_MATERIAL_TEMPLATE, is creating a new material, called POISON, using the CREATURE_EXTRACT_TEMPLATE as the basis. After this, the STATE_NAME and STATE_ADJ tokens are used to define the names and adjectives assigned to different states of the material - GAS, LIQUID and ALL_SOLID, in this case, though ALL is also a valid token. At this stage, you can use any material tags like MAT_FIXED_TEMP or similar to set further material properties, though this usually isn't necessary.

ENTERS_BLOOD
This tag determines whether a poison enters the blood or not. If it is not included, the poison will splatter (if liquid) or flow (if gas) over the affected body part instead when injected. If you're using a contact poison, leave this out. Necessary for injected poisons.
SYNDROME
This tag ends the material details and begins the definition of the actual syndrome.
SYN_NAME
This one is self-explanatory - the name of the syndrome as it will appear in-game.
SYN_AFFECTED_CLASS
This token defines what CREATURE_CLASS will be affected by the syndrome. Most creatures are classed under GENERAL_POISON. Multiple tokens can be used in a single syndrome.
SYN_IMMUNE_CLASS
As above, but makes class immune.
SYN_IMMUNE_CREATURE
This token defines which creatures CANNOT be affected by the syndrome - useful for addressing specific instances within a population, such as a specific caste or an individual creature that falls under GENERAL_POISON. Syntax is [SYN_IMMUNE_CREATURE:creature:caste]. ALL can be used for the caste.
SYN_AFFECTED_CREATURE
As above, but makes creature or caste susceptible.

SYN_INJECTED, SYN_CONTACT, SYN_INHALED, SYN_INGESTED
This token determines the method of infection - injected syndromes must be injected via a creature attack, while contact syndromes result from any contamination of a creature by material splatter (such as blood), inhaled syndromes must be inhaled in gaseous form (such as from boiling or a creature breath attack), and ingestion syndromes must be eaten or drunk. Any combination of these tags can be used. A fun variation on the usual creature injection routine is to create a material with a SYN_CONTACT syndrome and have a creature use it for blood - this tends to end poorly for any predator that chooses to attack them.

[SPECIALATTACK_INJECT_EXTRACT:LOCAL_CREATURE_MAT:VENOM:LIQUID:100:100]
This is one method for getting a poison into a creature. If [ENTERS_BLOOD] is applied, it will be injected into the bloodstream. Otherwise, it will just splatter over the area. Put this on a creature attack. Substance type (gas, liquid, solid) does not appear to have an effect. The numbers on the end are minimum and maximum.

CE_X, or creature effect tokens, are the real meat and bones of your syndrome. They're detailed below.

==Creature effect tokens==
Each and every syndrome has a number of creature effect tokens, represented by CE_X - these lovely little beauties determine exactly how the poor creature suffering from the syndrome is affected. An example CE token is as follows:

[CE_NECROSIS:SEV:100:PROB:100:LOCALIZED:VASCULAR_ONLY:RESISTABLE:START:50:PEAK:1000:END:2000]

In this example, we have an effect that will always cause severe necrosis in whichever bodypart it touches, so long as that bodypart is vascular and that the creature is not able to resist it in some manner. The effect begins shortly after the syndrome is contracted, peaks 1000 [[time|time units]] afterwards, and finally ceases another 1000 time units later.

As a general rule of thumb, so long as CE_X starts the string and START/PEAK/END end it, the order of the intervening tokens isn't important.

*CE_X
The effect type. This can be a number of different tokens, as detailed in the table below this list.
*SEV:X
The severity of the effect. Higher values appear to be worse, with SEV:1000 CE_NECROSIS causing a part to near-instantly become rotten.
*PROB:X
The probability of the effect actually manifesting in the victim, as a percentage. 100 means always, 1 means a 1 in 100 chance.
*LOCALIZED (Overwrites BP tokens)
This tag causes an effect to ignore all BP tokens and then forces the game to attempt to apply the effect to the limb that came into contact with the contagion - i.e. the part that was bitten by the creature injecting the syndrome material, or the one that was splattered by a contact contagion. If an effect can not be applied to the contacted limb (such as IMPAIR_FUNCTION on a non-organ) then this token makes the syndrome have no effect. This token also makes inhaled syndromes have no effect.
*BP:BODY_PART:TISSUE (Overwritten by LOCALIZED)
Specifies which body parts and tissues are to be affected by the syndrome. BODY_PART can be BY_CATEGORY:x to target body parts with a matching [CATEGORY:x] [[body token]] (or ALL to affect everything), BY_TYPE:x to target body parts having a particular type (UPPERBODY, LOWERBODY, HEAD, GRASP, or STANCE), or BY_TOKEN:x to target individual body parts by their ID (as specified in the [BP] token). For example, if you wanted to target the lungs of a creature, you would use BP:BY_CATEGORY:LUNG:ALL. The syndrome would act on all bodyparts within the creature with the CATEGORY tag LUNG and affect all tissue layers. For another example, say you wanted to cause the skin to rot off a creature - you could use BP:BY_CATEGORY:ALL:SKIN, targeting the SKIN tissue on all bodyparts. Multiple targets can be given in one syndrome by placing the BP tokens end to end. This is one of the most powerful and useful aspects of the syndrome system, as it allows you to selectively target bodyparts relevant to the contagion, like lungs for coal dust inhalation, or the eyes for exposure to an acid gas. Not everything takes a target!
*VASCULAR_ONLY (Optional)
This syndrome only affects tissue layers with the VASCULAR token.
*MUSCULAR_ONLY (Optional)
This syndrome only affects tissue layers with the MUSCULAR token. Are you seeing a trend here?
*SIZE_DILUTES (Optional)
This token presumably causes the effects of the syndrome to scale with the size of the creature compared to the size of the dose of contagion they received, but has yet to be extensively tested.
*SIZE_DELAYS (Optional)
As above, this token has yet to be tested but presumably delays the onset of a syndrome according to the size of the victim.

The details of this table are still being thrashed out by modders, so if you have anything to add, please don't hesitate to hit the edit button!

Non-targeted syndromes will ignore any BP tokens and LOCALIZED tokens.
{| {{prettytable}}
|- bgcolor="Bisque"
! Token
! Accepts Target
! Description
|-
| CE_BLEEDING
| Yes
| Causes the targeted bodypart to start bleeding, with heavy enough bleeding resulting in the death of the sufferer. Some conditions seem to cause bleeding to be fatal no matter how weak.
|-
| CE_BLISTERS
| Yes
| Covers the targeted bodypart with blisters.
|-
| CE_BRUISING
| Yes
| Causes the targeted bodypart to undergo bruising.
|-
| CE_IMPAIR_FUNCTION
| Yes
| An organ afflicted with this CE is rendered inoperable - for example, if both lungs are impaired the creature can't breathe and will suffocate. This token only affects organs, not limbs.
|-
| CE_NECROSIS
| Yes
| Causes the targeted bodypart to rot, with associated tissue damage and miasma. Badly necrotic limbs will require amputation and heavy rot will eventually result in bleeding. Necrosis has some strange behavior involving bleeding to death that isn't fully understood; a 100% necrotic creature can survive fine with no non-yellow bodyparts but will die of bleeding as soon as they end a round of combat, even if they never take a hit. Because of this, fairly useless unless targeting the lungs or eyes.
|-
| CE_NUMBNESS
| Yes
| Causes numbness in the affected body part, blocking pain. Extreme numbness may lead to sensory nerve damage.
|-
| CE_OOZING
| Yes
| Causes pus to ooze from the afflicted bodypart.
|-
| CE_PAIN
| Yes
| Afflicts the targeted bodypart with intense pain.
|-
| CE_PARALYSIS
| Yes
| Causes paralysis in the affected body part. Targeted causes sluggishness and significantly reduces speed. Untargeted paralysis is 'complete paralysis' and will cause suffocation in smaller creatures.
|-
| CE_SWELLING
| Yes
| Causes the targeted bodypart to swell up. Extreme swelling may lead to necrosis.
|-
| CE_COUGH_BLOOD
| No
| This effect results in the sufferer periodically coughing blood, which stains the tile they're on and requires cleanup. It doesn't appear to be lethal, but may cause minor bleeding damage.
|-
| CE_DIZZINESS
| No
| Inflicts the Dizziness condition, occasional fainting and a general slowdown in movement and work speed.
|-
| CE_DROWSINESS
| No
| Causes the Drowsiness condition.
|-
| CE_FEVER
| No
| Causes the Fever condition.
|-
| CE_NAUSEA
| No
| Causes the Nausea condition, and heavy vomiting. Can eventually lead to dehydration and death.
|-
| CE_UNCONSCIOUSNESS
| No
| Renders unconscious.
|-
| CE_VOMIT_BLOOD
| No
| This effect results in the sufferer periodically vomiting blood, which stains the tile they're on and requires cleanup. It doesn't appear to be lethal, but may cause minor bleeding damage.
|}

==Special Syndromes==
v0.34 has added several special syndrome tags that take different arguments than the above. These are used for generated interactions in unmodded games, but may be used as well for any substance or custom interaction.

{| {{prettytable}}
|- bgcolor="Bisque"
! Token
! Arguments
! Description
|-
| CE_ADD_TAG
| tags:START:number(:END:number)
| Adds a tag to the affected creature. Many arguments can be used sequentially within one syndrome token. See the [[Interaction token]] '''IT_REQUIRES''' for valid tags.
|-
| CE_REMOVE_TAG
| tags:START:number(:END:number)
| Removes a tag from a creature. Supported arguments are the same as CE_ADD_TAG.
|-
| CE_DISPLAY_TILE
| TILE:tile number:colour:START:number(:END:number)
| The creature displays the specified tile and colour instead of its normal one.
|-
| CE_DISPLAY_NAME
| NAME:singular:plural:adjective:START:number(:END:number)
| Attaches a specified name to the creature's normal name.
|-
| CE_FLASH_TILE
| TILE:tile number:colour:FREQUENCY:?:?:START:number(:END:number)
| The creature flashes between its normal tile and the one specified here.
|-
| CE_PHYS_ATT_CHANGE
| [[Attribute]]:percentage:fixed boost(?):START:number(:END:number)
| Alters the physical [[attribute]]s of a creature.
|-
| CE_MENT_ATT_CHANGE
| [[Attribute]]:percentage:fixed boost(?):START:number(:END:number)
| Alters the mental [[attribute]]s of a creature.
|-
| CE_BODY_APPEARANCE_MODIFIER
|
|
|-
| CE_BP_APPEARANCE_MODIFIER
| START:number(:END:number):body part:APPEARANCE_MODIFIER:attribute:number]
| Alters the characteristics (height, width etc.) of a body part.
|-
| CE_MATERIAL_FORCE_MULTIPLIER
|
|
|-
| CE_BODY_MAT_INTERACTION
|
|
|-
| CE_SPEED_CHANGE
| speed modifier:START:number(:END:number) (might be more arguments existing in the first part?)
| Changes the speed of a creature.
Speed modifier contains one or both:
* SPEED_PERC:percentage
* SPEED_ADD:number (higher speed makes a creature slower, negative numbers are accepted though will only reduce a creature's speed to zero)
The minimum and maximum speeds able to be created by CE_SPEED_CHANGE are 99 and 10,000 respectively.
|-
| CE_CAN_DO_INTERACTION
| START:number(:END:number)
| Makes the creature able to perform an interaction. See [[Interaction token]]. To specify the interaction, use the argument:
* CDI:INTERACTION:interaction name
|-
| CE_BODY_TRANSFORMATION
| START:number(:END:number)
| Transforms into another creature. The target creature is specified with:
* CE:CREATURE:creature name:caste name<br>
Note that any wounds the creature has suffered will instantly heal upon transforming, both into and out of the target form. [[Undead]] limbs of a creature with this token will grow into a full instance of that creature.
|-
| CE_SKILL_ROLL_ADJUST
| PERC:percentage:PERC_ON:percentage:START:number(:END:number)
| Alters the skill level(?) of a creature. The argument PERC specifies a percentage of the creature's current skill, and PERC_ON the probability of the effect being applied.
|}

==Inorganic syndromes and you!==
It's perfectly possible - and quite simple - to add a nasty syndrome to a type of rock or metal - you simply add the syndrome tokens to the material definition in the same manner that you would add them to a creature material definition. The only catch is that since your hapless dwarves will only normally encounter the material in metal, gem or boulder form, a bit of creativity must be used to actually get them inside your citizens - that is, you need to make them 'explosively boil' as soon as they're mined or produced. This has the sad side effect of destroying the actual item - sorry, no highly radioactive uranium this release.

The easiest way to accomplish this is to assign the material a low boiling point, usually just under room temperature, and make sure its temperature is fixed to a point above it.
[MAT_FIXED_TEMP:9001]
[BOILING_POINT:9000]
Now, as soon as this substance hits the open air - by being mined, smelted or reaction-produced at a custom workshop - it will EXPLOSIVELY BOIL, flooding a small area with delicious syndrome-rich gas. Creatures who inhale the gas will be immediately hit with the syndrome you thoughtfully attached to the material definition earlier!

There are a number of other tokens you can use to control the colour and naming conventions of your syndrome material, referred to as MATERIAL tokens.

==Breath attacks==
Breath attacks have been changed to use Interactions as of 0.34.01. Instead of [MATERIAL_BREATH_ATTACK], you would now use the MATERIAL_EMISSION interaction, like so:

[CAN_DO_INTERACTION:MATERIAL_EMISSION]
[CDI:ADV_NAME:Breath custom material]
[CDI:USAGE_HINT:ATTACK]
[CDI:BP_REQUIRED:BY_CATEGORY:MOUTH]
[CDI:MATERIAL:LOCAL_CREATURE_MAT:CUSTOMMATERIAL:TRAILING_VAPOR_FLOW]
[CDI:TARGET:C:LINE_OF_SIGHT]
[CDI:TARGET_RANGE:C:15]
[CDI:MAX_TARGET_NUMBER:C:1]
[CDI:WAIT_PERIOD:50]

The most important part is this line:

[CDI:MATERIAL:LOCAL_CREATURE_MAT:CUSTOMMATERIAL:TRAILING_VAPOR_FLOW]

The CDI refers to CAN_DO_INTERACTION; the MATERIAL states that this line shows what the material is. LOCAL_CREATURE_MAT:CUSTOMMATERIAL is your material, and TRAILING_VAPOR_FLOW refers to the breath attack type. Other types are seen below. Also important is this line:

[CDI:TARGET:C:LINE_OF_SIGHT]

LINE_OF_SIGHT refers to where the target C may be; others include SELF_ALLOWED (presumably like LINE_OF_SIGHT, but with the creature allowed to target itself), SELF_ONLY (preferable for undirected attacks and TOUCHABLE (for up-close attacks, as trailing flows tend to be).

===Breath Attack Types===

{| {{prettytable}}
|- bgcolor="#ddd"
! Token
! Description
|-
| TRAILING_DUST_FLOW
| Lets out a cloud of solid dust. Appears to use cave-in dust physics, causing this to fling around anything it comes in contact with, making it capable of smashing creatures into the ground and flinging them over walls. Creature will attack as normal.
|-
| TRAILING_VAPOR_FLOW
| Similar to the trailing gas, but easier to breathe in, and condensed, so it will collect on creatures. Creature will attack as normal.
|-
| TRAILING_GAS_FLOW
| Shoots a trail of gas substance at the creature. Fairly easy to dodge. Creature will attack as normal.
|-
| SOLID_GLOB
| Shoots a solid glob of spinning substance at the creature, leaving symbols similar to broken arrows. Essentially a projectile weapon. Some creatures with this breath attack will not move, preferring instead to stay and shoot globs at you, even when you are literally right next to them.
|-
| LIQUID_GLOB
| Shoots a '''solid''' glob of spinning substance at the creature. Essentially the same as SOLID_GLOB. May do less damage.
|-
| SPATTER_POWDER
|
|-
| SPATTER_LIQUID
|
|-
| UNDIRECTED_GAS
| Creature occasionally releases a cloud of substance. Similar to TRAILING_GAS_FLOW, but undirected, thus affecting a larger area but losing the distance. Creature will attack as normal.
|-
| UNDIRECTED_VAPOR
| Creature occasionally releases a cloud of substance. Similar to TRAILING_VAPOR_FLOW, but undirected, thus affecting a larger area but losing the distance. Creature will attack as normal.
|-
| UNDIRECTED_DUST
| Creature occasionally releases a large cloud of substance, which will spread and dissipate. Similar to TRAILING_DUST_FLOW, but undirected, thus affecting a larger area but losing the distance - range is roughly the same as that of a cave-in. Creature will attack as normal. <s>DO NOT USE THIS TAG UNLESS YOU WANT TO KILL THE CREATURE AND EVERYTHING NEAR IT AND SEND PEOPLE FLYING.</s> You know you want to.
|-
| WEB_SPRAY
| Emits a burst of [[web]]s that entangle target creatures.
|-
| DRAGONFIRE
| Emits a wide cone of [[fire]] that burns target creatures.
|-
| FIREJET
| Emits a narrow cone of [[fire]] that burns target creatures.
|-
| FIREBALL
| Emits a fireball that burns the target creature.
|-
| WEATHER_CREEPING_GAS
| Creates a slowly expanding cloud of gas, similar to miasma.
|-
| WEATHER_CREEPING_VAPOR
| Creates a slowly expanding cloud of vapor.
|-
| WEATHER_CREEPING_DUST
| Creates a slowly expanding cloud of dust.
|-
| WEATHER_FALLING_MATERIAL
| Causes it to start raining a particular material.
|}

Keep in mind that you can use multiple breath attacks, which appears to make the creature choose between them at random.

{{Category|Modding}}
[[ru:DF2012:Syndrome]]

v0.34:Syndrome

2012-03-21T17:56:43Z

I2amroy: /* Creature effect tokens */

{{quality|Masterwork|21:09, 26 April 2011 (UTC)}}{{av}}

A '''syndrome''' is a disease or effect that a poor hapless creature might get through encountering certain creatures, extracts or vindictive modders. They generally cause unpleasant and frequently fatal [[symptoms]] over a short to long period of time, but some will clear up over time or with the assistance of a [[doctor]]. A [[Health care|Hospital]] is required to diagnose and potentially treat the syndrome. [[File:Snakebite.png|200px|thumb|right|An example of a syndrome in effect. This hippo did not ultimately survive the encounter despite one bite being the only injury sustained.]]

==List of syndromes==
{| {{prettytable}}
|- bgcolor="#dddddd"
! Syndrome
! Venom
! Acquired
! Short-term Symptoms
! Long-term Symptoms
! Chronic Symptoms
|-
| Adder bite
| adder venom (injected)
| Being bitten by an [[adder]], [[giant adder]] or [[adder man]]
| Strong pain
| Swelling<br>Blisters<br>Nausea
|
|-
| Bark scorpion sting
| bark scorpion venom (injected)
| Being stung by a [[bark scorpion]], [[giant bark scorpion]] or [[bark scorpion man]]
| Strong pain
| none
| none
|-
| Black mamba bite
| black mamba venom (injected)
| Being bitten by a [[black mamba]], [[giant black mamba]] or [[black mamba man]]
| Dizziness<br>Drowsiness<br>Strong pain<br>Fever<br>Unconsciousness<br>Complete paralysis<sup>1</sup>
|
|
|-
| Blob blisters
| cave blob fluid<br />(contact or ingested)
| Touching a [[cave blob]]
| Mild pain<br/>Mild blisters
| None
| None
|-
| Brown recluse spider bite
| brown recluse spider venom (injected)
| Being bitten by a [[brown recluse spider]], [[giant brown recluse spider]] or [[brown recluse spider man]]
| Nausea<br>Fever<br>Pain<br>
| Severe localised necrosis
|
|-
| Bumblebee sting
| bumblebee venom (injected)
| Being stung by a [[bumblebee]] worker
| Pain<br>Strong swelling
|
|
|-
| Bushmaster bite
| bushmaster venom (injected)
| Being bitten by a [[bushmaster]], [[giant bushmaster]] or [[bushmaster man]]
| Strong pain<br>Mild bleeding<br>Dizziness<br>Nausea<br>Unconsciousness<br>Complete paralysis<sup>1</sup>
|
|
|-
| Cave floater sickness
| cave floater gas<br />(inhaled or ingested)
| Expelled from [[cave floater]]
| Mild nausea
| Fever<br/>Strong drowsiness (delayed)<br/>Strong dizziness (delayed)
| None
|-
| Cave spider bite
| cave spider venom<br />(injected)
| Being bitten by a [[cave spider]]
| None
| None
| Very mild dizziness
|-
| Copperhead snake bite
| copperhead snake venom (injected)
| Being bitten by a [[copperhead snake]], [[giant copperhead snake]] or [[copperhead snake man]]
| Pain<br>Swelling<br>Nausea
|
|
|-
| Giant cave spider bite
| giant cave spider venom<br />(injected)
| Being bitten by a [[giant cave spider]]
| Complete paralysis<sup>1</sup><br/>'''Being eaten by the GCS'''
| None, not that it really matters.
| None
|-
| Gila monster bite
| gila monster venom (injected)
| Being bitten by a [[gila monster]], [[giant gila monster]] or [[gila monster man]]
| Pain<br>Mild swelling
|
|
|-
| Gnomeblight
| [[gnomeblight]]<br />(contact, inhaled, injected, or ingested)
| Unknown. Affects gnomes only
| None
| Severe systemic necrosis<sup>2</sup>
| None
|-
| Giant desert scorpion sting
| giant desert scorpion<br />(injected)
| Being stung by a [[giant desert scorpion]]
|
| Necrosis of the brain and nervous system<sup>2</sup>
| '''Unavoidable death'''
|-
| Helmet snake bite
| helmet snake venom<br />(injected)
| Being bitten by a [[helmet snake]]
| Minor bleeding
| Fever<br/>Nausea<br/>Dizziness<br/>Localized swelling<br/>Localized oozing<br/>Localized bruising<br/>Strong pain<br/>Intense localized necrosis<br/>Possible loss of limb
| None
|-
| Honey bee sting
| honey bee venom (injected)
| Being stung by a [[honey bee]] worker
| Pain<br>Strong swelling
|
|
|-
| Iron man cough
| iron man gas<br />(inhaled)
| Expelled by [[iron man]]
| Coughing blood
| None
| None
|-
| King cobra bite
| king cobra venom<br />(injected)
| Being bitten by a [[king cobra]]
| Complete paralysis<sup>1</sup><br/>Pain, dizziness, drowsiness
| None
| None
|-
| Phantom spider bite
| phantom spider venom<br />(injected)
| Being bitten by a [[phantom spider]]
| None
| Numbness and mild dizziness
| None
|-
| Platypus sting
| platypus venom<br />(injected)
| Being kicked by a [[platypus]], [[giant platypus]] or [[platypus man]]
| Pain and swelling
| Extreme pain, swelling possibly to the point of necrosis
| None
|-
| Rattlesnake bite
| rattlesnake venom<br />(injected)
| Being bitten by a [[rattlesnake]], [[giant rattlesnake]] or [[rattlesnake man]]
| Pain, nausea, blisters, swelling, bruising
| Severe localized necrosis
| None
|-
| Serpent man bite
| serpent man venom<br />(injected)
| Being bitten by a [[serpent man]]
| Complete paralysis<sup>1</sup>
| None
| None
|-
| [evil rain] sickness<sup>3</sup>
| random
| Being caught outside in freakish weather in an evil biome
| random
| random
| random
|-
| [evil cloud] sickness<sup>4</sup>
| random
| Being caught in a creeping cloud in an evil biome
| random
| random
| random
|-
| beast sickness<sup>5</sup>
| random
| Encounters with [[forgotten beast]]s
| random
| random
| random
|-
| titan sickness<sup>5</sup>
| random
| Encounters with [[titan]]s
| random
| random
| random
|-
| demon sickness<sup>5</sup>
| random
| Encounters with [[demon]]s
| random
| random
| random
|}
:<small>1. For small creatures such as humans and dwarves, paralysis tends to result in suffocation.</small>
:<small>2. Necrosis of the brain will eventually result in instant death once the brain rots away completely.</small>
:<small>3. Evil rain typically only causes minor symptoms such as blisters, bruising, coughing blood, dizziness, fever, nausea, oozing, and pain.</small>
:<small>4. Evil clouds either cause major symptoms (as with beast/titan/demon sicknesses) or permanently transform creatures into [[Undead|zombie-like]] forms.</small>
:<small>5. [[Titan]]s, [[forgotten beast]]s, and [[demon]]s have a chance to have a randomized syndrome. These range from pointless (mild blisters from inhaling boiling blood) to instantly deadly (Severe necrosis from a contact poison attached to a breath weapon/creature made of blood.</small>

==The anatomy of a syndrome==
Mechanically, syndromes are bundles of tokens attached to a material - they're confined to creature materials in vanilla DF, but it's a simple matter to add them to inorganic materials. When the material is injected, touched, inhaled, or ingested (depending on the syndrome), the creature suffers the predations of a nasty disease or poison. Here's an example syndrome, taken from the Giant Cave Spider raws.

If you are having troubles getting the syndromes to work (ie, in combat reports, getting "'''supersnake''' n/a splatters~etc"), then simply throw the venom template into the actual creature's raw, which is what the LOCAL_CREATURE_MAT actually calls on; the venom being in the same file.

[USE_MATERIAL_TEMPLATE:POISON:CREATURE_EXTRACT_TEMPLATE]
[STATE_NAME:ALL_SOLID:frozen giant cave spider venom]
[STATE_ADJ:ALL_SOLID:frozen giant cave spider venom]
[STATE_NAME:LIQUID:giant cave spider venom]
[STATE_ADJ:LIQUID:giant cave spider venom]
[STATE_NAME:GAS:boiling giant cave spider venom]
[STATE_ADJ:GAS:boiling giant cave spider venom]
[PREFIX:NONE]
[ENTERS_BLOOD]
[SYNDROME]
[SYN_NAME:giant cave spider bite]
[SYN_AFFECTED_CLASS:GENERAL_POISON]
[SYN_IMMUNE_CREATURE:SPIDER_CAVE:ALL]
[SYN_INJECTED]
[CE_PARALYSIS:SEV:100:PROB:100:RESISTABLE:SIZE_DILUTES:START:5:PEAK:10:END:20]

The first line, USE_MATERIAL_TEMPLATE, is creating a new material, called POISON, using the CREATURE_EXTRACT_TEMPLATE as the basis. After this, the STATE_NAME and STATE_ADJ tokens are used to define the names and adjectives assigned to different states of the material - GAS, LIQUID and ALL_SOLID, in this case, though ALL is also a valid token. At this stage, you can use any material tags like MAT_FIXED_TEMP or similar to set further material properties, though this usually isn't necessary.

ENTERS_BLOOD
This tag determines whether a poison enters the blood or not. If it is not included, the poison will splatter (if liquid) or flow (if gas) over the affected body part instead when injected. If you're using a contact poison, leave this out. Necessary for injected poisons.
SYNDROME
This tag ends the material details and begins the definition of the actual syndrome.
SYN_NAME
This one is self-explanatory - the name of the syndrome as it will appear in-game.
SYN_AFFECTED_CLASS
This token defines what CREATURE_CLASS will be affected by the syndrome. Most creatures are classed under GENERAL_POISON. Multiple tokens can be used in a single syndrome.
SYN_IMMUNE_CLASS
As above, but makes class immune.
SYN_IMMUNE_CREATURE
This token defines which creatures CANNOT be affected by the syndrome - useful for addressing specific instances within a population, such as a specific caste or an individual creature that falls under GENERAL_POISON. Syntax is [SYN_IMMUNE_CREATURE:creature:caste]. ALL can be used for the caste.
SYN_AFFECTED_CREATURE
As above, but makes creature or caste susceptible.

SYN_INJECTED, SYN_CONTACT, SYN_INHALED, SYN_INGESTED
This token determines the method of infection - injected syndromes must be injected via a creature attack, while contact syndromes result from any contamination of a creature by material splatter (such as blood), inhaled syndromes must be inhaled in gaseous form (such as from boiling or a creature breath attack), and ingestion syndromes must be eaten or drunk. Any combination of these tags can be used. A fun variation on the usual creature injection routine is to create a material with a SYN_CONTACT syndrome and have a creature use it for blood - this tends to end poorly for any predator that chooses to attack them.

[SPECIALATTACK_INJECT_EXTRACT:LOCAL_CREATURE_MAT:VENOM:LIQUID:100:100]
This is one method for getting a poison into a creature. If [ENTERS_BLOOD] is applied, it will be injected into the bloodstream. Otherwise, it will just splatter over the area. Put this on a creature attack. Substance type (gas, liquid, solid) does not appear to have an effect. The numbers on the end are minimum and maximum.

CE_X, or creature effect tokens, are the real meat and bones of your syndrome. They're detailed below.

==Creature effect tokens==
Each and every syndrome has a number of creature effect tokens, represented by CE_X - these lovely little beauties determine exactly how the poor creature suffering from the syndrome is affected. An example CE token is as follows:

[CE_NECROSIS:SEV:100:PROB:100:LOCALIZED:VASCULAR_ONLY:RESISTABLE:START:50:PEAK:1000:END:2000]

In this example, we have an effect that will always cause severe necrosis in whichever bodypart it touches, so long as that bodypart is vascular and that the creature is not able to resist it in some manner. The effect begins shortly after the syndrome is contracted, peaks 1000 [[time|time units]] afterwards, and finally ceases another 1000 time units later.

As a general rule of thumb, so long as CE_X starts the string and START/PEAK/END end it, the order of the intervening tokens isn't important.

*CE_X
The effect type. This can be a number of different tokens, as detailed in the table below this list.
*SEV:X
The severity of the effect. Higher values appear to be worse, with SEV:1000 CE_NECROSIS causing a part to near-instantly become rotten.
*PROB:X
The probability of the effect actually manifesting in the victim, as a percentage. 100 means always, 1 means a 1 in 100 chance.
*LOCALIZED (Overwrites BP tokens)
This tag causes an effect to ignore all BP tokens and then forces the game to attempt to apply the effect to the limb that came into contact with the contagion - i.e. the part that was bitten by the creature injecting the syndrome material, or the one that was splattered by a contact contagion. If an effect can not be applied to the contacted limb (such as IMPAIR_FUNCTION on a non-organ) then this token makes the syndrome have no effect. This token also makes inhaled syndromes have no effect.
*BP:BODY_PART:TISSUE (Overwritten by LOCALIZED)
Specifies which body parts and tissues are to be affected by the syndrome. BODY_PART can be BY_CATEGORY:x to target body parts with a matching [CATEGORY:x] [[body token]] (or ALL to affect everything), BY_TYPE:x to target body parts having a particular type (UPPERBODY, LOWERBODY, HEAD, GRASP, or STANCE), or BY_TOKEN:x to target individual body parts by their ID (as specified in the [BP] token). For example, if you wanted to target the lungs of a creature, you would use BP:BY_CATEGORY:LUNG:ALL. The syndrome would act on all bodyparts within the creature with the CATEGORY tag LUNG and affect all tissue layers. For another example, say you wanted to cause the skin to rot off a creature - you could use BP:BY_CATEGORY:ALL:SKIN, targeting the SKIN tissue on all bodyparts. Multiple targets can be given in one syndrome by placing the BP tokens end to end. This is one of the most powerful and useful aspects of the syndrome system, as it allows you to selectively target bodyparts relevant to the contagion, like lungs for coal dust inhalation, or the eyes for exposure to an acid gas. Not everything takes a target!
*VASCULAR_ONLY (Optional)
This syndrome only affects tissue layers with the VASCULAR token.
*MUSCULAR_ONLY (Optional)
This syndrome only affects tissue layers with the MUSCULAR token. Are you seeing a trend here?
*SIZE_DILUTES (Optional)
This token presumably causes the effects of the syndrome to scale with the size of the creature compared to the size of the dose of contagion they received, but has yet to be extensively tested.
*SIZE_DELAYS (Optional)
As above, this token has yet to be tested but presumably delays the onset of a syndrome according to the size of the victim.

The details of this table are still being thrashed out by modders, so if you have anything to add, please don't hesitate to hit the edit button!

Non-targeted syndromes will ignore any BP tokens and LOCALIZED tokens.
{| {{prettytable}}
|- bgcolor="Bisque"
! Token
! Accepts Target
! Description
|-
| CE_BLEEDING
| Yes
| Causes the targeted bodypart to start bleeding, with heavy enough bleeding resulting in the death of the sufferer. Some conditions seem to cause bleeding to be fatal no matter how weak.
|-
| CE_BLISTERS
| Yes
| Covers the targeted bodypart with blisters.
|-
| CE_BRUISING
| Yes
| Causes the targeted bodypart to undergo bruising.
|-
| CE_IMPAIR_FUNCTION
| Yes
| An organ afflicted with this CE is rendered inoperable - for example, if both lungs are impaired the creature can't breathe and will suffocate. This token only affects organs, not limbs.
|-
| CE_NECROSIS
| Yes
| Causes the targeted bodypart to rot, with associated tissue damage and miasma. Badly necrotic limbs will require amputation and heavy rot will eventually result in bleeding. Necrosis has some strange behavior involving bleeding to death that isn't fully understood; a 100% necrotic creature can survive fine with no non-yellow bodyparts but will die of bleeding as soon as they end a round of combat, even if they never take a hit. Because of this, fairly useless unless targeting the lungs or eyes.
|-
| CE_NUMBNESS
| Yes
| Causes numbness in the affected body part, blocking pain. Extreme numbness may lead to sensory nerve damage.
|-
| CE_OOZING
| Yes
| Causes pus to ooze from the afflicted bodypart.
|-
| CE_PAIN
| Yes
| Afflicts the targeted bodypart with intense pain.
|-
| CE_PARALYSIS
| Yes
| Causes paralysis in the affected body part. Targeted causes sluggishness and significantly reduces speed. Untargeted paralysis is 'complete paralysis' and will cause suffocation in smaller creatures.
|-
| CE_SWELLING
| Yes
| Causes the targeted bodypart to swell up. Extreme swelling may lead to necrosis.
|-
| CE_COUGH_BLOOD
| No
| This effect results in the sufferer periodically coughing blood, which stains the tile they're on and requires cleanup. It doesn't appear to be lethal, but may cause minor bleeding damage.
|-
| CE_DIZZINESS
| No
| Inflicts the Dizziness condition, occasional fainting and a general slowdown in movement and work speed.
|-
| CE_DROWSINESS
| No
| Causes the Drowsiness condition.
|-
| CE_FEVER
| No
| Causes the Fever condition.
|-
| CE_NAUSEA
| No
| Causes the Nausea condition, and heavy vomiting. Can eventually lead to dehydration and death.
|-
| CE_UNCONSCIOUSNESS
| No
| Renders unconscious.
|-
| CE_VOMIT_BLOOD
| No
| This effect results in the sufferer periodically vomiting blood, which stains the tile they're on and requires cleanup. It doesn't appear to be lethal, but may cause minor bleeding damage.
|}

==Special Syndromes==
v0.34 has added several special syndrome tags that take different arguments than the above. These are used for generated interactions in unmodded games, but may be used as well for any substance or custom interaction.

{| {{prettytable}}
|- bgcolor="Bisque"
! Token
! Arguments
! Description
|-
| CE_ADD_TAG
| [[creature token]]s:START:number(:END:number)
| Adds a [[creature token]] to the affected creature. Many arguments can be used sequentially within one syndrome token.<sup>6</sup>
|-
| CE_REMOVE_TAG
| [[creature token]]s:START:number(:END:number)
| Removes a [[creature token]] from a creature. Supported arguments are the same as CE_ADD_TAG.
|-
| CE_DISPLAY_TILE
| TILE:tile number:colour:START:number(:END:number)
| The creature displays the specified tile and colour instead of its normal one.
|-
| CE_DISPLAY_NAME
| NAME:singular:plural:adjective:START:number(:END:number)
| Attaches a specified name to the creature's normal name.
|-
| CE_FLASH_TILE
| TILE:tile number:colour:FREQUENCY:?:?:START:number(:END:number)
| The creature flashes between its normal tile and the one specified here.
|-
| CE_PHYS_ATT_CHANGE
| [[Attribute]]:percentage:fixed boost(?):START:number(:END:number)
| Alters the physical [[attribute]]s of a creature.
|-
| CE_MENT_ATT_CHANGE
| [[Attribute]]:percentage:fixed boost(?):START:number(:END:number)
| Alters the mental [[attribute]]s of a creature.
|-
| CE_BODY_APPEARANCE_MODIFIER
|
|
|-
| CE_BP_APPEARANCE_MODIFIER
| START:number(:END:number):body part:APPEARANCE_MODIFIER:attribute:number]
| Alters the characteristics (height, width etc.) of a body part.
|-
| CE_MATERIAL_FORCE_MULTIPLIER
|
|
|-
| CE_BODY_MAT_INTERACTION
|
|
|-
| CE_SPEED_CHANGE
| SPEED_PERC:percentage:START:number(:END:number) (might be more arguments existing in the first part?)
| Changes the speed of a creature.
|-
| CE_CAN_DO_INTERACTION
| START:number(:END:number)
| Makes the creature able to perform an interaction. See [[Interaction token]]. To specify the interaction, use the argument:
* CDI:INTERACTION:interaction name
|-
| CE_BODY_TRANSFORMATION
| START:number(:END:number)
| Transforms into another creature. The target creature is specified with:
* CE:CREATURE:creature name:caste name<br>
Note that any wounds the creature has suffered will instantly heal upon transforming, both into and out of the target form. [[Undead]] limbs of a creature with this token will grow into a full instance of that creature.
|-
| CE_SKILL_ROLL_ADJUST
| PERC:percentage:PERC_ON:percentage:START:number(:END:number)
| Alters the skill level(?) of a creature. The argument PERC specifies a percentage of the creature's current skill, and PERC_ON the probability of the effect being applied.
|}
:<small>6. At the moment, only a limited subset of creature tokens are supported. Currently supported tokens are:
* EXTRAVISION
* OPPOSED_TO_LIFE
* SUPERNATURAL
* NOT_LIVING
* NOEXERT
* CRAZED
* BLOODSUCKER
* NOPAIN
* NOBREATHE
* HAS_BLOOD
* NOSTUN
* NONAUSEA
* NO_DIZZINESS
* NO_FEVERS
* TRANCES
* NOEMOTION
* LIKESFIGHTING
* PARALYZEIMMUNE
* NOFEAR
* NO_EAT
* NO_DRINK
* NO_SLEEP
* MISCHIEVOUS
* NO_PHYS_ATT_GAIN
* NO_PHYS_ATT_RUST
* NOTHOUGHT
* NO_THOUGHT_CENTER_FOR_MOVEMENT
* NO_CONNECTIONS_FOR_MOVEMENT
* CAN_SPEAK
* CAN_LEARN
* UTTERANCES
* MORTAL
* NO_AGING
* STERILE
* FIT_FOR_ANIMATION
* FIT_FOR_RESURRECTION
</small>

==Inorganic syndromes and you!==
It's perfectly possible - and quite simple - to add a nasty syndrome to a type of rock or metal - you simply add the syndrome tokens to the material definition in the same manner that you would add them to a creature material definition. The only catch is that since your hapless dwarves will only normally encounter the material in metal, gem or boulder form, a bit of creativity must be used to actually get them inside your citizens - that is, you need to make them 'explosively boil' as soon as they're mined or produced. This has the sad side effect of destroying the actual item - sorry, no highly radioactive uranium this release.

The easiest way to accomplish this is to assign the material a low boiling point, usually just under room temperature, and make sure its temperature is fixed to a point above it.
[MAT_FIXED_TEMP:9001]
[BOILING_POINT:9000]
Now, as soon as this substance hits the open air - by being mined, smelted or reaction-produced at a custom workshop - it will EXPLOSIVELY BOIL, flooding a small area with delicious syndrome-rich gas. Creatures who inhale the gas will be immediately hit with the syndrome you thoughtfully attached to the material definition earlier!

There are a number of other tokens you can use to control the colour and naming conventions of your syndrome material, referred to as MATERIAL tokens.

==Breath attacks==
Breath attacks have been changed to use Interactions as of 0.34.01. Instead of [MATERIAL_BREATH_ATTACK], you would now use the MATERIAL_EMISSION interaction, like so:

[CAN_DO_INTERACTION:MATERIAL_EMISSION]
[CDI:ADV_NAME:Breath custom material]
[CDI:USAGE_HINT:ATTACK]
[CDI:BP_REQUIRED:BY_CATEGORY:MOUTH]
[CDI:MATERIAL:LOCAL_CREATURE_MAT:CUSTOMMATERIAL:TRAILING_VAPOR_FLOW]
[CDI:TARGET:C:LINE_OF_SIGHT]
[CDI:TARGET_RANGE:C:15]
[CDI:MAX_TARGET_NUMBER:C:1]
[CDI:WAIT_PERIOD:50]

The most important part is this line:

[CDI:MATERIAL:LOCAL_CREATURE_MAT:CUSTOMMATERIAL:TRAILING_VAPOR_FLOW]

The CDI refers to CAN_DO_INTERACTION; the MATERIAL states that this line shows what the material is. LOCAL_CREATURE_MAT:CUSTOMMATERIAL is your material, and TRAILING_VAPOR_FLOW refers to the breath attack type. Other types are seen below. Also important is this line:

[CDI:TARGET:C:LINE_OF_SIGHT]

LINE_OF_SIGHT refers to where the target C may be; others include SELF_ALLOWED (presumably like LINE_OF_SIGHT, but with the creature allowed to target itself), SELF_ONLY (preferable for undirected attacks and TOUCHABLE (for up-close attacks, as trailing flows tend to be).

===Breath Attack Types===

{| {{prettytable}}
|- bgcolor="#ddd"
! Token
! Description
|-
| TRAILING_DUST_FLOW
| Lets out a cloud of solid dust. Appears to use cave-in dust physics, causing this to fling around anything it comes in contact with, making it capable of smashing creatures into the ground and flinging them over walls. Creature will attack as normal.
|-
| TRAILING_VAPOR_FLOW
| Similar to the trailing gas, but easier to breathe in, and condensed, so it will collect on creatures. Creature will attack as normal.
|-
| TRAILING_GAS_FLOW
| Shoots a trail of gas substance at the creature. Fairly easy to dodge. Creature will attack as normal.
|-
| SOLID_GLOB
| Shoots a solid glob of spinning substance at the creature, leaving symbols similar to broken arrows. Essentially a projectile weapon. Some creatures with this breath attack will not move, preferring instead to stay and shoot globs at you, even when you are literally right next to them.
|-
| LIQUID_GLOB
| Shoots a '''solid''' glob of spinning substance at the creature. Essentially the same as SOLID_GLOB. May do less damage.
|-
| SPATTER_POWDER
|
|-
| SPATTER_LIQUID
|
|-
| UNDIRECTED_GAS
| Creature occasionally releases a cloud of substance. Similar to TRAILING_GAS_FLOW, but undirected, thus affecting a larger area but losing the distance. Creature will attack as normal.
|-
| UNDIRECTED_VAPOR
| Creature occasionally releases a cloud of substance. Similar to TRAILING_VAPOR_FLOW, but undirected, thus affecting a larger area but losing the distance. Creature will attack as normal.
|-
| UNDIRECTED_DUST
| Creature occasionally releases a large cloud of substance, which will spread and dissipate. Similar to TRAILING_DUST_FLOW, but undirected, thus affecting a larger area but losing the distance - range is roughly the same as that of a cave-in. Creature will attack as normal. <s>DO NOT USE THIS TAG UNLESS YOU WANT TO KILL THE CREATURE AND EVERYTHING NEAR IT AND SEND PEOPLE FLYING.</s> You know you want to.
|-
| WEB_SPRAY
| Emits a burst of [[web]]s that entangle target creatures.
|-
| DRAGONFIRE
| Emits a wide cone of [[fire]] that burns target creatures.
|-
| FIREJET
| Emits a narrow cone of [[fire]] that burns target creatures.
|-
| FIREBALL
| Emits a fireball that burns the target creature.
|-
| WEATHER_CREEPING_GAS
| Creates a slowly expanding cloud of gas, similar to miasma.
|-
| WEATHER_CREEPING_VAPOR
| Creates a slowly expanding cloud of vapor.
|-
| WEATHER_CREEPING_DUST
| Creates a slowly expanding cloud of dust.
|-
| WEATHER_FALLING_MATERIAL
| Causes it to start raining a particular material.
|}

Keep in mind that you can use multiple breath attacks, which appears to make the creature choose between them at random.

{{Category|Modding}}
[[ru:DF2012:Syndrome]]

v0.31:Weapon

2012-01-25T18:28:39Z

I2amroy: /* Dwarf-manufactured weapons */

{{quality|Exceptional|00:05, 23 November 2010 (UTC)}}{{av}}{{Buggy}}

"Weapon" can refer to either the manufactured weapons used by dwarves and other creatures for either [[combat]] or specific [[labor]]s, or natural weapons like fists, horns and [[syndrome|breath attacks]] used for creature-specific methods of combat.


=Manufactured weapons=
These weapons are constructed by dwarves or other intelligent races. There are many types of weapons, but not all may be manufactured in [[Dwarf fortress mode|Fortress Mode]]. For notes on how to create weapons see [[Metalsmith's forge]].

==Notes about manufactured weapons==
*If you find your dwarves wearing more than one weapon -- or any unwanted [[armor]], for that matter -- one way to get rid of them is to dump the weapon from their {{k|v}}-{{k|i}} inventory screen. This does not always work, as they might re-equip the item. Another option is to remove any weapons and/or shields listed on their military equip screen. This too does not always work. At least "left-handedness" seems to not pose a problem. If you cancel the work by {{k|v}}-{{k|p}} and selecting a job that needs a tool they will sometimes put it back in the pile. Example: Miners use picks, cancel their mining job and they will put the pick away AFTER you ordered it to be dumped.
*Using weapons is much more effective than unarmed combat -- an untrained swordsdwarf with an [[iron]] weapon can defeat a grand master [[wrestler]], provided neither is wearing armor.
**Larger weapons with more heft tend to do more damage. How damage is calculated is currently not fully understood, and this is an area requiring more research.
*Weapons and ammunition with the "foreign" attribute (item being rarer than Common in the entity file) must be either imported by either [[trade]]rs or [[invader]]s, or acquired from [[strange mood]]s.
*Weapons originating from strange moods can be made from almost any material: while it is never normally possible to manufacture a [[bone]] spear, for example, a fey [[bone carver]] may produce one from a single [[rainbow trout]] bone.
*Training weapons are all wooden, and all made at the [[Carpenter's workshop|carpenter's workshop]]. <s>All</s> Battle axe, Spear, and Short Sword training weapons can be constructed in dwarf fortress mode.
*Crossbows can be made of metal, wood, and bone. Metal crossbows are made by a [[weaponsmith]] at a [[forge]], while wood and bone crossbows are made by a [[bowyer]] at a bowyer's workshop. The material of a crossbow does not affect its firing ability, only its melee damage. A dwarf's marksmanship skill is only affected by the core [[item quality|quality]] of the bow. This may be a consideration when deciding which dwarf you want outfitting your marksdwarves: a [[experience|legendary]] bowyer is a better choice than a proficient weaponsmith.

*The size for a weapon is its volume in cm<sup>3</sup>.
*Attacks of type EDGE will either slice or pierce their target, depending on the contact area and penetration depth, while BLUNT attacks tend to damage internal organs without necessarily causing significant damage to outer layers.
*The contact area represents the area of contact of the weapon, and the penetration determines how deep the attack goes (and is apparently ignored entirely for BLUNT attacks -- indicated by numbers in parentheses). Large contact areas combined with low penetration represent slashing attacks, while small contact areas with high penetration behave as piercing attacks.
*The velocity seems to adjust the amount of actual force used during the attack (otherwise based on the size of the weapon, the material from which the weapon is made, and the strength of the wielder) - for example, war hammers have a 2x velocity multiplier, presumably to model the fact that the hammer's mass is concentrated at the tip which, when combined with a long handle, permits swinging it harder than a weapon whose mass is evenly distributed (such as a sword).

===Weapons as tools===
[[hunter|Hunters]], [[wood cutter|Woodcutters]] and [[miner|Miners]] use weapons for their [[labor|work]] and if need be will also [[combat|fight]] using them. Hunters seem to be limited to [[crossbow|crossbows]] while miners and woodcutters use [[pick|picks]] and [[battle axe|axes]] respectively.

==Dwarf-manufactured weapons==

{| class="wikitable" border="border"
! Type
! Size
! Attack
! [[Attack type]]
! Contact Area
! Penetration
! Velocity
! Skill Used
! Hands Used
! [[Weaponsmith|Metal]]
! [[Bowyer|Wood]]
! [[Bowyer|Bone]]
! [[Stone crafter|Obsidian]]
|- valign="top"
|rowspan="3"| Battle Axe
|rowspan="3"| 800
| Hack || Edge || 40000 || 6000 || 1.25x
|rowspan="3"| Axe
|rowspan="3"| Multigrasp?
|rowspan="3"| Yes
|rowspan="3"| No
|rowspan="3"| No
|rowspan="3"| No
|-
| Flat slap || Blunt || 40000 || (6000) || 1.25x
|-
| Pommel strike || Blunt || 100 || (1000) || 1x
|-
| Crossbow (Melee)
| 400
| Bash || Blunt || 10000 || (4000) || 1.25x
| Hammer
| Singlegrasp?
| Yes
| Yes
| Yes
| No
|-
| Mace
| 800
| Bash || Blunt || 20 || (200) || 2.0x
| Mace
| Singlegrasp
| Yes
| No
| No
| No
|-
| Pick
| 500
| Strike || Edge || 100 || 4000 || 2.0x
| Mining
| Singlegrasp
| Yes
| No
| No
| No
|- valign="top"
|rowspan="4"| Short Sword
|rowspan="4"| 300
| Slash || Edge || 20000 || 4000 || 1.25x
|rowspan="4"| Sword
|rowspan="4"| Singlegrasp
|rowspan="4"| Yes
|rowspan="4"| No
|rowspan="4"| No
|rowspan="4"| Yes
|-
| Stab || Edge || 50 || 2000 || 1.0x
|-
| Flat slap || Blunt || 20000 || (4000) || 1.25x
|-
| Pommel strike || Blunt || 100 || (1000) || 1.0x
|- valign="top"
|rowspan="2"| Spear
|rowspan="2"| 400
| Stab || Edge || 20 || 10000 || 1.0x
|rowspan="2"| Spear
|rowspan="2"| Singlegrasp
|rowspan="2"| Yes
|rowspan="2"| No
|rowspan="2"| No
|rowspan="2"| No
|-
| Shaft bash || Blunt || 10000 || (6000) || 1.25x
|-
| War Hammer
| 400
| Bash || Blunt || 10 || (200) || 2.0x
| Hammer
| Singlegrasp
| Yes
| No
| No
| No
|}

==Training Weapons==

All training weapons must be made of [[Wood|wood]] at the [[Carpenter's workshop|carpenter's workshop]].

{| class="wikitable" border="border"
|-
! Type
! Size
! Attack
! [[Attack type]]
! Contact Area
! Penetration
! Velocity
! Skill Used
|- valign="top"
|rowspan="3"| Training Axe
|rowspan="3"| 800
| Hack || Blunt || 30000 || (6000) || 1.25x
|rowspan="3"| Axe
|-
| Flat slap || Blunt || 30000 || (6000) || 1.25x
|-
| Pommel strike || Blunt || 100 || (1000) || 1.0x
|- valign="top"
|rowspan="4"| Training Sword
|rowspan="4"| 300
| Slash || Blunt || 20000 || (4000) || 1.25x
|rowspan="4"| Sword
|-
| Stab || Blunt || 50 || (2000) || 1.0x
|-
| Flat slap || Blunt || 20000 || (4000) || 1.25x
|-
| Pommel strike || Blunt || 100 || (1000) || 1.0x
|- valign="top"
|rowspan="2"| Training Spear
|rowspan="2"| 400
| Stab || Blunt || 200 || (10000) || 1.0x
|rowspan="2"| Spear
|-
| Shaft bash || Blunt || 10000 || (6000) || 1.25x
|}

==Foreign weapons==
In fortress mode, foreign weapons can only be constructed by a dwarf experiencing a [[Strange mood|strange mood]], out of any material. They may also be acquired from other races through trade or looting. [[Elf|Elves]] construct these out of wood, while other races construct them out of metal. Many dwarf-made weapons can be made by foreign civilizations as well, the ''Used by'' column is in no way all the weapons that race can make.

Using any multigrasp weapon in a single hand (ie. with a shield in the other hand) gives you a disability to hit.

{| class="wikitable" border="border"
|-
! Type
! Size
! Attack
! [[Attack type]]
! Contact Area
! Penetration
! Velocity
! Skill Used
! Used by
! Hands Used
|- valign="top"
|rowspan="4"| 2H Sword
|rowspan="4"| 900
| Slash || Edge || 100000 || 8000 || 1.25x
|rowspan="4"| Sword
|rowspan="4"| [[Goblin]], [[Human]]
|rowspan="4"| Multigrasp
|-
| Stab || Edge || 50 || 4000 || 1.0x
|-
| Flat slap || Blunt || 100000 || (8000) || 1.25x
|-
| Pommel strike || Blunt || 100 || (1000) || 1.0x
|- valign="top"
| Blowgun (Melee)
| 150
| Bash || Blunt || 10000 || (4000) || 1.25x
| Sword
| Subterranean animal peoples
| Singlegrasp?
|- valign="top"
| Bow (Melee)
| 300
| Bash || Blunt || 10000 || (4000) || 1.25x
| Sword
| [[Elf]], Goblin, Human, [[Kobold]]
| Singlegrasp?
|- valign="top"
| Flail
| 500
| Bash || Blunt || 200 || (4000) || 2.5x
| Mace
| Goblin, Human
| Singlegrasp
|- valign="top"
|rowspan="3"| Great Axe
|rowspan="3"| 1300
| Hack || Edge || 60000 || 8000 || 1.25x
|rowspan="3"| Axe
|rowspan="3"| Goblin, Human
|rowspan="3"| Multigrasp
|-
| Flat slap || Blunt || 60000 || (8000) || 1.25x
|-
| Pommel strike || Blunt || 100 || (1000) || 1.0x
|- valign="top"
|rowspan="3"| Halberd
|rowspan="3"| 1200
| Slash || Edge || 20000 || 8000 || 1.25x
|rowspan="3"| Axe
|rowspan="3"| Goblin, Human
|rowspan="3"| Multigrasp
|-
| Stab || Edge || 50 || 2000 || 1.0x
|-
| Shaft bash || Blunt || 20000 || (6000) || 1.25x
|- valign="top"
|rowspan="3"| Dagger (Large)
|rowspan="3"| 200
| Slash || Edge || 1000 || 800 || 1.25x
|rowspan="3"| Dagger
|rowspan="3"| Goblin, Kobold
|rowspan="3"| Singlegrasp
|-
| Stab || Edge || 5 || 1000 || 1.0x
|-
| Pommel strike || Blunt || 20 || (600) || 1.0x
|- valign="top"
|rowspan="4"| Long Sword
|rowspan="4"| 700
| Slash || Edge || 60000 || 6000 || 1.25x
|rowspan="4"| Sword
|rowspan="4"| Elf, Goblin, Human
|rowspan="4"| Singlegrasp
|-
| Stab || Edge || 50 || 3000 || 1.0x
|-
| Flat slap || Blunt || 60000 || (6000) || 1.25x
|-
| Pommel strike || Blunt || 100 || (1000) || 1.0x
|- valign="top"
| Maul
| 1300
| Bash || Blunt || 100 || (6000) || 2.0x
| Hammer
| Goblin, Human
| Multigrasp
|- valign="top"
|rowspan="2"| Morningstar
|rowspan="2"| 500
| Bash || Edge || 10 || 500 || 2.0x
|rowspan="2"| Mace
|rowspan="2"| Goblin, Human
|rowspan="2"| Singlegrasp
|-
| Pommel strike || Blunt || 50 || (1000) || 1.0x
|- valign="top"
|rowspan="2"| Pike
|rowspan="2"| 800
| Stab || Edge || 20 || 12000 || 1.0x
|rowspan="2"| Pike
|rowspan="2"| Goblin, Human
|rowspan="2"| Multigrasp
|-
| Shaft bash || Blunt || 10000 || (6000) || 1.25x
|- valign="top"
|rowspan="4"| Scimitar
|rowspan="4"| 300
| Slash || Edge || 20000 || 4000 || 1.25x
|rowspan="4"| Sword
|rowspan="4"| Goblin, Human
|rowspan="4"| Singlegrasp
|-
| Stab || Edge || 50 || 2000 || 1.0x
|-
| Flat slap || Blunt || 20000 || (4000) || 1.25x
|-
| Pommel strike || Blunt || 50 || (1000) || 1.0x
|- valign="top"
| Scourge
| 300
| Lash || Edge || 10 || 50 || 2.0x
| Whip
| Goblin
| Singlegrasp
|- valign="top"
| Whip
| 100
| Lash || Blunt || 1 || (10) || 5.0x
| Whip
| Goblin, Human
| Singlegrasp
|}

==Quality Level==
Weapons have a to-hit bonus based on quality, however there is no bonus for any quality level under masterwork.
{{DF2010:Item quality/Table}}

==Weapon Material Quality==

{{DF2010 material metal table head}}

{{DF2010 material metal table row|name=Adamantine|color={{Tile|/|3:1}}<span style="display:none">3:3:1</span>|source=[[Raw adamantine]]|notes= <br/>|soliddensity=0.200|mp=25000|val=300|valinc=+50|impactyield=5000|impactfracture=5000|impactelasticity=0|shearyield=5000|shearfracture=5000|shearelasticity=0
}}

{{DF2010 material metal table row|name=Steel|color={{Tile|/|0:1}}<span style="display:none">0:7:1</span>|source=[[Iron]] + [[Pig iron]] + [[flux]] stone + [[fuel]] '''!'''|notes= |soliddensity=7.85|val=30|valinc=+20|mp=12718|impactyield=1505|impactfracture=2520|impactelasticity=940|shearyield=430|shearfracture=720|shearelasticity=215
}}

{{DF2010 material metal table row|name=Bismuth bronze|color={{Tile|/|6:1}}<span style="display:none">6:6:1</span>|source=2 [[Copper]] + 1 [[Tin]] + 1 [[Bismuth]] '''!'''|notes= |soliddensity=8.25|val=6|valinc=+4|mp=11868|impactyield=602|impactfracture=843|impactelasticity=547|shearyield=172|shearfracture=241|shearelasticity=156
}}

{{DF2010 material metal table row|name=Bronze|color={{Tile|/|6:0}}<span style="display:none">6:4:0</span>|source=[[Tin]] + [[Copper]]|notes= |soliddensity=8.25|val=5|valinc=+3|mp=11868|impactyield=602|impactfracture=843|impactelasticity=547|shearyield=172|shearfracture=241|shearelasticity=156
}}

{{DF2010 material metal table row|name=Iron|color={{Tile|/|0:1}}<span style="display:none">0:7:1</span>|source=[[Hematite]], [[Limonite]], [[Magnetite]]|notes= |soliddensity=7.85|mp=12768|val=10|valinc=+2|impactyield=542|impactfracture=1080|impactelasticity=319|shearyield=155|shearfracture=310|shearelasticity=189
}}

{{DF2010 material metal table row|name=Copper|color={{Tile|/|6:0}}<span style="display:none">6:4:0</span>|source=[[Native copper]], [[Malachite]], [[Tetrahedrite]]|notes= |soliddensity=8.93|mp=11952|val=2|valinc=+0, +0, -1*|impactyield=245|impactfracture=770|impactelasticity=175|shearyield=70|shearfracture=220|shearelasticity=145
}}

{{DF2010 material metal table row|name=Silver|color={{Tile|/|7:1}}<span style="display:none">7:7:1</span>|source=[[Native silver]], [[Horn silver]],<br />[[Galena]] (50%), [[Tetrahedrite]] (20%) |notes= |soliddensity=10.49|mp=11731|val=10|valinc=+0, +0,<br />+5*, +7*|impactyield=350|impactfracture=595|impactelasticity=350|shearyield=100|shearfracture=170|shearelasticity=333
}}

{{DF2010 material metal table row|name=Bone|color={{Tile|/|7:1}}<span style="display:none">7:7:1</span>|source=Creatures|notes= |soliddensity=0.50|mp=NONE(burn at 10250)|val=1|valinc=+?, +?,<br />+?, +?|impactyield=200|impactfracture=200|impactelasticity=100|shearyield=115|shearfracture=130|shearelasticity=100
}}

{{DF2010 material metal table row|name=Wood|color={{Tile|/|7:1}}<span style="display:none">7:7:1</span>|source=Trees|notes= |soliddensity=0.50|mp=NONE(burn at 10250)|val=1|valinc=+?, +?,<br />+?, +?|impactyield=10|impactfracture=10|impactelasticity=1000|shearyield=40|shearfracture=40|shearelasticity=1000
}}

{{DF2010 material metal table row|name=Shell|color={{Tile|/|7:1}}<span style="display:none">7:7:1</span>|source=Creatures|notes= Only available as Artifact Weapons.|soliddensity=0.50|mp=NONE(burn at 10250)|val=1|valinc=+?, +?,<br />+?, +?|impactyield=200|impactfracture=200|impactelasticity=100|shearyield=115|shearfracture=130|shearelasticity=100
}}

|}
*''Combat information'' is used internally by the game to determine the combat properties of weapons and armor made from this metal:
:'''Density''': Used in conjunction with other factors - heavier weapons (higher numbers) hit with more force, light weapons tend to have less penetration. Value shown here is g/cm<sup>3</sup>, which is the raw value divided by 10<sup>3</sup>
:'''Impact yield''': Used for blunt-force combat; ''higher'' is better. This is the raw value divided by 10<sup>3</sup> (i.e., kPa).
:'''Impact fracture''': Used for blunt-force combat; ''higher'' is better. This is the raw value divided by 10<sup>3</sup> (i.e., kPa).
:'''Impact elasticity''': Used for blunt-force combat; ''lower'' is better. This is the raw value.
:'''Shear yield''': Used for cutting calculations in combat; ''higher'' is better. This is the raw value divided by 10<sup>3</sup> (i.e., kPa).
:'''Shear fracture''': Used for cutting calculations in combat; ''higher'' is better. This is the raw value divided by 10<sup>3</sup> (i.e., kPa).
:'''Shear elasticity''': Used for cutting calculations in combat; ''lower'' is better. This is the raw value.

*General Term Explanations (From Wikipedia)
:'''Yield Strength''' - The stress at which material strain changes from elastic deformation to plastic deformation, causing it to deform permanently.
:'''Fracture Strength''' - The stress coordinate on the stress-strain curve at the point of rupture.

:'''Stress''' - Force per area = F/A
:'''Strain''' - Deformation of a solid due to stress = Stress/Young's Modulus

So...
:Explanations!
::'''Yield Strength''' is the amount of stress required to permanently deform (bend) a material (plastic deformation)
::'''Fracture Strength''' is the amount of stress required to permanently break (rupture) a material
::'''Elasticity''' (or ''IMPACT_STRAIN_AT_YIELD'' in RAWs) is the amount of deformation (bending) that occurs at the yield point
:Implications to Dwarf Fortress Combat
::Yield combined with Elasticity can tell what a material will do under stress (be it from a hammer, axe, or arrow)
::Higher yield means that it takes more stress to deform
::Lower elasticity means that it will deform less when stress is applied

'''Preliminary Combat Testing & Analysis'''

Adamantine and Steel take first and second place respectively, with Iron the third best material in the game. Beyond which, bronze is in a close tie with copper as to being the second worst material. As in older versions, silver continues to hold steady as the worst material available (no longer beneficial with wooden training weapons being available now) in regards to edged weaponry.
Additionally, with regards to blunt weapons almost all of the non-adamantine materials perform equally well, with a very slight edge towards steel and silver. Here is the thread with the details:

http://www.bay12forums.com/smf/index.php?topic=53571.0

Keep in mind with how unbelievably complicated this system is nothing should be taken as word of law yet.

{| {{prettytable}}
|- bgcolor="#999999"
!
! Best
! Better
! Good
! Fair
! Poor
! Terrible
! Notes

|-
| Armor
| Adamantine
| Steel
| Iron
| Bronze, Bismuth Bronze
| Copper
|
|

|-
| Edged Weapons
| Adamantine <p>(worst for missiles)
| Steel
| Iron
| Bronze, Bismuth Bronze
| Copper
| Silver
| For piercing iron armor, copper is better than bronze. For piercing copper or bronze armor, bronze is better than copper.
|-
| Blunt Weapons
| Steel, Silver
| Copper, Bismuth Bronze, Bronze, Iron
| ---
| ---
| ---
| Adamantine
| All six non-adamantine metals perform nearly identically. Steel has a slightly higher rate of critical wounds, while silver is slightly more likely to penetrate armor.

|}

Cross refrencing this table with the table at the top of this section seems to indicate that low densities, high impact fractures, and high shear fractures contribute to the killing power of edged weapons.

==Arena Testing==

Testing of weapons (15 dwarfs vs 15 dwarfs combats) shows that, in v0.31.12, the best dwarven-made weapon against humanoids is the [[silver]] war hammer.
Even in 15x(steel armor+silver war hammer) versus 15x(adamantine armor+adamantine battle axe) matches, hammerdwarves won with less than 50% casualties (mostly one-strike kills). However, when the dwarves in question were without armor or only wearing leather/cloth, the result was inverted - axedwarves won with less than 50% casualties. In battles against megabeasts, 6 silver hammerdwarves were barely able to scratch a [[bronze colossus]] (attacks were glancing away) due to bronze being a better "weapon" material.

This is because silver has the highest solid density of all materials that can regularly be made into weapons by dwarves. Tests show that indeed [[gold]] and [[platinum]] (increasingly dense) do increasing amounts of damage, and that war hammers remain the tool of choice, however they can only be produced by a moody dwarf (and a very lucky one at that).

More arena tests are available in the [[Military testing]] article.

==Ammunition==

Ammunition is fired from ranged weapons like crossbows and blowguns, and is stored in ammunition [[stockpile]]s, sometimes in quivers. Ammunition may also refer to the [[stone]]s and [[ballista]] arrows fired from siege engines: For more information about these weapons, see the [[siege engine]] article.

===Notes about ammunition===

*Ammunition for foreign weapons like bows and blowguns is also considered foreign and cannot be manufactured in the fortress.

*All ammunition has the "EDGE" attack type.

===Ammunition table===

{| class="wikitable" border="border"
|-
! Type
! Size
! Contact Area
! Penetration
! Skill Used
! Craftable
! Used by
|-
| Bolt (Crossbow)
| 150
| 2
| 2000
| Crossbowman
| Yes ([[Weaponsmith|metal]], [[Wood crafter|wood]], [[Bone carver|bone]])
| [[Dwarf]], [[Goblin]], [[Human]]
|-
| Arrow (Bow)
| 150
| 2
| 2000
| Bowman
| No
| [[Elf]], [[Goblin]], [[Human]], [[Kobold]]
|-
| Blowdart (Blowgun)
| 20
| 1
| 50
| Blowgunner
| No
|
|}

==Weapon-Dwarf Relationships==
Dwarves can become attached to a weapon, even a low quality weapon, which can make it difficult or impossible to get them to upgrade later.

In addition, the game tracks kills not only by entity but also by weapon. A weapon that has racked up enough kills might be named by its wielder. When this happens the game will pause and bring up a dialog box, similar to discovering a new cavern. Once named, the weapon will appear in the artifact list, albeit in blue.

=Natural weapons=

Natural weapons are incredibly varied, but may be divided into a few basic types. Every creature in the game has natural weapons of one sort or another. (Even if one mods the attacks out, the creature will '''push''' as an attack.) A short description of natural weapons and damage considerations follows.

==Types of natural weapons==

===Striking natural weapons===
Every creature has basic natural weapons, most commonly biting and kicking. Damage done by these weapons depends greatly on the respective size of the combatants and the strength and striking/kicking/biting skill of the attacker.

Natural weapons in this category can include but are not limited to punching with the '''fists''', biting with the '''teeth''', goring with the '''horns''', scratching with the '''nails''', and '''kicking'''.

===Other natural weapons===
The various [[syndrome]] delivery methods fall under this category, including breath weapons, poisonous blood, area dusting, venomous bites, and so on. With the exception of some breath weapons, these attacks do not rely on size for damage calculation. For more information, see the [[syndrome]] page. For specific information on breath weapons, see the [[Syndrome#Breath_attacks|breath attacks]] section of the syndrome page.

[[Category:Weapons]]

=Bugs=
*Equipping weapons/armor on military is erratic{{Bug|535}}
==See also==
* [[User:Shinziril#Weapons_and_Armor|Outstanding research]] on weapons and armor by Shinziril

v0.31:Maximizing framerate

2012-01-19T00:56:54Z

I2amroy: /* Increasing your Framerate */

{{quality|Fine|01:51, 19 January 2011 (UTC)}}
{{av}}
[[File:Frames_Per_Second_Meter.png|300px|thumb|bottom|A picture of Dwarf Fortress with Frames Per Second displayed.]]

[[Frames per second|Framerate]] is used in Dwarf Fortress to measure the speed at which the game is running. It is measured in "frames per second", or FPS for short. To check your FPS in Dwarf Fortress, simply change [FPS:NO] to [FPS:YES] in [[init.txt]], and your FPS will be displayed on the top row of the screen. The first number is the current frame rate, while the number in parentheses is the current graphical frame refresh rate.

==Increasing your Framerate==
In general, the more stuff the game has to keep track of, the slower the game will run. So, reducing the amount of stuff active keeps your game running fast. Some possible reasons for slowdown, and ways to reduce and/or eliminate them:

* Each dwarf needs to keep track of where he's going.
** Limit the number of dwarves by setting the population cap.
* Each animal needs to pathfind, too.
** Tame animals can be put into [[cage]]s, keeping them from having anywhere to go. Or you can butcher them.
* Invaders also need to pathfind.
** Turn off invasions using the option in [[D_init.txt]]. Or you can kill them all.
* Contaminants, including [[blood]] spatters, accumulate on the ground and on dwarves and creatures. When they walk over contaminants, these sometimes get smeared and spread. There is a bug ({{bug|296}}) which makes contaminants continuously multiply and another bug ({{bug|3270}}) which prevents blood spatters from ever disappearing.
** There is a setting in D_init.txt (as of {{version|0.31.16}}) that prevents them spreading from dwarf (or animal) to ground. For [[DF2010:Fortress_mode|Fortress Mode]], this is [[DF2010:Technical_tricks#More_Game_Options|WALKING_SPREADS_SPATTER_DWF]] and is already turned off by default.
** If the contaminants are outside, isolate the area and let [[DF2010:Weather|rain]] slowly wash it away. Pets can be kept out with a [[Activity_zone#Pen.2FPasture|pen/pasture]] or a [[DF2010:Activity_zone#Pit.2FPond|pit]]. Similarly, setting the [[traffic]] designation to restricted and/or assigning [[Activity_zone|Activity Zones]] strategically may keep dwarves away.
** Add in some in-fortress means of cleaning dwarves and pets. The "Dwarven Bathtub" is one example. And make sure you have the [[cleaning]] labor enabled. Details of these and other suggestions can be found on the [[cleaning]] page.
** Finding the above cleaning measures too tedious or lacking, some players opt to [[DF2010:Cheating|cheat]] by using the [[DF2010:Utilities#dfcleanmap|dfcleanmap]] tool from the [[DF2010:Utilities#DFHack|DFhack]] library.
* G_FPS is a setting in the [[init.txt]] file. It controls how often Dwarf Fortress redraws the screen. It also controls how often the game checks for keyboard or mouse input.
** Reducing G_FPS can speed up the rest of the game. The default choice of 50 works well, but many people reduce it down to 20 with no ill effect.
** Reducing G_FPS too far can make the game unresponsive and glitchy. Some people can cope with 5; most cannot.
* PRINT_MODE is another init setting. It controls the method Dwarf Fortress uses to draw the screen.
** More advanced methods allow DF to make more use of OpenGL features and therefore your graphics card. STANDARD and VBO are good starting points.
** More advanced methods may still have bugs. 2D is more likely to be reliable.
* [[Temperature]] and [[Weather]] are two more features which users may or may not notice.
** Disabling them, using the settings in d_init.txt, can speed things up.
** But then rain won't refill [[murky pool]]s, [[magma]] won't melt [[goblin]]s, etc.
** One user [http://www.bay12forums.com/smf/index.php?topic=86761.msg2352509#msg2352509 reported] an FPS boost from 35 to 90 upon disabling temperature.
* The size of your world and embark site both increase the amount of terrain which DF needs to keep track of.
** If you don't mind going vertical, try reducing your embark site from the default 4x4 squares to 3x3 or even 2x2.
** World size probably doesn't matter except for the size of the save files, but reducing the number of cavern layers (default of 3) will help. You need at least 1 cavern layer to get underground [[crop|plants]], and 2 caverns to get all the underground [[tree]]s.
* Proper use of [[traffic]] designations will help.
** Setting corridors to "high" traffic, and dead-end workshop rooms next to them to "low" traffic, means the pathfinder algorithm will search more quickly along the corridor, and waste less time searching in the rooms.
** Changing the normal traffic weight to 1 in d_init.txt will optimize the pathfinder at the cost of High traffic zones not making a difference ([http://www.bay12forums.com/smf/index.php?topic=97763.msg2841109#msg2841109 source])
* Closing off unused areas with raised [[bridge]]s and locked [[door]]s can help.
** Reducing the area which the pathfinder algorithm has to search lets it run faster.
** In general the pathfinder algorithm is good about not searching irrelevant areas. Caverns are probably the worst offender.
* Fewer items inside a fort means fewer items to be [[stockpile]]d, checked for [[wear]], and so on and so forth.
** Use a [[Dwarven atom smasher]] to remove items, or donate them to [[Trading|passing caravans]] to be taken away.
** Don't dig out so much of the ground, don't build such large [[Farming|farm plot]]s, just don't generate so many items in the first place.
* Flowing [[water]] slows the game down.
** Don't build [[mist]] generators, [[Screw pump|pump stacks]], or other major water-moving projects. If you do build them, build a [[Lever|way to switch them off]].
** Don't embark on a [[river]] or [[ocean]]. Rivers aren't too bad in their natural state, because the game only needs to calculate at where the water enters and where the water leaves, more-or-less skipping the water in between. Then you start damming them and pumping water out, and it gets worse.
** [[Aquifer]]s don't impose load until you start digging around in them.
**[[Water wheel#Perpetual motion|Dwarven water reactors]] also slow down the game, often significantly.
* Disabling your Dwarven civ from wearing clothing as a mod (required regen of world) may help maintain higher fps later in the game{{bug|3942}}, if you don't mind naked dwarves running around. Alternatively, finding a way to dump excess/worn out clothing might help restore fps on existing fortresses. Requires research.
* Encountering [[HFS]] will dramatically reduce FPS if you seal the breach ({{bug|1340}}). Either avoid doing so or use the work around posted in the bug report.
* Use the default ASCII Graphics Tileset. Custom tilesets (such as Ironhand, Mayday, and Phoebus) can decrease your framerate.
*Mac OSX: Spotlight indexes files on your mac. Since DF constantly changes files, spotlight will keep indexing them using 60-70% of your CPU. Exclude DF in system preferences: spotlight's privacy settings and you can get a factor of two in FPS. This can easily provide benefits of over 30 FPS, even on multicore computers that do not need to worry about CPU.

v0.31:Reactions

2011-12-04T06:26:06Z

I2amroy: /* Reaction name */

{{quality|Fine|09:41, 6 October 2010 (UTC)}}
{{av}}

Reactions are modular, editable formulas that take specific ingredients, or reagents, and use them to produce a desired item. A lot of reactions are hardcoded - building beds or creating glass, for example -- but a few are freely editable, and it's quite simple to add additional ones.

== Reaction differences between modes ==
In [[Fortress mode]], reactions are linked to specific buildings, and must be added to a civilization's [[Entities|entity file]] to be usable by that civilization. This has the useful effect of limiting new items and materials (such as special [[wood]] or [[metal]]) to civilizations that have the requisite reaction -- so that if you give your custom civilization a reaction to produce star metal or some other custom material, only they will be able to use it.

In [[Adventure mode]], reactions are freely available via x > create, and any adventurer character can make free use of them. Reagents may be held in the hands or dropped on the ground, but cannot be used within a backpack or quiver. As of .10, there are several bugs with Adventure mode reactions, chief of which is the fact that you cannot select liquid reagents. 

Prior to version 31.10, a reaction could only result in an object of base [[quality]]. However, in .10 items produced via reactions have been observed to have quality modifiers. The way skill factors into them has yet is the same as for normal items{{version|0.31.21}}.

==Anatomy of a reaction==

Reactions are found within reaction_x files (such as reaction_smelter or reaction_other). Generally speaking they adhere to the following structure:

[REACTION:<identifier>]
[NAME:<name>]
[BUILDING:<BUILDING NAME>:<BUILDING KEY>]
[REAGENT:A:150:BAR:NONE:POTASH:NONE]
[PRODUCT:100:1:BAR:NONE:PEARLASH:NONE][PRODUCT_DIMENSION:150]
[FUEL]
[SKILL:<SKILL TOKEN>]
[AUTOMATIC]
[ADVENTURE_MODE_ENABLED]
* ''[[#Reaction identifier|identifier]]'': The internal ID of the reaction.
* ''[[#Reaction name|name]]'': The name of the reaction, visible to the player in the Fortress mode or Adventure mode menus.
* ''[[#Building|building]]'': The building ID that the reaction uses, and the relevant keyboard shortcut.
* ''[[#Reagents|...reagents...]]'': Zero or more reagents (ingredients) that are required to be in stock for the reaction to be possible.
* ''[[#Products|...products...]]'': Zero or more products that are created from the reaction.
* ''[[#fuel|fuel]]'': (optional) If present, the reaction requires charcoal, coke or a magma-powered workshop.
* ''[[#skill|skill]]'': (optional) The skill required and trained by the reaction.
* ''[[#automatic|automatic]]'': (optional) If present, the reaction will automatically be enqueued whenever it can possibly be performed.
* ''[[#adventure mode|adventure mode]]'': (optional) If present, the reaction is used by the player in Adventure mode instead.

=== Reaction identifier ===

The reaction identifier may be anything, so long as it is unique within the raw data files. A good habit to get into is to append a short prefix or suffix to each name related to the name of your mod, to ensure nobody else is going to make an identical reaction and thereby mess up the game if their mod is run alongside yours.

=== Reaction name ===

This can be anything at all, and is usually used to describe the reaction. '''Tan a hide''', for example, is the name of the default leather-producing reaction. Generally this should be written as a small descriptive verb phrase, with the first letter capitalized, for consistency with the existing reactions.

=== Building ===

[BUILDING:<BUILDING NAME>:<BUILDING KEY>]
* ''name'': The ID of the building where this reaction will appear in the tasks menu.
* ''key'': The keyboard shortcut used to queue up the reaction.

The BUILDING NAME is the name of the building that will house this reaction, and the building key is the keyboard shortcut that will queue up the reaction. If two reactions have the same key, then one of them will be assigned a different key, the first alphabetically available at the building.

Valid buildings are KILN, SMELTER, TANNER, KITCHEN, QUERN, MILLSTONE, STILL, CRAFTSMAN, and any custom buildings.

Specifying multiple BUILDING tokens will cause the reaction to be available at all of the specified buildings.

=== Reagents ===
REAGENTs are a little bit complicated. They are the ingredients that the reaction will use. You can define as many as you like within a reaction.

[REAGENT:<name>:<quantity>:<item token>:<material token>][...modifiers...]
* ''[[#name|name]]'': The name of the reagent, local to the reaction.
* ''[[#quantity|quantity]]'': The amount of the item that will be used in the reaction.
* ''[[#item_token|item token]]'': The type of the item you require.
* ''[[#material_token|material token]]'': The material the item should be made of.
* ''[[#Modifiers|...modifiers...]]'': Zero or more tokens which further clarify the acceptable types when the item type and material types are insufficient to distinguish them.

==== name ====
The name field is a small string used to identify the reagent within the reaction. The name is not visible to the player. It is local to the reaction and does not need to be unique across all of the reactions, so you can reuse the same names over and over, although each reagent within the same individual reaction must have a different name.

Most reactions are simply named '''A''', '''B''', and so forth in default reactions, although names such as '''TOOLSTONE''' or '''FLUX''' will also work equally well. The PRODUCT may make reference to this name — for instance, if a container '''B''' is specified as a reagent, PRODUCT_TO_CONTAINER:B specifies that container.

==== quantity ====
The quantity differs between item types. Generally speaking, cloth, thread, powder and globs use numbers representing the size of material within one item, and everything else uses a static quantity. While REAGENT:A:'''''10''''':'''''THREAD''''':NONE:NONE:NONE thread is an extremely tiny portion of a random spool of thread, REAGENT:A:'''''10''''':'''''TOY''''':NONE:NONE:NONE is ten unique, solid toy items.

Sometimes the quantity of product is directly connected with the quantity of reagent; it seems to be 150 / REAGENT <quantity> (rounding down) so that Reagent <quantity> of 3 gives 50 product and a <quantity> of 4 gives 37. (150/4=37.5) [List of item types this applies to? Bars, for instance.]

==== item token ====
Item tokens are of the form ITEM_TYPE:ITEM_SUBTYPE.

The item type is the sort of item you require; WEAPON, TOY or SKIN_TANNED, for example. A {{L|item token|full list}} is available.

For reagents, the item token can also be set to ANY_RAW_MATERIAL:NONE (to permit BAR, BOULDER, POWDER_MISC, or GLOB) or ANY_CRAFT:NONE (to permit FIGURINE, AMULET, SCEPTER, CROWN, RING, EARRING, or BRACELET). Internally, these special values are both converted to NONE:NONE and merely set special modifiers (similar to [BUILDMAT]) - they cannot be used in any other context.

The item subtype is name of the exact item that you require. Examples are ITEM_WEAPON_SPEAR or ITEM_TOY_PUZZLEBOX. Some items, like quivers or backpacks, or chunks of stone or metal, only require the item token to be filled in, so if you're asking for those you should set the subtype to NONE. Subtypes are the entities defined within the local raw data files and their exact names can be referenced by looking at the corresponding file.

For backwards compatibility, reagents can also accept "METAL_ORE:metal_id" in place of both the item and material tokens - this is equivalent to using the reagent BOULDER:NONE:NONE:NONE with the modifier [METAL_ORE:metal_id] (see below).

==== material token ====
Material tokens come in several forms - see {{L|material token|here}} for a full list. For reagents, this will typically be INORGANIC:MATERIAL_ID, whereas products will typically use GET_MATERIAL_FROM_REAGENT:REAGENT_ID:REACTION_PRODUCT_ID.

==== Modifiers ====
Reagents may also have extra tokens added on afterwards, placed just after the REAGENT tag.

A list of them follows:

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Meaning
|-
| [REACTION_CLASS:X]
| Detailed below the reaction anatomy section.
|-
| [HAS_MATERIAL_REACTION_PRODUCT:X]
| Detailed below the reaction anatomy section.
|-
| [CONTAINS:X]
| Reagent is a container that holds the specified reagent.
|-
| [UNROTTEN]
| Reagent must not be rotten, mainly for organic materials.
|-
| [CONTAINS_LYE]
| Reagent must be a BARREL or TOOL which contains at least one item of type LIQUID_MISC made of LYE.
|-
| [POTASHABLE]
| Alias for [CONTAINS_LYE].
|-
| [NOT_WEB]
| States that the reagent must have been collected (to distinguish silk thread from webs).
|-
| [WEB_ONLY]
| States that the reagent must be undisturbed (to distinguish silk thread from webs).
|-
| [EMPTY]
| If the reagent is a container, it must be empty.
|-
| [NOT_CONTAIN_BARREL_ITEM]
| If the reagent is a container, it must not contain lye or milk.
|-
| [BAG]
| Reagent must be a bag - that is, a BOX made of plant fiber, silk, yarn, or leather.
|-
| [GLASS_MATERIAL]
| Reagent material must have the [IS_GLASS] token. All 3 types of glass have this token hardcoded.
|-
| [BUILDMAT]
| Reagent must be a general building component - BAR, BLOCKS, BOULDER, or WOOD.
|-
| [FIRE_BUILD_SAFE]
| Reagent material must be stable at temperatures below 11000. Currently broken - requires material's IGNITE_POINT to be set to "NONE". Only works with items of type BAR, BLOCKS, BOULDER, WOOD, and ANVIL - all others are rejected.
|-
| [MAGMA_BUILD_SAFE]
| Reagent material must be stable at temperatures below 12000. Currently broken - requires material's IGNITE_POINT to be set to "NONE". Only works with items of type BAR, BLOCKS, BOULDER, WOOD, and ANVIL - all others are rejected.
|-
| [CAN_USE_ARTIFACT]
| Reagent can be an Artifact. Using [PRESERVE_REAGENT] with this is strongly advised.
|-
| [WORTHLESS_STONE_ONLY]
| Reagent material must be non-economic.
|-
| [ANY_PLANT_MATERIAL]
| Reagent material must be subordinate to a PLANT object.
|-
| [ANY_SILK_MATERIAL]
| Reagent material must have the [SILK] token.
|-
| [ANY_YARN_MATERIAL]
| Reagent material must have the [YARN] token.
|-
| [ANY_SOAP_MATERIAL]
| Reagent material must have the [SOAP] token.
|-
| [ANY_LEATHER_MATERIAL]
| Reagent material must have the [LEATHER] token.
|-
| [ANY_BONE_MATERIAL]
| Reagent material must have the [BONE] token.
|-
| [ANY_STRAND_TISSUE]
| Reagent is made of a tissue having [TISSUE_SHAPE:STRANDS], intended for matching hair and wool. Must be used with [USE_BODY_COMPONENT].
|-
| [ANY_SHELL_MATERIAL]
| Reagent material must have the [SHELL] token.
|-
| [ANY_TOOTH_MATERIAL]
| Reagent material must have the [TOOTH] token.
|-
| [ANY_HORN_MATERIAL]
| Reagent material must have the [HORN] token.
|-
| [ANY_PEARL_MATERIAL]
| Reagent material must have the [PEARL] token.
|-
| [USE_BODY_COMPONENT]
| Reagent must be a body part.
|-
| [NO_EDGE_ALLOWED]
| Reagent must not be sharpened (used for knapping).
|-
| [NOT_ENGRAVED]
| Reagent has not been engraved (excludes memorial slabs).
|-
| [NOT_IMPROVED]
| Reagent has not been decorated.
|-
| [DOES_NOT_ABSORB]
| Reagent material must have [ABSORPTION:0]
|-
| [FOOD_STORAGE_CONTAINER]
| Reagent is either a BARREL or a TOOL with the FOOD_STORAGE use.
|-
| [HARD_ITEM_MATERIAL]
| Material has the [ITEMS_HARD] token.
|-
| [NOT_PRESSED]
| Reagent must not be in the SOLID_PRESSED state.
|-
| [METAL_ORE:X]
| Reagent material must be an ore of the specified metal.
|-
| [MIN_DIMENSION:X]
| ?
|-
| [HAS_TOOL_USE:X]
| Reagent must be a {{L|tool}} with the specific TOOL_USE value. The reagent's item type must be TOOL:NONE for this to make any sense.
|-
| [PRESERVE_REAGENT]
| Reagent is not destroyed, which is the normal effect, at the completion of the reaction. Typically used for containers.
|-
| [DOES_NOT_DETERMINE_PRODUCT_AMOUNT]
| Reagent quantity is ignored for the purposes of producing extra outputs. Typically used for containers so that {{L|stack}}s of reagents will correctly produce additional outputs.
|}

Generally speaking, if you set a field in a reagent to NONE, the reaction won't discriminate when it comes to that particular field. For example, if you require a BOULDER reagent but leave the material as NONE:NONE, it will grab any available BOULDER-type item regardless of material.

===Products===
Products are the end product of the reaction. A reaction can have as many products as it likes.

Products are almost identical to reagents, except that they do not need to be named, can't have fields undefined, and don't use the quantity field to determine the product size. Instead, the token PRODUCT_DIMENSION:X is tacked on after the PRODUCT token, determining the size of the product.

Products can be produced directly to a container using the [PRODUCT_TO_CONTAINER:<IDENTIFIER>] token, where the IDENTIFIER is the name of a reagent. This requires the reagent to have the PRESERVE_REAGENT token.

Restating this in the above style, we have:
[PRODUCT:<probability>:<quantity>:<item token>:<material token>][...modifiers...][PRODUCT_DIMENSION:X][PRODUCT_TO_CONTAINER:<IDENTIFIER>]

====probability====
The percentage chance the product will be produced when the reaction is completed.

====quantity====
Determines how many of the product will be produced.

====item token====
The {{L|item token}} and subtype of the item you produce.

For products, this can also be set to CRAFTS:NONE to produce up to three random {{L|craft}} items. This value cannot be used in any other context.

====material token====
A {{L|material token}} describing what the product will be made of.

====Product modifiers====
Zero or more tokens which further clarify the acceptable types when the item type and material types are insufficient to distinguish them.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Meaning
|-
| [FORCE_EDGE]
| Product is given a sharp edge. Used for knapping.
|-
| [PRODUCT_PASTE]
| Product is created in the SOLID_PASTE state.
|-
| [PRODUCT_PRESSED]
| Product is created in the SOLID_PRESSED state.
|-
| [PRODUCT_DIMENSION:<size>]
| Specifies the size of the product. A size of 150 is typical for BAR, POWDER_MISC, LIQUID_MISC, and DRINK. A size of 15000 is typical for THREAD, and a size of 10000 is typical for CLOTH.
|-
| [PRODUCT_TO_CONTAINER:<id>]
| Places the product in a container; <id> must be the name of a reagent with the PRESERVE_REAGENT token and a container item type.

|}

===Improvements===
Improvements are applied to existing reagents. A reaction can have as many improvements as it likes.

Restating this in the above style, we have:
[IMPROVEMENT:<probability>:<reagent name>:<improvement type>:<material token>]

====probability====
The percentage chance the improvement will be applied to the reagent when the reaction is completed.

====reagent name====
The name of the reagent that will be improved. In order to be meaningful, this reagent must have [PRESERVE_REAGENT].

====improvement type====
The following improvement types can be used:
{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Meaning
|-
| COVERED
| Item is encrusted/studded/decorated with <material>.
|-
| GLAZED
| Item is glazed with <material>.
|-
| RINGS_HANGING
| Item is adorned with hanging rings of <material>.
|-
| BANDS
| Item is encircled with bands of <material>.
|-
| SPIKES
| Item menaces with spikes of <material>.
|}

All other item improvement tokens (ART_IMAGE, ITEMSPECIFIC, THREAD, CLOTH, and SEWN_IMAGE) are ignored.

====material token====
A {{L|material token}} describing what the decoration will be made of.

===Other tokens===

==== fuel ====
The FUEL token means that the reaction requires coke or charcoal to be performed. Fuel is not needed when the reaction is performed at a magma workshop (a {{L|magma kiln}}, {{L|magma smelter}}, or any custom building having [NEEDS_MAGMA]).

==== skill ====
The SKILL token determines what [[Skill tokens|skill]] the reaction requires and what skill it trains. Multiple skills can be listed but only one will be used.

==== automatic ====
The AUTOMATIC token means that the reaction will be queued automatically if the reaction reagents are all present.

==== adventure mode enabled ====
The ADVENTURE_MODE_ENABLED token means that this version of the reaction is not used by dwarves at home in a fortress, but rather the wanderers of Adventure Mode. When using this token, it will be allowed for adventurers of any race, without editing Entity files.

==Material reaction products and reaction classes==

You can get a certain measure of control over very specific materials using reaction classes and material reaction products - the tokens look like this:

[REACTION_CLASS:FAT]
[HAS_MATERIAL_REACTION_PRODUCT:RENDER_MAT]

Reaction classes represent different classes of material - basically, the material of the reagent must have a REACTION_CLASS the same as the one in the reaction.

Material reaction products are similar, but are generally used more for things like different kinds of creature materials than universal materials like stone. This token is how skin can be tanned into leather, which are two separate materials - the skin material has leather as a MATERIAL_REACTION_PRODUCT.

In short, they require the material to have a token such as
[MATERIAL_REACTION_PRODUCT:X:Y]
...where X is the name of the reaction product that will be referred to in the reaction (RENDER_MAT, in the reaction class example, or TAN_MAT for leather) and Y is a {{L|material token}} indicating the material of the desired product (such as LOCAL_CREATURE_MAT:LEATHER]).

==Reactions and world generation==

There are several things to keep in mind when you're adding reactions to a game that already exists.

* Most entity changes require a regen, but adding PERMITTED_REACTION tokens for reactions that existed at the time of world generation to the entity file in the save directory do not.
* Adding reactions to the raws in a save directory requires you to regen the world.
* You can alter an existing reaction in any way you like without regenning the world, so long as you don't alter the reaction identifier.

==Full Token List==
For the sake of convenience and readability this is a complete compilation of the previously listed reaction tokens in alphabetical order

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Description

|-
| ADVENTURE_MODE_ENABLED
|
| this version of the reaction is not used by dwarves at home in a fortress, but rather the wanderers of Adventure Mode. When using this token, it will be allowed for adventurers of any race, without editing Entity files

|-
| ANY_BONE_MATERIAL
|
| Reagent material must have the [BONE] token.

|-
| ANY_HORN_MATERIAL
|
| Reagent material must have the [HORN] token.

|-
| ANY_LEATHER_MATERIAL
|
| Reagent material must have the [LEATHER] token.

|-
| ANY_PEARL_MATERIAL
|
| Reagent material must have the [PEARL] token.

|-
| ANY_PLANT_MATERIAL
|
| Reagent material must be subordinate to a PLANT object.

|-
| ANY_SHELL_MATERIAL
|
| Reagent material must have the [SHELL] token.

|-
| ANY_SILK_MATERIAL
|
| Reagent material must have the [SILK] token.

|-
| ANY_SOAP_MATERIAL
|
| Reagent material must have the [SOAP] token.

|-
| ANY_STRAND_TISSUE
|
| Reagent is made of a tissue having [TISSUE_SHAPE:STRANDS], intended for matching hair and wool. Must be used with [USE_BODY_COMPONENT].

|-
| ANY_TOOTH_MATERIAL
|
| Reagent material must have the [TOOTH] token.

|-
| ANY_YARN_MATERIAL
|
| Reagent material must have the [YARN] token.

|-
| AUTOMATIC
|
| the reaction will be queued automatically if the reaction reagents are all present.

|-
| BAG
|
| Reagent has to be a bag. Intended to be used with an item type of BOX, to prevent chests, coffers, and other containers from being used instead.

|-
| BUILDING
|
* Building name
* in-building reaction hotkey
| Sets the building that the reaction will be performed in, and the button used to queue the reaction once that building's menu is accessed in-game

|-
| BUILDMAT
|
| Reagent is able to be used to build structures (Stone, Wood, Blocks, Bars?).

|-
| CAN_USE_ARTIFACT
|
| Reagent can be an Artifact. Using [PRESERVE_REAGENT] with this is strongly advised.

|-
| CONTAINS
| required content
| Reagent is a container that holds the specified reagent.

|-
| CONTAINS_LYE
|
| If the reagent is a container, it must contain LYE. No longer used - instead, use one reagent for the LYE itself and another reagent with [CONTAINS:lye_reagent].

|-
| DOES_NOT_ABSORB
|
| Reagent material must have [ABSORPTION:0]

|-
| DOES_NOT_DETERMINE_PRODUCT_AMOUNT
|
| Setting this dis-allows the quantity of a reagent (probably first in the list) to determine the output quantity. Used where the input is a stack, e.g. liquids in a barrel.

|-
| EMPTY
|
| If the reagent is a container, it must be empty.

|-
| FIRE_BUILD_SAFE
|
| Reagent must be considered fire safe - ie. not wood, and not coal.

|-
| FORCE_EDGE
|
| Product is given a sharp edge. Used for knapping.

|-
| FUEL
|
| Requires that the reaction either use up a unit of coal or charcoal or else be performed at a magma workshop

|-
| GLASS_MATERIAL
|
| Reagent material has [IS_GLASS].

|-
| HAS_MATERIAL_REACTION_PRODUCT
| required reaction product
|

|-
| HAS_TOOL_USE
| Tool-use token
| Reagent must be a {{L|tool}} with the specific TOOL_USE value. The reagent's item type must be TOOL:NONE for this to make any sense.

|-
| IMPROVEMENT
|
* Probability
* Reagent Name
* Improvement type
* Material Token
| Improvement types include BANDS, COVERED, GLAZED, RINGS_HANGING, and SPIKES

|-
| MAGMA_BUILD_SAFE
|
| Currently broken - behaves exactly the same as FIRE_BUILD_SAFE.

|-
| METAL_ORE
|
* Inorganic material
| Reagent material must be an ore of the specified metal

|-
| MIN_DIMENSION
|
| ?

|-
| NAME
| name
| defines the name used by the reaction in-game

|-
| NO_EDGE_ALLOWED
|
| Reagent must not be sharpened (used for knapping).

|-
| NOT_CONTAIN_BARREL_ITEM
|
| If the reagent is a Barrel, it must not contain an item that has to reside in a barrel. Barrel items appear to be lye and milk. Alcohol appears to be covered as part of [EMPTY]. A reaction which places an item in a barrel should probably have both tags.

|-
| NOT_ENGRAVED
|
| Reagent must not be engraved?

|-
| NOT_IMPROVED
|
| Reagent has not been decorated.

|-
| NOT_PRESSED
|
| Reagent must not be in the SOLID_PRESSED state.

|-
| NOT_WEB
|
| Reagent must be "collected" - used with THREAD:NONE to exclude webs.

|-
| POTASHABLE
|
| Alias for CONTAINS_LYE.

|-
| PRESERVE_REAGENT
|
| Reagent is not destroyed, which is the normal effect, at the completion of the reaction. Typically used for containers.

|-
| PRODUCT
|
*Probability
*Quantity
*Item Token
*Material Token
| Defines one of the products to be outputted by the reaction

|-
| PRODUCT_DIMENSION
| size
| Specifies the size of the product. A size of 150 is typical for BAR, POWDER_MISC, LIQUID_MISC, and DRINK. A size of 15000 is typical for THREAD, and a size of 10000 is typical for CLOTH.

|-
| PRODUCT_PASTE
|
| Product is created in the SOLID_PASTE state.

|-
| PRODUCT_PRESSED
|
| Product is created in the SOLID_PRESSED state.

|-
| PRODUCT_TO_CONTAINER
| Reagent ID
| Places the product in a container; <id> must be the name of a reagent with the PRESERVE_REAGENT token and a container item type.

|-
| REACTION
| Identifier
| defines a new reaction

|-
| REACTION_CLASS
|
|

|-
|REAGENT
|
* name/id
* quantity
* item token (and subtoken)
* material token (and subtoken)
| Requires a given reagent as an input for a reaction

|-
| SKILL
| Skill Token
| Skill used by the reaction

|-
| UNROTTEN
|
| Reagent must not be rotten, mainly for organic materials.

|-
| USE_BODY_COMPONENT
|
| Reagent material must come off a creature's body.

|-
| WEB_ONLY
|
| Reagent must be "undisturbed" - used with THREAD:NONE to gather webs.

|-
| WORTHLESS_STONE_ONLY
|
| Reagent is not made of an economic stone.

|}

[[Category:DF2010:Modding]]

v0.31:Reactions

2011-12-04T06:10:26Z

I2amroy: /* Reaction name */

{{quality|Fine|09:41, 6 October 2010 (UTC)}}
{{av}}

Reactions are modular, editable formulas that take specific ingredients, or reagents, and use them to produce a desired item. A lot of reactions are hardcoded - building beds or creating glass, for example -- but a few are freely editable, and it's quite simple to add additional ones.

== Reaction differences between modes ==
In [[Fortress mode]], reactions are linked to specific buildings, and must be added to a civilization's [[Entities|entity file]] to be usable by that civilization. This has the useful effect of limiting new items and materials (such as special [[wood]] or [[metal]]) to civilizations that have the requisite reaction -- so that if you give your custom civilization a reaction to produce star metal or some other custom material, only they will be able to use it.

In [[Adventure mode]], reactions are freely available via x > create, and any adventurer character can make free use of them. Reagents may be held in the hands or dropped on the ground, but cannot be used within a backpack or quiver. As of .10, there are several bugs with Adventure mode reactions, chief of which is the fact that you cannot select liquid reagents. 

Prior to version 31.10, a reaction could only result in an object of base [[quality]]. However, in .10 items produced via reactions have been observed to have quality modifiers. The way skill factors into them has yet is the same as for normal items{{version|0.31.21}}.

==Anatomy of a reaction==

Reactions are found within reaction_x files (such as reaction_smelter or reaction_other). Generally speaking they adhere to the following structure:

[REACTION:<identifier>]
[NAME:<name>]
[BUILDING:<BUILDING NAME>:<BUILDING KEY>]
[REAGENT:A:150:BAR:NONE:POTASH:NONE]
[PRODUCT:100:1:BAR:NONE:PEARLASH:NONE][PRODUCT_DIMENSION:150]
[FUEL]
[SKILL:<SKILL TOKEN>]
[AUTOMATIC]
[ADVENTURE_MODE_ENABLED]
* ''[[#Reaction identifier|identifier]]'': The internal ID of the reaction.
* ''[[#Reaction name|name]]'': The name of the reaction, visible to the player in the Fortress mode or Adventure mode menus.
* ''[[#Building|building]]'': The building ID that the reaction uses, and the relevant keyboard shortcut.
* ''[[#Reagents|...reagents...]]'': Zero or more reagents (ingredients) that are required to be in stock for the reaction to be possible.
* ''[[#Products|...products...]]'': Zero or more products that are created from the reaction.
* ''[[#fuel|fuel]]'': (optional) If present, the reaction requires charcoal, coke or a magma-powered workshop.
* ''[[#skill|skill]]'': (optional) The skill required and trained by the reaction.
* ''[[#automatic|automatic]]'': (optional) If present, the reaction will automatically be enqueued whenever it can possibly be performed.
* ''[[#adventure mode|adventure mode]]'': (optional) If present, the reaction is used by the player in Adventure mode instead.

=== Reaction identifier ===

The reaction identifier may be anything, so long as it is unique within the raw data files. A good habit to get into is to append a short prefix or suffix to each name related to the name of your mod, to ensure nobody else is going to make an identical reaction and thereby mess up the game if their mod is run alongside yours.

=== Reaction name ===

This can be anything at all, and is usually used to describe the reaction. '''tan a hide''', for example, is the name of the default leather-producing reaction. Generally this should be written as a small descriptive verb phrase, with the first letter not capitalized, for consistency with the existing reactions.

=== Building ===

[BUILDING:<BUILDING NAME>:<BUILDING KEY>]
* ''name'': The ID of the building where this reaction will appear in the tasks menu.
* ''key'': The keyboard shortcut used to queue up the reaction.

The BUILDING NAME is the name of the building that will house this reaction, and the building key is the keyboard shortcut that will queue up the reaction. If two reactions have the same key, then one of them will be assigned a different key, the first alphabetically available at the building.

Valid buildings are KILN, SMELTER, TANNER, KITCHEN, QUERN, MILLSTONE, STILL, CRAFTSMAN, and any custom buildings.

Specifying multiple BUILDING tokens will cause the reaction to be available at all of the specified buildings.

=== Reagents ===
REAGENTs are a little bit complicated. They are the ingredients that the reaction will use. You can define as many as you like within a reaction.

[REAGENT:<name>:<quantity>:<item token>:<material token>][...modifiers...]
* ''[[#name|name]]'': The name of the reagent, local to the reaction.
* ''[[#quantity|quantity]]'': The amount of the item that will be used in the reaction.
* ''[[#item_token|item token]]'': The type of the item you require.
* ''[[#material_token|material token]]'': The material the item should be made of.
* ''[[#Modifiers|...modifiers...]]'': Zero or more tokens which further clarify the acceptable types when the item type and material types are insufficient to distinguish them.

==== name ====
The name field is a small string used to identify the reagent within the reaction. The name is not visible to the player. It is local to the reaction and does not need to be unique across all of the reactions, so you can reuse the same names over and over, although each reagent within the same individual reaction must have a different name.

Most reactions are simply named '''A''', '''B''', and so forth in default reactions, although names such as '''TOOLSTONE''' or '''FLUX''' will also work equally well. The PRODUCT may make reference to this name — for instance, if a container '''B''' is specified as a reagent, PRODUCT_TO_CONTAINER:B specifies that container.

==== quantity ====
The quantity differs between item types. Generally speaking, cloth, thread, powder and globs use numbers representing the size of material within one item, and everything else uses a static quantity. While REAGENT:A:'''''10''''':'''''THREAD''''':NONE:NONE:NONE thread is an extremely tiny portion of a random spool of thread, REAGENT:A:'''''10''''':'''''TOY''''':NONE:NONE:NONE is ten unique, solid toy items.

Sometimes the quantity of product is directly connected with the quantity of reagent; it seems to be 150 / REAGENT <quantity> (rounding down) so that Reagent <quantity> of 3 gives 50 product and a <quantity> of 4 gives 37. (150/4=37.5) [List of item types this applies to? Bars, for instance.]

==== item token ====
Item tokens are of the form ITEM_TYPE:ITEM_SUBTYPE.

The item type is the sort of item you require; WEAPON, TOY or SKIN_TANNED, for example. A {{L|item token|full list}} is available.

For reagents, the item token can also be set to ANY_RAW_MATERIAL:NONE (to permit BAR, BOULDER, POWDER_MISC, or GLOB) or ANY_CRAFT:NONE (to permit FIGURINE, AMULET, SCEPTER, CROWN, RING, EARRING, or BRACELET). Internally, these special values are both converted to NONE:NONE and merely set special modifiers (similar to [BUILDMAT]) - they cannot be used in any other context.

The item subtype is name of the exact item that you require. Examples are ITEM_WEAPON_SPEAR or ITEM_TOY_PUZZLEBOX. Some items, like quivers or backpacks, or chunks of stone or metal, only require the item token to be filled in, so if you're asking for those you should set the subtype to NONE. Subtypes are the entities defined within the local raw data files and their exact names can be referenced by looking at the corresponding file.

For backwards compatibility, reagents can also accept "METAL_ORE:metal_id" in place of both the item and material tokens - this is equivalent to using the reagent BOULDER:NONE:NONE:NONE with the modifier [METAL_ORE:metal_id] (see below).

==== material token ====
Material tokens come in several forms - see {{L|material token|here}} for a full list. For reagents, this will typically be INORGANIC:MATERIAL_ID, whereas products will typically use GET_MATERIAL_FROM_REAGENT:REAGENT_ID:REACTION_PRODUCT_ID.

==== Modifiers ====
Reagents may also have extra tokens added on afterwards, placed just after the REAGENT tag.

A list of them follows:

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Meaning
|-
| [REACTION_CLASS:X]
| Detailed below the reaction anatomy section.
|-
| [HAS_MATERIAL_REACTION_PRODUCT:X]
| Detailed below the reaction anatomy section.
|-
| [CONTAINS:X]
| Reagent is a container that holds the specified reagent.
|-
| [UNROTTEN]
| Reagent must not be rotten, mainly for organic materials.
|-
| [CONTAINS_LYE]
| Reagent must be a BARREL or TOOL which contains at least one item of type LIQUID_MISC made of LYE.
|-
| [POTASHABLE]
| Alias for [CONTAINS_LYE].
|-
| [NOT_WEB]
| States that the reagent must have been collected (to distinguish silk thread from webs).
|-
| [WEB_ONLY]
| States that the reagent must be undisturbed (to distinguish silk thread from webs).
|-
| [EMPTY]
| If the reagent is a container, it must be empty.
|-
| [NOT_CONTAIN_BARREL_ITEM]
| If the reagent is a container, it must not contain lye or milk.
|-
| [BAG]
| Reagent must be a bag - that is, a BOX made of plant fiber, silk, yarn, or leather.
|-
| [GLASS_MATERIAL]
| Reagent material must have the [IS_GLASS] token. All 3 types of glass have this token hardcoded.
|-
| [BUILDMAT]
| Reagent must be a general building component - BAR, BLOCKS, BOULDER, or WOOD.
|-
| [FIRE_BUILD_SAFE]
| Reagent material must be stable at temperatures below 11000. Currently broken - requires material's IGNITE_POINT to be set to "NONE". Only works with items of type BAR, BLOCKS, BOULDER, WOOD, and ANVIL - all others are rejected.
|-
| [MAGMA_BUILD_SAFE]
| Reagent material must be stable at temperatures below 12000. Currently broken - requires material's IGNITE_POINT to be set to "NONE". Only works with items of type BAR, BLOCKS, BOULDER, WOOD, and ANVIL - all others are rejected.
|-
| [CAN_USE_ARTIFACT]
| Reagent can be an Artifact. Using [PRESERVE_REAGENT] with this is strongly advised.
|-
| [WORTHLESS_STONE_ONLY]
| Reagent material must be non-economic.
|-
| [ANY_PLANT_MATERIAL]
| Reagent material must be subordinate to a PLANT object.
|-
| [ANY_SILK_MATERIAL]
| Reagent material must have the [SILK] token.
|-
| [ANY_YARN_MATERIAL]
| Reagent material must have the [YARN] token.
|-
| [ANY_SOAP_MATERIAL]
| Reagent material must have the [SOAP] token.
|-
| [ANY_LEATHER_MATERIAL]
| Reagent material must have the [LEATHER] token.
|-
| [ANY_BONE_MATERIAL]
| Reagent material must have the [BONE] token.
|-
| [ANY_STRAND_TISSUE]
| Reagent is made of a tissue having [TISSUE_SHAPE:STRANDS], intended for matching hair and wool. Must be used with [USE_BODY_COMPONENT].
|-
| [ANY_SHELL_MATERIAL]
| Reagent material must have the [SHELL] token.
|-
| [ANY_TOOTH_MATERIAL]
| Reagent material must have the [TOOTH] token.
|-
| [ANY_HORN_MATERIAL]
| Reagent material must have the [HORN] token.
|-
| [ANY_PEARL_MATERIAL]
| Reagent material must have the [PEARL] token.
|-
| [USE_BODY_COMPONENT]
| Reagent must be a body part.
|-
| [NO_EDGE_ALLOWED]
| Reagent must not be sharpened (used for knapping).
|-
| [NOT_ENGRAVED]
| Reagent has not been engraved (excludes memorial slabs).
|-
| [NOT_IMPROVED]
| Reagent has not been decorated.
|-
| [DOES_NOT_ABSORB]
| Reagent material must have [ABSORPTION:0]
|-
| [FOOD_STORAGE_CONTAINER]
| Reagent is either a BARREL or a TOOL with the FOOD_STORAGE use.
|-
| [HARD_ITEM_MATERIAL]
| Material has the [ITEMS_HARD] token.
|-
| [NOT_PRESSED]
| Reagent must not be in the SOLID_PRESSED state.
|-
| [METAL_ORE:X]
| Reagent material must be an ore of the specified metal.
|-
| [MIN_DIMENSION:X]
| ?
|-
| [HAS_TOOL_USE:X]
| Reagent must be a {{L|tool}} with the specific TOOL_USE value. The reagent's item type must be TOOL:NONE for this to make any sense.
|-
| [PRESERVE_REAGENT]
| Reagent is not destroyed, which is the normal effect, at the completion of the reaction. Typically used for containers.
|-
| [DOES_NOT_DETERMINE_PRODUCT_AMOUNT]
| Reagent quantity is ignored for the purposes of producing extra outputs. Typically used for containers so that {{L|stack}}s of reagents will correctly produce additional outputs.
|}

Generally speaking, if you set a field in a reagent to NONE, the reaction won't discriminate when it comes to that particular field. For example, if you require a BOULDER reagent but leave the material as NONE:NONE, it will grab any available BOULDER-type item regardless of material.

===Products===
Products are the end product of the reaction. A reaction can have as many products as it likes.

Products are almost identical to reagents, except that they do not need to be named, can't have fields undefined, and don't use the quantity field to determine the product size. Instead, the token PRODUCT_DIMENSION:X is tacked on after the PRODUCT token, determining the size of the product.

Products can be produced directly to a container using the [PRODUCT_TO_CONTAINER:<IDENTIFIER>] token, where the IDENTIFIER is the name of a reagent. This requires the reagent to have the PRESERVE_REAGENT token.

Restating this in the above style, we have:
[PRODUCT:<probability>:<quantity>:<item token>:<material token>][...modifiers...][PRODUCT_DIMENSION:X][PRODUCT_TO_CONTAINER:<IDENTIFIER>]

====probability====
The percentage chance the product will be produced when the reaction is completed.

====quantity====
Determines how many of the product will be produced.

====item token====
The {{L|item token}} and subtype of the item you produce.

For products, this can also be set to CRAFTS:NONE to produce up to three random {{L|craft}} items. This value cannot be used in any other context.

====material token====
A {{L|material token}} describing what the product will be made of.

====Product modifiers====
Zero or more tokens which further clarify the acceptable types when the item type and material types are insufficient to distinguish them.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Meaning
|-
| [FORCE_EDGE]
| Product is given a sharp edge. Used for knapping.
|-
| [PRODUCT_PASTE]
| Product is created in the SOLID_PASTE state.
|-
| [PRODUCT_PRESSED]
| Product is created in the SOLID_PRESSED state.
|-
| [PRODUCT_DIMENSION:<size>]
| Specifies the size of the product. A size of 150 is typical for BAR, POWDER_MISC, LIQUID_MISC, and DRINK. A size of 15000 is typical for THREAD, and a size of 10000 is typical for CLOTH.
|-
| [PRODUCT_TO_CONTAINER:<id>]
| Places the product in a container; <id> must be the name of a reagent with the PRESERVE_REAGENT token and a container item type.

|}

===Improvements===
Improvements are applied to existing reagents. A reaction can have as many improvements as it likes.

Restating this in the above style, we have:
[IMPROVEMENT:<probability>:<reagent name>:<improvement type>:<material token>]

====probability====
The percentage chance the improvement will be applied to the reagent when the reaction is completed.

====reagent name====
The name of the reagent that will be improved. In order to be meaningful, this reagent must have [PRESERVE_REAGENT].

====improvement type====
The following improvement types can be used:
{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Meaning
|-
| COVERED
| Item is encrusted/studded/decorated with <material>.
|-
| GLAZED
| Item is glazed with <material>.
|-
| RINGS_HANGING
| Item is adorned with hanging rings of <material>.
|-
| BANDS
| Item is encircled with bands of <material>.
|-
| SPIKES
| Item menaces with spikes of <material>.
|}

All other item improvement tokens (ART_IMAGE, ITEMSPECIFIC, THREAD, CLOTH, and SEWN_IMAGE) are ignored.

====material token====
A {{L|material token}} describing what the decoration will be made of.

===Other tokens===

==== fuel ====
The FUEL token means that the reaction requires coke or charcoal to be performed. Fuel is not needed when the reaction is performed at a magma workshop (a {{L|magma kiln}}, {{L|magma smelter}}, or any custom building having [NEEDS_MAGMA]).

==== skill ====
The SKILL token determines what [[Skill tokens|skill]] the reaction requires and what skill it trains. Multiple skills can be listed but only one will be used.

==== automatic ====
The AUTOMATIC token means that the reaction will be queued automatically if the reaction reagents are all present.

==== adventure mode enabled ====
The ADVENTURE_MODE_ENABLED token means that this version of the reaction is not used by dwarves at home in a fortress, but rather the wanderers of Adventure Mode. When using this token, it will be allowed for adventurers of any race, without editing Entity files.

==Material reaction products and reaction classes==

You can get a certain measure of control over very specific materials using reaction classes and material reaction products - the tokens look like this:

[REACTION_CLASS:FAT]
[HAS_MATERIAL_REACTION_PRODUCT:RENDER_MAT]

Reaction classes represent different classes of material - basically, the material of the reagent must have a REACTION_CLASS the same as the one in the reaction.

Material reaction products are similar, but are generally used more for things like different kinds of creature materials than universal materials like stone. This token is how skin can be tanned into leather, which are two separate materials - the skin material has leather as a MATERIAL_REACTION_PRODUCT.

In short, they require the material to have a token such as
[MATERIAL_REACTION_PRODUCT:X:Y]
...where X is the name of the reaction product that will be referred to in the reaction (RENDER_MAT, in the reaction class example, or TAN_MAT for leather) and Y is a {{L|material token}} indicating the material of the desired product (such as LOCAL_CREATURE_MAT:LEATHER]).

==Reactions and world generation==

There are several things to keep in mind when you're adding reactions to a game that already exists.

* Most entity changes require a regen, but adding PERMITTED_REACTION tokens for reactions that existed at the time of world generation to the entity file in the save directory do not.
* Adding reactions to the raws in a save directory requires you to regen the world.
* You can alter an existing reaction in any way you like without regenning the world, so long as you don't alter the reaction identifier.

==Full Token List==
For the sake of convenience and readability this is a complete compilation of the previously listed reaction tokens in alphabetical order

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Description

|-
| ADVENTURE_MODE_ENABLED
|
| this version of the reaction is not used by dwarves at home in a fortress, but rather the wanderers of Adventure Mode. When using this token, it will be allowed for adventurers of any race, without editing Entity files

|-
| ANY_BONE_MATERIAL
|
| Reagent material must have the [BONE] token.

|-
| ANY_HORN_MATERIAL
|
| Reagent material must have the [HORN] token.

|-
| ANY_LEATHER_MATERIAL
|
| Reagent material must have the [LEATHER] token.

|-
| ANY_PEARL_MATERIAL
|
| Reagent material must have the [PEARL] token.

|-
| ANY_PLANT_MATERIAL
|
| Reagent material must be subordinate to a PLANT object.

|-
| ANY_SHELL_MATERIAL
|
| Reagent material must have the [SHELL] token.

|-
| ANY_SILK_MATERIAL
|
| Reagent material must have the [SILK] token.

|-
| ANY_SOAP_MATERIAL
|
| Reagent material must have the [SOAP] token.

|-
| ANY_STRAND_TISSUE
|
| Reagent is made of a tissue having [TISSUE_SHAPE:STRANDS], intended for matching hair and wool. Must be used with [USE_BODY_COMPONENT].

|-
| ANY_TOOTH_MATERIAL
|
| Reagent material must have the [TOOTH] token.

|-
| ANY_YARN_MATERIAL
|
| Reagent material must have the [YARN] token.

|-
| AUTOMATIC
|
| the reaction will be queued automatically if the reaction reagents are all present.

|-
| BAG
|
| Reagent has to be a bag. Intended to be used with an item type of BOX, to prevent chests, coffers, and other containers from being used instead.

|-
| BUILDING
|
* Building name
* in-building reaction hotkey
| Sets the building that the reaction will be performed in, and the button used to queue the reaction once that building's menu is accessed in-game

|-
| BUILDMAT
|
| Reagent is able to be used to build structures (Stone, Wood, Blocks, Bars?).

|-
| CAN_USE_ARTIFACT
|
| Reagent can be an Artifact. Using [PRESERVE_REAGENT] with this is strongly advised.

|-
| CONTAINS
| required content
| Reagent is a container that holds the specified reagent.

|-
| CONTAINS_LYE
|
| If the reagent is a container, it must contain LYE. No longer used - instead, use one reagent for the LYE itself and another reagent with [CONTAINS:lye_reagent].

|-
| DOES_NOT_ABSORB
|
| Reagent material must have [ABSORPTION:0]

|-
| DOES_NOT_DETERMINE_PRODUCT_AMOUNT
|
| Setting this dis-allows the quantity of a reagent (probably first in the list) to determine the output quantity. Used where the input is a stack, e.g. liquids in a barrel.

|-
| EMPTY
|
| If the reagent is a container, it must be empty.

|-
| FIRE_BUILD_SAFE
|
| Reagent must be considered fire safe - ie. not wood, and not coal.

|-
| FORCE_EDGE
|
| Product is given a sharp edge. Used for knapping.

|-
| FUEL
|
| Requires that the reaction either use up a unit of coal or charcoal or else be performed at a magma workshop

|-
| GLASS_MATERIAL
|
| Reagent material has [IS_GLASS].

|-
| HAS_MATERIAL_REACTION_PRODUCT
| required reaction product
|

|-
| HAS_TOOL_USE
| Tool-use token
| Reagent must be a {{L|tool}} with the specific TOOL_USE value. The reagent's item type must be TOOL:NONE for this to make any sense.

|-
| IMPROVEMENT
|
* Probability
* Reagent Name
* Improvement type
* Material Token
| Improvement types include BANDS, COVERED, GLAZED, RINGS_HANGING, and SPIKES

|-
| MAGMA_BUILD_SAFE
|
| Currently broken - behaves exactly the same as FIRE_BUILD_SAFE.

|-
| METAL_ORE
|
* Inorganic material
| Reagent material must be an ore of the specified metal

|-
| MIN_DIMENSION
|
| ?

|-
| NAME
| name
| defines the name used by the reaction in-game

|-
| NO_EDGE_ALLOWED
|
| Reagent must not be sharpened (used for knapping).

|-
| NOT_CONTAIN_BARREL_ITEM
|
| If the reagent is a Barrel, it must not contain an item that has to reside in a barrel. Barrel items appear to be lye and milk. Alcohol appears to be covered as part of [EMPTY]. A reaction which places an item in a barrel should probably have both tags.

|-
| NOT_ENGRAVED
|
| Reagent must not be engraved?

|-
| NOT_IMPROVED
|
| Reagent has not been decorated.

|-
| NOT_PRESSED
|
| Reagent must not be in the SOLID_PRESSED state.

|-
| NOT_WEB
|
| Reagent must be "collected" - used with THREAD:NONE to exclude webs.

|-
| POTASHABLE
|
| Alias for CONTAINS_LYE.

|-
| PRESERVE_REAGENT
|
| Reagent is not destroyed, which is the normal effect, at the completion of the reaction. Typically used for containers.

|-
| PRODUCT
|
*Probability
*Quantity
*Item Token
*Material Token
| Defines one of the products to be outputted by the reaction

|-
| PRODUCT_DIMENSION
| size
| Specifies the size of the product. A size of 150 is typical for BAR, POWDER_MISC, LIQUID_MISC, and DRINK. A size of 15000 is typical for THREAD, and a size of 10000 is typical for CLOTH.

|-
| PRODUCT_PASTE
|
| Product is created in the SOLID_PASTE state.

|-
| PRODUCT_PRESSED
|
| Product is created in the SOLID_PRESSED state.

|-
| PRODUCT_TO_CONTAINER
| Reagent ID
| Places the product in a container; <id> must be the name of a reagent with the PRESERVE_REAGENT token and a container item type.

|-
| REACTION
| Identifier
| defines a new reaction

|-
| REACTION_CLASS
|
|

|-
|REAGENT
|
* name/id
* quantity
* item token (and subtoken)
* material token (and subtoken)
| Requires a given reagent as an input for a reaction

|-
| SKILL
| Skill Token
| Skill used by the reaction

|-
| UNROTTEN
|
| Reagent must not be rotten, mainly for organic materials.

|-
| USE_BODY_COMPONENT
|
| Reagent material must come off a creature's body.

|-
| WEB_ONLY
|
| Reagent must be "undisturbed" - used with THREAD:NONE to gather webs.

|-
| WORTHLESS_STONE_ONLY
|
| Reagent is not made of an economic stone.

|}

[[Category:DF2010:Modding]]

v0.31:Reactions

2011-12-04T06:10:10Z

I2amroy: /* Reaction name */

{{quality|Fine|09:41, 6 October 2010 (UTC)}}
{{av}}

Reactions are modular, editable formulas that take specific ingredients, or reagents, and use them to produce a desired item. A lot of reactions are hardcoded - building beds or creating glass, for example -- but a few are freely editable, and it's quite simple to add additional ones.

== Reaction differences between modes ==
In [[Fortress mode]], reactions are linked to specific buildings, and must be added to a civilization's [[Entities|entity file]] to be usable by that civilization. This has the useful effect of limiting new items and materials (such as special [[wood]] or [[metal]]) to civilizations that have the requisite reaction -- so that if you give your custom civilization a reaction to produce star metal or some other custom material, only they will be able to use it.

In [[Adventure mode]], reactions are freely available via x > create, and any adventurer character can make free use of them. Reagents may be held in the hands or dropped on the ground, but cannot be used within a backpack or quiver. As of .10, there are several bugs with Adventure mode reactions, chief of which is the fact that you cannot select liquid reagents. 

Prior to version 31.10, a reaction could only result in an object of base [[quality]]. However, in .10 items produced via reactions have been observed to have quality modifiers. The way skill factors into them has yet is the same as for normal items{{version|0.31.21}}.

==Anatomy of a reaction==

Reactions are found within reaction_x files (such as reaction_smelter or reaction_other). Generally speaking they adhere to the following structure:

[REACTION:<identifier>]
[NAME:<name>]
[BUILDING:<BUILDING NAME>:<BUILDING KEY>]
[REAGENT:A:150:BAR:NONE:POTASH:NONE]
[PRODUCT:100:1:BAR:NONE:PEARLASH:NONE][PRODUCT_DIMENSION:150]
[FUEL]
[SKILL:<SKILL TOKEN>]
[AUTOMATIC]
[ADVENTURE_MODE_ENABLED]
* ''[[#Reaction identifier|identifier]]'': The internal ID of the reaction.
* ''[[#Reaction name|name]]'': The name of the reaction, visible to the player in the Fortress mode or Adventure mode menus.
* ''[[#Building|building]]'': The building ID that the reaction uses, and the relevant keyboard shortcut.
* ''[[#Reagents|...reagents...]]'': Zero or more reagents (ingredients) that are required to be in stock for the reaction to be possible.
* ''[[#Products|...products...]]'': Zero or more products that are created from the reaction.
* ''[[#fuel|fuel]]'': (optional) If present, the reaction requires charcoal, coke or a magma-powered workshop.
* ''[[#skill|skill]]'': (optional) The skill required and trained by the reaction.
* ''[[#automatic|automatic]]'': (optional) If present, the reaction will automatically be enqueued whenever it can possibly be performed.
* ''[[#adventure mode|adventure mode]]'': (optional) If present, the reaction is used by the player in Adventure mode instead.

=== Reaction identifier ===

The reaction identifier may be anything, so long as it is unique within the raw data files. A good habit to get into is to append a short prefix or suffix to each name related to the name of your mod, to ensure nobody else is going to make an identical reaction and thereby mess up the game if their mod is run alongside yours.

=== Reaction name ===

This can be anything at all, and is usually used to describe the reaction. '''tan a hide''', for example, is the name of the default leather-producing reaction. Generally this should be written as a small descriptive verb phrase, with the first letter not capitalised, for consistency with the existing reactions.

=== Building ===

[BUILDING:<BUILDING NAME>:<BUILDING KEY>]
* ''name'': The ID of the building where this reaction will appear in the tasks menu.
* ''key'': The keyboard shortcut used to queue up the reaction.

The BUILDING NAME is the name of the building that will house this reaction, and the building key is the keyboard shortcut that will queue up the reaction. If two reactions have the same key, then one of them will be assigned a different key, the first alphabetically available at the building.

Valid buildings are KILN, SMELTER, TANNER, KITCHEN, QUERN, MILLSTONE, STILL, CRAFTSMAN, and any custom buildings.

Specifying multiple BUILDING tokens will cause the reaction to be available at all of the specified buildings.

=== Reagents ===
REAGENTs are a little bit complicated. They are the ingredients that the reaction will use. You can define as many as you like within a reaction.

[REAGENT:<name>:<quantity>:<item token>:<material token>][...modifiers...]
* ''[[#name|name]]'': The name of the reagent, local to the reaction.
* ''[[#quantity|quantity]]'': The amount of the item that will be used in the reaction.
* ''[[#item_token|item token]]'': The type of the item you require.
* ''[[#material_token|material token]]'': The material the item should be made of.
* ''[[#Modifiers|...modifiers...]]'': Zero or more tokens which further clarify the acceptable types when the item type and material types are insufficient to distinguish them.

==== name ====
The name field is a small string used to identify the reagent within the reaction. The name is not visible to the player. It is local to the reaction and does not need to be unique across all of the reactions, so you can reuse the same names over and over, although each reagent within the same individual reaction must have a different name.

Most reactions are simply named '''A''', '''B''', and so forth in default reactions, although names such as '''TOOLSTONE''' or '''FLUX''' will also work equally well. The PRODUCT may make reference to this name — for instance, if a container '''B''' is specified as a reagent, PRODUCT_TO_CONTAINER:B specifies that container.

==== quantity ====
The quantity differs between item types. Generally speaking, cloth, thread, powder and globs use numbers representing the size of material within one item, and everything else uses a static quantity. While REAGENT:A:'''''10''''':'''''THREAD''''':NONE:NONE:NONE thread is an extremely tiny portion of a random spool of thread, REAGENT:A:'''''10''''':'''''TOY''''':NONE:NONE:NONE is ten unique, solid toy items.

Sometimes the quantity of product is directly connected with the quantity of reagent; it seems to be 150 / REAGENT <quantity> (rounding down) so that Reagent <quantity> of 3 gives 50 product and a <quantity> of 4 gives 37. (150/4=37.5) [List of item types this applies to? Bars, for instance.]

==== item token ====
Item tokens are of the form ITEM_TYPE:ITEM_SUBTYPE.

The item type is the sort of item you require; WEAPON, TOY or SKIN_TANNED, for example. A {{L|item token|full list}} is available.

For reagents, the item token can also be set to ANY_RAW_MATERIAL:NONE (to permit BAR, BOULDER, POWDER_MISC, or GLOB) or ANY_CRAFT:NONE (to permit FIGURINE, AMULET, SCEPTER, CROWN, RING, EARRING, or BRACELET). Internally, these special values are both converted to NONE:NONE and merely set special modifiers (similar to [BUILDMAT]) - they cannot be used in any other context.

The item subtype is name of the exact item that you require. Examples are ITEM_WEAPON_SPEAR or ITEM_TOY_PUZZLEBOX. Some items, like quivers or backpacks, or chunks of stone or metal, only require the item token to be filled in, so if you're asking for those you should set the subtype to NONE. Subtypes are the entities defined within the local raw data files and their exact names can be referenced by looking at the corresponding file.

For backwards compatibility, reagents can also accept "METAL_ORE:metal_id" in place of both the item and material tokens - this is equivalent to using the reagent BOULDER:NONE:NONE:NONE with the modifier [METAL_ORE:metal_id] (see below).

==== material token ====
Material tokens come in several forms - see {{L|material token|here}} for a full list. For reagents, this will typically be INORGANIC:MATERIAL_ID, whereas products will typically use GET_MATERIAL_FROM_REAGENT:REAGENT_ID:REACTION_PRODUCT_ID.

==== Modifiers ====
Reagents may also have extra tokens added on afterwards, placed just after the REAGENT tag.

A list of them follows:

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Meaning
|-
| [REACTION_CLASS:X]
| Detailed below the reaction anatomy section.
|-
| [HAS_MATERIAL_REACTION_PRODUCT:X]
| Detailed below the reaction anatomy section.
|-
| [CONTAINS:X]
| Reagent is a container that holds the specified reagent.
|-
| [UNROTTEN]
| Reagent must not be rotten, mainly for organic materials.
|-
| [CONTAINS_LYE]
| Reagent must be a BARREL or TOOL which contains at least one item of type LIQUID_MISC made of LYE.
|-
| [POTASHABLE]
| Alias for [CONTAINS_LYE].
|-
| [NOT_WEB]
| States that the reagent must have been collected (to distinguish silk thread from webs).
|-
| [WEB_ONLY]
| States that the reagent must be undisturbed (to distinguish silk thread from webs).
|-
| [EMPTY]
| If the reagent is a container, it must be empty.
|-
| [NOT_CONTAIN_BARREL_ITEM]
| If the reagent is a container, it must not contain lye or milk.
|-
| [BAG]
| Reagent must be a bag - that is, a BOX made of plant fiber, silk, yarn, or leather.
|-
| [GLASS_MATERIAL]
| Reagent material must have the [IS_GLASS] token. All 3 types of glass have this token hardcoded.
|-
| [BUILDMAT]
| Reagent must be a general building component - BAR, BLOCKS, BOULDER, or WOOD.
|-
| [FIRE_BUILD_SAFE]
| Reagent material must be stable at temperatures below 11000. Currently broken - requires material's IGNITE_POINT to be set to "NONE". Only works with items of type BAR, BLOCKS, BOULDER, WOOD, and ANVIL - all others are rejected.
|-
| [MAGMA_BUILD_SAFE]
| Reagent material must be stable at temperatures below 12000. Currently broken - requires material's IGNITE_POINT to be set to "NONE". Only works with items of type BAR, BLOCKS, BOULDER, WOOD, and ANVIL - all others are rejected.
|-
| [CAN_USE_ARTIFACT]
| Reagent can be an Artifact. Using [PRESERVE_REAGENT] with this is strongly advised.
|-
| [WORTHLESS_STONE_ONLY]
| Reagent material must be non-economic.
|-
| [ANY_PLANT_MATERIAL]
| Reagent material must be subordinate to a PLANT object.
|-
| [ANY_SILK_MATERIAL]
| Reagent material must have the [SILK] token.
|-
| [ANY_YARN_MATERIAL]
| Reagent material must have the [YARN] token.
|-
| [ANY_SOAP_MATERIAL]
| Reagent material must have the [SOAP] token.
|-
| [ANY_LEATHER_MATERIAL]
| Reagent material must have the [LEATHER] token.
|-
| [ANY_BONE_MATERIAL]
| Reagent material must have the [BONE] token.
|-
| [ANY_STRAND_TISSUE]
| Reagent is made of a tissue having [TISSUE_SHAPE:STRANDS], intended for matching hair and wool. Must be used with [USE_BODY_COMPONENT].
|-
| [ANY_SHELL_MATERIAL]
| Reagent material must have the [SHELL] token.
|-
| [ANY_TOOTH_MATERIAL]
| Reagent material must have the [TOOTH] token.
|-
| [ANY_HORN_MATERIAL]
| Reagent material must have the [HORN] token.
|-
| [ANY_PEARL_MATERIAL]
| Reagent material must have the [PEARL] token.
|-
| [USE_BODY_COMPONENT]
| Reagent must be a body part.
|-
| [NO_EDGE_ALLOWED]
| Reagent must not be sharpened (used for knapping).
|-
| [NOT_ENGRAVED]
| Reagent has not been engraved (excludes memorial slabs).
|-
| [NOT_IMPROVED]
| Reagent has not been decorated.
|-
| [DOES_NOT_ABSORB]
| Reagent material must have [ABSORPTION:0]
|-
| [FOOD_STORAGE_CONTAINER]
| Reagent is either a BARREL or a TOOL with the FOOD_STORAGE use.
|-
| [HARD_ITEM_MATERIAL]
| Material has the [ITEMS_HARD] token.
|-
| [NOT_PRESSED]
| Reagent must not be in the SOLID_PRESSED state.
|-
| [METAL_ORE:X]
| Reagent material must be an ore of the specified metal.
|-
| [MIN_DIMENSION:X]
| ?
|-
| [HAS_TOOL_USE:X]
| Reagent must be a {{L|tool}} with the specific TOOL_USE value. The reagent's item type must be TOOL:NONE for this to make any sense.
|-
| [PRESERVE_REAGENT]
| Reagent is not destroyed, which is the normal effect, at the completion of the reaction. Typically used for containers.
|-
| [DOES_NOT_DETERMINE_PRODUCT_AMOUNT]
| Reagent quantity is ignored for the purposes of producing extra outputs. Typically used for containers so that {{L|stack}}s of reagents will correctly produce additional outputs.
|}

Generally speaking, if you set a field in a reagent to NONE, the reaction won't discriminate when it comes to that particular field. For example, if you require a BOULDER reagent but leave the material as NONE:NONE, it will grab any available BOULDER-type item regardless of material.

===Products===
Products are the end product of the reaction. A reaction can have as many products as it likes.

Products are almost identical to reagents, except that they do not need to be named, can't have fields undefined, and don't use the quantity field to determine the product size. Instead, the token PRODUCT_DIMENSION:X is tacked on after the PRODUCT token, determining the size of the product.

Products can be produced directly to a container using the [PRODUCT_TO_CONTAINER:<IDENTIFIER>] token, where the IDENTIFIER is the name of a reagent. This requires the reagent to have the PRESERVE_REAGENT token.

Restating this in the above style, we have:
[PRODUCT:<probability>:<quantity>:<item token>:<material token>][...modifiers...][PRODUCT_DIMENSION:X][PRODUCT_TO_CONTAINER:<IDENTIFIER>]

====probability====
The percentage chance the product will be produced when the reaction is completed.

====quantity====
Determines how many of the product will be produced.

====item token====
The {{L|item token}} and subtype of the item you produce.

For products, this can also be set to CRAFTS:NONE to produce up to three random {{L|craft}} items. This value cannot be used in any other context.

====material token====
A {{L|material token}} describing what the product will be made of.

====Product modifiers====
Zero or more tokens which further clarify the acceptable types when the item type and material types are insufficient to distinguish them.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Meaning
|-
| [FORCE_EDGE]
| Product is given a sharp edge. Used for knapping.
|-
| [PRODUCT_PASTE]
| Product is created in the SOLID_PASTE state.
|-
| [PRODUCT_PRESSED]
| Product is created in the SOLID_PRESSED state.
|-
| [PRODUCT_DIMENSION:<size>]
| Specifies the size of the product. A size of 150 is typical for BAR, POWDER_MISC, LIQUID_MISC, and DRINK. A size of 15000 is typical for THREAD, and a size of 10000 is typical for CLOTH.
|-
| [PRODUCT_TO_CONTAINER:<id>]
| Places the product in a container; <id> must be the name of a reagent with the PRESERVE_REAGENT token and a container item type.

|}

===Improvements===
Improvements are applied to existing reagents. A reaction can have as many improvements as it likes.

Restating this in the above style, we have:
[IMPROVEMENT:<probability>:<reagent name>:<improvement type>:<material token>]

====probability====
The percentage chance the improvement will be applied to the reagent when the reaction is completed.

====reagent name====
The name of the reagent that will be improved. In order to be meaningful, this reagent must have [PRESERVE_REAGENT].

====improvement type====
The following improvement types can be used:
{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Meaning
|-
| COVERED
| Item is encrusted/studded/decorated with <material>.
|-
| GLAZED
| Item is glazed with <material>.
|-
| RINGS_HANGING
| Item is adorned with hanging rings of <material>.
|-
| BANDS
| Item is encircled with bands of <material>.
|-
| SPIKES
| Item menaces with spikes of <material>.
|}

All other item improvement tokens (ART_IMAGE, ITEMSPECIFIC, THREAD, CLOTH, and SEWN_IMAGE) are ignored.

====material token====
A {{L|material token}} describing what the decoration will be made of.

===Other tokens===

==== fuel ====
The FUEL token means that the reaction requires coke or charcoal to be performed. Fuel is not needed when the reaction is performed at a magma workshop (a {{L|magma kiln}}, {{L|magma smelter}}, or any custom building having [NEEDS_MAGMA]).

==== skill ====
The SKILL token determines what [[Skill tokens|skill]] the reaction requires and what skill it trains. Multiple skills can be listed but only one will be used.

==== automatic ====
The AUTOMATIC token means that the reaction will be queued automatically if the reaction reagents are all present.

==== adventure mode enabled ====
The ADVENTURE_MODE_ENABLED token means that this version of the reaction is not used by dwarves at home in a fortress, but rather the wanderers of Adventure Mode. When using this token, it will be allowed for adventurers of any race, without editing Entity files.

==Material reaction products and reaction classes==

You can get a certain measure of control over very specific materials using reaction classes and material reaction products - the tokens look like this:

[REACTION_CLASS:FAT]
[HAS_MATERIAL_REACTION_PRODUCT:RENDER_MAT]

Reaction classes represent different classes of material - basically, the material of the reagent must have a REACTION_CLASS the same as the one in the reaction.

Material reaction products are similar, but are generally used more for things like different kinds of creature materials than universal materials like stone. This token is how skin can be tanned into leather, which are two separate materials - the skin material has leather as a MATERIAL_REACTION_PRODUCT.

In short, they require the material to have a token such as
[MATERIAL_REACTION_PRODUCT:X:Y]
...where X is the name of the reaction product that will be referred to in the reaction (RENDER_MAT, in the reaction class example, or TAN_MAT for leather) and Y is a {{L|material token}} indicating the material of the desired product (such as LOCAL_CREATURE_MAT:LEATHER]).

==Reactions and world generation==

There are several things to keep in mind when you're adding reactions to a game that already exists.

* Most entity changes require a regen, but adding PERMITTED_REACTION tokens for reactions that existed at the time of world generation to the entity file in the save directory do not.
* Adding reactions to the raws in a save directory requires you to regen the world.
* You can alter an existing reaction in any way you like without regenning the world, so long as you don't alter the reaction identifier.

==Full Token List==
For the sake of convenience and readability this is a complete compilation of the previously listed reaction tokens in alphabetical order

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Description

|-
| ADVENTURE_MODE_ENABLED
|
| this version of the reaction is not used by dwarves at home in a fortress, but rather the wanderers of Adventure Mode. When using this token, it will be allowed for adventurers of any race, without editing Entity files

|-
| ANY_BONE_MATERIAL
|
| Reagent material must have the [BONE] token.

|-
| ANY_HORN_MATERIAL
|
| Reagent material must have the [HORN] token.

|-
| ANY_LEATHER_MATERIAL
|
| Reagent material must have the [LEATHER] token.

|-
| ANY_PEARL_MATERIAL
|
| Reagent material must have the [PEARL] token.

|-
| ANY_PLANT_MATERIAL
|
| Reagent material must be subordinate to a PLANT object.

|-
| ANY_SHELL_MATERIAL
|
| Reagent material must have the [SHELL] token.

|-
| ANY_SILK_MATERIAL
|
| Reagent material must have the [SILK] token.

|-
| ANY_SOAP_MATERIAL
|
| Reagent material must have the [SOAP] token.

|-
| ANY_STRAND_TISSUE
|
| Reagent is made of a tissue having [TISSUE_SHAPE:STRANDS], intended for matching hair and wool. Must be used with [USE_BODY_COMPONENT].

|-
| ANY_TOOTH_MATERIAL
|
| Reagent material must have the [TOOTH] token.

|-
| ANY_YARN_MATERIAL
|
| Reagent material must have the [YARN] token.

|-
| AUTOMATIC
|
| the reaction will be queued automatically if the reaction reagents are all present.

|-
| BAG
|
| Reagent has to be a bag. Intended to be used with an item type of BOX, to prevent chests, coffers, and other containers from being used instead.

|-
| BUILDING
|
* Building name
* in-building reaction hotkey
| Sets the building that the reaction will be performed in, and the button used to queue the reaction once that building's menu is accessed in-game

|-
| BUILDMAT
|
| Reagent is able to be used to build structures (Stone, Wood, Blocks, Bars?).

|-
| CAN_USE_ARTIFACT
|
| Reagent can be an Artifact. Using [PRESERVE_REAGENT] with this is strongly advised.

|-
| CONTAINS
| required content
| Reagent is a container that holds the specified reagent.

|-
| CONTAINS_LYE
|
| If the reagent is a container, it must contain LYE. No longer used - instead, use one reagent for the LYE itself and another reagent with [CONTAINS:lye_reagent].

|-
| DOES_NOT_ABSORB
|
| Reagent material must have [ABSORPTION:0]

|-
| DOES_NOT_DETERMINE_PRODUCT_AMOUNT
|
| Setting this dis-allows the quantity of a reagent (probably first in the list) to determine the output quantity. Used where the input is a stack, e.g. liquids in a barrel.

|-
| EMPTY
|
| If the reagent is a container, it must be empty.

|-
| FIRE_BUILD_SAFE
|
| Reagent must be considered fire safe - ie. not wood, and not coal.

|-
| FORCE_EDGE
|
| Product is given a sharp edge. Used for knapping.

|-
| FUEL
|
| Requires that the reaction either use up a unit of coal or charcoal or else be performed at a magma workshop

|-
| GLASS_MATERIAL
|
| Reagent material has [IS_GLASS].

|-
| HAS_MATERIAL_REACTION_PRODUCT
| required reaction product
|

|-
| HAS_TOOL_USE
| Tool-use token
| Reagent must be a {{L|tool}} with the specific TOOL_USE value. The reagent's item type must be TOOL:NONE for this to make any sense.

|-
| IMPROVEMENT
|
* Probability
* Reagent Name
* Improvement type
* Material Token
| Improvement types include BANDS, COVERED, GLAZED, RINGS_HANGING, and SPIKES

|-
| MAGMA_BUILD_SAFE
|
| Currently broken - behaves exactly the same as FIRE_BUILD_SAFE.

|-
| METAL_ORE
|
* Inorganic material
| Reagent material must be an ore of the specified metal

|-
| MIN_DIMENSION
|
| ?

|-
| NAME
| name
| defines the name used by the reaction in-game

|-
| NO_EDGE_ALLOWED
|
| Reagent must not be sharpened (used for knapping).

|-
| NOT_CONTAIN_BARREL_ITEM
|
| If the reagent is a Barrel, it must not contain an item that has to reside in a barrel. Barrel items appear to be lye and milk. Alcohol appears to be covered as part of [EMPTY]. A reaction which places an item in a barrel should probably have both tags.

|-
| NOT_ENGRAVED
|
| Reagent must not be engraved?

|-
| NOT_IMPROVED
|
| Reagent has not been decorated.

|-
| NOT_PRESSED
|
| Reagent must not be in the SOLID_PRESSED state.

|-
| NOT_WEB
|
| Reagent must be "collected" - used with THREAD:NONE to exclude webs.

|-
| POTASHABLE
|
| Alias for CONTAINS_LYE.

|-
| PRESERVE_REAGENT
|
| Reagent is not destroyed, which is the normal effect, at the completion of the reaction. Typically used for containers.

|-
| PRODUCT
|
*Probability
*Quantity
*Item Token
*Material Token
| Defines one of the products to be outputted by the reaction

|-
| PRODUCT_DIMENSION
| size
| Specifies the size of the product. A size of 150 is typical for BAR, POWDER_MISC, LIQUID_MISC, and DRINK. A size of 15000 is typical for THREAD, and a size of 10000 is typical for CLOTH.

|-
| PRODUCT_PASTE
|
| Product is created in the SOLID_PASTE state.

|-
| PRODUCT_PRESSED
|
| Product is created in the SOLID_PRESSED state.

|-
| PRODUCT_TO_CONTAINER
| Reagent ID
| Places the product in a container; <id> must be the name of a reagent with the PRESERVE_REAGENT token and a container item type.

|-
| REACTION
| Identifier
| defines a new reaction

|-
| REACTION_CLASS
|
|

|-
|REAGENT
|
* name/id
* quantity
* item token (and subtoken)
* material token (and subtoken)
| Requires a given reagent as an input for a reaction

|-
| SKILL
| Skill Token
| Skill used by the reaction

|-
| UNROTTEN
|
| Reagent must not be rotten, mainly for organic materials.

|-
| USE_BODY_COMPONENT
|
| Reagent material must come off a creature's body.

|-
| WEB_ONLY
|
| Reagent must be "undisturbed" - used with THREAD:NONE to gather webs.

|-
| WORTHLESS_STONE_ONLY
|
| Reagent is not made of an economic stone.

|}

[[Category:DF2010:Modding]]

v0.31:Strange mood

2011-11-25T06:48:59Z

I2amroy:

{{quality|Exceptional|02:25, 4 May 2011 (UTC)}}{{av}}

{{buggy|bugsection=Bugs}}
{{minorspoiler}}
Periodically, individual dwarves are struck with an idea for a {{L|legendary artifact}} and enter a '''strange mood'''. Dwarves which enter a strange mood will stop whatever they are doing and pursue the construction of this artifact to the exclusion of all else. They will not stop to eat, drink, sleep, or even run away from dangerous creatures. If they do not manage to begin construction of the artifact within a handful of months, they will go [[#Failure|insane]] and die soon afterward.
Note: All controllable civilizations are currently able to enter strange moods, though in vanilla DF the only civilization this applies to is dwarves.

==Overview==

# The conditions necessary for a strange mood to occur are not fully understood, although they may possess even dwarf children.
# The game will pause, center on a dwarf, and announce that the dwarf has entered one of five different types of strange moods. The [[#Types of moods|types of moods]] are listed below. While in a mood, a dwarf will display a blinking exclamation point (see {{L|status icons}}).
# For the duration of the mood, the dwarf will claim a workshop related to the skill that the mood affects (not all skills are eligible), kick out any dwarf who was using it, and render it otherwise unusable until the mood has been resolved. If a moody dwarf does not claim a workshop, it is because the appropriate workshop does not exist. (See [[#Skills and workshops|skills and workshops]] below to determine which workshop(s) might be required.) A moody dwarf will ''not'' be available to build a needed workshop; another dwarf with the appropriate {{L|labor}} designation must do so for them, if one is necessary.
# After claiming a workshop, the dwarf will set about collecting the required materials for their artifact. If the dwarf remains idle inside the workshop, it's because they cannot find the right material. Reference the [[#Demands|demands]] section to determine what may be required. Important Note: They will only collect these materials in the order that they require them. In other words, you have to determine where they are on the list of required materials and then provide the next one before they will continue collecting other materials.
# Once all materials have been gathered, the game will once again pause and center, and the moody dwarf will begin construction. Upon completion the dwarf will create a semi-random artifact related to the skill affected and gain {{L|legendary}} (or higher) status in that skill (unless the mood type is [[#Possessed|possessed]]). See the [[#Skills and workshops|skills and workshops]] for information on which skills can be gained, or the [[#Artifacts created|artifacts created]] section for more details on the artifacts themselves.

== Types of moods ==
For each of the following types of moods, the first message is how the mood is {{L|Announcement|announced}}; the second message appears in the dwarf's profile when he or she is viewed with the {{K|v}} key. All moody dwarves will have "Strange Mood" listed as their active task.

=== Fey ===
* {{Gametext|<dwarf> is taken by a fey mood!|7:1}}
: ''Has the aspect of one fey!''

This is the most basic strange mood. Fey dwarves will clearly state their demands when the workshop they are in is examined.

A fey dwarf's happiness is automatically set to 'quite content'.

=== Secretive ===
* {{Gametext|<dwarf> withdraws from society...|7:0}}
: ''Peculiarly secretive...''

Secretive moods are the same as fey moods, except a secretive dwarf will sketch pictures of their required materials instead of clearly stating their demands if they cannot find what they need. Descriptions of all these [[#Demands|secretive requirements]] can be seen only by viewing the workshop that the moody dwarf has claimed, with {{k|q}}, and then only while the dwarf is waiting inside it. More than one "picture" is likely; these will cycle through the entire list automatically if any one is not available. (Since materials are gathered ''in order'', it's quite possible that only one of a long list is needed to allow the moody dwarf to continue on their project. If the dwarf has gathered some of the materials (seen as "tasked" when looking at the workshop with {{k|t}}), then the next in the list is what they are looking for.)

A secretive dwarf's happiness is automatically set to 'quite content'.

=== Possessed ===
* {{Gametext|<dwarf> has been possessed!|5:1}}
: ''Possessed by unknown forces!''

Possessed dwarves have cryptic material requests, and have the unfortunate distinction of not receiving any experience upon successful construction of an artifact. No controllable circumstances lead to a possessed mood instead of one of the more desirable fey or secretive moods. It is pure luck-based. Possessed dwarves will mutter the name of the artifact they are working on once they have all the materials they need.

A possession is the only mood that does ''not'' result in a jump in {{L|experience}}.

A possessed dwarf's happiness is automatically set to 'quite content'.

A possessed dwarf that is muttering nonsense has already gathered everything it needs

=== Fell ===
* {{Gametext|<dwarf> looses a roaring laughter, fell and terrible!|5:0}}
: ''Has a horrible fell look!''

A dwarf that goes into a fell mood will always take over a {{L|butcher's shop}} or a {{L|tanner's shop}}. If neither are available, any other workshop will be used instead. The dwarf will then ''murder'' the nearest dwarf (bonus if its a noble), drag the corpse into the shop and make some sort of object out of dwarf {{L|leather}} or {{L|bone}}. Once the artifact is completed, the fell dwarf will become a legendary {{L|bone carver}} or {{L|leatherworker}}. Strangely, none of the other dwarves seem to mind the murder. Only unhappy dwarves may enter a fell mood.

Aside from the loss of a potentially important dwarf in the wrong place at the wrong time, there doesn't seem to be any downside to a fell mood. The end result is always an artifact and a legendary craftsdwarf. Since the only ingredient used (a dwarf) is available in abundance, a fell mood will only fail if the fell dwarf is completely isolated from other dwarves, or if the proper workshop does not exist.

=== Macabre ===
* {{Gametext|<dwarf> begins to stalk and brood...|0:1}}
: ''Brooding darkly...''

Macabre moods are similar to fell moods, but the dwarf will not murder a fellow dwarf. A macabre dwarf may require bones{{verify}}, skulls{{verify}} or remains (this includes vermin remains and many otherwise unusable items); if you do not happen to have any, you will have to make some, e.g. by butchering an animal, or let the moody dwarf go insane. Like fell moods, only unhappy dwarves can enter macabre moods.

==Caveats==
* Shells are a common request in moods and are only produced from preparing raw {{l|turtle}}s, {{L|mussel}}s, {{L|oyster}}s, or {{L|cave lobster}}s at a fishery. That is, you must be able to fish them at your site - there is no way of trading for them, since traded {{L|cave lobster}}s and {{L|turtle}}s are ''processed'' fish (with the shells already removed). Version 0.31.12 and beyond should have much fewer shell requests.
* Should the claimed workshop be a {{L|magma forge}} and lose power due to insufficient magma beneath it, the mood will fail immediately and the dwarf will go {{L|insane}}. Should the forge be in danger of losing power, you should forbid it before it is claimed and wait until it is powered up reliably. Once magma forges are built, at least some dwarfes will no longer be satisfied with a regular forge.
* The following can happen (v .31.12) "OVERWROTE JOB: Strange Mood BY Starting Fist Fight".
* The mood's primary material will only be mentioned ''once'' in the dwarf's requests, even if the dwarf wants more than one unit of it. [http://www.bay12forums.com/smf/index.php?topic=75139.0;topicseen]
* The item to be built is not set at the beginning of the mood. Saving (even after a dwarf has begun to gather materials) will allow you to reload and the result may be a different artifact. If you want to receive artifact adamantine breastplate, make sure to have adamantine nearby and forbid/move away any other materials. You can reload the artifact creating process, even after the dwarf has gathered most of components by forbidding the claimed items. If other items of that type are available, dwarf will immediately switch to them.

==Bugs==
{{version|0.31.03}}
* There are bugs reported related to moody dwarves. As has been the case in 40d, most turned out to be (understandable) failures of the player to grasp the mechanics of artifact creation and demands. Bug tracker: [http://bay12games.com/dwarves/mantisbt/view_all_bug_page.php]
* Dwarves may request "rock bars" -- This is satisfied by metal bars.
{{version|0.31.10}}
* Moody Dwarves don't respect burrows when grabbing a workshop, but DO when looking for items. If his claimed workshop is outside his assigned burrow, the dwarf will continue to grab materials until all materials of the needed type are exhausted within his assigned burrow, this is similar to the [[Planepacked]] glitch.
* If a dwarf dies because of failing to complete an artifact, a memorial made to the dwarf will read that the dwarf did create it, despite the failure, and will even list the name of the artifact that never came to be.

== Demands ==
Once a workshop is claimed, the dwarf will begin collecting materials. Each artifact will require between one and ten materials to complete. The dwarf may well need several items of one material! If the moody dwarf remains idle, then the necessary materials are not available. {{L|Forbidden}} items must be reclaimed ({{K|d}} - {{K|b}} - {{K|c}}) before they may be used, but moody dwarves will ignore settings regarding {{L|economic stone}}. Press {{K|q}} and highlight the workshop to receive a series of clues about what the dwarf needs. Hints that stay active for longer than 2 seconds mean that multiple pieces of that material will be required; each single demand will be displayed for 2 seconds, so if it says "gems... shining" for 6 seconds, 3 gems are demanded. However, occasionally a hint shown for only 2 seconds will require more than one item to fulfill it; this behavior seems to occur mainly (only?) with the primary material (the base material of the artifact, and the first item gathered).{{Verify}} Materials will always be fetched ''in order'', so if at least one item has already been retrieved (the items will show up with "TSK" ("task") next to them when the workshop is viewed with the {{K|t}} context menu), it will usually be possible to tell what item is required next.

If you want your dwarves to construct their artifacts out of valuable materials instead of whatever useless thing happens to be close at hand, you can selectively forbid types of material through the stocks screen so that only the material you want them to use is available; though this might interfere with the normal crafting operations of your fortress, the disruption is generally short-lived (as long as you remember to unforbid them again afterwards!). You can even forbid something a moody dwarf is carrying (which may be necessary sometimes, since while they are not waiting in the workshop they will not tell you what they need); the dwarf will finish hauling it to the workshop, but then immediately go searching for another. This trick can mean the difference between a bauxite statue decorated with moss agates and a native platinum statue encrusted with diamonds. Be aware that this may not always work - moody {{L|metalsmith}}s will occasionally insist on a specific type of metal with which to make their artifact, and forbidding other metals to force them to use a more valuable material will simply cause them to sit in the workshop until you give them what they want. This metal is usually the one listed in their Thoughts and Preferences page as their favorite metal. Weaponsmiths and armorers are likely to insist on adamantine wafers should any exist in your fortress, forbidden or not, regardless of the particular dwarf's preferences{{verify}}.

As of DF2010, burrows seem to allow even better control over moody dwarf's material usage. Simply by creating a burrow around claimed workshop and another part over desired material, moody dwarf can be controlled without forbidding every single stone in fortress. A moody dwarf will follow the burrow-definitions just like a regular worker, but be mindful that they will not leave the burrow to get materials that are outside of their assigned burrow. A problem can arise when bones from an outside refuse stockpile are needed by a moody dwarf that is assigned to a burrow.

The various demands are translated here:

:{| class="wikitable" style="text-align:left;width:90%;"
|-
! Material
! Fey
! Secretive
! Possessed
|-
|
| <dwarf> screams "I must have <demand>!"
| <dwarf> sketches pictures of <demand>.
| <dwarf> mutters "<artifact> needs <demand>..."
|-
| {{L|Stone}}
| rock
| a quarry
| stone... rock
|-
| Stone/metal {{L|block}}s
| rock blocks
| square blocks
| blocks... bricks
|-
| {{L|Wood}}
| wood logs
| a forest
| tree... life
|-
| Metal {{L|bar}}
| rock bars
| shining bars of metal
| bars... metal
|-
| {{L|Gem}}s (cut)
| cut gems
| cut gems
| gems... shining
|-
| {{L|Gem}}s (raw)
| rough gems
| rough gems
| rough... color
|-
| Green {{L|glass}}
| raw green glass
| glass
| raw... green
|-
| Clear glass
| raw clear glass{{verify}}
| glass and burning wood
| raw... clear
|-
| Crystal glass
| raw crystal glass{{verify}}
| rough gems and glass
| raw... crystal
|-
| {{L|Bone}}{{verify}}
| bones
| skeletons
| bones... yes
|-
| {{L|Shell}}{{verify}}
| shells
| shells
| a shell...
|-
| {{L|Leather}}
| tanned hides
| stacked leather
| leather... skin
|-
| {{L|Cloth}} (plant fiber)
| plant cloth
| stacked cloth
| cloth... thread
|-
| {{L|Cloth}} (silk)
| silk cloth
| stacked cloth
| cloth... thread
|-
| {{L|Cloth}} (yarn)
| yarn cloth
| stacked cloth
| cloth... thread
|-
| {{L|Bone}}, possibly {{L|Skull}}, {{L|Horn}}, {{L|Ivory}}
| body parts
| death
| a corpse
|}

Dwarves in macabre moods will list their demands in the same fashion as those in fey moods (though with them brooding "Yes. I need <item>." instead of screaming "I must have <item>!"). They may also say "Leave me. I need... things... certain things", in which case they want special items such as {{L|skull}}s or vermin {{L|remains}}.

Fey dwarves will sometimes ask for rock bars. This is just a typographical error, caused by stones and metals having been joined into a single "inorganic" material type in version 0.31 - they are actually asking for metal bars.

Related to the above behavior, moody dwarves demanding rock blocks will also accept blocks forged from metal bars.

Moody metalworkers may occasionally require a specific type of metal as their artifact's primary material - for secretive moods and possessions, take a look at the dwarf's material preferences to see which metal the dwarf wants to use.

Once all materials have been gathered, viewing the workshop with {{K|q}} will display a special message depending on the type of mood:
* Fey - "<dwarf> works furiously!"
* Secretive - "<dwarf> works secretly..."
* Possessed - "<dwarf> keeps muttering <artifact>..."
* Macabre - "<dwarf> works, darkly brooding..."
* Fell - "<dwarf> works with menacing fury!"

== The mechanics of moods ==

==== Eligibility ====
The deciding factor for eligibility is a dwarf's actual {{L|Unit type token|profession}}. ''(Note that "{{L|Skill#Custom profession labels|custom professions}}" have no effect on this!)'' Thus, dwarves may enter strange moods regardless of what skills they have or don't have, so long as they are of an acceptable profession. Dwarves who have already created an artifact are not eligible to create another, and since every mood ends in either an artifact or death, every dwarf may enter at most one mood. Dwarves who have obtained one or more legendary skills without creating artifacts may enter strange moods.

Dwarves with a {{L|Soldier#Soldier professions|military profession}} other than "Recruit" can '''not''' enter moods. Incidental military skills make no difference - eligibility (and weighting) depends purely on the actual ''{{L|profession}}'' as listed at the time, so soldiers '''can''' enter moods if they are ''off duty'' and thus in Civilian mode. Babies may '''not''' enter moods.

Any other profession is eligible to enter a mood, but not all have the same ''chance'' to enter a mood...

:''('''Note''' - Specifically, and to avoid previous misunderstandings, {{L|Strand extractor}}, {{L|Clerk}}/{{L|Administrator}}/{{L|Trader}}, {{L|Doctor}} (and related), {{L|Building designer|Architect}}, {{L|Soldier#Recruits|Recruit}} and {{L|Child}} '''are''' moodable professions.)''

=== Chance ===
When determining who will have a strange mood, each eligible dwarf is put into a weighted lottery. The odds are assigned a higher or lower weight based on the dwarf's {{L|profession}}. The default weight is 6, but some professions are more likely to enter a strange mood than others. (This is like most dwarves getting 6 tickets to the lottery, and others getting more.)

{| class="wikitable" cellspacing="0" border="2" cellpadding="5"
|-
! Weighting
! Professions

|-
| 21 ||Armorer, Blacksmith, Bone Carver, Clothier, Craftsdwarf, Jeweler, Gem Cutter, Gem Setter, Glassmaker, Leatherworker, Metalcrafter, Metalsmith, Stonecrafter, Weaponsmith, Weaver, Woodcrafter
|-
| 11 ||Bowyer, Carpenter, Stoneworker, Mason, Woodworker
|-
| 6 ||Engraver, Mechanic, Miner, Tanner, & all other {{L|profession}}s (including Peasant).

|}

:'''''Example:''' What this means is: if you had 21 dwarves, made up of 20 eligible farmers, furnace operators, miners, woodcutters etc. (with 6 chances each) plus one Armorer (with 21 chances), that one Armorer would have a 21 in 141 chance <small>(20 dwarves x 6 chances each = 120 + 21 chances more = 141 total)</small> of the mood striking them. That's about 1 in 7, while the other 20 have a 6 in 141 chance each, or about 1 in 24. The odds are still against the armorer, but much better than for any other single dwarf.''

Note that not every profession is from a moodable skill. A Soaper, Architect, Furnace Operator or Strand Extractor can be taken by a mood, but that will not make those skills legendary, nor will they create an artifact bar of soap, building, bar of metal or wafer of adamantine.

:NOTE: ''If your game was saved shortly before one of you dwarves acquired a mood, reloading that game will most likely cause the chances to be completely re-figured, resulting in a different mood at a different time for a different dwarf with different materials. This is true for most all random events and results in Dwarf Fortress.''

=== Skills and workshops ===

{| class="wikitable" cellpadding="4" style="border:1px solid black;border-collapse:collapse;text-align:left;float:right;margin:0 0 20px 30px;"
|-
! colspan="2" style="background-color:#eee;border-bottom:1px solid black;text-align:center;" | Artifact Skill Rewards
|-
! Highest skill
! Workshop used
|- style="border-top:1px solid #aaa;vertical-align:top;"
| {{L|Armorsmith}}
| {{L|Metalsmith's forge}} (or {{L|Magma forge}})
|- style="border-top:1px solid #aaa;vertical-align:top;"
| {{L|Bone carver}}
| {{L|Craftsdwarf's workshop}}
|- style="border-top:1px solid #aaa;vertical-align:top;"
| {{L|Bowyer}}
| {{L|Bowyer's workshop}}
|- style="border-top:1px solid #aaa;vertical-align:top;"
| {{L|Carpenter}}
| {{L|Carpenter's workshop}}
|- style="border-top:1px solid #aaa;vertical-align:top;"
| {{L|Clothier}}
| {{L|Clothier's shop}}
|- style="border-top:1px solid #aaa;vertical-align:top;"
| {{L|Engraver}}
| {{L|Craftsdwarf's workshop}}
|- style="border-top:1px solid #aaa;vertical-align:top;"
| {{L|Gem cutter}}
| {{L|Jeweler's workshop}}
|- style="border-top:1px solid #aaa;vertical-align:top;"
| {{L|Gem setter}}
| {{L|Jeweler's workshop}}
|- style="border-top:1px solid #aaa;vertical-align:top;"
| {{L|Glassmaker}}
| {{L|Glass furnace}} (or {{L|Magma glass furnace}})
|- style="border-top:1px solid #aaa;vertical-align:top;"
| {{L|Leatherworker}}
| {{L|Leather works}}
|- style="border-top:1px solid #aaa;vertical-align:top;"
| {{L|Mason}}
| {{L|Mason's workshop}}
|- style="border-top:1px solid #aaa;vertical-align:top;"
| {{L|Mechanic}}
| {{L|Mechanic's workshop}}
|- style="border-top:1px solid #aaa;vertical-align:top;"
| {{L|Metal crafter}}
| {{L|Magma forge}} (or {{L|Metalsmith's forge}})
|- style="border-top:1px solid #aaa;vertical-align:top;"
| {{L|Metalsmith}}
| {{L|Magma forge}} (or {{L|Metalsmith's forge}})
|- style="border-top:1px solid #aaa;vertical-align:top;"
| {{L|Miner}}
| {{L|Mason's workshop}}
|- style="border-top:1px solid #aaa;vertical-align:top;"
| {{L|Stone crafter}}
| {{L|Craftsdwarf's workshop}}
|- style="border-top:1px solid #aaa;vertical-align:top;"
| {{L|Tanner}}
| {{L|Leather works}}
|- style="border-top:1px solid #aaa;vertical-align:top;"
| {{L|Weaponsmith}}
| {{L|Magma forge}} (or {{L|Metalsmith's forge}})
|- style="border-top:1px solid #aaa;vertical-align:top;"
| {{L|Weaver}}
| {{L|Clothier's shop}}
|- style="border-top:1px solid #aaa;vertical-align:top;"
| {{L|Wood crafter}}
| {{L|Craftsdwarf's workshop}}
|- style="border-top:1px solid #aaa;vertical-align:top;"
| Anyone Else
| {{L|Craftsdwarf's workshop}}
|}

A dwarf will claim a workshop according to their highest applicable skill, and upon completion of the artifact, gain 20,000 {{L|experience}} in that skill (excepting {{L|Strange mood#Possessed|possessed}} dwarves). This will give the dwarf a legendary-level {{L|skill}} (specifically, "legendary+1" or higher, depending on the dwarf's initial skill level). The table to the right describes all applicable skills and their potential workshop requirements - there are only 20 skills that determine the workshop and that can be affected by a mood (sometimes referred to as '''moodable''' skills.) If a dwarf does not possess at least one of the moodable skills listed to the right, they will take over a {{L|craftsdwarf's workshop}} and gain one of {{L|bone carver}}, {{L|stone crafter}}, or {{L|wood crafter}} skills, producing an artifact {{L|craft}}.

This fact can be utilized to maximize the possibility of getting a dwarf with the specific legendary skill you want: since ''non''-moodable skills are ignored, whenever possible make sure that each dwarf's highest ''moodable'' skill is one of those you want*. Have all your peasants, {{L|farmer}}s, non-professional military and other dwarves without any moodable skills do a tiny bit of work in the skill(s) you most want; if a "{{L|experience|dabbling}}" skill is the highest moodable skill they have, that is the skill that will be used.

:''(* {{L|Armorsmith}}, {{L|Weaponsmith}}, {{L|Metal crafter}} and {{L|Metalsmith}} are possibly the most-desired legendary skills, but much depends on your fortress, your current mix of skills, and your play style.)''

== Artifacts created ==
The type of artifact created will depend on the dwarf's highest skill. Masons and miners will always create some kind of stone furniture; bone carvers, a bone or shell object; carpenters, a wood object, etc. engravers and stone crafters will turn out a stone craft; metalworkers, metal crafts, weapons, or armor (depending on the type of metalworker); weavers, an article of clothing; tanners, a leather armor or object. If a dwarf has no moodable skills, they will take over a {{L|craftsdwarf's workshop}} and create a bone, stone or wood craft of some type. The precise type of craft created is usually somewhat random but if a dwarf has a personality preference for a particular thing, such as gauntlets or floodgates or crowns, and that thing is an available choice given the dwarf's profession, they will generally create an object of that type.

The first object grabbed by the dwarf will be the "primary" substance; all other materials will be used to decorate the artifact. If a dwarf grabs a piece of {{L|chalk}} and makes a statue, for instance, it will be a "chalk statue", but an artifact can potentially be composed of bone, cloth, gems, leather, metal, shell, stone, and wood all at once. In some cases, a moody dwarf will produce an item which normally cannot be made from that material, leading to such odd constructions as an {{L|obsidian}} {{L|bed}}, {{L|ruby}} {{L|floodgate}}, or turtle {{L|shell}} {{L|cage}}.

Once created, most {{L|artifact}}s will be available for use just like a normal item of its type. Artifact furniture is useful for high value {{L|noble}} rooms. Artifact weapons in {{L|weapon trap}}s can also boost a room's value considerably, as in the case of artifact trap components and mechanisms.

Unless the mood was a Possession, the dwarf will gain 20,000 points of {{L|experience}} in the skill used to produce the artifact, enough to boost them to Legendary.

== Failure ==
If you can't provide the desired workshop and all the required component materials within a couple of months, the dwarf will go {{L|insanity|insane}}, which cancels the mood and the artifact. As if that's not bad enough, any dwarf who goes insane will soon die, one way or another.

A dwarf who is '''stark raving mad''' or '''melancholy''' is harmless to others (until they die and start a {{L|tantrum}} spiral), but a '''berserk''' dwarf will attack other dwarves and possibly pull levers at random. You may want to station a squad nearby or assign a few war dogs to the dwarf on the chance that they will lash out. If you build your workshops inside enclosed rooms with doors you can also lock the moody dwarf in the room until he or she starves. In extreme cases, building a wall around an open workshop is the best precaution.

v0.31:Strange mood

2011-11-25T06:48:26Z

I2amroy:

{{quality|Exceptional|02:25, 4 May 2011 (UTC)}}{{av}}

{{buggy|bugsection=Bugs}}
{{minorspoiler}}
Periodically, individual dwarves are struck with an idea for a {{L|legendary artifact}} and enter a '''strange mood'''. Dwarves which enter a strange mood will stop whatever they are doing and pursue the construction of this artifact to the exclusion of all else. They will not stop to eat, drink, sleep, or even run away from dangerous creatures. If they do not manage to begin construction of the artifact within a handful of months, they will go [[#Failure|insane]] and die soon afterward.
Note: All controllable civilizations are currently able to enter strange moods.

==Overview==

# The conditions necessary for a strange mood to occur are not fully understood, although they may possess even dwarf children.
# The game will pause, center on a dwarf, and announce that the dwarf has entered one of five different types of strange moods. The [[#Types of moods|types of moods]] are listed below. While in a mood, a dwarf will display a blinking exclamation point (see {{L|status icons}}).
# For the duration of the mood, the dwarf will claim a workshop related to the skill that the mood affects (not all skills are eligible), kick out any dwarf who was using it, and render it otherwise unusable until the mood has been resolved. If a moody dwarf does not claim a workshop, it is because the appropriate workshop does not exist. (See [[#Skills and workshops|skills and workshops]] below to determine which workshop(s) might be required.) A moody dwarf will ''not'' be available to build a needed workshop; another dwarf with the appropriate {{L|labor}} designation must do so for them, if one is necessary.
# After claiming a workshop, the dwarf will set about collecting the required materials for their artifact. If the dwarf remains idle inside the workshop, it's because they cannot find the right material. Reference the [[#Demands|demands]] section to determine what may be required. Important Note: They will only collect these materials in the order that they require them. In other words, you have to determine where they are on the list of required materials and then provide the next one before they will continue collecting other materials.
# Once all materials have been gathered, the game will once again pause and center, and the moody dwarf will begin construction. Upon completion the dwarf will create a semi-random artifact related to the skill affected and gain {{L|legendary}} (or higher) status in that skill (unless the mood type is [[#Possessed|possessed]]). See the [[#Skills and workshops|skills and workshops]] for information on which skills can be gained, or the [[#Artifacts created|artifacts created]] section for more details on the artifacts themselves.

== Types of moods ==
For each of the following types of moods, the first message is how the mood is {{L|Announcement|announced}}; the second message appears in the dwarf's profile when he or she is viewed with the {{K|v}} key. All moody dwarves will have "Strange Mood" listed as their active task.

=== Fey ===
* {{Gametext|<dwarf> is taken by a fey mood!|7:1}}
: ''Has the aspect of one fey!''

This is the most basic strange mood. Fey dwarves will clearly state their demands when the workshop they are in is examined.

A fey dwarf's happiness is automatically set to 'quite content'.

=== Secretive ===
* {{Gametext|<dwarf> withdraws from society...|7:0}}
: ''Peculiarly secretive...''

Secretive moods are the same as fey moods, except a secretive dwarf will sketch pictures of their required materials instead of clearly stating their demands if they cannot find what they need. Descriptions of all these [[#Demands|secretive requirements]] can be seen only by viewing the workshop that the moody dwarf has claimed, with {{k|q}}, and then only while the dwarf is waiting inside it. More than one "picture" is likely; these will cycle through the entire list automatically if any one is not available. (Since materials are gathered ''in order'', it's quite possible that only one of a long list is needed to allow the moody dwarf to continue on their project. If the dwarf has gathered some of the materials (seen as "tasked" when looking at the workshop with {{k|t}}), then the next in the list is what they are looking for.)

A secretive dwarf's happiness is automatically set to 'quite content'.

=== Possessed ===
* {{Gametext|<dwarf> has been possessed!|5:1}}
: ''Possessed by unknown forces!''

Possessed dwarves have cryptic material requests, and have the unfortunate distinction of not receiving any experience upon successful construction of an artifact. No controllable circumstances lead to a possessed mood instead of one of the more desirable fey or secretive moods. It is pure luck-based. Possessed dwarves will mutter the name of the artifact they are working on once they have all the materials they need.

A possession is the only mood that does ''not'' result in a jump in {{L|experience}}.

A possessed dwarf's happiness is automatically set to 'quite content'.

A possessed dwarf that is muttering nonsense has already gathered everything it needs

=== Fell ===
* {{Gametext|<dwarf> looses a roaring laughter, fell and terrible!|5:0}}
: ''Has a horrible fell look!''

A dwarf that goes into a fell mood will always take over a {{L|butcher's shop}} or a {{L|tanner's shop}}. If neither are available, any other workshop will be used instead. The dwarf will then ''murder'' the nearest dwarf (bonus if its a noble), drag the corpse into the shop and make some sort of object out of dwarf {{L|leather}} or {{L|bone}}. Once the artifact is completed, the fell dwarf will become a legendary {{L|bone carver}} or {{L|leatherworker}}. Strangely, none of the other dwarves seem to mind the murder. Only unhappy dwarves may enter a fell mood.

Aside from the loss of a potentially important dwarf in the wrong place at the wrong time, there doesn't seem to be any downside to a fell mood. The end result is always an artifact and a legendary craftsdwarf. Since the only ingredient used (a dwarf) is available in abundance, a fell mood will only fail if the fell dwarf is completely isolated from other dwarves, or if the proper workshop does not exist.

=== Macabre ===
* {{Gametext|<dwarf> begins to stalk and brood...|0:1}}
: ''Brooding darkly...''

Macabre moods are similar to fell moods, but the dwarf will not murder a fellow dwarf. A macabre dwarf may require bones{{verify}}, skulls{{verify}} or remains (this includes vermin remains and many otherwise unusable items); if you do not happen to have any, you will have to make some, e.g. by butchering an animal, or let the moody dwarf go insane. Like fell moods, only unhappy dwarves can enter macabre moods.

==Caveats==
* Shells are a common request in moods and are only produced from preparing raw {{l|turtle}}s, {{L|mussel}}s, {{L|oyster}}s, or {{L|cave lobster}}s at a fishery. That is, you must be able to fish them at your site - there is no way of trading for them, since traded {{L|cave lobster}}s and {{L|turtle}}s are ''processed'' fish (with the shells already removed). Version 0.31.12 and beyond should have much fewer shell requests.
* Should the claimed workshop be a {{L|magma forge}} and lose power due to insufficient magma beneath it, the mood will fail immediately and the dwarf will go {{L|insane}}. Should the forge be in danger of losing power, you should forbid it before it is claimed and wait until it is powered up reliably. Once magma forges are built, at least some dwarfes will no longer be satisfied with a regular forge.
* The following can happen (v .31.12) "OVERWROTE JOB: Strange Mood BY Starting Fist Fight".
* The mood's primary material will only be mentioned ''once'' in the dwarf's requests, even if the dwarf wants more than one unit of it. [http://www.bay12forums.com/smf/index.php?topic=75139.0;topicseen]
* The item to be built is not set at the beginning of the mood. Saving (even after a dwarf has begun to gather materials) will allow you to reload and the result may be a different artifact. If you want to receive artifact adamantine breastplate, make sure to have adamantine nearby and forbid/move away any other materials. You can reload the artifact creating process, even after the dwarf has gathered most of components by forbidding the claimed items. If other items of that type are available, dwarf will immediately switch to them.

==Bugs==
{{version|0.31.03}}
* There are bugs reported related to moody dwarves. As has been the case in 40d, most turned out to be (understandable) failures of the player to grasp the mechanics of artifact creation and demands. Bug tracker: [http://bay12games.com/dwarves/mantisbt/view_all_bug_page.php]
* Dwarves may request "rock bars" -- This is satisfied by metal bars.
{{version|0.31.10}}
* Moody Dwarves don't respect burrows when grabbing a workshop, but DO when looking for items. If his claimed workshop is outside his assigned burrow, the dwarf will continue to grab materials until all materials of the needed type are exhausted within his assigned burrow, this is similar to the [[Planepacked]] glitch.
* If a dwarf dies because of failing to complete an artifact, a memorial made to the dwarf will read that the dwarf did create it, despite the failure, and will even list the name of the artifact that never came to be.

== Demands ==
Once a workshop is claimed, the dwarf will begin collecting materials. Each artifact will require between one and ten materials to complete. The dwarf may well need several items of one material! If the moody dwarf remains idle, then the necessary materials are not available. {{L|Forbidden}} items must be reclaimed ({{K|d}} - {{K|b}} - {{K|c}}) before they may be used, but moody dwarves will ignore settings regarding {{L|economic stone}}. Press {{K|q}} and highlight the workshop to receive a series of clues about what the dwarf needs. Hints that stay active for longer than 2 seconds mean that multiple pieces of that material will be required; each single demand will be displayed for 2 seconds, so if it says "gems... shining" for 6 seconds, 3 gems are demanded. However, occasionally a hint shown for only 2 seconds will require more than one item to fulfill it; this behavior seems to occur mainly (only?) with the primary material (the base material of the artifact, and the first item gathered).{{Verify}} Materials will always be fetched ''in order'', so if at least one item has already been retrieved (the items will show up with "TSK" ("task") next to them when the workshop is viewed with the {{K|t}} context menu), it will usually be possible to tell what item is required next.

If you want your dwarves to construct their artifacts out of valuable materials instead of whatever useless thing happens to be close at hand, you can selectively forbid types of material through the stocks screen so that only the material you want them to use is available; though this might interfere with the normal crafting operations of your fortress, the disruption is generally short-lived (as long as you remember to unforbid them again afterwards!). You can even forbid something a moody dwarf is carrying (which may be necessary sometimes, since while they are not waiting in the workshop they will not tell you what they need); the dwarf will finish hauling it to the workshop, but then immediately go searching for another. This trick can mean the difference between a bauxite statue decorated with moss agates and a native platinum statue encrusted with diamonds. Be aware that this may not always work - moody {{L|metalsmith}}s will occasionally insist on a specific type of metal with which to make their artifact, and forbidding other metals to force them to use a more valuable material will simply cause them to sit in the workshop until you give them what they want. This metal is usually the one listed in their Thoughts and Preferences page as their favorite metal. Weaponsmiths and armorers are likely to insist on adamantine wafers should any exist in your fortress, forbidden or not, regardless of the particular dwarf's preferences{{verify}}.

As of DF2010, burrows seem to allow even better control over moody dwarf's material usage. Simply by creating a burrow around claimed workshop and another part over desired material, moody dwarf can be controlled without forbidding every single stone in fortress. A moody dwarf will follow the burrow-definitions just like a regular worker, but be mindful that they will not leave the burrow to get materials that are outside of their assigned burrow. A problem can arise when bones from an outside refuse stockpile are needed by a moody dwarf that is assigned to a burrow.

The various demands are translated here:

:{| class="wikitable" style="text-align:left;width:90%;"
|-
! Material
! Fey
! Secretive
! Possessed
|-
|
| <dwarf> screams "I must have <demand>!"
| <dwarf> sketches pictures of <demand>.
| <dwarf> mutters "<artifact> needs <demand>..."
|-
| {{L|Stone}}
| rock
| a quarry
| stone... rock
|-
| Stone/metal {{L|block}}s
| rock blocks
| square blocks
| blocks... bricks
|-
| {{L|Wood}}
| wood logs
| a forest
| tree... life
|-
| Metal {{L|bar}}
| rock bars
| shining bars of metal
| bars... metal
|-
| {{L|Gem}}s (cut)
| cut gems
| cut gems
| gems... shining
|-
| {{L|Gem}}s (raw)
| rough gems
| rough gems
| rough... color
|-
| Green {{L|glass}}
| raw green glass
| glass
| raw... green
|-
| Clear glass
| raw clear glass{{verify}}
| glass and burning wood
| raw... clear
|-
| Crystal glass
| raw crystal glass{{verify}}
| rough gems and glass
| raw... crystal
|-
| {{L|Bone}}{{verify}}
| bones
| skeletons
| bones... yes
|-
| {{L|Shell}}{{verify}}
| shells
| shells
| a shell...
|-
| {{L|Leather}}
| tanned hides
| stacked leather
| leather... skin
|-
| {{L|Cloth}} (plant fiber)
| plant cloth
| stacked cloth
| cloth... thread
|-
| {{L|Cloth}} (silk)
| silk cloth
| stacked cloth
| cloth... thread
|-
| {{L|Cloth}} (yarn)
| yarn cloth
| stacked cloth
| cloth... thread
|-
| {{L|Bone}}, possibly {{L|Skull}}, {{L|Horn}}, {{L|Ivory}}
| body parts
| death
| a corpse
|}

Dwarves in macabre moods will list their demands in the same fashion as those in fey moods (though with them brooding "Yes. I need <item>." instead of screaming "I must have <item>!"). They may also say "Leave me. I need... things... certain things", in which case they want special items such as {{L|skull}}s or vermin {{L|remains}}.

Fey dwarves will sometimes ask for rock bars. This is just a typographical error, caused by stones and metals having been joined into a single "inorganic" material type in version 0.31 - they are actually asking for metal bars.

Related to the above behavior, moody dwarves demanding rock blocks will also accept blocks forged from metal bars.

Moody metalworkers may occasionally require a specific type of metal as their artifact's primary material - for secretive moods and possessions, take a look at the dwarf's material preferences to see which metal the dwarf wants to use.

Once all materials have been gathered, viewing the workshop with {{K|q}} will display a special message depending on the type of mood:
* Fey - "<dwarf> works furiously!"
* Secretive - "<dwarf> works secretly..."
* Possessed - "<dwarf> keeps muttering <artifact>..."
* Macabre - "<dwarf> works, darkly brooding..."
* Fell - "<dwarf> works with menacing fury!"

== The mechanics of moods ==

==== Eligibility ====
The deciding factor for eligibility is a dwarf's actual {{L|Unit type token|profession}}. ''(Note that "{{L|Skill#Custom profession labels|custom professions}}" have no effect on this!)'' Thus, dwarves may enter strange moods regardless of what skills they have or don't have, so long as they are of an acceptable profession. Dwarves who have already created an artifact are not eligible to create another, and since every mood ends in either an artifact or death, every dwarf may enter at most one mood. Dwarves who have obtained one or more legendary skills without creating artifacts may enter strange moods.

Dwarves with a {{L|Soldier#Soldier professions|military profession}} other than "Recruit" can '''not''' enter moods. Incidental military skills make no difference - eligibility (and weighting) depends purely on the actual ''{{L|profession}}'' as listed at the time, so soldiers '''can''' enter moods if they are ''off duty'' and thus in Civilian mode. Babies may '''not''' enter moods.

Any other profession is eligible to enter a mood, but not all have the same ''chance'' to enter a mood...

:''('''Note''' - Specifically, and to avoid previous misunderstandings, {{L|Strand extractor}}, {{L|Clerk}}/{{L|Administrator}}/{{L|Trader}}, {{L|Doctor}} (and related), {{L|Building designer|Architect}}, {{L|Soldier#Recruits|Recruit}} and {{L|Child}} '''are''' moodable professions.)''

=== Chance ===
When determining who will have a strange mood, each eligible dwarf is put into a weighted lottery. The odds are assigned a higher or lower weight based on the dwarf's {{L|profession}}. The default weight is 6, but some professions are more likely to enter a strange mood than others. (This is like most dwarves getting 6 tickets to the lottery, and others getting more.)

{| class="wikitable" cellspacing="0" border="2" cellpadding="5"
|-
! Weighting
! Professions

|-
| 21 ||Armorer, Blacksmith, Bone Carver, Clothier, Craftsdwarf, Jeweler, Gem Cutter, Gem Setter, Glassmaker, Leatherworker, Metalcrafter, Metalsmith, Stonecrafter, Weaponsmith, Weaver, Woodcrafter
|-
| 11 ||Bowyer, Carpenter, Stoneworker, Mason, Woodworker
|-
| 6 ||Engraver, Mechanic, Miner, Tanner, & all other {{L|profession}}s (including Peasant).

|}

:'''''Example:''' What this means is: if you had 21 dwarves, made up of 20 eligible farmers, furnace operators, miners, woodcutters etc. (with 6 chances each) plus one Armorer (with 21 chances), that one Armorer would have a 21 in 141 chance <small>(20 dwarves x 6 chances each = 120 + 21 chances more = 141 total)</small> of the mood striking them. That's about 1 in 7, while the other 20 have a 6 in 141 chance each, or about 1 in 24. The odds are still against the armorer, but much better than for any other single dwarf.''

Note that not every profession is from a moodable skill. A Soaper, Architect, Furnace Operator or Strand Extractor can be taken by a mood, but that will not make those skills legendary, nor will they create an artifact bar of soap, building, bar of metal or wafer of adamantine.

:NOTE: ''If your game was saved shortly before one of you dwarves acquired a mood, reloading that game will most likely cause the chances to be completely re-figured, resulting in a different mood at a different time for a different dwarf with different materials. This is true for most all random events and results in Dwarf Fortress.''

=== Skills and workshops ===

{| class="wikitable" cellpadding="4" style="border:1px solid black;border-collapse:collapse;text-align:left;float:right;margin:0 0 20px 30px;"
|-
! colspan="2" style="background-color:#eee;border-bottom:1px solid black;text-align:center;" | Artifact Skill Rewards
|-
! Highest skill
! Workshop used
|- style="border-top:1px solid #aaa;vertical-align:top;"
| {{L|Armorsmith}}
| {{L|Metalsmith's forge}} (or {{L|Magma forge}})
|- style="border-top:1px solid #aaa;vertical-align:top;"
| {{L|Bone carver}}
| {{L|Craftsdwarf's workshop}}
|- style="border-top:1px solid #aaa;vertical-align:top;"
| {{L|Bowyer}}
| {{L|Bowyer's workshop}}
|- style="border-top:1px solid #aaa;vertical-align:top;"
| {{L|Carpenter}}
| {{L|Carpenter's workshop}}
|- style="border-top:1px solid #aaa;vertical-align:top;"
| {{L|Clothier}}
| {{L|Clothier's shop}}
|- style="border-top:1px solid #aaa;vertical-align:top;"
| {{L|Engraver}}
| {{L|Craftsdwarf's workshop}}
|- style="border-top:1px solid #aaa;vertical-align:top;"
| {{L|Gem cutter}}
| {{L|Jeweler's workshop}}
|- style="border-top:1px solid #aaa;vertical-align:top;"
| {{L|Gem setter}}
| {{L|Jeweler's workshop}}
|- style="border-top:1px solid #aaa;vertical-align:top;"
| {{L|Glassmaker}}
| {{L|Glass furnace}} (or {{L|Magma glass furnace}})
|- style="border-top:1px solid #aaa;vertical-align:top;"
| {{L|Leatherworker}}
| {{L|Leather works}}
|- style="border-top:1px solid #aaa;vertical-align:top;"
| {{L|Mason}}
| {{L|Mason's workshop}}
|- style="border-top:1px solid #aaa;vertical-align:top;"
| {{L|Mechanic}}
| {{L|Mechanic's workshop}}
|- style="border-top:1px solid #aaa;vertical-align:top;"
| {{L|Metal crafter}}
| {{L|Magma forge}} (or {{L|Metalsmith's forge}})
|- style="border-top:1px solid #aaa;vertical-align:top;"
| {{L|Metalsmith}}
| {{L|Magma forge}} (or {{L|Metalsmith's forge}})
|- style="border-top:1px solid #aaa;vertical-align:top;"
| {{L|Miner}}
| {{L|Mason's workshop}}
|- style="border-top:1px solid #aaa;vertical-align:top;"
| {{L|Stone crafter}}
| {{L|Craftsdwarf's workshop}}
|- style="border-top:1px solid #aaa;vertical-align:top;"
| {{L|Tanner}}
| {{L|Leather works}}
|- style="border-top:1px solid #aaa;vertical-align:top;"
| {{L|Weaponsmith}}
| {{L|Magma forge}} (or {{L|Metalsmith's forge}})
|- style="border-top:1px solid #aaa;vertical-align:top;"
| {{L|Weaver}}
| {{L|Clothier's shop}}
|- style="border-top:1px solid #aaa;vertical-align:top;"
| {{L|Wood crafter}}
| {{L|Craftsdwarf's workshop}}
|- style="border-top:1px solid #aaa;vertical-align:top;"
| Anyone Else
| {{L|Craftsdwarf's workshop}}
|}

A dwarf will claim a workshop according to their highest applicable skill, and upon completion of the artifact, gain 20,000 {{L|experience}} in that skill (excepting {{L|Strange mood#Possessed|possessed}} dwarves). This will give the dwarf a legendary-level {{L|skill}} (specifically, "legendary+1" or higher, depending on the dwarf's initial skill level). The table to the right describes all applicable skills and their potential workshop requirements - there are only 20 skills that determine the workshop and that can be affected by a mood (sometimes referred to as '''moodable''' skills.) If a dwarf does not possess at least one of the moodable skills listed to the right, they will take over a {{L|craftsdwarf's workshop}} and gain one of {{L|bone carver}}, {{L|stone crafter}}, or {{L|wood crafter}} skills, producing an artifact {{L|craft}}.

This fact can be utilized to maximize the possibility of getting a dwarf with the specific legendary skill you want: since ''non''-moodable skills are ignored, whenever possible make sure that each dwarf's highest ''moodable'' skill is one of those you want*. Have all your peasants, {{L|farmer}}s, non-professional military and other dwarves without any moodable skills do a tiny bit of work in the skill(s) you most want; if a "{{L|experience|dabbling}}" skill is the highest moodable skill they have, that is the skill that will be used.

:''(* {{L|Armorsmith}}, {{L|Weaponsmith}}, {{L|Metal crafter}} and {{L|Metalsmith}} are possibly the most-desired legendary skills, but much depends on your fortress, your current mix of skills, and your play style.)''

== Artifacts created ==
The type of artifact created will depend on the dwarf's highest skill. Masons and miners will always create some kind of stone furniture; bone carvers, a bone or shell object; carpenters, a wood object, etc. engravers and stone crafters will turn out a stone craft; metalworkers, metal crafts, weapons, or armor (depending on the type of metalworker); weavers, an article of clothing; tanners, a leather armor or object. If a dwarf has no moodable skills, they will take over a {{L|craftsdwarf's workshop}} and create a bone, stone or wood craft of some type. The precise type of craft created is usually somewhat random but if a dwarf has a personality preference for a particular thing, such as gauntlets or floodgates or crowns, and that thing is an available choice given the dwarf's profession, they will generally create an object of that type.

The first object grabbed by the dwarf will be the "primary" substance; all other materials will be used to decorate the artifact. If a dwarf grabs a piece of {{L|chalk}} and makes a statue, for instance, it will be a "chalk statue", but an artifact can potentially be composed of bone, cloth, gems, leather, metal, shell, stone, and wood all at once. In some cases, a moody dwarf will produce an item which normally cannot be made from that material, leading to such odd constructions as an {{L|obsidian}} {{L|bed}}, {{L|ruby}} {{L|floodgate}}, or turtle {{L|shell}} {{L|cage}}.

Once created, most {{L|artifact}}s will be available for use just like a normal item of its type. Artifact furniture is useful for high value {{L|noble}} rooms. Artifact weapons in {{L|weapon trap}}s can also boost a room's value considerably, as in the case of artifact trap components and mechanisms.

Unless the mood was a Possession, the dwarf will gain 20,000 points of {{L|experience}} in the skill used to produce the artifact, enough to boost them to Legendary.

== Failure ==
If you can't provide the desired workshop and all the required component materials within a couple of months, the dwarf will go {{L|insanity|insane}}, which cancels the mood and the artifact. As if that's not bad enough, any dwarf who goes insane will soon die, one way or another.

A dwarf who is '''stark raving mad''' or '''melancholy''' is harmless to others (until they die and start a {{L|tantrum}} spiral), but a '''berserk''' dwarf will attack other dwarves and possibly pull levers at random. You may want to station a squad nearby or assign a few war dogs to the dwarf on the chance that they will lash out. If you build your workshops inside enclosed rooms with doors you can also lock the moody dwarf in the room until he or she starves. In extreme cases, building a wall around an open workshop is the best precaution.

v0.31:Martial trance

2011-11-25T06:47:05Z

I2amroy:

{{quality|Fine|16:45, 30 August 2010 (UTC)}}{{av}}
<br>
[[Image:Champions.png|150px|thumb|right| The aftermath of a dwarf in martial trance. ]]
{{expand Topic}}
<br>
A {{l|creature}} enters '''martial trance''' when it is fighting multiple enemies at once. The trance offers a boost to the creature's abilities - a creature in a martial trance has a significantly increased chance of blocking or parrying an attack, and is more likely to hit their opponent. However, it does not give a direct damage bonus like '''enraged'''. The symbol for a dwarf in a trance is {{Tile|!|2:1}} which will flash over his {{L|Status icons|icon}}.

{{l|Dwarves}} are the only creatures which enter martial trances without {{l|modding}}, the RAW tag which determines this is [TRANCES]. A dwarven adventurer may also enter a martial trance in {{l|Adventurer mode}}. Fresh recruits can, when pressed to fight, go into martial trance as well.

This is also a great way to dispose of {{l|Bogeymen}} in adventurer mode, as you can dodge most of their attacks and most of your attacks will land successfully regardless of the difficulty of the shot.

v0.31:Creature token

2011-11-25T06:46:21Z

I2amroy: /* T */

{{av}}{{Quality|Exceptional}}

A full list of all known creature tokens.

__NOTOC__

<div align="center">
{{alphabetical TOC}}
</div>

==A==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| ADOPTS_OWNER
|
| Tame creature cannot be made available for adoption, instead automatically adopting whoever it wants. It appears that the basic requirements for adoption are intact; for example, the creature is more likely to adopt an owner which likes creatures of that species.{{verify}}

|-
| ALCOHOL_DEPENDENT
|
| Creature needs alcohol to get through the working day.

|-
| ALL_ACTIVE
|
| Sets if the creature is active in day, night, and twilight. Seems to be a separate value from DIURNAL/NOCTURNAL/CREPUSCULAR, rather than implying them.

|-
| ALTTILE
|
| If set, the creature will blink between its [TILE] and its [ALTTILE].

|-
| AMBUSHPREDATOR
|
| Instead of charging relentlessly at prey, a creature with this tag will wait till the prey is within a few squares before charging.{{verify}}

|-
| AMPHIBIOUS
|
| Allows a creature to breathe with or without {{L| water}}. Implies [AQUATIC].

|-
| APP_MOD_DESC_RANGE
|
*Range
| [http://www.bay12forums.com/smf/index.php?topic=60554.msg1766793#msg1766793 Forum post describing how description ranges work]

|-
| APP_MOD_GENETIC_MODEL
|
*Model (Accepts DOMINANT_MORE, DOMINANT_LESS, and MIX)
| Defines a genetic model for the relevant appearance modifier(s). May or may not do anything significant at present.

|-
| APP_MOD_IMPORTANCE
|
*number
| Determines how important the appearance modifier is, for determining whether it shows up in the creature description.{{verify}}

|-
| APP_MOD_NOUN
|
*noun
*SINGULAR or PLURAL
| creates a noun for the appearance and whether it is singular or plural

|-
| APP_MOD_RATE
|
*Rate (integer)
*Scale (DAILY, YEARLY)
*min:max of growth
*start year:start day
*end year:end day
| setting the growth rate of the modifier. The last two tokens can be replaced by NO_END to have growth continue indefinitely.

|-
| APPLY_CREATURE_VARIATION
|
*CV TEMPLATE NAME
| Loads the Creature Variation Template specified.

|-
| APPLY_CURRENT_CREATURE_VARIATION
|
| Applies loaded Creature Variation

|-
| AQUATIC
|
| Allows a creature to breathe underwater, but causes it to "drown" out of {{L|water}}.

|-
| ARENA_RESTRICTED
|
| Does not appear in arena mode list

|-
| ARTIFICIAL_HIVEABLE
|
| Can be kept in artificial hives by beekeepers.

|-
| AT_PEACE_WITH_WILDLIFE
|
| Does not attack or frighten wildlife.

|-
| ATTACK
|
*token
*bodypart
*selection criteria
*location
| Defines the attack name, and the body part used. See [[#Attack Tokens|below]] for valid subtokens
'''Example:'''<br />
[ATTACK:GORE:BODYPART:BY_CATEGORY:HORN]<br />
''GORE'' : name of the attack<br />
''BODYPART:BY_CATEGORY:HORN'' : the horn is used to attack (presuming the creature has one)

|-
| ATTACK_TRIGGER
| pop:exported wealth:created wealth
| Specifies when a {{L|megabeast}} will attack the fortress.

|}

<div align="center">
{{alphabetical TOC}}
</div>

==B==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| BABY
| integer
| Age at which creature is considered a child. Default is zero. One can think of this as the duration of the baby stage.

|-
| BABYNAME
| singular:plural
| Defines a new name for a creature in baby state at the caste level. For non-caste-specific baby names, see GENERAL_BABY_NAME.

|-
| BEACH_FREQUENCY
|
| {{L|Whale}}s and {{L|Sea nettle jellyfish|jellyfish}} have this. Controls the beaching frequency of the creature.

|-
| BENIGN
|
| Determines whether creature can show up on "tame" maps (includes {{L|elephant}}s), which will generally avoid dwarves, although they may chase and/or attack them if they get too close).

|-
| BIOME
|
* {{L|biome token}}
| Select a {{L|Biome}} the creature may appear in.

|-
| BLOOD
|
* {{L|material token}}
*matter state (LIQUID, GAS, SOLID)
| Specifies what the creature's blood is made of.

|-
| BODY
| body parts
| Draws body parts from OBJECT:BODY files (such as body_default.txt)
'''Example:'''<br />
[BODY:BODY_WITH_HEAD_FLAG:HEART:GUTS:BRAIN:MOUTH] <br />
This is the body from a {{L|Purring maggot}}. It creates a body with head, a heart, some guts, a brain, and a mouth. Thats all a maggot needs.

|-
| BODY_APPEARANCE_MODIFIER
|
*ATTRIBUTE
*lowest:lower:low:median:high:higher:highest
| These body modifiers give individual creatures different characteristics. In the case of HEIGHT, BROADNESS and LENGTH, the modifier is also a percentage change to the BODY_SIZE of the individual creature. The seven numbers afterward give a distribution of ranges. Each interval has an equal chance of occurring.
'''Example:'''<br />
[BODY_APPEARANCE_MODIFIER:HEIGHT:90:95:98:100:102:105:110] <br />
''HEIGHT'' : marks the height to be changed <br />
''90:95:98:100:102:105:110'' : sets the range from the shortest (90% of the average height) to the tallest (110% of the average height) creature variation.

|-
| BODY_DETAIL_PLAN
| PlanName, PlanName:type:type:type:etc
| loads a plan listed OBJECT:BODY_DETAIL_PLAN files, such as b_detail_plan_default.txt. Mass applies USE_MATERIAL_TEMPLATE, mass alters RELSIZE, alters body part positions, and will allow tissue layers to be defined. Tissue layers are defined in order of skin to bone here.
'''Example:'''<br />
[BODY_DETAIL_PLAN:VERTEBRATE_TISSUE_LAYERS:SKIN:FAT:MUSCLE:BONE:CARTILAGE] <br />
This creates the detailed body of a {{L|fox}}, the skin, fat, muscle, bones and cartilage out of the vertebrate tissues.<br />
A {{L|Purring maggot|maggot}} would only need:<br />
''[BODY_DETAIL_PLAN:EXOSKELETON_TISSUE_LAYERS:SKIN:FAT:MUSCLE]''

|-
| BODY_SIZE
| years:days:size
| sets up size at a given time. Size is in cubic centimeters (milliliters), and for normal body materials is roughly equal to the creature's average weight in grams.
'''Example:'''<br />
[BODY_SIZE:0:0:10000]<br />
[BODY_SIZE:1:168:50000]<br />
[BODY_SIZE:12:0:220000]<br />
This describes the size of a {{L|minotaur}}. His birth size would be 10000 (10000 mL, ~10 kg). With 1 year and 168 days he would be 50000 tall (~50 kg). As an adult (with 12 years) he would weight roughly 220 kg

|-
| BODYGLOSS
| gloss
| Substitutes body part text with replacement text. Draws gloss information from OBJECT:BODY files (such as body_default.txt)

|-
| BONECARN
|
| Creature 'eats' bones. Eating bones makes their happiness go up, but can cause death (suffocation){{verify}}. Implies CARNIVORE. Civilized creatures (ex. Kobolds) with this tag tend to die out during world generation.

|-
| BP_APPEARANCE_MODIFIER
|
*QUALITY
*lowest:lower:low:median:high:higher:highest
| sets up the breadth of possibilities for appearance qualities for a selected BP group. EG. Eyes (CLOSE_SET, DEEP_SET, ROUND_VS_NARROW, LARGE_IRIS),Lips (THICKNESS), Nose (BROADNESS, LENGTH, UPTURNED, CONVEX), Ear (SPLAYED_OUT, HANGING_LOBES, BROADNESS, HEIGHT), Tooth (GAPS), Skull (HIGH_CHEEKBONES, BROAD_CHIN, JUTTING CHIN, SQUARE_CHIN), Neck (DEEP_VOICE, RASPY_VOICE), Head (BROADNESS, HEIGHT)

|-
| BUILDINGDESTROYER
| 1 or 2
| Allows a creature to destroy furniture and buildings. Value [1] targets mostly doors, hatches, furniture and the like. Value [2] targets anything not made with the b + C commands.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==C==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| CAN_LEARN
|
| The creature gets skills and professions. Note that this token makes the creature unable to be butchered by an adventurer so it is not recommended for uncivilized monsters. Adventurers lacking this token can allocate but not increase attributes and skills. skills allocated will disappear on start.

|-
| CAN_SPEAK
|
| Can talk. Note that it is not necessary for a creature to gain social skills. If a member of a civilization (such as a pet) has this token, it'll need to eat and drink.{{verify}}

|-
| CANNOT_UNDEAD
|
| Cannot be turned into a zombie or skeletal undead. Also prevents ghosts of that creature appearing.

|-
| CANOPENDOORS
|
| Allows the creature to open doors.

|-
| CARNIVORE
|
| Creature ''only'' eats meat. Note that carnivorous species will not be able to survive worldgen if they do not also have NO_EAT.

|-
| CASTE
|
*name
| defines a caste

|-
| CASTE_ALTTILE
|
*tile number or "letter"
| Caste-specific alternate tile. Expects CASTE_TILE

|-
| CASTE_COLOR
|
*fg
*bg
*brightness
| Creature tile color of the caste.

|-
| CASTE_GLOWCOLOR
|
*fg
*bg
*brightness
| GLOWTILE color of the caste.

|-
| CASTE_GLOWTILE
|
*tile value or "letter"
| Caste-specific glowtile

|-
| CASTE_NAME
| singular:plural:adjective
| The name of the caste of the creature in the game.

|-
| CASTE_PROFESSION_NAME
|
*Profession
*singular
*plural
| alters the name of the given profession, caste-specific

|-
| CASTE_SOLDIER_ALTTILE
| 'character' or tile number
| Creatures of this caste active in their civilization's military will blink between their default tile and this one.

|-
| CASTE_SOLDIER_TILE
| 'character' or tile number
| Creatures of this caste active in their civilization's military will use this tile instead.

|-
| CASTE_SPEECH
| speech file?
| Possibly a caste-specific instance of the SPEECH token

|-
| CASTE_TILE
|
* tile number or "letter"
| Caste-specific creature tile.

|-
| CAVE_ADAPT
|
| Gives the creature a bonus in caves. Also causes [[Cave adaptation]].

|-
| CHANGE_BODY_SIZE_PERC
|
|

|-
| CHILD
| integer
| age at which creature is considered an adult. One can think of this as the duration of the child stage. Without this token, a creature will not reproduce in Fortress mode.

|-
| CHILDNAME
| singular:plural
| Defines a new name for a creature in child state at the caste level. For non-caste-specific child names, see GENERAL_CHILD_NAME.

|-
| CLUSTER_NUMBER
|
*min
*max
| The minimum/maximum numbers of how many creatures per spawned cluster. Certain vermin fish use this token in combination with temperate ocean and river biome tokens to perform seasonal migrations.
e.g. [CLUSTER_NUMBER:1:3]

|-
|CLUTCH_SIZE
|
*min
*max
|Number of eggs laid in one sitting.

|-
| COLONY_EXTERNAL
|
| Caste hovers around colony.

|-
| COLOR
| foreground:background:brightness
| Color of the creature's tile.

|-
| COMMON_DOMESTIC
|
| Allows the creature to be brought with immigrants and when creating a new fortress, as long as the creature also includes at least one of the following tokens: PET, PACK_ANIMAL, WAGON_PULLER, MOUNT. In addition, the creature must be NATURAL rather than FANCIFUL

|-
| CONVERTED_SPOUSE
|
| Found only at caste level. Creatures of this caste's species with the SPOUSE_CONVERTER and NIGHT_CREATURE_HUNTER tokens will kidnap SPOUSE_CONVERSION_TARGETs of an appropriate sex and convert them into castes with CONVERTED_SPOUSE.

|-
| COOKABLE_LIVE
|
| Set this to allow the creature to be cooked in meals without first being butchered / fishcleaned.

|-
| COPY_TAGS_FROM
|
*CREATURE NAME
| Copies tags from another specified creature.

|-
| CREATURE_CLASS
|
*classname
| Creature class. Can be anything, but only existing use is GENERAL_POISON. Appears to only be used for Syndromes. Supposedly can also be used for entity positions.

|-
| CREATURE_SOLDIER_TILE
| 'character' or tile number
| Creatures active in their civilization's military will use this tile instead.

|-
| CREATURE_TILE
| 'character' or tile number
| The symbol of the creature in ASCII mode.

|-
| CREPUSCULAR
|
| Sets if the creature is active at twilight.

|-
| CURIOUSBEAST_EATER
|
| Allows a creature to steal and eat edible items from a site.

|-
| CURIOUSBEAST_GUZZLER
|
| Allows a creature to (very quickly) drink your alcohol. Or spill the barrel to the ground. Also affects undead versions of the creature.

|-
| CURIOUSBEAST_ITEM
|
| Allows a creature to steal things (apparently the highest value it can find). Semimegabeast thievery is in Legends mode. Lightweight creatures can probably steal heavy items.

|-
| CV_ADD_TAG
|
*TAG NAME
| Adds a tag. Used in conjunction with creature variation templates.

|-
| CV_REMOVE_TAG
|
*TAG NAME
| Removes a tag. Used in conjunction with creature variation templates.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==D==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| DEMON
|
| Found on generated {{L|demon}}s; sets the creature as potential {{L|hell}} spawn

|-
| DESCRIPTION
| text
| A brief description of the creature type.

|-
| DIE_WHEN_VERMIN_BITE
|
| Dies upon attacking. Used for bee stings.

|-
| DIFFICULTY
| integer
| Toady: "Difficulty determines how deep it places them in adventure mode/reclaim caves, and the chance that they are wounded the first few river attacks." Also increases experience gain during adventure mode.

|-
| DIURNAL
|
| Sets if the creature is active in day.

|-
| DOES_NOT_EXIST
|
| Creature does not actually exist; used for fanciful creatures.

|-
| DRAGONFIREBREATH
|
| Creature breathes fire in a cone.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==E==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| EGG_MATERIAL
|
* {{L|material token}}
*state (SOLID, LIQUID, or GAS)
| Egg material. Egg-laying creatures will define this 3 times, using LOCAL_CREATURE_MAT:EGGSHELL, LOCAL_CREATURE_MAT:EGG_WHITE, and then LOCAL_CREATURE_MAT:EGG_YOLK. Eggs will be made out of eggshell. Edibility is determined by tags on whites or yolk, but they otherwise do not exist.

|-
| EGG_SIZE
|
*size
| Determines how long it takes for eggs to hatch{{verify}}. The larger the number, the longer it takes.

|-
| EQUIPMENT_WAGON
|
| Makes the creature into a large 3x3 creature responsible for carrying trade goods, pulled by two [WAGON_PULLER]s and driven by a merchant.

|-
| EQUIPS
|
| Allows the creature to wear or wield items.

|-
| EVIL
|
| Creature is considered evil and will only show up in evil biomes. Has no effect on cavern creatures.

|-
| EXTRACT
|
* {{L|material token}}
| Defines a creature extract which can be obtained via {{L|small animal dissection}}.

|-
| EXTRAVISION
|
| Creature can see regardless of whether it has working eyes.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==F==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| FANCIFUL
|
| Makes every civilization know about the creature. The creature won't occur in regular material preference lists. The tag also adds some art value modifiers. Used for things like dragons and other legendary creatures. Conflicts with [COMMON_DOMESTIC]

|-
| FEATURE_ATTACK_GROUP
|
| Found on subterranean animalmen.

|-
| FEATURE_BEAST
|
| Found on {{L|forgotten beast}}s.

|-
| FEMALE
|
| Inside a female caste, sets femaleness. Outside of a caste, sets all individuals female unless overridden by caste.

|-
| FIREBREATH
|
| The creature breathes long range fireballs and has a short range cone shaped fire breath attack.

|-
| FIREIMMUNE
|
| Renders a creature immune to being damaged by FIREBREATH's short range cone attack.

|-
| FIREIMMUNE_SUPER
|
| The creature is immune to DRAGONFIREBREATH. Implies FIREIMMUNE.

|-
| FISHITEM
|
| Needs to be cleaned at a fishery

|-
| FIXED_TEMP
| temperature
| The natural heat generated by the creature.

|-
| FLEEQUICK
|
| Determines how soon a creature flees in a losing battle. Creatures with this tag will flee at the first sign of resistance.

|-
| FLIER
|
| Allows a creature to fly. Fortress Mode pathfinding only partially incorporates pathfinding - flying dwarves need a land path to exist between them and an area in order to access it, but as long as one such path exists, they do not need to use it, instead being able to fly over intervening obstacles.

|-
| FREQUENCY
|
*number, max 100
| Determines the time between creature spawns in Fortress Mode. Higher is more occurrences per time unit. Creatures without a frequency statement default to 50. Almost all others have either [FREQUENCY:5] or [FREQUENCY:100]. Not to be confused with POP_RATIO
|}

<div align="center">
{{alphabetical TOC}}
</div>

==G==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| GENERAL_BABY_NAME
| singular:plural
| name at creature level

|-
| GENERAL_CHILD_NAME
| singular:plural
| name at creature level

|-
| GENERATED
|
| Found on procedurally generated creatures like {{L|Forgotten beast}}s, (biome name) {{L|titan}}s, {{L|Demon}}s, and {{L|night creature}}s.

|-
| GETS_INFECTIONS_FROM_ROT
|
| Creature can get infections from necrotic tissue.

|-
| GETS_WOUND_INFECTIONS
|
| Creature's wounds can become infected.

|-
| GLOWCOLOR
|
*foreground
*background
*brightness
| The colour of the GLOWTILE of the creature.

|-
| GLOWTILE
| ascii character
| If present, the being glows in the dark (generally used for Adventure Mode). The tile is what replaces the being's current tile when it is obscured from your sight by darkness. The default setting for kobolds (a yellow quotation mark) provides a nice "glowing eyes" effect. The game is also hardcoded to automatically convert quotation mark GLOWTILES into apostrophes if the creature has lost one eye. This works at the generic creature level - for caste-specific glow tiles, use CASTE_GLOWTILE instead.

|-
| GNAWER
| verb (gnawed)
| The creature chews on food barrels and bags.

|-
| GO_TO_END
|
| When using tags from an existing creature, inserts new tags at the end of the creature.

|-
| GO_TO_START
|
| When using tags from an existing creature, inserts new tags at the beginning of the creature.

|-
| GO_TO_TAG
|
| When using tags from an existing creature, inserts new tags after the specified tag.

|-
| GOOD
|
| Determines whether creature can show up on "good" areas. Eg. unicorn.

|-
| GRASSTRAMPLE
| value
| The value determines how rapidly grass is trampled when a creature steps on it - a value of 0 causes the creature to never damage grass, while a value of 100 causes grass to be trampled as rapidly as possible. Defaults to 5.

|-
| GRAVITATE_BODY_SIZE
| target value
| Used in Creature Variants. This token changes the adult body size to the average of the old adult body size and the target value and scales all intermediate growth stages by the same factor.

|-
| GRAZER
|
*number
| Animals is a grazer. The higher the number, the less frequently it needs to eat in order to survive.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==H==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| HABIT
| type:probability
| Defines certain behaviors for the creature. The habit types are COLLECT_TROPHIES, COOK_PEOPLE, COOK_VERMIN, GRIND_VERMIN, COOK_BLOOD, GRIND_BONE_MEAL, EAT_BONE_PORRIDGE, USE_ANY_MELEE_WEAPON, GIANT_NEST, and COLLECT_WEALTH. These may require the creature to have a lair to work properly.

|-
| HABIT_NUM
| number or TEST_ALL
| "If you set HABIT_NUM to a number, it should give you that exact number of habits according to the weights.".<sup>[[http://www.bay12forums.com/smf/index.php?topic=60554.msg1719248#msg1719248 source post]]</sup> All lists of HABITs are preceded by [HABIT_NUM:TEST_ALL]

|-
| HAS_NERVES
|
| This makes the creature susceptible to severed motor and sensory nerves when muscles are torn in limb, grasp and stance parts. Some butchering yields nervous tissue.

|-
| HASSHELL
|
| The creature has a shell. Seemingly no longer used - holdover from previous versions.

|-
| HIVE_PRODUCT
|
*number
*{{L|time}}
*{{L|item token}}s
| What product is harvested from {{L|Beekeeping industry|beekeeping}}.

|-
| HOMEOTHERM
|
| Default 'NONE'. The creature's normal body {{L|temperature}}

|-
| HUNTS_VERMIN
|
| Creature hunts and kills nearby vermin.

|}

<div align="center">
{{alphabetical TOC}}
</div>

==I==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| IMMOBILE_LAND
|
| The creature is immobile while on land. Only works on AQUATIC creatures which can't breath on land.

|-
| IMMOLATE
|
| Will ignite, and potentially completely destroy, items the creature is standing on. Keep booze away from critters with this tag.

|-
| INTELLIGENT
|
| Implies CAN_SPEAK and CAN_LEARN. CAN_LEARN probably means the creature gets skills - including social skills - and professions. Not recommended for uncivilized monsters.

|-
| ITEMCORPSE
|
* {{L|item token}}:subtype
* {{L|material token}}
| Determines if the creature leaves behind a non-standard corpse (i.e. wood, statue, bars, ash from ghost etc).

|-
| ITEMCORPSE_QUALITY
|
| The quality of an item-type corpse left behind; 5 is masterpiece-level.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==L==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| LAIR
| type:probability
| Found on megabeasts, semimegabeasts, and night creatues. The creature will seek out sites of this type and take them as lairs. The lair types are SIMPLE_BURROW, SIMPLE_MOUND, WILDERNESS_LOCATION, SHRINE, and LABYRINTH.

|-
| LAIR_CHARACTERISTIC
| characteristic:probability
| Defines certain features of the creature's lair. The only valid characteristic is HAS_DOORS.

|-
| LAIR_HUNTER
|
| This creature will actively hunt adventurers in its lair.

|-
| LAIR_HUNTER_SPEECH
| speech file
| What this creature says while hunting adventurers in its lair.

|-
| LARGE_PREDATOR
|
| Will attack things that are smaller than it (like dwarves). Only one group of "large predators" will appear on any given map (possibly two groups on "savage" maps). In adventure mode, large predators will try to ambush and attack you (and your party will attack them back). Also, they can be mentioned in the intro paragraph when starting a fortress e.g. "ere the wolves get hungry."

|-
| LARGE_ROAMING
|
| In Fortress Mode, spawns outdoors and is not a vermin creature.

|-
| LAYS_EGGS
|
| Creature lays eggs instead of giving birth to live young.

|-
| LAYS_UNUSUAL_EGGS
|
* {{L|item token}}
* {{L|material token}}
| Creature lays a particular item instead of regular eggs.

|-
| LIGAMENTS
|
* {{L|material token}}
*healing rate
| Defines the material and healing rate of ligaments.

|-
| LIGHT_GEN
|
| The creature will generate light, such as in adventurer mode at night.

|-
| LIKES_FIGHTING
|
| The creature will attack enemies rather than flee from them. This tag has the same effect on player-controlled creatures - included modded dwarves.

|-
| LISP
|
| Creature uses "sssssnake talk" (multiplies 'S' when talking - "My name isss Recisssiz.")

|-
| LITTERSIZE
|
* minumum
* maximum
| Determines the random chance of how many creatures are generated when giving birth. [LITTERSIZE:1:2]

|-
| LOCKPICKER
|
| Lets a creature open doors that are set to forbidden in Fortress Mode.

|-
| LOOSE_CLUSTERS
|
| The creatures will scatter if they have this tag, or form tight packs if they don't.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==M==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| MAGICAL
|
| Unknown.

|-
| MAGMA_VISION
|
| Creature's able to see while covered in magma.

|-
| MALE
|
| The species or caste is all male.

|-
| MANNERISM_??
|
*occasionally body part
| Adds a possible mannerism to the creature's profile.
Refer to {{L|Creature mannerism token}}s

|-
| MATERIAL
|
*material id
| Begins defining a new material.{{verify}}

|-
| MATERIAL_BREATH_ATTACK
|
* {{L|material token}}
* breath attack type (TRAILING_DUST_FLOW, TRAILING_VAPOR_FLOW, TRAILING_GAS_FLOW, SOLID_GLOB, LIQUID_GLOB, UNDIRECTED_GAS, UNDIRECTED_VAPOR, UNDIRECTED_DUST)
| Creates an attack referencing a material, using a given type of breath attack.

|-
| MATUTINAL
|
| Sets if the creature is active in dawn.

|-
| MAXAGE
| min:max
| Range of time in years in which death from old age may occur. Once a creature reaches the min value, it has a random chance each season of dying from old age. Unknown if the chance increases with further age.

|-
| MEANDERER
|
| Gives a creature random movement.

|-
| MEGABEAST
|
| Appears on fortress territory in Fortress Mode occasionally. Can also be worshipped.

|-
|MENT_ATT_CAP_PERC
|
*ATTRIBUTE Token
*Cap %
|Default is 200. This means you can increase your attribute to 200% of its starting value (or the average value + your starting value if that is higher).

|-
| MENT_ATT_RANGE
|
*ATTRIBUTE
*lowest:lower:low:median:high:higher:highest
| Sets up a mental attribute's range of values (0-5000). All mental attribute ranges default to 200:800:900:1000:1100:1300:2000.

|-
| MENT_ATT_RATES
|
*ATTRIBUTE Token
*cost to improve
*unused counter rate
*rust counter rate
*demotion counter rate
| Mental attribute gain/decay rates. Defaults are 500:4:5:4.

|-
| MILKABLE
|
* {{L|material token}}
* frequency
| Allows the creature to be milked.

|-
| MISCHIEVIOUS
|
| Will pull any levers it comes across. Also makes creature spawn invisible and with several ranks in Ambusher. "They go on little missions to mess with various fortress buildings, not just levers."

|-
| MODVALUE
|
| Seemingly no longer used - holdover from previous versions.

|-
| MOUNT
|
| Creature may be used as a mount.

|-
| MOUNT_EXOTIC
|
| You need the Dungeon master noble to mount the creature.

|-
| MULTIPLE_LITTER_RARE
|
| Makes litters with more than one offspring rare.

|-
| MULTIPLY_VALUE
|
*Multiplier
| Multiplies value of materials.

|-
| MUNDANE
|
| Marks if the creature is an actual real-life creature. Only used for age-names at present, and determining whether a creature will attack creatures with the AT_PEACE_WITH_WILDLIFE token.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==N==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| NAME
| singular:plural:adjective
| The generic name for any creature of this type - will be used when distinctions between caste are unimportant. For names for specific castes, use CASTE_NAME instead.

|-
| NATURAL
|
| Animal is considered to be natural.

|-
| NATURAL_SKILL
| skill:value
| The creature possesses this skill at this level inherently. It begins with this skill at this level, and the skill may never rust below this level. Requires CAN_LEARN or INTELLIGENT to function (changed in .25 or earlier that CAN_LEARN is no longer required).

|-
| NIGHT_CREATURE_BOGEYMAN
|
| Found on bogeymen. Creatures with this tag will join other bogeymen in attacking adventurers at night, and will also adopt their other behaviors, such as vanishing in smoke upon being killed. Setting the number of night creatures to zero in the world gen parameters will remove only the randomly-generated bogeymen.

|-
| NIGHT_CREATURE_HUNTER
|
| If this creature has SPOUSE_CONVERTER, it will actively attempt to seek out potential conversion targets, abduct them, and convert them. Night creatures will seek out one SPOUSE_CONVERSION_TARGET <s>of the opposite sex</s>(seems to choose anyone of any sex of the caste/s that have the CONVERTED_SPOUSE tag), convert them, and then have children with them(if possible). NIGHT_CREATURE_HUNTERs without SPOUSE_CONVERTER will not be placed. Setting the number of night creatures to zero in the world gen parameters will remove only the randomly-generated night creatures.

|-
| NO_AUTUMN
|
| does not appear this season.

|-
| NO_DIZZINESS
|
| Creature cannot become dizzy

|-
| NO_DRINK
|
| Creature does not need to drink.

|-
| NO_EAT
|
| Creature does not need to eat.

|-
| NO_FEVERS
|
| Creature cannot suffer fevers

|-
| NO_GENDER
|
| Creature has no gender.

|-
| NO_SLEEP
|
| Creature does not need to sleep.

|-
| NO_SPRING
|
| does not appear this season.

|-
| NO_SUMMER
|
| does not appear this season.

|-
| NO_THOUGHT_CENTER_FOR_MOVEMENT
|
| Creatures doesn't require an organ with the [THOUGHT] tag to survive; generally used on creatures that don't have brains.

|-
| NO_WINTER
|
| does not appear this season.

|-
| NOBONES
|
| Creature has no bones.

|-
| NOBREATHE
|
| Creature doesn't need to breathe or have [BREATHE] parts in body. Cannot drown or be strangled.

|-
| NOCTURNAL
|
| Sets if the creature is active in night.

|-
| NOEMOTION
|
| The creature has no emotions, and does not rage.

|-
| NOEXERT
|
| Creature can't become tired or over-exerted.

|-
| NOFEAR
|
| Creature doesn't feel fear and will never run away from battle.

|-
| NOMEAT
|
| Creature will not drop meat on butcher.

|-
| NONAUSEA
|
| Creature can't vomit.

|-
| NOPAIN
|
| Creature doesn't feel pain.

|-
| NOSKIN
|
| Creature will not drop skin on butcher.

|-
| NOSKULL
|
| Creature will not drop skull on butcher, rot, or decay of severed head.

|-
| NOSMELLYROT
|
| Does not produce miasma when rotting

|-
| NOSTUCKINS
|
| Weapons can't be stuck in creature.

|-
| NOSTUN
|
| Creature can't be stunned. Creatures with this tag never wake up from sleep in Fortress Mode and stay drowsy. If this creature must eat and drink while playing, it WILL die.

|-
| NOT_BUTCHERABLE
|
| Cannot be butchered

|-
| NOTHOUGHT
|
| Creature doesn't think, or doesn't require a [BRAIN] body part.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==P==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| PACK_ANIMAL
|
| Allows the creature to be used as a pack animal. Currently only used by merchants.

|-
| PARALYZEIMMUNE
|
| The creature is immune to all paralyzing special attacks.

|-
| PATTERNFLIER
|
|

|-
| PEARL
|
| Creature will generate pearls.

|-
| PENETRATEPOWER
| value
| Controls the ability of vermin to find a way into containers when they are eating food from your stockpiles. Wood and cloth objects roll a 0-9 and if it's greater than the penetrate power, their contents escape for the time being. Other objects roll a 0-99.

|-
| PERSONALITY
|
*ATTRIBUTE
*lowest:median:highest
| Determines the range and chance of personality traits. Standard is 0:50:100. See [[DF2010:Personality_trait|Personality traits]] for more info.

|-
| PET
|
| Allows the creature to be tamed. Also allows all females of the species to breed regardless of marital status.

|-
| PET_EXOTIC
|
| You need a Dungeon master noble in your fortress for the creature to be tamable (but any Animal trainer can do the taming).

|-
| PETVALUE
| value
| How valuable a tamed animal/pet is. Actual cost in points in the embarking screen is (PETVALUE/2)+1 for an untrained animal, PETVALUE+1 for a trained(War or Hunting) one. Note that for an animal to be selectable in this screen, it must have the COMMON_DOMESTIC token.

|-
| PETVALUE_DIVISOR
| value
| Divides the creature's PETVALUE by the specified number. Used for bees to prevent a single hive from being worth a fortune.

|-
|PHYS_ATT_CAP_PERC
|
*ATTRIBUTE Token
*Cap %
|Default is 200. This means you can increase your attribute to 200% of its starting value (or the average value + your starting value if that is higher).

|-
| PHYS_ATT_RANGE
|
*ATTRIBUTE
*lowest:lower:low:median:high:higher:highest
| Sets up a physical attribute's range of values (0-5000). All physical attribute ranges default to 200:700:900:1000:1100:1300:2000.

|-
| PHYS_ATT_RATES
|
*ATTRIBUTE Token
*cost to improve
*unused counter rate
*rust counter rate
*demotion counter rate
| Physical attribute gain/decay rates. Defaults for STRENGTH, AGILITY, TOUGHNESS, and ENDURANCE are 500:3:4:3, while RECUPERATION and DISEASE_RESISTANCE default to 500:NONE:NONE:NONE.

|-
| PLUS_BP_GROUP
|
*BY_TYPE, BY_CATEGORY, or BY_TOKEN
*body type, category, or token
| Adds a body part group to selected body part group. Presumably used immediately after SET_BP_GROUP.

|-
| PLUS_MATERIAL
|
*material
| Adds a material to selected materials. Used immediately after SELECT_MATERIAL.

|-
| POP_RATIO
|
| Weighted population of caste; Lower is rarer. Not to be confused with FREQUENCY.

|-
| POPULATION_NUMBER
| min:max
| old guess: "The minimum/maximum numbers of how many of these creatures can show up on a map per year."<br>Toady: "Pop number is the number per square of the region, I think."

|-
| POWER
|
|Allows the being to represent itself as a deity. Requires CAN_SPEAK to actually do anything more than settle at a location.

|-
| PREFSTRING
| string
| Sets what other creatures like about this creature. "Urist likes dwarves for their beards." Multiple entries will be chosen from at random

|-
| PROFESSION_NAME
|
*Profession
*singular
*plural
| The generic name for members of this profession, at the creature level. In order to give members of specific castes different names for professions, use CASTE_PROFESSION_NAME instead.

|-
| PRONE_TO_RAGE
| number
| Untested effect, though it clearly affects how likely a creature is to become enraged. Number may be percentage chance of becoming enraged during combat. As described in file_changes.txt, creatures with this token "follow its normal behavior, but flip out on occasion, higher rate = more flipping out".

|-
| PUS
|
* {{L|material token}}
*matter state (LIQUID, GAS, SOLID)
| Specifies what the creature's wounds will ooze when infected.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==R==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| RELSIZE
|
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*body category, type, or token
*Relsize
| Specifies a new relative size for a part than what is stated in the body plan. For example, Dwarves have larger livers.

|-
| REMAINS
| singular:plural
| What creature's remains are called.

|-
| REMAINS_COLOR
|
| What color creature's remains are.

|-
| REMAINS_ON_VERMIN_BITE_DEATH
|
| Leaves remains when its attack causes it to die? Seems to go with DIE_WHEN_VERMIN_BITE.

|-
| REMAINS_UNDETERMINED
|
| Unknown.

|-
| REMOVE_MATERIAL
|
*material token
| Removes a material from a creature.

|-
| REMOVE_TISSUE
|
*material token
| Removes a tissue from a creature.

|-
| RETURNS_VERMIN_KILLS_TO_OWNER
|
| Used with HUNTS_VERMIN, causes the creature to return killed vermin to its owner.

|}

<div align="center">
{{alphabetical TOC}}
</div>

==S==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| SAVAGE
|
| Allows creature to show up on (and limits it to) "savage" maps.

|-
| SECRETION
|
* {{L|material token}}
*Material State
*location secreted from (by_type, by_category, by_token)
*body part
*tissue layer
| creates a secreted material on given tissue on a given part of the body.

|-
| SELECT_ADDITIONAL_CASTE
|
*caste name
| adds an additional previously defined caste to the selection. Used immediately after SELECT_CASTE.

|-
| SELECT_CASTE
|
*caste name, or ALL
| selects a previously defined caste

|-
| SELECT_MATERIAL
|
*Material token
| Selects a locally defined material. Can be ALL.

|-
| SEMIMEGABEAST
|
| Appears as boss creature in quests. Makes history by rampaging around towns. Possibly inhabits non-mountain caves.

|-
| SET_BP_GROUP
|
*selection criteria BY_TYPE, BY_CATEGORY, BY_TOKEN
*category, type, or token
| Begins a selection of body parts.

|-
| SET_TL_GROUP
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
*tissue
| begins a selection of tissue layers

|-
| SHEARABLE_TISSUE_LAYER
|
* tissue modifier
* required value
| Tissue layer can be sheared for its component material. The specified modifier must be at least of the desired value for shearing to be possible (a llama's wool must have a LENGTH of 300 before it is shearable).

|-
| SKILL_LEARN_RATE
| {{L|skill_token}}:percentage
| The rate at which this creature learns this skill. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SKILL_LEARN_RATES
| percentage
| The rate at which this creature learns all skills. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SKILL_RATE
| {{L|skill_token}}:percentage:value:value:value
| As SKILL_RATES for individual skills. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SKILL_RATES
|
*% of improvement points you get
*unused counter rate
*rust counter rate
*demotion counter rate
| Affects skill gain and decay. Lower numbers in the last three slots make decay occur faster ([SKILL_RATES:100:1:1:1] would cause rapid decay). The counter rates may also be replaced with NONE.
Default is [SKILL_RATES:100:8:16:16]. [SLOW_LEARNER] changes the 100 to a 50. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SKILL_RUST_RATE
| {{L|skill_token}}:value:value:value
| The rate at which this skill decays. Lower values cause the skill to decay faster. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SKILL_RUST_RATES
| value:value:value
| The rate at which all skills decay. Lower values cause the skills to decay faster. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SLOW_LEARNER
|
| Similar to [CAN_LEARN], but slower; skills are gained at a fraction of the rate. Present in the entries for ogres and giants; can be applied to civ or player races.

|-
| SMALL_REMAINS
|
| If a creature has this token, it'll leave "remains" instead of a corpse.

|-
| SOLDIER_ALTTILE
| 'character' or tile number
| If this creature is active in its civilization's military, it will blink between its default tile and this one.

|-
| SOUND
|
* Sound application (currently accepts ALERT or PEACEFUL_INTERMITTENT)
* Sound range (in tiles)
* Sound delay (lower values = sound is produced more often)
* VOCALIZATION or NONE (determines whether the sound requires breathing or not)
* First-person description
* Third-person description
* Description when out of sight
| Creature makes sounds periodically, which can be heard in Adventure mode.

|-
| SPECIFIC_FOOD
|
* PLANT or CREATURE
* Plant/creature ID
| Indicates that the creature is only capable of eating a particular type of food.

|-
| SPEECH
| speech file
| Boasting speeches relating to killing this creature. Examples include dwarf.txt and elf.txt in data\speech.

|-
| SPEECH_FEMALE
| speech file
| Boasting speeches relating to killing females of this creature.

|-
| SPEECH_MALE
| speech file
| Boasting speeches relating to killing males of this creature.

|-
| SPEED
| value
| Sets the creatures' movement and work speed, 1000/[100 + SPEED X] is the resulting effect on creatures movement and work rates from default. See {{L|Speed}} for more information.

|-
| SPHERE
|
*sphere name
| Sets what religious spheres the creature is aligned to, for purposes of being worshipped via the [POWER] token. Also affects the layout of hidden fun stuff, and the creature's name.

|-
| SPOUSE_CONVERSION_TARGET
|
| This creature can be converted by a night creature with SPOUSE_CONVERTED.

|-
| SPOUSE_CONVERTER
|
| Enables the creature to convert SPOUSE_CONVERSION_TARGETs into CONVERTED_SPOUSE castes of its species. The creature won't actually actively do this unless it also has NIGHT_CREATURE_HUNTER, however.

|-
| SWIM_SPEED
|
*speed
| How fast the creature swims. Typically 2500 (0.38 times the default speed).

|-
| SWIMS_INNATE
|
| The creature naturally knows how to swim, as opposed to [SWIMS_LEARNED] below. Currently, an AI bug prevents this from being useful on PC races in fortress mode.

|-
| SWIMS_LEARNED
|
| The creature doesn't know how to swim unless it has learned the skill. Requires [CAN_LEARN], obviously.

|}

<div align="center">
{{alphabetical TOC}}
</div>

==T==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| TENDONS
|
* {{L|material token}}
*healing rate
| Defines the material and healing rate of tendons.

|-
| THICKWEB
|
| The creature's webs can catch larger creatures.

|-
| TISSUE
| name
| Begins defining a tissue in the creature file.

|-
| TITAN
|
| Found on {{L|titan}}s.

|-
| TL_COLOR_MODIFIER
| COLOR:freq:COLOR:freq etc
| Creates a list of color patterns, giving each a frequency.

|-
| TLCM_GENETIC_MODEL
|
| tissue layer color modifier is passed to offspring genetically?

|-
| TLCM_IMPORTANCE
|
*number
| Presumably modifies the importance of the tissue layer color modifier, for description purposes.
HOWEVER using this appears to remove all mention of colour from creature descriptions. It does not appear in any default creatures.

|-
| TLCM_NOUN
|
*name
*SINGULAR or PLURAL
| names the tissue layer color modifier, and determines the noun

|-
| TLCM_TIMING
|
*ROOT
*start change window years:days:end change window years:days
| determines the point in the creature's life where the color change begins

|-
| TRADE_CAPACITY
|
| How much the creature can carry when used by merchants.

|-
| TRAINABLE
|
| Implies both [TRAINABLE_HUNTING] and [TRAINABLE_WAR].

|-
| TRAINABLE_HUNTING
|
| Can be trained as hunting beasts by way of kennels.

|-
| TRAINABLE_WAR
|
| Can be trained as war beasts by way of kennels.

|-
| TRANCES
|
| Allows the creature to go into martial trances.

|-
| TRAPAVOID
|
| The creature is immune to traps. Probably every procedurally generated megabeast has this.

|-
| TRIGGERABLE_GROUP
| min:max
| A large swarm of vermin can be disturbed, usually in Adventure mode.{{verify}}

|-
| TSU_NOUN
|
*noun
*SINGULAR or PLURAL
| Noun for the TISSUE_STYLE_UNIT, used in the description of the tissue layer's style.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==U==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| UBIQUITOUS
|
| Creature will occur in every region with the correct biome. Does not apply to evil/good tags.

|-
| UNDERGROUND_DEPTH
|
*mindepth
*maxdepth
| Depth the creature appears underground. Numbers can be from 1 to 5. Only magma creatures use 4 or 5 in the default raws. A single argument may be used instead of min and max. Dwarven civilizations will only export (via the embark screen or caravans) things that available at depth 1.

|-
| UNDERSWIM
|
| Creature swims under the water and can't be seen. Currently appears to have no effect as of 31.25.

|-
| UNIQUE_DEMON
|
| Typically found on generated {{L|demon}}s; causes the game to create a single named instance of the demon which will emerge from the underworld and take over civilizations during worldgen. Cannot be used for modder-defined creatures.

|-
| USE_CASTE
|
*new caste token
*old caste token
| Defines a new caste derived directly from a previous caste. The new caste inherits all properties of the old one. The effect of this tag is automatic if one has not yet defined any castes: "Any caste-level tag that occurs before castes are explicitly declared is saved up and placed on any caste that is declared later, unless the caste is explicitly derived from another caste."

|-
| USE_MATERIAL
|
*new material ID
*old material ID
| Defines a new local creature material and populates it with all properties defined in the specified local creature material.

|-
| USE_MATERIAL_TEMPLATE
|
*new material token
*material template
| Defines a new local creature material and populates it with all properties defined in the specified template.

|-
| USE_TISSUE
|
*new tissue token
*old tissue id
| Defines a new local creature tissue and populates it with all properties defined in the local tissue specified in the second argument.

|-
| USE_TISSUE_TEMPLATE
|
*new tissue token
*tissue template
| Loads a tissue template listed in OBJECT:TISSUE_TEMPLATE files, such as tissue_template_default.txt.

|-
| UTTERANCES
|
| Changes the language of the creature into an unintelligible mess.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==V==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| VEGETATION
|
| unknown

|-
| VERMIN_BITE
|
*chance of occurance{{verify}}
*verb (bitten, stung, etc)
* {{L|material token}}
| Vermin bites, and injects something.

|-
| VERMIN_EATER
|
| The vermin creature will attempt to eat exposed food. See PENETRATEPOWER. Distict from VERMIN_ROTTER.

|-
| VERMIN_FISH
|
| The vermin appears in water and will attempt to swim around.

|-
| VERMIN_GROUNDER
|
| The creature appears in "general" surface ground locations. Note that this doesn't stop the creature from flying if it can (most vermin birds have this tag).

|-
| VERMIN_HATEABLE
|
| Some dwarves will hate the creature and get unhappy thoughts when around it.

|-
| VERMIN_MICRO
|
| This makes the creature move in a swarm of creatures of the same race as it. I.E. Swarm of flies, swarm of ants, etc.

|-
| VERMIN_NOFISH
|
| The creature cannot be caught by fishing.

|-
| VERMIN_NOROAM
|
| The creature will not be observed randomly roaming about the map.

|-
| VERMIN_NOTRAP
|
| The creature cannot be caught in baited animal traps; however, a "catch live land animal" task may still be able to capture one if a dwarf finds one roaming around.

|-
| VERMIN_ROTTER
|
| Present on flies, knuckle worms, acorn flies, and blood gnats. Probably means either the creature is attracted to rot, the creature speeds rotting, or both.

|-
| VERMIN_SOIL
|
| The creature randomly appears near dirt or mud.

|-
| VERMIN_SOIL_COLONY
|
| The vermin will appear in a single tile cluster of many vermin, such as a colony of ants.

|-
| VERMINHUNTER
|
| Implies AT_PEACE_WITH_WILDLIFE, RETURNS_VERMIN_KILLS_TO_OWNER, HUNTS_VERMIN, and ADOPTS_OWNER.

|-
| VESPERTINE
|
| Sets if the creature is active in evening.

|-
| VIEWRANGE
| value
| Value should determine how close you have to get to a critter before it attacks (or prevents adv mode travel etc.) Default is 20.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==W==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| WAGON_PULLER
|
| Allows the creature to pull caravan wagons.

|-
| WEBBER
|
* {{L|material token}}
| Allows the creature to create webs, and defines what the webs are made of.

|-
| WEBIMMUNE
|
| The creature will not get caught in thick webs.
|}

==Attack Tokens==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| ATTACK_SKILL
|
*skill used ({{L|Skill token}})
| defines the attack skill used

|-
| ATTACK_VERB
| 2nd person:3rd person
| descriptive text for the attack

|-
| ATTACK_CONTACT_PERC
|
*% value
| amount of available tissue used in attack, or possibly percent chance the attack makes contact

|-
| ATTACK_PENETRATION_PERC
|
*% value
| probably amount of material that makes contact when penetration is done, or possibly percent chance the attack penetrates (as in sharp items. Default is 0, so it can be left out for blunt attacks, if this is what it does)

|-
| ATTACK_PRIORITY
|
*MAIN or SECOND
| use of the attack in combat. Secondary attacks are only used if main attacks are impossible.

|-
| ATTACK_VELOCITY_MODIFIER
| number
| Modifies the attack velocity. Believed to be percent based (so 100 would be "normal"). May be on same scale as weapon velocity (where 1000 is "normal").

|-
| ATTACK_FLAG_CANLATCH
|
| Enables an attacker to occasionally latch on with the bodypart used by an attack when an attack with this flag in its definition is made.

|-
| ATTACK_FLAG_WITH
|
| In adventure mode, displays the name of the body part used by an attack when announcing the attack.

|-
| ATTACK_FLAG_EDGE
|
| attack type

|-
| SPECIALATTACK_INJECT_EXTRACT
|
* {{L|material token}}
*state (SOLID, LIQUID, GAS)
*min:max
| attack type addition that injects a material into the victim.

|-
| SPECIALATTACK_SUCK_BLOOD
| min:max
| Successful attack draws out an amount of blood randomized between the min and max value.
|}

==Important Related Tokens==
These next groups of tokens include several tokens that are not technically classified as creature tokens in string dump, but bear mentioning in this as they are used frequently in creature raws. (Some regular creature tokens may also be reprinted for the sake of ease of navigation)

===Tissue Modification===
This next group of tokens deals setting and modifying tissue properties. (See also {{L|Tissue definition token}})

{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| INSULATION
|
*value
| Tissue supplies the creature with heat insulation. Higher values result in more insulation.

|-
| PLUS_TISSUE_LAYER
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
| Adds a tissue to those selected

|-
| PLUS_TL_GROUP
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
*tissue
| continues a selection of tissue layers

|-
| SELECT_TISSUE
|
*tissue token
| Selects a tissue for editing.

|-
| SELECT_TISSUE_LAYER
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token | Selects a tissue at a location
* (optional) FRONT, BACK, LEFT, RIGHT, TOP, BOTTOM, AROUND.
| Selects a tissue layer for descriptor and cosmetic purposes.

|-
| SET_LAYER_TISSUE
|
| Sets a tissue layer to be made of a different tissue.

|-
| TISSUE_LAYER
|
*BY_TYPE, BY_CATEGORY, BY_TOKEN
*TYPE,CATEGORY, or TOKEN
*TISSUE
*LOCATION
| Adds the tissue layer to wherever it is required.
Non-argument Locations can be FRONT, RIGHT, LEFT, TOP, BOTTOM. Argument locations are AROUND and CLEANS, requiring a further body part and a % of coverage/cleansing

|-
| TISSUE_LAYER_OVER
|
*BY_TYPE, BY_CATEGORY, BY_TOKEN
*TYPE,CATEGORY, or TOKEN
*TISSUE
*LOCATION
| Presumably a counterpart to TISSUE_LAYER_UNDER (see below).

|-
| TISSUE_LAYER_UNDER
|
*BY_TYPE, BY_CATEGORY, BY_TOKEN
*TYPE,CATEGORY, or TOKEN
*TISSUE
| Adds the tissue layer under a given part.
For example an Iron Man has a gaseous poison within and this tissue (GAS is its name) has the token [TISSUE_LEAKS] and its state is GAS so when you puncture the iron outside and damage this tissue it leaks gas (can have a syndrome by using a previous one in the creature sample.) [TISSUE_LAYER_UNDER:BY_CATEGORY:ALL:{tissue}] {tissue} is what will be under the TISSUE_LAYER here is an example Tissue from Iron Man
[TISSUE:GAS]
[TISSUE_NAME:gas:NP] [TISSUE_MATERIAL:LOCAL_CREATURE_MAT:GAS] [TISSUE_MAT_STATE:GAS] [RELATIVE_THICKNESS:50] [TISSUE_LEAKS] [TISSUE_SHAPE:LAYER]

|-
| TISSUE_LAYER_APPEARANCE_MODIFIER
|
*QUALITY
*lowest:lower:low:median:high:higher:highest
| sets the range of qualities, including LENGTH, DENSE, HIGH_POSITION, CURLY, GREASY, WRINKLY

|-
| TISSUE_LEAKS
|
| The selected tissue leaks out of the creature when the layers above it are pierced. As per an iron man's internal poison gas.

|-
| TISSUE_MATERIAL
|
*VALUE (material)
*MATERIAL (material subtype)
| Defines the tissue material. VALUE can be LOCAL_CREATURE_MAT, INORGANIC etc. MATERIAL is a subtype of the material, e.g. [TISSUE_MATERIAL:INORGANIC:BRONZE]

|-
| TISSUE_STYLE_UNIT
|
*tissue
*shaping
| sets tissue to be in a certain shape, mostly used with tissues HAIR, BEARD, MOUSTACHE, SIDEBURNS.

|-
| TL_COLOR_MODIFIER
| COLOR:freq:COLOR:freq etc
| Creates a list of color patterns, giving each a frequency.

|-
| TL_CONNECTS
|
| Presumably gives the CONNECTS attribute to selected layers.

|-
| TL_HEALING_RATE
|
| Presumably changes the HEALING_RATE of the selected tissue layers.

|-
| TL_MAJOR_ARTERIES
|
| Gives Major Artery attribute to selected layers.

|-
| TL_PAIN_RECEPTORS
|
| Seems to set new number of pain receptors for selected tissue layers.

|-
| TL_RELATIVE_THICKNESS
|
| Seems to set new relative thickness for selected tissue layers.

|-
| TL_VASCULAR
|
| Seems to set new a VASCULAR value (which modulates bleeding) for selected tissue layers.

|}

==See Also==
*{{L|Body detail plan token}}
*{{L|Body token}}
*{{L|Material definition token}}
*{{L|Syndrome}}
*{{L|Tissue definition token}}

{{Category|Modding}}
{{Category|Tokens}}

v0.31:Creature token

2011-11-25T00:02:24Z

I2amroy: /* T */

{{av}}{{Quality|Exceptional}}

A full list of all known creature tokens.

__NOTOC__

<div align="center">
{{alphabetical TOC}}
</div>

==A==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| ADOPTS_OWNER
|
| Tame creature cannot be made available for adoption, instead automatically adopting whoever it wants. It appears that the basic requirements for adoption are intact; for example, the creature is more likely to adopt an owner which likes creatures of that species.{{verify}}

|-
| ALCOHOL_DEPENDENT
|
| Creature needs alcohol to get through the working day.

|-
| ALL_ACTIVE
|
| Sets if the creature is active in day, night, and twilight. Seems to be a separate value from DIURNAL/NOCTURNAL/CREPUSCULAR, rather than implying them.

|-
| ALTTILE
|
| If set, the creature will blink between its [TILE] and its [ALTTILE].

|-
| AMBUSHPREDATOR
|
| Instead of charging relentlessly at prey, a creature with this tag will wait till the prey is within a few squares before charging.{{verify}}

|-
| AMPHIBIOUS
|
| Allows a creature to breathe with or without {{L| water}}. Implies [AQUATIC].

|-
| APP_MOD_DESC_RANGE
|
*Range
| [http://www.bay12forums.com/smf/index.php?topic=60554.msg1766793#msg1766793 Forum post describing how description ranges work]

|-
| APP_MOD_GENETIC_MODEL
|
*Model (Accepts DOMINANT_MORE, DOMINANT_LESS, and MIX)
| Defines a genetic model for the relevant appearance modifier(s). May or may not do anything significant at present.

|-
| APP_MOD_IMPORTANCE
|
*number
| Determines how important the appearance modifier is, for determining whether it shows up in the creature description.{{verify}}

|-
| APP_MOD_NOUN
|
*noun
*SINGULAR or PLURAL
| creates a noun for the appearance and whether it is singular or plural

|-
| APP_MOD_RATE
|
*Rate (integer)
*Scale (DAILY, YEARLY)
*min:max of growth
*start year:start day
*end year:end day
| setting the growth rate of the modifier. The last two tokens can be replaced by NO_END to have growth continue indefinitely.

|-
| APPLY_CREATURE_VARIATION
|
*CV TEMPLATE NAME
| Loads the Creature Variation Template specified.

|-
| APPLY_CURRENT_CREATURE_VARIATION
|
| Applies loaded Creature Variation

|-
| AQUATIC
|
| Allows a creature to breathe underwater, but causes it to "drown" out of {{L|water}}.

|-
| ARENA_RESTRICTED
|
| Does not appear in arena mode list

|-
| ARTIFICIAL_HIVEABLE
|
| Can be kept in artificial hives by beekeepers.

|-
| AT_PEACE_WITH_WILDLIFE
|
| Does not attack or frighten wildlife.

|-
| ATTACK
|
*token
*bodypart
*selection criteria
*location
| Defines the attack name, and the body part used. See [[#Attack Tokens|below]] for valid subtokens
'''Example:'''<br />
[ATTACK:GORE:BODYPART:BY_CATEGORY:HORN]<br />
''GORE'' : name of the attack<br />
''BODYPART:BY_CATEGORY:HORN'' : the horn is used to attack (presuming the creature has one)

|-
| ATTACK_TRIGGER
| pop:exported wealth:created wealth
| Specifies when a {{L|megabeast}} will attack the fortress.

|}

<div align="center">
{{alphabetical TOC}}
</div>

==B==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| BABY
| integer
| Age at which creature is considered a child. Default is zero. One can think of this as the duration of the baby stage.

|-
| BABYNAME
| singular:plural
| Defines a new name for a creature in baby state at the caste level. For non-caste-specific baby names, see GENERAL_BABY_NAME.

|-
| BEACH_FREQUENCY
|
| {{L|Whale}}s and {{L|Sea nettle jellyfish|jellyfish}} have this. Controls the beaching frequency of the creature.

|-
| BENIGN
|
| Determines whether creature can show up on "tame" maps (includes {{L|elephant}}s), which will generally avoid dwarves, although they may chase and/or attack them if they get too close).

|-
| BIOME
|
* {{L|biome token}}
| Select a {{L|Biome}} the creature may appear in.

|-
| BLOOD
|
* {{L|material token}}
*matter state (LIQUID, GAS, SOLID)
| Specifies what the creature's blood is made of.

|-
| BODY
| body parts
| Draws body parts from OBJECT:BODY files (such as body_default.txt)
'''Example:'''<br />
[BODY:BODY_WITH_HEAD_FLAG:HEART:GUTS:BRAIN:MOUTH] <br />
This is the body from a {{L|Purring maggot}}. It creates a body with head, a heart, some guts, a brain, and a mouth. Thats all a maggot needs.

|-
| BODY_APPEARANCE_MODIFIER
|
*ATTRIBUTE
*lowest:lower:low:median:high:higher:highest
| These body modifiers give individual creatures different characteristics. In the case of HEIGHT, BROADNESS and LENGTH, the modifier is also a percentage change to the BODY_SIZE of the individual creature. The seven numbers afterward give a distribution of ranges. Each interval has an equal chance of occurring.
'''Example:'''<br />
[BODY_APPEARANCE_MODIFIER:HEIGHT:90:95:98:100:102:105:110] <br />
''HEIGHT'' : marks the height to be changed <br />
''90:95:98:100:102:105:110'' : sets the range from the shortest (90% of the average height) to the tallest (110% of the average height) creature variation.

|-
| BODY_DETAIL_PLAN
| PlanName, PlanName:type:type:type:etc
| loads a plan listed OBJECT:BODY_DETAIL_PLAN files, such as b_detail_plan_default.txt. Mass applies USE_MATERIAL_TEMPLATE, mass alters RELSIZE, alters body part positions, and will allow tissue layers to be defined. Tissue layers are defined in order of skin to bone here.
'''Example:'''<br />
[BODY_DETAIL_PLAN:VERTEBRATE_TISSUE_LAYERS:SKIN:FAT:MUSCLE:BONE:CARTILAGE] <br />
This creates the detailed body of a {{L|fox}}, the skin, fat, muscle, bones and cartilage out of the vertebrate tissues.<br />
A {{L|Purring maggot|maggot}} would only need:<br />
''[BODY_DETAIL_PLAN:EXOSKELETON_TISSUE_LAYERS:SKIN:FAT:MUSCLE]''

|-
| BODY_SIZE
| years:days:size
| sets up size at a given time. Size is in cubic centimeters (milliliters), and for normal body materials is roughly equal to the creature's average weight in grams.
'''Example:'''<br />
[BODY_SIZE:0:0:10000]<br />
[BODY_SIZE:1:168:50000]<br />
[BODY_SIZE:12:0:220000]<br />
This describes the size of a {{L|minotaur}}. His birth size would be 10000 (10000 mL, ~10 kg). With 1 year and 168 days he would be 50000 tall (~50 kg). As an adult (with 12 years) he would weight roughly 220 kg

|-
| BODYGLOSS
| gloss
| Substitutes body part text with replacement text. Draws gloss information from OBJECT:BODY files (such as body_default.txt)

|-
| BONECARN
|
| Creature 'eats' bones. Eating bones makes their happiness go up, but can cause death (suffocation){{verify}}. Implies CARNIVORE. Civilized creatures (ex. Kobolds) with this tag tend to die out during world generation.

|-
| BP_APPEARANCE_MODIFIER
|
*QUALITY
*lowest:lower:low:median:high:higher:highest
| sets up the breadth of possibilities for appearance qualities for a selected BP group. EG. Eyes (CLOSE_SET, DEEP_SET, ROUND_VS_NARROW, LARGE_IRIS),Lips (THICKNESS), Nose (BROADNESS, LENGTH, UPTURNED, CONVEX), Ear (SPLAYED_OUT, HANGING_LOBES, BROADNESS, HEIGHT), Tooth (GAPS), Skull (HIGH_CHEEKBONES, BROAD_CHIN, JUTTING CHIN, SQUARE_CHIN), Neck (DEEP_VOICE, RASPY_VOICE), Head (BROADNESS, HEIGHT)

|-
| BUILDINGDESTROYER
| 1 or 2
| Allows a creature to destroy furniture and buildings. Value [1] targets mostly doors, hatches, furniture and the like. Value [2] targets anything not made with the b + C commands.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==C==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| CAN_LEARN
|
| The creature gets skills and professions. Note that this token makes the creature unable to be butchered by an adventurer so it is not recommended for uncivilized monsters. Adventurers lacking this token can allocate but not increase attributes and skills. skills allocated will disappear on start.

|-
| CAN_SPEAK
|
| Can talk. Note that it is not necessary for a creature to gain social skills. If a member of a civilization (such as a pet) has this token, it'll need to eat and drink.{{verify}}

|-
| CANNOT_UNDEAD
|
| Cannot be turned into a zombie or skeletal undead. Also prevents ghosts of that creature appearing.

|-
| CANOPENDOORS
|
| Allows the creature to open doors.

|-
| CARNIVORE
|
| Creature ''only'' eats meat. Note that carnivorous species will not be able to survive worldgen if they do not also have NO_EAT.

|-
| CASTE
|
*name
| defines a caste

|-
| CASTE_ALTTILE
|
*tile number or "letter"
| Caste-specific alternate tile. Expects CASTE_TILE

|-
| CASTE_COLOR
|
*fg
*bg
*brightness
| Creature tile color of the caste.

|-
| CASTE_GLOWCOLOR
|
*fg
*bg
*brightness
| GLOWTILE color of the caste.

|-
| CASTE_GLOWTILE
|
*tile value or "letter"
| Caste-specific glowtile

|-
| CASTE_NAME
| singular:plural:adjective
| The name of the caste of the creature in the game.

|-
| CASTE_PROFESSION_NAME
|
*Profession
*singular
*plural
| alters the name of the given profession, caste-specific

|-
| CASTE_SOLDIER_ALTTILE
| 'character' or tile number
| Creatures of this caste active in their civilization's military will blink between their default tile and this one.

|-
| CASTE_SOLDIER_TILE
| 'character' or tile number
| Creatures of this caste active in their civilization's military will use this tile instead.

|-
| CASTE_SPEECH
| speech file?
| Possibly a caste-specific instance of the SPEECH token

|-
| CASTE_TILE
|
* tile number or "letter"
| Caste-specific creature tile.

|-
| CAVE_ADAPT
|
| Gives the creature a bonus in caves. Also causes [[Cave adaptation]].

|-
| CHANGE_BODY_SIZE_PERC
|
|

|-
| CHILD
| integer
| age at which creature is considered an adult. One can think of this as the duration of the child stage. Without this token, a creature will not reproduce in Fortress mode.

|-
| CHILDNAME
| singular:plural
| Defines a new name for a creature in child state at the caste level. For non-caste-specific child names, see GENERAL_CHILD_NAME.

|-
| CLUSTER_NUMBER
|
*min
*max
| The minimum/maximum numbers of how many creatures per spawned cluster. Certain vermin fish use this token in combination with temperate ocean and river biome tokens to perform seasonal migrations.
e.g. [CLUSTER_NUMBER:1:3]

|-
|CLUTCH_SIZE
|
*min
*max
|Number of eggs laid in one sitting.

|-
| COLONY_EXTERNAL
|
| Caste hovers around colony.

|-
| COLOR
| foreground:background:brightness
| Color of the creature's tile.

|-
| COMMON_DOMESTIC
|
| Allows the creature to be brought with immigrants and when creating a new fortress, as long as the creature also includes at least one of the following tokens: PET, PACK_ANIMAL, WAGON_PULLER, MOUNT. In addition, the creature must be NATURAL rather than FANCIFUL

|-
| CONVERTED_SPOUSE
|
| Found only at caste level. Creatures of this caste's species with the SPOUSE_CONVERTER and NIGHT_CREATURE_HUNTER tokens will kidnap SPOUSE_CONVERSION_TARGETs of an appropriate sex and convert them into castes with CONVERTED_SPOUSE.

|-
| COOKABLE_LIVE
|
| Set this to allow the creature to be cooked in meals without first being butchered / fishcleaned.

|-
| COPY_TAGS_FROM
|
*CREATURE NAME
| Copies tags from another specified creature.

|-
| CREATURE_CLASS
|
*classname
| Creature class. Can be anything, but only existing use is GENERAL_POISON. Appears to only be used for Syndromes. Supposedly can also be used for entity positions.

|-
| CREATURE_SOLDIER_TILE
| 'character' or tile number
| Creatures active in their civilization's military will use this tile instead.

|-
| CREATURE_TILE
| 'character' or tile number
| The symbol of the creature in ASCII mode.

|-
| CREPUSCULAR
|
| Sets if the creature is active at twilight.

|-
| CURIOUSBEAST_EATER
|
| Allows a creature to steal and eat edible items from a site.

|-
| CURIOUSBEAST_GUZZLER
|
| Allows a creature to (very quickly) drink your alcohol. Or spill the barrel to the ground. Also affects undead versions of the creature.

|-
| CURIOUSBEAST_ITEM
|
| Allows a creature to steal things (apparently the highest value it can find). Semimegabeast thievery is in Legends mode. Lightweight creatures can probably steal heavy items.

|-
| CV_ADD_TAG
|
*TAG NAME
| Adds a tag. Used in conjunction with creature variation templates.

|-
| CV_REMOVE_TAG
|
*TAG NAME
| Removes a tag. Used in conjunction with creature variation templates.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==D==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| DEMON
|
| Found on generated {{L|demon}}s; sets the creature as potential {{L|hell}} spawn

|-
| DESCRIPTION
| text
| A brief description of the creature type.

|-
| DIE_WHEN_VERMIN_BITE
|
| Dies upon attacking. Used for bee stings.

|-
| DIFFICULTY
| integer
| Toady: "Difficulty determines how deep it places them in adventure mode/reclaim caves, and the chance that they are wounded the first few river attacks." Also increases experience gain during adventure mode.

|-
| DIURNAL
|
| Sets if the creature is active in day.

|-
| DOES_NOT_EXIST
|
| Creature does not actually exist; used for fanciful creatures.

|-
| DRAGONFIREBREATH
|
| Creature breathes fire in a cone.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==E==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| EGG_MATERIAL
|
* {{L|material token}}
*state (SOLID, LIQUID, or GAS)
| Egg material. Egg-laying creatures will define this 3 times, using LOCAL_CREATURE_MAT:EGGSHELL, LOCAL_CREATURE_MAT:EGG_WHITE, and then LOCAL_CREATURE_MAT:EGG_YOLK. Eggs will be made out of eggshell. Edibility is determined by tags on whites or yolk, but they otherwise do not exist.

|-
| EGG_SIZE
|
*size
| Determines how long it takes for eggs to hatch{{verify}}. The larger the number, the longer it takes.

|-
| EQUIPMENT_WAGON
|
| Makes the creature into a large 3x3 creature responsible for carrying trade goods, pulled by two [WAGON_PULLER]s and driven by a merchant.

|-
| EQUIPS
|
| Allows the creature to wear or wield items.

|-
| EVIL
|
| Creature is considered evil and will only show up in evil biomes. Has no effect on cavern creatures.

|-
| EXTRACT
|
* {{L|material token}}
| Defines a creature extract which can be obtained via {{L|small animal dissection}}.

|-
| EXTRAVISION
|
| Creature can see regardless of whether it has working eyes.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==F==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| FANCIFUL
|
| Makes every civilization know about the creature. The creature won't occur in regular material preference lists. The tag also adds some art value modifiers. Used for things like dragons and other legendary creatures. Conflicts with [COMMON_DOMESTIC]

|-
| FEATURE_ATTACK_GROUP
|
| Found on subterranean animalmen.

|-
| FEATURE_BEAST
|
| Found on {{L|forgotten beast}}s.

|-
| FEMALE
|
| Inside a female caste, sets femaleness. Outside of a caste, sets all individuals female unless overridden by caste.

|-
| FIREBREATH
|
| The creature breathes long range fireballs and has a short range cone shaped fire breath attack.

|-
| FIREIMMUNE
|
| Renders a creature immune to being damaged by FIREBREATH's short range cone attack.

|-
| FIREIMMUNE_SUPER
|
| The creature is immune to DRAGONFIREBREATH. Implies FIREIMMUNE.

|-
| FISHITEM
|
| Needs to be cleaned at a fishery

|-
| FIXED_TEMP
| temperature
| The natural heat generated by the creature.

|-
| FLEEQUICK
|
| Determines how soon a creature flees in a losing battle. Creatures with this tag will flee at the first sign of resistance.

|-
| FLIER
|
| Allows a creature to fly. Fortress Mode pathfinding only partially incorporates pathfinding - flying dwarves need a land path to exist between them and an area in order to access it, but as long as one such path exists, they do not need to use it, instead being able to fly over intervening obstacles.

|-
| FREQUENCY
|
*number, max 100
| Determines the time between creature spawns in Fortress Mode. Higher is more occurrences per time unit. Creatures without a frequency statement default to 50. Almost all others have either [FREQUENCY:5] or [FREQUENCY:100]. Not to be confused with POP_RATIO
|}

<div align="center">
{{alphabetical TOC}}
</div>

==G==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| GENERAL_BABY_NAME
| singular:plural
| name at creature level

|-
| GENERAL_CHILD_NAME
| singular:plural
| name at creature level

|-
| GENERATED
|
| Found on procedurally generated creatures like {{L|Forgotten beast}}s, (biome name) {{L|titan}}s, {{L|Demon}}s, and {{L|night creature}}s.

|-
| GETS_INFECTIONS_FROM_ROT
|
| Creature can get infections from necrotic tissue.

|-
| GETS_WOUND_INFECTIONS
|
| Creature's wounds can become infected.

|-
| GLOWCOLOR
|
*foreground
*background
*brightness
| The colour of the GLOWTILE of the creature.

|-
| GLOWTILE
| ascii character
| If present, the being glows in the dark (generally used for Adventure Mode). The tile is what replaces the being's current tile when it is obscured from your sight by darkness. The default setting for kobolds (a yellow quotation mark) provides a nice "glowing eyes" effect. The game is also hardcoded to automatically convert quotation mark GLOWTILES into apostrophes if the creature has lost one eye. This works at the generic creature level - for caste-specific glow tiles, use CASTE_GLOWTILE instead.

|-
| GNAWER
| verb (gnawed)
| The creature chews on food barrels and bags.

|-
| GO_TO_END
|
| When using tags from an existing creature, inserts new tags at the end of the creature.

|-
| GO_TO_START
|
| When using tags from an existing creature, inserts new tags at the beginning of the creature.

|-
| GO_TO_TAG
|
| When using tags from an existing creature, inserts new tags after the specified tag.

|-
| GOOD
|
| Determines whether creature can show up on "good" areas. Eg. unicorn.

|-
| GRASSTRAMPLE
| value
| The value determines how rapidly grass is trampled when a creature steps on it - a value of 0 causes the creature to never damage grass, while a value of 100 causes grass to be trampled as rapidly as possible. Defaults to 5.

|-
| GRAVITATE_BODY_SIZE
| target value
| Used in Creature Variants. This token changes the adult body size to the average of the old adult body size and the target value and scales all intermediate growth stages by the same factor.

|-
| GRAZER
|
*number
| Animals is a grazer. The higher the number, the less frequently it needs to eat in order to survive.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==H==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| HABIT
| type:probability
| Defines certain behaviors for the creature. The habit types are COLLECT_TROPHIES, COOK_PEOPLE, COOK_VERMIN, GRIND_VERMIN, COOK_BLOOD, GRIND_BONE_MEAL, EAT_BONE_PORRIDGE, USE_ANY_MELEE_WEAPON, GIANT_NEST, and COLLECT_WEALTH. These may require the creature to have a lair to work properly.

|-
| HABIT_NUM
| number or TEST_ALL
| "If you set HABIT_NUM to a number, it should give you that exact number of habits according to the weights.".<sup>[[http://www.bay12forums.com/smf/index.php?topic=60554.msg1719248#msg1719248 source post]]</sup> All lists of HABITs are preceded by [HABIT_NUM:TEST_ALL]

|-
| HAS_NERVES
|
| This makes the creature susceptible to severed motor and sensory nerves when muscles are torn in limb, grasp and stance parts. Some butchering yields nervous tissue.

|-
| HASSHELL
|
| The creature has a shell. Seemingly no longer used - holdover from previous versions.

|-
| HIVE_PRODUCT
|
*number
*{{L|time}}
*{{L|item token}}s
| What product is harvested from {{L|Beekeeping industry|beekeeping}}.

|-
| HOMEOTHERM
|
| Default 'NONE'. The creature's normal body {{L|temperature}}

|-
| HUNTS_VERMIN
|
| Creature hunts and kills nearby vermin.

|}

<div align="center">
{{alphabetical TOC}}
</div>

==I==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| IMMOBILE_LAND
|
| The creature is immobile while on land. Only works on AQUATIC creatures which can't breath on land.

|-
| IMMOLATE
|
| Will ignite, and potentially completely destroy, items the creature is standing on. Keep booze away from critters with this tag.

|-
| INTELLIGENT
|
| Implies CAN_SPEAK and CAN_LEARN. CAN_LEARN probably means the creature gets skills - including social skills - and professions. Not recommended for uncivilized monsters.

|-
| ITEMCORPSE
|
* {{L|item token}}:subtype
* {{L|material token}}
| Determines if the creature leaves behind a non-standard corpse (i.e. wood, statue, bars, ash from ghost etc).

|-
| ITEMCORPSE_QUALITY
|
| The quality of an item-type corpse left behind; 5 is masterpiece-level.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==L==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| LAIR
| type:probability
| Found on megabeasts, semimegabeasts, and night creatues. The creature will seek out sites of this type and take them as lairs. The lair types are SIMPLE_BURROW, SIMPLE_MOUND, WILDERNESS_LOCATION, SHRINE, and LABYRINTH.

|-
| LAIR_CHARACTERISTIC
| characteristic:probability
| Defines certain features of the creature's lair. The only valid characteristic is HAS_DOORS.

|-
| LAIR_HUNTER
|
| This creature will actively hunt adventurers in its lair.

|-
| LAIR_HUNTER_SPEECH
| speech file
| What this creature says while hunting adventurers in its lair.

|-
| LARGE_PREDATOR
|
| Will attack things that are smaller than it (like dwarves). Only one group of "large predators" will appear on any given map (possibly two groups on "savage" maps). In adventure mode, large predators will try to ambush and attack you (and your party will attack them back). Also, they can be mentioned in the intro paragraph when starting a fortress e.g. "ere the wolves get hungry."

|-
| LARGE_ROAMING
|
| In Fortress Mode, spawns outdoors and is not a vermin creature.

|-
| LAYS_EGGS
|
| Creature lays eggs instead of giving birth to live young.

|-
| LAYS_UNUSUAL_EGGS
|
* {{L|item token}}
* {{L|material token}}
| Creature lays a particular item instead of regular eggs.

|-
| LIGAMENTS
|
* {{L|material token}}
*healing rate
| Defines the material and healing rate of ligaments.

|-
| LIGHT_GEN
|
| The creature will generate light, such as in adventurer mode at night.

|-
| LIKES_FIGHTING
|
| The creature will attack enemies rather than flee from them. This tag has the same effect on player-controlled creatures - included modded dwarves.

|-
| LISP
|
| Creature uses "sssssnake talk" (multiplies 'S' when talking - "My name isss Recisssiz.")

|-
| LITTERSIZE
|
* minumum
* maximum
| Determines the random chance of how many creatures are generated when giving birth. [LITTERSIZE:1:2]

|-
| LOCKPICKER
|
| Lets a creature open doors that are set to forbidden in Fortress Mode.

|-
| LOOSE_CLUSTERS
|
| The creatures will scatter if they have this tag, or form tight packs if they don't.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==M==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| MAGICAL
|
| Unknown.

|-
| MAGMA_VISION
|
| Creature's able to see while covered in magma.

|-
| MALE
|
| The species or caste is all male.

|-
| MANNERISM_??
|
*occasionally body part
| Adds a possible mannerism to the creature's profile.
Refer to {{L|Creature mannerism token}}s

|-
| MATERIAL
|
*material id
| Begins defining a new material.{{verify}}

|-
| MATERIAL_BREATH_ATTACK
|
* {{L|material token}}
* breath attack type (TRAILING_DUST_FLOW, TRAILING_VAPOR_FLOW, TRAILING_GAS_FLOW, SOLID_GLOB, LIQUID_GLOB, UNDIRECTED_GAS, UNDIRECTED_VAPOR, UNDIRECTED_DUST)
| Creates an attack referencing a material, using a given type of breath attack.

|-
| MATUTINAL
|
| Sets if the creature is active in dawn.

|-
| MAXAGE
| min:max
| Range of time in years in which death from old age may occur. Once a creature reaches the min value, it has a random chance each season of dying from old age. Unknown if the chance increases with further age.

|-
| MEANDERER
|
| Gives a creature random movement.

|-
| MEGABEAST
|
| Appears on fortress territory in Fortress Mode occasionally. Can also be worshipped.

|-
|MENT_ATT_CAP_PERC
|
*ATTRIBUTE Token
*Cap %
|Default is 200. This means you can increase your attribute to 200% of its starting value (or the average value + your starting value if that is higher).

|-
| MENT_ATT_RANGE
|
*ATTRIBUTE
*lowest:lower:low:median:high:higher:highest
| Sets up a mental attribute's range of values (0-5000). All mental attribute ranges default to 200:800:900:1000:1100:1300:2000.

|-
| MENT_ATT_RATES
|
*ATTRIBUTE Token
*cost to improve
*unused counter rate
*rust counter rate
*demotion counter rate
| Mental attribute gain/decay rates. Defaults are 500:4:5:4.

|-
| MILKABLE
|
* {{L|material token}}
* frequency
| Allows the creature to be milked.

|-
| MISCHIEVIOUS
|
| Will pull any levers it comes across. Also makes creature spawn invisible and with several ranks in Ambusher. "They go on little missions to mess with various fortress buildings, not just levers."

|-
| MODVALUE
|
| Seemingly no longer used - holdover from previous versions.

|-
| MOUNT
|
| Creature may be used as a mount.

|-
| MOUNT_EXOTIC
|
| You need the Dungeon master noble to mount the creature.

|-
| MULTIPLE_LITTER_RARE
|
| Makes litters with more than one offspring rare.

|-
| MULTIPLY_VALUE
|
*Multiplier
| Multiplies value of materials.

|-
| MUNDANE
|
| Marks if the creature is an actual real-life creature. Only used for age-names at present, and determining whether a creature will attack creatures with the AT_PEACE_WITH_WILDLIFE token.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==N==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| NAME
| singular:plural:adjective
| The generic name for any creature of this type - will be used when distinctions between caste are unimportant. For names for specific castes, use CASTE_NAME instead.

|-
| NATURAL
|
| Animal is considered to be natural.

|-
| NATURAL_SKILL
| skill:value
| The creature possesses this skill at this level inherently. It begins with this skill at this level, and the skill may never rust below this level. Requires CAN_LEARN or INTELLIGENT to function (changed in .25 or earlier that CAN_LEARN is no longer required).

|-
| NIGHT_CREATURE_BOGEYMAN
|
| Found on bogeymen. Creatures with this tag will join other bogeymen in attacking adventurers at night, and will also adopt their other behaviors, such as vanishing in smoke upon being killed. Setting the number of night creatures to zero in the world gen parameters will remove only the randomly-generated bogeymen.

|-
| NIGHT_CREATURE_HUNTER
|
| If this creature has SPOUSE_CONVERTER, it will actively attempt to seek out potential conversion targets, abduct them, and convert them. Night creatures will seek out one SPOUSE_CONVERSION_TARGET <s>of the opposite sex</s>(seems to choose anyone of any sex of the caste/s that have the CONVERTED_SPOUSE tag), convert them, and then have children with them(if possible). NIGHT_CREATURE_HUNTERs without SPOUSE_CONVERTER will not be placed. Setting the number of night creatures to zero in the world gen parameters will remove only the randomly-generated night creatures.

|-
| NO_AUTUMN
|
| does not appear this season.

|-
| NO_DIZZINESS
|
| Creature cannot become dizzy

|-
| NO_DRINK
|
| Creature does not need to drink.

|-
| NO_EAT
|
| Creature does not need to eat.

|-
| NO_FEVERS
|
| Creature cannot suffer fevers

|-
| NO_GENDER
|
| Creature has no gender.

|-
| NO_SLEEP
|
| Creature does not need to sleep.

|-
| NO_SPRING
|
| does not appear this season.

|-
| NO_SUMMER
|
| does not appear this season.

|-
| NO_THOUGHT_CENTER_FOR_MOVEMENT
|
| Creatures doesn't require an organ with the [THOUGHT] tag to survive; generally used on creatures that don't have brains.

|-
| NO_WINTER
|
| does not appear this season.

|-
| NOBONES
|
| Creature has no bones.

|-
| NOBREATHE
|
| Creature doesn't need to breathe or have [BREATHE] parts in body. Cannot drown or be strangled.

|-
| NOCTURNAL
|
| Sets if the creature is active in night.

|-
| NOEMOTION
|
| The creature has no emotions, and does not rage.

|-
| NOEXERT
|
| Creature can't become tired or over-exerted.

|-
| NOFEAR
|
| Creature doesn't feel fear and will never run away from battle.

|-
| NOMEAT
|
| Creature will not drop meat on butcher.

|-
| NONAUSEA
|
| Creature can't vomit.

|-
| NOPAIN
|
| Creature doesn't feel pain.

|-
| NOSKIN
|
| Creature will not drop skin on butcher.

|-
| NOSKULL
|
| Creature will not drop skull on butcher, rot, or decay of severed head.

|-
| NOSMELLYROT
|
| Does not produce miasma when rotting

|-
| NOSTUCKINS
|
| Weapons can't be stuck in creature.

|-
| NOSTUN
|
| Creature can't be stunned. Creatures with this tag never wake up from sleep in Fortress Mode and stay drowsy. If this creature must eat and drink while playing, it WILL die.

|-
| NOT_BUTCHERABLE
|
| Cannot be butchered

|-
| NOTHOUGHT
|
| Creature doesn't think, or doesn't require a [BRAIN] body part.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==P==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| PACK_ANIMAL
|
| Allows the creature to be used as a pack animal. Currently only used by merchants.

|-
| PARALYZEIMMUNE
|
| The creature is immune to all paralyzing special attacks.

|-
| PATTERNFLIER
|
|

|-
| PEARL
|
| Creature will generate pearls.

|-
| PENETRATEPOWER
| value
| Controls the ability of vermin to find a way into containers when they are eating food from your stockpiles. Wood and cloth objects roll a 0-9 and if it's greater than the penetrate power, their contents escape for the time being. Other objects roll a 0-99.

|-
| PERSONALITY
|
*ATTRIBUTE
*lowest:median:highest
| Determines the range and chance of personality traits. Standard is 0:50:100. See [[DF2010:Personality_trait|Personality traits]] for more info.

|-
| PET
|
| Allows the creature to be tamed. Also allows all females of the species to breed regardless of marital status.

|-
| PET_EXOTIC
|
| You need a Dungeon master noble in your fortress for the creature to be tamable (but any Animal trainer can do the taming).

|-
| PETVALUE
| value
| How valuable a tamed animal/pet is. Actual cost in points in the embarking screen is (PETVALUE/2)+1 for an untrained animal, PETVALUE+1 for a trained(War or Hunting) one. Note that for an animal to be selectable in this screen, it must have the COMMON_DOMESTIC token.

|-
| PETVALUE_DIVISOR
| value
| Divides the creature's PETVALUE by the specified number. Used for bees to prevent a single hive from being worth a fortune.

|-
|PHYS_ATT_CAP_PERC
|
*ATTRIBUTE Token
*Cap %
|Default is 200. This means you can increase your attribute to 200% of its starting value (or the average value + your starting value if that is higher).

|-
| PHYS_ATT_RANGE
|
*ATTRIBUTE
*lowest:lower:low:median:high:higher:highest
| Sets up a physical attribute's range of values (0-5000). All physical attribute ranges default to 200:700:900:1000:1100:1300:2000.

|-
| PHYS_ATT_RATES
|
*ATTRIBUTE Token
*cost to improve
*unused counter rate
*rust counter rate
*demotion counter rate
| Physical attribute gain/decay rates. Defaults for STRENGTH, AGILITY, TOUGHNESS, and ENDURANCE are 500:3:4:3, while RECUPERATION and DISEASE_RESISTANCE default to 500:NONE:NONE:NONE.

|-
| PLUS_BP_GROUP
|
*BY_TYPE, BY_CATEGORY, or BY_TOKEN
*body type, category, or token
| Adds a body part group to selected body part group. Presumably used immediately after SET_BP_GROUP.

|-
| PLUS_MATERIAL
|
*material
| Adds a material to selected materials. Used immediately after SELECT_MATERIAL.

|-
| POP_RATIO
|
| Weighted population of caste; Lower is rarer. Not to be confused with FREQUENCY.

|-
| POPULATION_NUMBER
| min:max
| old guess: "The minimum/maximum numbers of how many of these creatures can show up on a map per year."<br>Toady: "Pop number is the number per square of the region, I think."

|-
| POWER
|
|Allows the being to represent itself as a deity. Requires CAN_SPEAK to actually do anything more than settle at a location.

|-
| PREFSTRING
| string
| Sets what other creatures like about this creature. "Urist likes dwarves for their beards." Multiple entries will be chosen from at random

|-
| PROFESSION_NAME
|
*Profession
*singular
*plural
| The generic name for members of this profession, at the creature level. In order to give members of specific castes different names for professions, use CASTE_PROFESSION_NAME instead.

|-
| PRONE_TO_RAGE
| number
| Untested effect, though it clearly affects how likely a creature is to become enraged. Number may be percentage chance of becoming enraged during combat. As described in file_changes.txt, creatures with this token "follow its normal behavior, but flip out on occasion, higher rate = more flipping out".

|-
| PUS
|
* {{L|material token}}
*matter state (LIQUID, GAS, SOLID)
| Specifies what the creature's wounds will ooze when infected.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==R==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| RELSIZE
|
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*body category, type, or token
*Relsize
| Specifies a new relative size for a part than what is stated in the body plan. For example, Dwarves have larger livers.

|-
| REMAINS
| singular:plural
| What creature's remains are called.

|-
| REMAINS_COLOR
|
| What color creature's remains are.

|-
| REMAINS_ON_VERMIN_BITE_DEATH
|
| Leaves remains when its attack causes it to die? Seems to go with DIE_WHEN_VERMIN_BITE.

|-
| REMAINS_UNDETERMINED
|
| Unknown.

|-
| REMOVE_MATERIAL
|
*material token
| Removes a material from a creature.

|-
| REMOVE_TISSUE
|
*material token
| Removes a tissue from a creature.

|-
| RETURNS_VERMIN_KILLS_TO_OWNER
|
| Used with HUNTS_VERMIN, causes the creature to return killed vermin to its owner.

|}

<div align="center">
{{alphabetical TOC}}
</div>

==S==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| SAVAGE
|
| Allows creature to show up on (and limits it to) "savage" maps.

|-
| SECRETION
|
* {{L|material token}}
*Material State
*location secreted from (by_type, by_category, by_token)
*body part
*tissue layer
| creates a secreted material on given tissue on a given part of the body.

|-
| SELECT_ADDITIONAL_CASTE
|
*caste name
| adds an additional previously defined caste to the selection. Used immediately after SELECT_CASTE.

|-
| SELECT_CASTE
|
*caste name, or ALL
| selects a previously defined caste

|-
| SELECT_MATERIAL
|
*Material token
| Selects a locally defined material. Can be ALL.

|-
| SEMIMEGABEAST
|
| Appears as boss creature in quests. Makes history by rampaging around towns. Possibly inhabits non-mountain caves.

|-
| SET_BP_GROUP
|
*selection criteria BY_TYPE, BY_CATEGORY, BY_TOKEN
*category, type, or token
| Begins a selection of body parts.

|-
| SET_TL_GROUP
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
*tissue
| begins a selection of tissue layers

|-
| SHEARABLE_TISSUE_LAYER
|
* tissue modifier
* required value
| Tissue layer can be sheared for its component material. The specified modifier must be at least of the desired value for shearing to be possible (a llama's wool must have a LENGTH of 300 before it is shearable).

|-
| SKILL_LEARN_RATE
| {{L|skill_token}}:percentage
| The rate at which this creature learns this skill. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SKILL_LEARN_RATES
| percentage
| The rate at which this creature learns all skills. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SKILL_RATE
| {{L|skill_token}}:percentage:value:value:value
| As SKILL_RATES for individual skills. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SKILL_RATES
|
*% of improvement points you get
*unused counter rate
*rust counter rate
*demotion counter rate
| Affects skill gain and decay. Lower numbers in the last three slots make decay occur faster ([SKILL_RATES:100:1:1:1] would cause rapid decay). The counter rates may also be replaced with NONE.
Default is [SKILL_RATES:100:8:16:16]. [SLOW_LEARNER] changes the 100 to a 50. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SKILL_RUST_RATE
| {{L|skill_token}}:value:value:value
| The rate at which this skill decays. Lower values cause the skill to decay faster. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SKILL_RUST_RATES
| value:value:value
| The rate at which all skills decay. Lower values cause the skills to decay faster. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SLOW_LEARNER
|
| Similar to [CAN_LEARN], but slower; skills are gained at a fraction of the rate. Present in the entries for ogres and giants; can be applied to civ or player races.

|-
| SMALL_REMAINS
|
| If a creature has this token, it'll leave "remains" instead of a corpse.

|-
| SOLDIER_ALTTILE
| 'character' or tile number
| If this creature is active in its civilization's military, it will blink between its default tile and this one.

|-
| SOUND
|
* Sound application (currently accepts ALERT or PEACEFUL_INTERMITTENT)
* Sound range (in tiles)
* Sound delay (lower values = sound is produced more often)
* VOCALIZATION or NONE (determines whether the sound requires breathing or not)
* First-person description
* Third-person description
* Description when out of sight
| Creature makes sounds periodically, which can be heard in Adventure mode.

|-
| SPECIFIC_FOOD
|
* PLANT or CREATURE
* Plant/creature ID
| Indicates that the creature is only capable of eating a particular type of food.

|-
| SPEECH
| speech file
| Boasting speeches relating to killing this creature. Examples include dwarf.txt and elf.txt in data\speech.

|-
| SPEECH_FEMALE
| speech file
| Boasting speeches relating to killing females of this creature.

|-
| SPEECH_MALE
| speech file
| Boasting speeches relating to killing males of this creature.

|-
| SPEED
| value
| Sets the creatures' movement and work speed, 1000/[100 + SPEED X] is the resulting effect on creatures movement and work rates from default. See {{L|Speed}} for more information.

|-
| SPHERE
|
*sphere name
| Sets what religious spheres the creature is aligned to, for purposes of being worshipped via the [POWER] token. Also affects the layout of hidden fun stuff, and the creature's name.

|-
| SPOUSE_CONVERSION_TARGET
|
| This creature can be converted by a night creature with SPOUSE_CONVERTED.

|-
| SPOUSE_CONVERTER
|
| Enables the creature to convert SPOUSE_CONVERSION_TARGETs into CONVERTED_SPOUSE castes of its species. The creature won't actually actively do this unless it also has NIGHT_CREATURE_HUNTER, however.

|-
| SWIM_SPEED
|
*speed
| How fast the creature swims. Typically 2500 (0.38 times the default speed).

|-
| SWIMS_INNATE
|
| The creature naturally knows how to swim, as opposed to [SWIMS_LEARNED] below. Currently, an AI bug prevents this from being useful on PC races in fortress mode.

|-
| SWIMS_LEARNED
|
| The creature doesn't know how to swim unless it has learned the skill. Requires [CAN_LEARN], obviously.

|}

<div align="center">
{{alphabetical TOC}}
</div>

==T==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| TENDONS
|
* {{L|material token}}
*healing rate
| Defines the material and healing rate of tendons.

|-
| THICKWEB
|
| The creature's webs can catch larger creatures.

|-
| TISSUE
| name
| Begins defining a tissue in the creature file.

|-
| TITAN
|
| Found on {{L|titan}}s.

|-
| TL_COLOR_MODIFIER
| COLOR:freq:COLOR:freq etc
| Creates a list of color patterns, giving each a frequency.

|-
| TLCM_GENETIC_MODEL
|
| tissue layer color modifier is passed to offspring genetically?

|-
| TLCM_IMPORTANCE
|
*number
| Presumably modifies the importance of the tissue layer color modifier, for description purposes.
HOWEVER using this appears to remove all mention of colour from creature descriptions. It does not appear in any default creatures.

|-
| TLCM_NOUN
|
*name
*SINGULAR or PLURAL
| names the tissue layer color modifier, and determines the noun

|-
| TLCM_TIMING
|
*ROOT
*start change window years:days:end change window years:days
| determines the point in the creature's life where the color change begins

|-
| TRADE_CAPACITY
|
| How much the creature can carry when used by merchants.

|-
| TRAINABLE
|
| Implies both [TRAINABLE_HUNTING] and [TRAINABLE_WAR].

|-
| TRAINABLE_HUNTING
|
| Can be trained as hunting beasts by way of kennels.

|-
| TRAINABLE_WAR
|
| Can be trained as war beasts by way of kennels.

|-
| TRANCES
|
| Allows the creature to go into martial trances. Also allows strange moods to occur in the creature.

|-
| TRAPAVOID
|
| The creature is immune to traps. Probably every procedurally generated megabeast has this.

|-
| TRIGGERABLE_GROUP
| min:max
| A large swarm of vermin can be disturbed, usually in Adventure mode.{{verify}}

|-
| TSU_NOUN
|
*noun
*SINGULAR or PLURAL
| Noun for the TISSUE_STYLE_UNIT, used in the description of the tissue layer's style.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==U==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| UBIQUITOUS
|
| Creature will occur in every region with the correct biome. Does not apply to evil/good tags.

|-
| UNDERGROUND_DEPTH
|
*mindepth
*maxdepth
| Depth the creature appears underground. Numbers can be from 1 to 5. Only magma creatures use 4 or 5 in the default raws. A single argument may be used instead of min and max. Dwarven civilizations will only export (via the embark screen or caravans) things that available at depth 1.

|-
| UNDERSWIM
|
| Creature swims under the water and can't be seen. Currently appears to have no effect as of 31.25.

|-
| UNIQUE_DEMON
|
| Typically found on generated {{L|demon}}s; causes the game to create a single named instance of the demon which will emerge from the underworld and take over civilizations during worldgen. Cannot be used for modder-defined creatures.

|-
| USE_CASTE
|
*new caste token
*old caste token
| Defines a new caste derived directly from a previous caste. The new caste inherits all properties of the old one. The effect of this tag is automatic if one has not yet defined any castes: "Any caste-level tag that occurs before castes are explicitly declared is saved up and placed on any caste that is declared later, unless the caste is explicitly derived from another caste."

|-
| USE_MATERIAL
|
*new material ID
*old material ID
| Defines a new local creature material and populates it with all properties defined in the specified local creature material.

|-
| USE_MATERIAL_TEMPLATE
|
*new material token
*material template
| Defines a new local creature material and populates it with all properties defined in the specified template.

|-
| USE_TISSUE
|
*new tissue token
*old tissue id
| Defines a new local creature tissue and populates it with all properties defined in the local tissue specified in the second argument.

|-
| USE_TISSUE_TEMPLATE
|
*new tissue token
*tissue template
| Loads a tissue template listed in OBJECT:TISSUE_TEMPLATE files, such as tissue_template_default.txt.

|-
| UTTERANCES
|
| Changes the language of the creature into an unintelligible mess.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==V==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| VEGETATION
|
| unknown

|-
| VERMIN_BITE
|
*chance of occurance{{verify}}
*verb (bitten, stung, etc)
* {{L|material token}}
| Vermin bites, and injects something.

|-
| VERMIN_EATER
|
| The vermin creature will attempt to eat exposed food. See PENETRATEPOWER. Distict from VERMIN_ROTTER.

|-
| VERMIN_FISH
|
| The vermin appears in water and will attempt to swim around.

|-
| VERMIN_GROUNDER
|
| The creature appears in "general" surface ground locations. Note that this doesn't stop the creature from flying if it can (most vermin birds have this tag).

|-
| VERMIN_HATEABLE
|
| Some dwarves will hate the creature and get unhappy thoughts when around it.

|-
| VERMIN_MICRO
|
| This makes the creature move in a swarm of creatures of the same race as it. I.E. Swarm of flies, swarm of ants, etc.

|-
| VERMIN_NOFISH
|
| The creature cannot be caught by fishing.

|-
| VERMIN_NOROAM
|
| The creature will not be observed randomly roaming about the map.

|-
| VERMIN_NOTRAP
|
| The creature cannot be caught in baited animal traps; however, a "catch live land animal" task may still be able to capture one if a dwarf finds one roaming around.

|-
| VERMIN_ROTTER
|
| Present on flies, knuckle worms, acorn flies, and blood gnats. Probably means either the creature is attracted to rot, the creature speeds rotting, or both.

|-
| VERMIN_SOIL
|
| The creature randomly appears near dirt or mud.

|-
| VERMIN_SOIL_COLONY
|
| The vermin will appear in a single tile cluster of many vermin, such as a colony of ants.

|-
| VERMINHUNTER
|
| Implies AT_PEACE_WITH_WILDLIFE, RETURNS_VERMIN_KILLS_TO_OWNER, HUNTS_VERMIN, and ADOPTS_OWNER.

|-
| VESPERTINE
|
| Sets if the creature is active in evening.

|-
| VIEWRANGE
| value
| Value should determine how close you have to get to a critter before it attacks (or prevents adv mode travel etc.) Default is 20.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==W==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| WAGON_PULLER
|
| Allows the creature to pull caravan wagons.

|-
| WEBBER
|
* {{L|material token}}
| Allows the creature to create webs, and defines what the webs are made of.

|-
| WEBIMMUNE
|
| The creature will not get caught in thick webs.
|}

==Attack Tokens==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| ATTACK_SKILL
|
*skill used ({{L|Skill token}})
| defines the attack skill used

|-
| ATTACK_VERB
| 2nd person:3rd person
| descriptive text for the attack

|-
| ATTACK_CONTACT_PERC
|
*% value
| amount of available tissue used in attack, or possibly percent chance the attack makes contact

|-
| ATTACK_PENETRATION_PERC
|
*% value
| probably amount of material that makes contact when penetration is done, or possibly percent chance the attack penetrates (as in sharp items. Default is 0, so it can be left out for blunt attacks, if this is what it does)

|-
| ATTACK_PRIORITY
|
*MAIN or SECOND
| use of the attack in combat. Secondary attacks are only used if main attacks are impossible.

|-
| ATTACK_VELOCITY_MODIFIER
| number
| Modifies the attack velocity. Believed to be percent based (so 100 would be "normal"). May be on same scale as weapon velocity (where 1000 is "normal").

|-
| ATTACK_FLAG_CANLATCH
|
| Enables an attacker to occasionally latch on with the bodypart used by an attack when an attack with this flag in its definition is made.

|-
| ATTACK_FLAG_WITH
|
| In adventure mode, displays the name of the body part used by an attack when announcing the attack.

|-
| ATTACK_FLAG_EDGE
|
| attack type

|-
| SPECIALATTACK_INJECT_EXTRACT
|
* {{L|material token}}
*state (SOLID, LIQUID, GAS)
*min:max
| attack type addition that injects a material into the victim.

|-
| SPECIALATTACK_SUCK_BLOOD
| min:max
| Successful attack draws out an amount of blood randomized between the min and max value.
|}

==Important Related Tokens==
These next groups of tokens include several tokens that are not technically classified as creature tokens in string dump, but bear mentioning in this as they are used frequently in creature raws. (Some regular creature tokens may also be reprinted for the sake of ease of navigation)

===Tissue Modification===
This next group of tokens deals setting and modifying tissue properties. (See also {{L|Tissue definition token}})

{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| INSULATION
|
*value
| Tissue supplies the creature with heat insulation. Higher values result in more insulation.

|-
| PLUS_TISSUE_LAYER
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
| Adds a tissue to those selected

|-
| PLUS_TL_GROUP
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
*tissue
| continues a selection of tissue layers

|-
| SELECT_TISSUE
|
*tissue token
| Selects a tissue for editing.

|-
| SELECT_TISSUE_LAYER
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token | Selects a tissue at a location
* (optional) FRONT, BACK, LEFT, RIGHT, TOP, BOTTOM, AROUND.
| Selects a tissue layer for descriptor and cosmetic purposes.

|-
| SET_LAYER_TISSUE
|
| Sets a tissue layer to be made of a different tissue.

|-
| TISSUE_LAYER
|
*BY_TYPE, BY_CATEGORY, BY_TOKEN
*TYPE,CATEGORY, or TOKEN
*TISSUE
*LOCATION
| Adds the tissue layer to wherever it is required.
Non-argument Locations can be FRONT, RIGHT, LEFT, TOP, BOTTOM. Argument locations are AROUND and CLEANS, requiring a further body part and a % of coverage/cleansing

|-
| TISSUE_LAYER_OVER
|
*BY_TYPE, BY_CATEGORY, BY_TOKEN
*TYPE,CATEGORY, or TOKEN
*TISSUE
*LOCATION
| Presumably a counterpart to TISSUE_LAYER_UNDER (see below).

|-
| TISSUE_LAYER_UNDER
|
*BY_TYPE, BY_CATEGORY, BY_TOKEN
*TYPE,CATEGORY, or TOKEN
*TISSUE
| Adds the tissue layer under a given part.
For example an Iron Man has a gaseous poison within and this tissue (GAS is its name) has the token [TISSUE_LEAKS] and its state is GAS so when you puncture the iron outside and damage this tissue it leaks gas (can have a syndrome by using a previous one in the creature sample.) [TISSUE_LAYER_UNDER:BY_CATEGORY:ALL:{tissue}] {tissue} is what will be under the TISSUE_LAYER here is an example Tissue from Iron Man
[TISSUE:GAS]
[TISSUE_NAME:gas:NP] [TISSUE_MATERIAL:LOCAL_CREATURE_MAT:GAS] [TISSUE_MAT_STATE:GAS] [RELATIVE_THICKNESS:50] [TISSUE_LEAKS] [TISSUE_SHAPE:LAYER]

|-
| TISSUE_LAYER_APPEARANCE_MODIFIER
|
*QUALITY
*lowest:lower:low:median:high:higher:highest
| sets the range of qualities, including LENGTH, DENSE, HIGH_POSITION, CURLY, GREASY, WRINKLY

|-
| TISSUE_LEAKS
|
| The selected tissue leaks out of the creature when the layers above it are pierced. As per an iron man's internal poison gas.

|-
| TISSUE_MATERIAL
|
*VALUE (material)
*MATERIAL (material subtype)
| Defines the tissue material. VALUE can be LOCAL_CREATURE_MAT, INORGANIC etc. MATERIAL is a subtype of the material, e.g. [TISSUE_MATERIAL:INORGANIC:BRONZE]

|-
| TISSUE_STYLE_UNIT
|
*tissue
*shaping
| sets tissue to be in a certain shape, mostly used with tissues HAIR, BEARD, MOUSTACHE, SIDEBURNS.

|-
| TL_COLOR_MODIFIER
| COLOR:freq:COLOR:freq etc
| Creates a list of color patterns, giving each a frequency.

|-
| TL_CONNECTS
|
| Presumably gives the CONNECTS attribute to selected layers.

|-
| TL_HEALING_RATE
|
| Presumably changes the HEALING_RATE of the selected tissue layers.

|-
| TL_MAJOR_ARTERIES
|
| Gives Major Artery attribute to selected layers.

|-
| TL_PAIN_RECEPTORS
|
| Seems to set new number of pain receptors for selected tissue layers.

|-
| TL_RELATIVE_THICKNESS
|
| Seems to set new relative thickness for selected tissue layers.

|-
| TL_VASCULAR
|
| Seems to set new a VASCULAR value (which modulates bleeding) for selected tissue layers.

|}

==See Also==
*{{L|Body detail plan token}}
*{{L|Body token}}
*{{L|Material definition token}}
*{{L|Syndrome}}
*{{L|Tissue definition token}}

{{Category|Modding}}
{{Category|Tokens}}

v0.31:Tissue definition token

2011-11-06T19:12:19Z

I2amroy: /* Defaults */

{{quality|Fine|21:41, 22 February 2011 (UTC)}}{{av}}

__TOC__

{| {{prettytable}}
|- bgcolor="#999999"
! Token
! Arguments
! Description

|-
| TISSUE_NAME
|
*name
*value
|name = name.
value = plural name, NP (No Plural) or STP (Standard Plural, adds an 's' on the end).

|-
| TISSUE_MATERIAL
|
* {{L|material token}}
| Defines the tissue material.

|-
| RELATIVE_THICKNESS
|
*value
| The thickness of the tissue. A higher thickness is harder to penetrate.

|-
| HEALING_RATE
|
*value
| Lower is faster. Omitting the token will result in a tissue that never heals.

|-
| VASCULAR
|
*value
| Related to how much said tissue bleeds. Higher = More bleeding
(Which is why the heart has the highest value.)

|-
| PAIN_RECEPTORS
|
*value
| Related to how much pain your character will suffer when said tissue is damaged. Higher = More pain when damaged
(Which is why the bone tissue has a much higher value than other tissues. A broken bone hurts a lot more than a cut.)

|-
| THICKENS_ON_STRENGTH
| N/A
| The thickness of the tissue increases when character strength increases.

|-
| THICKENS_ON_ENERGY_STORAGE
| N/A
| Thickness of said tissue increases when the character eats and doesn't exercise sufficiently.

|-
| ARTERIES
| N/A
| The tissue contains arteries.

|-
| SCARS
| N/A
| Simply whether or not the tissue will be scarred once healed.

|-
| STRUCTURAL
| N/A
| ?

|-
| CONNECTIVE_TISSUE_ANCHOR
| N/A
| ?

|-
| SETTABLE
| N/A
| The tissue can be set if broken.

|-
| SPLINTABLE
| N/A
| The tissue can be wrapped in a splint if broken.

|-
| FUNCTIONAL
| N/A
| The tissue performs some sort of special function (e.g. sight, hearing, breathing, etc.)

|-
| NERVOUS
| N/A
| Unknown - not used.

|-
| THOUGHT
| N/A
| Unknown - not used.

|-
| MUSCULAR
| N/A
| Seems to affect where sensory or motor nerves are located.

|-
| SMELL
| N/A
| Unknown - not used.

|-
| HEAR
| N/A
| Unknown - not used.

|-
| FLIGHT
| N/A
| Unknown - not used.

|-
| BREATHE
| N/A
| Unknown - not used.

|-
| SIGHT
| N/A
| Unknown - not used.

|-
| CONNECTS
| N/A
| ?

|-
| MAJOR_ARTERIES
| N/A
| Unknown - may cause tissue to severely bleed when damaged.

|-
| INSULATION
|
*value
| Tissue supplies the creature with heat insulation. Higher values result in more insulation.

|-
| COSMETIC
| N/A
| ?

|-
| STYLEABLE
| N/A
| The tissue can be styled as per a tissue style (defined in an {{L|Entity_token|entity}} entry)

|-
| TISSUE_SHAPE
|
*value
| Value can be LAYER, STRANDS, FEATHERS, SCALES, or CUSTOM.

|-
| SUBORDINATE_TO_TISSUE
|
*value
| Tissue is implicitly attached to another tissue. Used for hair and feathers.

|-
| TISSUE_MAT_STATE
|
*SOLID, LIQUID, or GAS
(possibly others, such as POWDER as well. Needs testing.)
| Sets/forces a default material state for the selected tissue.

|-
| TISSUE_LEAKS
| N/A
| The selected tissue leaks out of the creature when the layers above it are pierced.

|}

==Tissue Layer Tokens==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
|SET_LAYER_TISSUE
|
* tissue
| Sets a tissue layer to be made of a different tissue.

|-
|TL_RELATIVE_THICKNESS
|
* value
| Seems to set new relative thickness for selected tissue layers.

|-
|TL_CONNECTS
|
| Presumably gives the CONNECTS attribute to selected layers.

|-
|TL_MAJOR_ARTERIES
|
| Gives Major Artery attribute to selected layers.

|-
|TL_HEALING_RATE
|
* value
| Presumably changes the HEALING_RATE of the selected tissue layers.

|-
|TL_VASCULAR
|
| Seems to set new a VASCULAR value (which modulates bleeding) for selected tissue layers.

|-
|TL_PAIN_RECEPTORS
|
| Seems to set new number of pain receptors for selected tissue layers.

|}

==Defaults==
Default values (as of 0.31.21)
{| {{prettytable}} style="margin: 1em 1em 1em 0; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse; font-size: 70%;"
|- bgcolor="#999999"
! style="font-size: 150%;"| TISSUE_TEMPLATE !! TISSUE_NAME !! TISSUE_MATERIAL !! TISSUE_MAT_STATE !! RELATIVE_THICKNESS !! HEALING_RATE !! VASCULAR !! PAIN_RECEPTORS !! SUBORDINATE_TO_TISSUE !! INSULATION !! TISSUE_SHAPE
|-
| SKIN_TEMPLATE || skin:NP || LOCAL_CREATURE_MAT:SKIN || || 1 || 100 || 1 || 5 || || || LAYER
|-
| FAT_TEMPLATE || fat:NP || LOCAL_CREATURE_MAT:FAT || || 1 || 100 || 3 || 5 || || 100 || LAYER
|-
| MUSCLE_TEMPLATE || muscle:muscles || LOCAL_CREATURE_MAT:MUSCLE || || 3 || 100 || 5 || 5 || || || LAYER
|-
| BONE_TEMPLATE || bone:NP || LOCAL_CREATURE_MAT:BONE || || 2 || 1000 || 3 || 50 || || || LAYER
|-
| SHELL_TEMPLATE || shell:NP || LOCAL_CREATURE_MAT:SHELL || || 2 || 1000 || || || || || LAYER
|-
| HORN_TEMPLATE || horn:NP || LOCAL_CREATURE_MAT:HORN || || 2 || || || || || || LAYER
|-
| HOOF_TEMPLATE || hoof:NP || LOCAL_CREATURE_MAT:HOOF || || 2 || || || || || || LAYER
|-
| CARTILAGE_TEMPLATE || cartilage:NP || LOCAL_CREATURE_MAT:CARTILAGE || || 2 || || || || || || LAYER
|-
| HAIR_TEMPLATE || hair:NP || LOCAL_CREATURE_MAT:HAIR || || 1 || || || || SKIN || 100 || STRANDS
|-
| CHEEK_WHISKERS_TEMPLATE || cheek whisker:STP || LOCAL_CREATURE_MAT:HAIR || || 2 || || || || SKIN || || STRANDS
|-
| CHIN_WHISKERS_TEMPLATE || chin whisker:STP || LOCAL_CREATURE_MAT:HAIR || || 2 || || || || SKIN || || STRANDS
|-
| MOUSTACHE_TEMPLATE || moustache:NP || LOCAL_CREATURE_MAT:HAIR || || 2 || || || || SKIN || || STRANDS
|-
| SIDEBURNS_TEMPLATE || sideburns:NP || LOCAL_CREATURE_MAT:HAIR || || 2 || || || || SKIN || || STRANDS
|-
| EYEBROW_TEMPLATE || eyebrow:NP || LOCAL_CREATURE_MAT:HAIR || || 2 || || || || SKIN || || STRANDS
|-
| EYELASH_TEMPLATE || eyelash:eyelashes || LOCAL_CREATURE_MAT:HAIR || || 2 || || || || SKIN || || STRANDS
|-
| FEATHER_TEMPLATE || feather:STP || LOCAL_CREATURE_MAT:FEATHER || || 2 || || || || SKIN || 100 || FEATHERS
|-
| SCALE_TEMPLATE || scale:STP || LOCAL_CREATURE_MAT:SCALE || || 1 || 100 || 1 || 5 || || || SCALES
|-
| NAIL_TEMPLATE || nail:NP || LOCAL_CREATURE_MAT:NAIL || || 2 || || || || || || LAYER
|-
| CLAW_TEMPLATE || claw:NP || LOCAL_CREATURE_MAT:CLAW || || 2 || || || || || || LAYER
|-
| TALON_TEMPLATE || talon:NP || LOCAL_CREATURE_MAT:TALON || || 2 || || || || || || LAYER
|-
| TOOTH_TEMPLATE || tooth:NP || LOCAL_CREATURE_MAT:TOOTH || || 2 || || || || || || LAYER
|-
| IVORY_TEMPLATE || ivory:NP || LOCAL_CREATURE_MAT:IVORY || || 2 || || || || || || LAYER
|-
| EYE_TEMPLATE || eye tissue:NP || LOCAL_CREATURE_MAT:EYE || || 1 || 100 || 3 || 5 || || || LAYER
|-
| NERVE_TEMPLATE || nervous tissue:NP || LOCAL_CREATURE_MAT:NERVE || || 1 || || 3 || || || || LAYER
|-
| BRAIN_TEMPLATE || brain tissue:NP || LOCAL_CREATURE_MAT:BRAIN || || 1 || || 3 || || || || LAYER
|-
| LUNG_TEMPLATE || lung tissue:NP || LOCAL_CREATURE_MAT:LUNG || || 1 || 100 || 8 || 5 || || || LAYER
|-
| HEART_TEMPLATE || heart tissue:NP || LOCAL_CREATURE_MAT:HEART || || 1 || 100 || 10 || 5 || || || LAYER
|-
| LIVER_TEMPLATE || liver tissue:NP || LOCAL_CREATURE_MAT:LIVER || || 1 || 100 || 8 || 5 || || || LAYER
|-
| GUT_TEMPLATE || gut:NP || LOCAL_CREATURE_MAT:GUT || || 1 || 100 || 3 || 5 || || || LAYER
|-
| STOMACH_TEMPLATE || stomach tissue:NP || LOCAL_CREATURE_MAT:STOMACH || || 1 || 100 || 3 || 5 || || || LAYER
|-
| PANCREAS_TEMPLATE || pancreatic tissue:NP || LOCAL_CREATURE_MAT:PANCREAS || || 1 || 100 || 3 || 5 || || || LAYER
|-
| SPLEEN_TEMPLATE || spleen tissue:NP || LOCAL_CREATURE_MAT:SPLEEN || || 1 || 100 || 5 || 5 || || || LAYER
|-
| KIDNEY_TEMPLATE || kidney tissue:NP || LOCAL_CREATURE_MAT:KIDNEY || || 1 || 100 || 8 || 5 || || || LAYER
|-
| FLAME_TEMPLATE || flames:NP || LOCAL_CREATURE_MAT:FLAME || GAS || 1 || || || || || || LAYER
|-
| CHITIN_TEMPLATE || chitin:NP || LOCAL_CREATURE_MAT:CHITIN || || 1 || 100 || 1 || 5 || || || LAYER
|- bgcolor="#999999"
! style="font-size: 150%;"| TISSUE_TEMPLATE !! TISSUE_NAME !! TISSUE_MATERIAL !! TISSUE_MAT_STATE !! RELATIVE_THICKNESS !! HEALING_RATE !! VASCULAR !! PAIN_RECEPTORS !! SUBORDINATE_TO_TISSUE !! INSULATION !! TISSUE_SHAPE
|}

Default flags (as of 0.31.21)
{| {{prettytable}} style="margin: 1em 1em 1em 0; background: #f9f9f9; border: 1px #aaa solid; border-collapse: collapse; font-size: 70%;"
|- bgcolor="#999999" style="font-size: 70%;"
! style="font-size: 150%;"| TISSUE_TEMPLATE !! THICKENS_ON_ENERGY_STORAGE !! THICKENS_ON_STRENGTH !! ARTERIES !! SCARS !! MUSCULAR !! FUNCTIONAL !! STRUCTURAL !! CONNECTIVE_TISSUE_ANCHOR !! CONNECTS !! SETTABLE !! SPLINTABLE !! COSMETIC !! STYLEABLE
|-
| SKIN_TEMPLATE || || || || X || || || || || X || || || ||
|-
| FAT_TEMPLATE || X || || || X || || || || || X || || || ||
|-
| MUSCLE_TEMPLATE || || X || X || X || X || || || || X || || ||
|-
| BONE_TEMPLATE || || || || || || || X || X || X || X || X || ||
|-
| SHELL_TEMPLATE || || || || || || || X || || X || X || X || ||
|-
| HORN_TEMPLATE || || || || || || || X || || X || || ||
|-
| HOOF_TEMPLATE || || || || || || || X || || X || || ||
|-
| CARTILAGE_TEMPLATE || || || || || || || X || || X || || ||
|-
| HAIR_TEMPLATE || || || || || || || || || || || || X || X
|-
| CHEEK_WHISKERS_TEMPLATE || || || || || || || || || || || || X || X
|-
| CHIN_WHISKERS_TEMPLATE || || || || || || || || || || || || X || X
|-
| MOUSTACHE_TEMPLATE || || || || || || || || || || || || X || X
|-
| SIDEBURNS_TEMPLATE || || || || || || || || || || || || X || X
|-
| EYEBROW_TEMPLATE || || || || || || || || || || || || X || X
|-
| EYELASH_TEMPLATE || || || || || || || || || || || || X || X
|-
| FEATHER_TEMPLATE || || || || || || || || || || || ||
|-
| SCALE_TEMPLATE || || || || X || || || || || X || || || ||
|-
| NAIL_TEMPLATE || || || || || || || X || || X || || || ||
|-
| CLAW_TEMPLATE || || || || || || || X || || X || || || ||
|-
| TALON_TEMPLATE || || || || || || || X || || X || || || ||
|-
| TOOTH_TEMPLATE || || || || || || || X || || X || || || ||
|-
| IVORY_TEMPLATE || || || || || || || X || || X || || || ||
|-
| EYE_TEMPLATE || || || || X || || X || X || || X || || ||
|-
| NERVE_TEMPLATE || || || || X || || X || || || X || || ||
|-
| BRAIN_TEMPLATE || || || || X || || X || X || || X || || ||
|-
| LUNG_TEMPLATE || || || || X || || X || X || || X || || ||
|-
| HEART_TEMPLATE || || || || X || || X || X || || X || || ||
|-
| LIVER_TEMPLATE || || || || X || || X || X || || X || || ||
|-
| GUT_TEMPLATE || || || || X || || X || X || || X || || ||
|-
| STOMACH_TEMPLATE || || || || X || || X || X || || X || || ||
|-
| PANCREAS_TEMPLATE || || || || X || || X || X || || X || || ||
|-
| SPLEEN_TEMPLATE || || || || X || || X || X || || X || || ||
|-
| KIDNEY_TEMPLATE || || || || X || || X || X || || X || || ||
|-
| FLAME_TEMPLATE || || || || || X || X || X || || X || || ||
|-
| CHITIN_TEMPLATE || || || || X || || || X || X || X || X || X || ||

|- bgcolor="#999999" style="font-size: 70%;"
! style="font-size: 150%;"| TISSUE_TEMPLATE !! THICKENS_ON_ENERGY_STORAGE !! THICKENS_ON_STRENGTH !! ARTERIES !! SCARS !! MUSCULAR !! FUNCTIONAL !! STRUCTURAL !! CONNECTIVE_TISSUE_ANCHOR !! CONNECTS !! SETTABLE !! SPLINTABLE !! COSMETIC !! STYLEABLE
|}

==See Also==
*Material definition token

{{Category|Modding}}
{{Category|Tokens}}

v0.31:Syndrome

2011-11-06T19:09:13Z

I2amroy: /* Creature effect tokens */ Alphabetized the table and separated it by targetable/non-targetable

{{quality|Masterwork|21:09, 26 April 2011 (UTC)}}{{av}}

A '''syndrome''' is a disease or effect that a poor hapless creature might get through encountering certain creatures, extracts or vindictive modders. They generally cause unpleasant and frequently fatal {{L|symptoms}} over a short to long period of time, but some will clear up over time or with the assistance of a {{L|doctor}}. A {{L|Hospital}} is required to diagnose and potentially treat the syndrome. [[File:Snakebite.png|200px|thumb|right|An example of a syndrome in effect. This hippo did not ultimately survive the encounter despite one bite being the only injury sustained.]]

==List of syndromes==
{| {{prettytable}}
|- bgcolor="#dddddd"
! Syndrome
! Venom
! Acquired
! Short-term Symptoms
! Long-term Symptoms
! Chronic Symptoms
|-
| Blob blisters
| cave blob fluid<br />(contact)
| Touching a {{L|cave blob}}
| Mild pain<br/>Mild blisters
| None
| None
|-
| Cave floater sickness
| cave floater gas<br />(inhaled)
| Expelled from {{L|cave floater}}
| Mild nausea
| Fever<br/>Strong drowsiness (delayed)<br/>Strong dizziness (delayed)
| None
|-
| Cave spider bite
| cave spider venom<br />(injected)
| Being bitten by a {{L|cave spider}}
| None
| None
| Very mild dizziness
|-
| Phantom spider bite
| phantom spider venom<br />(injected)
| Being bitten by a {{L|phantom spider}}
| None
| Numbness and mild dizziness
| None
|-
| Giant cave spider bite
| giant cave spider venom<br />(injected)
| Being bitten by a {{L|giant cave spider}}
| Complete paralysis<sup>1</sup><br/>'''Being eaten by the GCS'''
| None, not that it really matters.
| None
|-
| Gnomeblight
| {{L|gnomeblight}}<br />(contact, inhaled, or injected)
| Unknown. Affects gnomes only
| None
| Severe systemic necrosis<sup>2</sup>
| None
|-
| Giant desert scorpion sting
| giant desert scorpion<br />(injected)
| Being stung by a {{L|giant desert scorpion}}
| None
| Necrosis of the brain and nervous system<sup>2</sup>
| None
|-
| Helmet snake bite
| helmet snake venom<br />(injected)
| Being bitten by a {{L|helmet snake}}
| Minor bleeding
| Fever<br/>Nausea<br/>Dizziness<br/>Localized swelling<br/>Localized oozing<br/>Localized bruising<br/>Strong pain<br/>Intense localized necrosis<br/>Possible loss of limb
| None
|-
| Iron man cough
| iron man gas<br />(inhaled)
| Expelled by {{L|iron man}}
| Coughing blood
| None
| None
|-
| Platypus sting
| platypus venom<br />(injected)
| Being kicked by a {{L|platypus}}, {{L|giant platypus}} or {{L|platypus man}}
| Pain and swelling
| Extreme pain, swelling possibly to the point of necrosis
| None
|-
| Serpent man bite
| serpent man venom<br />(injected)
| Being bitten by a {{L|serpent man}}
| Complete paralysis<sup>1</sup>
| None
| None
|-
| beast sickness<sup>3</sup>
| random
| Encounters with {{L|forgotten beast}}s
| random
| random
| random
|-
| titan sickness<sup>3</sup>
| random
| Encounters with {{L|titan}}s
| random
| random
| random
|-
| demon sickness<sup>3</sup>
| random
| Encounters with {{L|demon}}s
| random
| random
| random
|}
:<small>1. For small creatures such as humans and dwarves, paralysis tends to result in suffocation.</small>
:<small>2. Necrosis of the brain will eventually result in instant death once the brain rots away completely.</small>
:<small>3. {{L|Titan}}s, {{L|forgotten beast}}s, and {{L|demon}}s have a chance to have a randomized syndrome. These range from pointless (mild blisters from inhaling boiling blood) to instantly deadly (Severe necrosis from a contact poison attached to a breath weapon/creature made of blood.</small>

==The anatomy of a syndrome==
Mechanically, syndromes are bundles of tokens attached to a material - they're confined to creature materials in vanilla DF, but it's a simple matter to add them to inorganic materials. When the material is injected, touched or inhaled (depending on the syndrome), the creature suffers the predations of a nasty disease or poison. Here's an example syndrome, taken from the Giant Cave Spider raws.

If you are having troubles getting the syndromes to work (ie, in combat reports, getting "'''supersnake''' n/a splatters~etc"), then simply throw the venom template into the actual creature's raw, which is what the LOCAL_CREATURE_MAT actually calls on; the venom being in the same file.

[USE_MATERIAL_TEMPLATE:POISON:CREATURE_EXTRACT_TEMPLATE]
[STATE_NAME:ALL_SOLID:frozen giant cave spider venom]
[STATE_ADJ:ALL_SOLID:frozen giant cave spider venom]
[STATE_NAME:LIQUID:giant cave spider venom]
[STATE_ADJ:LIQUID:giant cave spider venom]
[STATE_NAME:GAS:boiling giant cave spider venom]
[STATE_ADJ:GAS:boiling giant cave spider venom]
[PREFIX:NONE]
[ENTERS_BLOOD]
[SYNDROME]
[SYN_NAME:giant cave spider bite]
[SYN_AFFECTED_CLASS:GENERAL_POISON]
[SYN_IMMUNE_CREATURE:SPIDER_CAVE:ALL]
[SYN_INJECTED]
[CE_PARALYSIS:SEV:100:PROB:100:RESISTABLE:SIZE_DILUTES:START:5:PEAK:10:END:20]

The first line, USE_MATERIAL_TEMPLATE, is creating a new material, called POISON, using the CREATURE_EXTRACT_TEMPLATE as the basis. After this, the STATE_NAME and STATE_ADJ tokens are used to define the names and adjectives assigned to different states of the material - GAS, LIQUID and ALL_SOLID, in this case, though ALL is also a valid token. At this stage, you can use any material tags like MAT_FIXED_TEMP or similar to set further material properties, though this usually isn't necessary.

ENTERS_BLOOD
This tag determines whether a poison enters the blood or not. If it is not included, the poison will splatter (if liquid) or flow (if gas) over the affected body part instead when injected. If you're using a contact poison, leave this out. Necessary for injected poisons.
SYNDROME
This tag ends the material details and begins the definition of the actual syndrome.
SYN_NAME
This one is self-explanatory - the name of the syndrome as it will appear in-game.
SYN_AFFECTED_CLASS
This token defines what CREATURE_CLASS will be affected by the syndrome. Most creatures are classed under GENERAL_POISON. Multiple tokens can be used in a single syndrome.
SYN_IMMUNE_CLASS
As above, but makes class immune.
SYN_IMMUNE_CREATURE
This token defines which creatures CANNOT be affected by the syndrome - useful for addressing specific instances within a population, such as a specific caste or an individual creature that falls under GENERAL_POISON. Syntax is [SYN_IMMUNE_CREATURE:creature:caste]. ALL can be used for the caste.
SYN_AFFECTED_CREATURE
As above, but makes creature or caste susceptible.

SYN_INJECTED, SYN_CONTACT, SYN_INHALED
This token determines the method of infection - injected syndromes must be injected via a creature attack, while contact syndromes result from any contamination of a creature by material splatter (such as blood) and inhaled syndromes must be inhaled in gaseous form, such as from boiling or a creature breath attack. Any combination of these tags can be used. A fun variation on the usual creature injection routine is to create a material with a SYN_CONTACT syndrome and have a creature use it for blood - this tends to end poorly for any predator that chooses to attack them.

[SPECIALATTACK_INJECT_EXTRACT:LOCAL_CREATURE_MAT:VENOM:LIQUID:100:100]
This is one method for getting a poison into a creature. If [ENTERS_BLOOD] is applied, it will be injected into the bloodstream. Otherwise, it will just splatter over the area. Put this on a creature attack. Substance type (gas, liquid, solid) does not appear to have an effect. The numbers on the end are minimum and maximum.

CE_X, or creature effect tokens, are the real meat and bones of your syndrome. They're detailed below.

==Creature effect tokens==
Each and every syndrome has a number of creature effect tokens, represented by CE_X - these lovely little beauties determine exactly how the poor creature suffering from the syndrome is affected. An example CE token is as follows:

[CE_NECROSIS:SEV:100:PROB:100:LOCALIZED:VASCULAR_ONLY:RESISTABLE:START:50:PEAK:1000:END:2000]

In this example, we have an effect that will always cause severe necrosis in whichever bodypart it touches, so long as that bodypart is vascular and that the creature is not able to resist it in some manner. The effect begins shortly after the syndrome is contracted, peaks 1000 {{L|time|time units}} afterwards, and finally ceases another 1000 time units later.

As a general rule of thumb, so long as CE_X starts the string and START/PEAK/END end it, the order of the intervening tokens isn't important.

*CE_X
The effect type. This can be a number of different tokens, as detailed in the table below this list.
*SEV:X
The severity of the effect. Higher values appear to be worse, with SEV:1000 CE_NECROSIS causing a part to near-instantly become rotten.
*PROB:X
The probability of the effect actually manifesting in the victim, as a percentage. 100 means always, 1 means a 1 in 100 chance.
*LOCALIZED (Overwrites BP tokens)
This tag causes an effect to ignore all BP tokens and then forces the game to attempt to apply the effect to the limb that came into contact with the contagion - ie. the part that was bitten by the creature injecting the syndrome material, or the one that was splattered by a contact contagion. If an effect can not be applied to the contacted limb (i.e. IMPAIR_FUNCTION on a non-organ) then this token makes the syndrome have no effect. This token also makes inhaled syndromes have no effect.
*BP:BODY_PART:TISSUE (Overwritten by LOCALIZED)
Specifies which body parts and tissues are to be affected by the syndrome. BODY_PART can be BY_CATEGORY:x to target body parts with a matching [CATEGORY:x] {{L|body token}} (or ALL to affect everything), BY_TYPE:x to target body parts having a particular type (UPPERBODY, LOWERBODY, HEAD, GRASP, or STANCE), or BY_TOKEN:x to target individual body parts by their ID (as specified in the [BP] token). For example, if you wanted to target the lungs of a creature, you would use BP:BY_CATEGORY:LUNG:ALL. The syndrome would act on all bodyparts within the creature with the CATEGORY tag LUNG and affect all tissue layers. For another example, say you wanted to cause the skin to rot off a creature - you could use BP:BY_CATEGORY:ALL:SKIN, targeting the SKIN tissue on all bodyparts. Multiple targets can be given in one syndrome by placing the BP tokens end to end. This is one of the most powerful and useful aspects of the syndrome system, as it allows you to selectively target bodyparts relevant to the contagion, like lungs for coal dust inhalation, or the eyes for exposure to an acid gas. Not everything takes a target!
*VASCULAR_ONLY (Optional)
This syndrome only affects tissue layers with the VASCULAR token.
*MUSCULAR_ONLY (Optional)
This syndrome only affects tissue layers with the MUSCULAR token. Are you seeing a trend here?
*SIZE_DILUTES (Optional)
This token presumably causes the effects of the syndrome to scale with the size of the creature compared to the size of the dose of contagion they received, but has yet to be extensively tested.
*SIZE_DELAYS (Optional)
As above, this token has yet to be tested but presumably delays the onset of a syndrome according to the size of the victim.

The details of this table are still being thrashed out by modders, so if you have anything to add, please don't hesitate to hit the edit button!

Non-targeted syndromes will ignore any BP tokens and LOCALIZED tokens.
{| {{prettytable}}
|- bgcolor="Bisque"
! Token
! Accepts Target
! Description
|-
| CE_BLEEDING
| Yes
| Causes the targeted bodypart to start bleeding, with heavy enough bleeding resulting in the death of the sufferer. Some conditions seem to cause bleeding to be fatal no matter how weak.
|-
| CE_BLISTERS
| Yes
| Covers the targeted bodypart with blisters.
|-
| CE_BRUISING
| Yes
| Causes the targeted bodypart to undergo bruising.
|-
| CE_IMPAIR_FUNCTION
| Yes
| An organ afflicted with this CE is rendered inoperable - for example, if both lungs are impaired the creature can't breathe and will suffocate. This token only affects organs, not limbs.
|-
| CE_NECROSIS
| Yes
| Causes the targeted bodypart to rot, with associated tissue damage and miasma. Badly necrotic limbs will require amputation and heavy rot will eventually result in bleeding. Necrosis has some strange behavior involving bleeding to death that isn't fully understood; a 100% necrotic creature can survive fine with no non-yellow bodyparts but will die of bleeding as soon as they end a round of combat, even if they never take a hit. Because of this, fairly useless unless targeting the lungs or eyes.
|-
| CE_NUMBNESS
| Yes
| Causes numbness in the affected body part, blocking pain. Extreme numbness may lead to sensory nerve damage.
|-
| CE_OOZING
| Yes
| Causes pus to ooze from the afflicted bodypart.
|-
| CE_PAIN
| Yes
| Afflicts the targeted bodypart with intense pain.
|-
| CE_PARALYSIS
| Yes
| Causes paralysis in the affected body part. Targeted causes sluggishness and significantly reduces speed. Untargeted paralysis is 'complete paralysis' and will cause suffocation in smaller creatures.
|-
| CE_SWELLING
| Yes
| Causes the targeted bodypart to swell up. Extreme swelling may lead to necrosis.
|-
| CE_COUGH_BLOOD
| No
| This effect results in the sufferer periodically coughing blood, which stains the tile they're on and requires cleanup. It doesn't appear to be lethal, but may cause minor bleeding damage.
|-
| CE_DIZZINESS
| No
| Inflicts the Dizziness condition, occasional fainting and a general slowdown in movement and work speed.
|-
| CE_DROWSINESS
| No
| Causes the Drowsiness condition.
|-
| CE_FEVER
| No
| Causes the Fever condition.
|-
| CE_NAUSEA
| No
| Causes the Nausea condition, and heavy vomiting. Can eventually lead to dehydration and death.
|-
| CE_UNCONSCIOUSNESS
| No
| Renders unconscious.
|-
| CE_VOMIT_BLOOD
| No
| This effect results in the sufferer periodically vomiting blood, which stains the tile they're on and requires cleanup. It doesn't appear to be lethal, but may cause minor bleeding damage.
|}

==Inorganic syndromes and you!==
It's perfectly possible - and quite simple - to add a nasty syndrome to a type of rock or metal - you simply add the syndrome tokens to the material definition in the same manner that you would add them to a creature material definition. The only catch is that since your hapless dwarves will only normally encounter the material in metal, gem or boulder form, a bit of creativity must be used to actually get them inside your citizens - that is, you need to make them 'explosively boil' as soon as they're mined or produced. This has the sad side effect of destroying the actual item - sorry, no highly radioactive uranium this release.

The easiest way to accomplish this is to assign the material a low boiling point, usually just under room temperature, and make sure its temperature is fixed to a point above it.
[MAT_FIXED_TEMP:9001]
[BOILING_POINT:9000]
Now, as soon as this substance hits the open air - by being mined, smelted or reaction-produced at a custom workshop - it will EXPLOSIVELY BOIL, flooding a small area with delicious syndrome-rich gas. Creatures who inhale the gas will be immediately hit with the syndrome you thoughtfully attached to the material definition earlier!

There are a number of other tokens you can use to control the colour and naming conventions of your syndrome material, referred to as MATERIAL tokens.

==Breath attacks==
If you want to really make a creature deadly, you can give it a breath attack to shoot your neurotoxin at your hapless dwarves from range. Some of these attacks have the unfortunate side effect of preventing a critter from using its regular attacks unless the enemy is ''on the same tile.'' You decide if it's worth it.

To use a breath attack, place something like the following anywhere in your creature entry:

[MATERIAL_BREATH_ATTACK:LOCAL_CREATURE_MAT:SPITTER_SPIT:SOLID_GLOB]

The LOCAL_CREATURE_MAT:SPITTER_SPIT refers to the material the breath attack will be made of - in this case, it is another material defined within the creature entry.

===Breath Attack Types===

{| {{prettytable}}
|- bgcolor="#ddd"
! | Token
! | Description
|-
| TRAILING_GAS_FLOW
| Shoots a trail of gas substance at the creature. Fairly easy to dodge. Creature will attack as normal.
|-
| TRAILING_VAPOR_FLOW
| Similar to the trailing gas, but easier to breathe in, and condensed, so it will collect on creatures. Creature will attack as normal.
|-
| TRAILING_DUST_FLOW
| Lets out a cloud of solid dust. Appears to use cave-in dust physics, causing this to fling around anything it comes in contact with, making it capable of smashing creatures into the ground and flinging them over walls. Creature will attack as normal.
|-
| SOLID_GLOB
| Shoots a solid glob of spinning substance at the creature, leaving symbols similar to broken arrows. Essentially a projectile weapon. Some creatures with this breath attack will not move, preferring instead to stay and shoot globs at you, even when you are literally right next to them.
|-
| LIQUID_GLOB
| Shoots a '''solid''' glob of spinning substance at the creature. Essentially the same as SOLID_GLOB. May do less damage.
|-
| UNDIRECTED_GAS
| Creature occasionally releases a cloud of substance. Similar to TRAILING_GAS_FLOW, but undirected, thus affecting a larger area but losing the distance. Creature will attack as normal.
|-
| UNDIRECTED_VAPOR
| Creature occasionally releases a cloud of substance. Similar to TRAILING_VAPOR_FLOW, but undirected, thus affecting a larger area but losing the distance. Creature will attack as normal.
|-
| UNDIRECTED_DUST
| Creature occasionally releases a large cloud of substance, which will spread and dissipate. Similar to TRAILING_DUST_FLOW, but undirected, thus affecting a larger area but losing the distance - range is roughly the same as that of a cave-in. Creature will attack as normal. <s>DO NOT USE THIS TAG UNLESS YOU WANT TO KILL THE CREATURE AND EVERYTHING NEAR IT AND SEND PEOPLE FLYING.</s> You know you want to.
|}

Keep in mind that you can use multiple breath attacks, which appears to make the creature choose between them at random.

{{Category|Modding}}
[[ru:DF2010:Syndrome]]

v0.31:Creature token

2011-11-06T18:49:46Z

I2amroy: /* F */

{{av}}{{Quality|Exceptional}}

A full list of all known creature tokens.

__NOTOC__

<div align="center">
{{alphabetical TOC}}
</div>

==A==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| ADOPTS_OWNER
|
| Tame creature cannot be made available for adoption, instead automatically adopting whoever it wants. It appears that the basic requirements for adoption are intact; for example, the creature is more likely to adopt an owner which likes creatures of that species.{{verify}}

|-
| ALCOHOL_DEPENDENT
|
| Creature needs alcohol to get through the working day.

|-
| ALL_ACTIVE
|
| Sets if the creature is active in day, night, and twilight. Seems to be a separate value from DIURNAL/NOCTURNAL/CREPUSCULAR, rather than implying them.

|-
| ALTTILE
|
| If set, the creature will blink between its [TILE] and its [ALTTILE].

|-
| AMBUSHPREDATOR
|
| Instead of charging relentlessly at prey, a creature with this tag will wait till the prey is within a few squares before charging.{{verify}}

|-
| AMPHIBIOUS
|
| Allows a creature to breathe with or without {{L| water}}. Implies [AQUATIC].

|-
| APP_MOD_DESC_RANGE
|
*Range
| [http://www.bay12forums.com/smf/index.php?topic=60554.msg1766793#msg1766793 Forum post describing how description ranges work]

|-
| APP_MOD_GENETIC_MODEL
|
*Model (Accepts DOMINANT_MORE, DOMINANT_LESS, and MIX)
| Defines a genetic model for the relevant appearance modifier(s). May or may not do anything significant at present.

|-
| APP_MOD_IMPORTANCE
|
*number
| Determines how important the appearance modifier is, for determining whether it shows up in the creature description.{{verify}}

|-
| APP_MOD_NOUN
|
*noun
*SINGULAR or PLURAL
| creates a noun for the appearance and whether it is singular or plural

|-
| APP_MOD_RATE
|
*Rate (integer)
*Scale (DAILY, YEARLY)
*min:max of growth
*start year:start day
*end year:end day
| setting the growth rate of the modifier. The last two tokens can be replaced by NO_END to have growth continue indefinitely.

|-
| APPLY_CREATURE_VARIATION
|
*CV TEMPLATE NAME
| Loads the Creature Variation Template specified.

|-
| APPLY_CURRENT_CREATURE_VARIATION
|
| Applies loaded Creature Variation

|-
| AQUATIC
|
| Allows a creature to breathe underwater, but causes it to "drown" out of {{L|water}}.

|-
| ARENA_RESTRICTED
|
| Does not appear in arena mode list

|-
| ARTIFICIAL_HIVEABLE
|
| Can be kept in artificial hives by beekeepers.

|-
| AT_PEACE_WITH_WILDLIFE
|
| Does not attack or frighten wildlife.

|-
| ATTACK
|
*token
*bodypart
*selection criteria
*location
| Defines the attack name, and the body part used. See [[#Attack Tokens|below]] for valid subtokens
'''Example:'''<br />
[ATTACK:GORE:BODYPART:BY_CATEGORY:HORN]<br />
''GORE'' : name of the attack<br />
''BODYPART:BY_CATEGORY:HORN'' : the horn is used to attack (presuming the creature has one)

|-
| ATTACK_TRIGGER
| pop:exported wealth:created wealth
| Specifies when a {{L|megabeast}} will attack the fortress.

|}

<div align="center">
{{alphabetical TOC}}
</div>

==B==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| BABY
| integer
| Age at which creature is considered a child. Default is zero. One can think of this as the duration of the baby stage.

|-
| BABYNAME
| singular:plural
| Defines a new name for a creature in baby state at the caste level. For non-caste-specific baby names, see GENERAL_BABY_NAME.

|-
| BEACH_FREQUENCY
|
| {{L|Whale}}s and {{L|Sea nettle jellyfish|jellyfish}} have this. Controls the beaching frequency of the creature.

|-
| BENIGN
|
| Determines whether creature can show up on "tame" maps (includes {{L|elephant}}s), which will generally avoid dwarves, although they may chase and/or attack them if they get too close).

|-
| BIOME
|
* {{L|biome token}}
| Select a {{L|Biome}} the creature may appear in.

|-
| BLOOD
|
* {{L|material token}}
*matter state (LIQUID, GAS, SOLID)
| Specifies what the creature's blood is made of.

|-
| BODY
| body parts
| Draws body parts from OBJECT:BODY files (such as body_default.txt)
'''Example:'''<br />
[BODY:BODY_WITH_HEAD_FLAG:HEART:GUTS:BRAIN:MOUTH] <br />
This is the body from a {{L|Purring maggot}}. It creates a body with head, a heart, some guts, a brain, and a mouth. Thats all a maggot needs.

|-
| BODY_APPEARANCE_MODIFIER
|
*ATTRIBUTE
*lowest:lower:low:median:high:higher:highest
| These body modifiers give individual creatures different characteristics. In the case of HEIGHT, BROADNESS and LENGTH, the modifier is also a percentage change to the BODY_SIZE of the individual creature. The seven numbers afterward give a distribution of ranges. Each interval has an equal chance of occurring.
'''Example:'''<br />
[BODY_APPEARANCE_MODIFIER:HEIGHT:90:95:98:100:102:105:110] <br />
''HEIGHT'' : marks the height to be changed <br />
''90:95:98:100:102:105:110'' : sets the range from the shortest (90% of the average height) to the tallest (110% of the average height) creature variation.

|-
| BODY_DETAIL_PLAN
| PlanName, PlanName:type:type:type:etc
| loads a plan listed OBJECT:BODY_DETAIL_PLAN files, such as b_detail_plan_default.txt. Mass applies USE_MATERIAL_TEMPLATE, mass alters RELSIZE, alters body part positions, and will allow tissue layers to be defined. Tissue layers are defined in order of skin to bone here.
'''Example:'''<br />
[BODY_DETAIL_PLAN:VERTEBRATE_TISSUE_LAYERS:SKIN:FAT:MUSCLE:BONE:CARTILAGE] <br />
This creates the detailed body of a {{L|fox}}, the skin, fat, muscle, bones and cartilage out of the vertebrate tissues.<br />
A {{L|Purring maggot|maggot}} would only need:<br />
''[BODY_DETAIL_PLAN:EXOSKELETON_TISSUE_LAYERS:SKIN:FAT:MUSCLE]''

|-
| BODY_SIZE
| years:days:size
| sets up size at a given time. Size is in cubic centimeters (milliliters), and for normal body materials is roughly equal to the creature's average weight in grams.
'''Example:'''<br />
[BODY_SIZE:0:0:10000]<br />
[BODY_SIZE:1:168:50000]<br />
[BODY_SIZE:12:0:220000]<br />
This describes the size of a {{L|minotaur}}. His birth size would be 10000 (10000 mL, ~10 kg). With 1 year and 168 days he would be 50000 tall (~50 kg). As an adult (with 12 years) he would weight roughly 220 kg

|-
| BODYGLOSS
| gloss
| Substitutes body part text with replacement text. Draws gloss information from OBJECT:BODY files (such as body_default.txt)

|-
| BONECARN
|
| Creature 'eats' bones. Eating bones makes their happiness go up, but can cause death (suffocation){{verify}}. Implies CARNIVORE.

|-
| BP_APPEARANCE_MODIFIER
|
*QUALITY
*lowest:lower:low:median:high:higher:highest
| sets up the breadth of possibilities for appearance qualities for a selected BP group. EG. Eyes (CLOSE_SET, DEEP_SET, ROUND_VS_NARROW, LARGE_IRIS),Lips (THICKNESS), Nose (BROADNESS, LENGTH, UPTURNED, CONVEX), Ear (SPLAYED_OUT, HANGING_LOBES, BROADNESS, HEIGHT), Tooth (GAPS), Skull (HIGH_CHEEKBONES, BROAD_CHIN, JUTTING CHIN, SQUARE_CHIN), Neck (DEEP_VOICE, RASPY_VOICE), Head (BROADNESS, HEIGHT)

|-
| BUILDINGDESTROYER
| 1 or 2
| Allows a creature to destroy furniture and buildings. Value [1] targets mostly doors, hatches, furniture and the like. Value [2] targets anything not made with the b + C commands.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==C==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| CAN_LEARN
|
| The creature gets skills and professions. Note that this token makes the creature unable to be butchered by an adventurer so it is not recommended for uncivilized monsters. Adventurers lacking this token can allocate but not increase attributes and skills. skills allocated will disappear on start.

|-
| CAN_SPEAK
|
| Can talk. Note that it is not necessary for a creature to gain social skills. If a member of a civilization (such as a pet) has this token, it'll need to eat and drink.{{verify}}

|-
| CANNOT_UNDEAD
|
| Cannot be turned into a zombie or skeletal undead. Also prevents ghosts of that creature appearing.

|-
| CANOPENDOORS
|
| Allows the creature to open doors.

|-
| CARNIVORE
|
| Creature ''only'' eats meat. Note that carnivorous species will not be able to survive worldgen if they do not also have NO_EAT.

|-
| CASTE
|
*name
| defines a caste

|-
| CASTE_ALTTILE
|
*tile number or "letter"
| Caste-specific alternate tile. Expects CASTE_TILE

|-
| CASTE_COLOR
|
*fg
*bg
*brightness
| Creature tile color of the caste.

|-
| CASTE_GLOWCOLOR
|
*fg
*bg
*brightness
| GLOWTILE color of the caste.

|-
| CASTE_GLOWTILE
|
*tile value or "letter"
| Caste-specific glowtile

|-
| CASTE_NAME
| singular:plural:adjective
| The name of the caste of the creature in the game.

|-
| CASTE_PROFESSION_NAME
|
*Profession
*singular
*plural
| alters the name of the given profession, caste-specific

|-
| CASTE_SOLDIER_ALTTILE
| 'character' or tile number
| Creatures of this caste active in their civilization's military will blink between their default tile and this one.

|-
| CASTE_SOLDIER_TILE
| 'character' or tile number
| Creatures of this caste active in their civilization's military will use this tile instead.

|-
| CASTE_SPEECH
| speech file?
| Possibly a caste-specific instance of the SPEECH token

|-
| CASTE_TILE
|
* tile number or "letter"
| Caste-specific creature tile.

|-
| CAVE_ADAPT
|
| Gives the creature a bonus in caves. Also causes [[Cave adaptation]].

|-
| CHANGE_BODY_SIZE_PERC
|
|

|-
| CHILD
| integer
| age at which creature is considered an adult. One can think of this as the duration of the child stage. Without this token, a creature will not reproduce in Fortress mode.

|-
| CHILDNAME
| singular:plural
| Defines a new name for a creature in child state at the caste level. For non-caste-specific child names, see GENERAL_CHILD_NAME.

|-
| CLUSTER_NUMBER
|
*min
*max
| The minimum/maximum numbers of how many creatures per spawned cluster. Certain vermin fish use this token in combination with temperate ocean and river biome tokens to perform seasonal migrations.
e.g. [CLUSTER_NUMBER:1:3]

|-
|CLUTCH_SIZE
|
*min
*max
|Number of eggs laid in one sitting.

|-
| COLONY_EXTERNAL
|
| Caste hovers around colony.

|-
| COLOR
| foreground:background:brightness
| Color of the creature's tile.

|-
| COMMON_DOMESTIC
|
| Allows the creature to be brought with immigrants and when creating a new fortress, as long as the creature also includes at least one of the following tokens: PET, PACK_ANIMAL, WAGON_PULLER, MOUNT. In addition, the creature must be NATURAL rather than FANCIFUL

|-
| CONVERTED_SPOUSE
|
| Found only at caste level. Creatures of this caste's species with the SPOUSE_CONVERTER and NIGHT_CREATURE_HUNTER tokens will kidnap SPOUSE_CONVERSION_TARGETs of an appropriate sex and convert them into castes with CONVERTED_SPOUSE.

|-
| COOKABLE_LIVE
|
| Set this to allow the creature to be cooked in meals without first being butchered / fishcleaned.

|-
| COPY_TAGS_FROM
|
*CREATURE NAME
| Copies tags from another specified creature.

|-
| CREATURE_CLASS
|
*classname
| Creature class. Can be anything, but only existing use is GENERAL_POISON. Appears to only be used for Syndromes. Supposedly can also be used for entity positions.

|-
| CREATURE_SOLDIER_TILE
| 'character' or tile number
| Creatures active in their civilization's military will use this tile instead.

|-
| CREATURE_TILE
| 'character' or tile number
| The symbol of the creature in ASCII mode.

|-
| CREPUSCULAR
|
| Sets if the creature is active at twilight.

|-
| CURIOUSBEAST_EATER
|
| Allows a creature to steal and eat edible items from a site.

|-
| CURIOUSBEAST_GUZZLER
|
| Allows a creature to (very quickly) drink your alcohol. Or spill the barrel to the ground. Also affects undead versions of the creature.

|-
| CURIOUSBEAST_ITEM
|
| Allows a creature to steal things (apparently the highest value it can find). Semimegabeast thievery is in Legends mode. Lightweight creatures can probably steal heavy items.

|-
| CV_ADD_TAG
|
*TAG NAME
| Adds a tag. Used in conjunction with creature variation templates.

|-
| CV_REMOVE_TAG
|
*TAG NAME
| Removes a tag. Used in conjunction with creature variation templates.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==D==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| DEMON
|
| Found on generated {{L|demon}}s; sets the creature as potential {{L|hell}} spawn

|-
| DESCRIPTION
| text
| A brief description of the creature type.

|-
| DIE_WHEN_VERMIN_BITE
|
| Dies upon attacking. Used for bee stings.

|-
| DIFFICULTY
| integer
| Toady: "Difficulty determines how deep it places them in adventure mode/reclaim caves, and the chance that they are wounded the first few river attacks." Also increases experience gain during adventure mode.

|-
| DIURNAL
|
| Sets if the creature is active in day.

|-
| DOES_NOT_EXIST
|
| Creature does not actually exist; used for fanciful creatures.

|-
| DRAGONFIREBREATH
|
| Creature breathes fire in a cone.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==E==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| EGG_MATERIAL
|
* {{L|material token}}
*state (SOLID, LIQUID, or GAS)
| Egg material. Egg-laying creatures will define this 3 times, using LOCAL_CREATURE_MAT:EGGSHELL, LOCAL_CREATURE_MAT:EGG_WHITE, and then LOCAL_CREATURE_MAT:EGG_YOLK. Eggs will be made out of eggshell. Edibility is determined by tags on whites or yolk, but they otherwise do not exist.

|-
| EGG_SIZE
|
*size
| Determines how long it takes for eggs to hatch{{verify}}. The larger the number, the longer it takes.

|-
| EQUIPMENT_WAGON
|
| Makes the creature into a large 3x3 creature responsible for carrying trade goods, pulled by two [WAGON_PULLER]s and driven by a merchant.

|-
| EQUIPS
|
| Allows the creature to wear or wield items.

|-
| EVIL
|
| Creature is considered evil and will only show up in evil biomes. Has no effect on cavern creatures.

|-
| EXTRACT
|
* {{L|material token}}
| Defines a creature extract which can be obtained via {{L|small animal dissection}}.

|-
| EXTRAVISION
|
| Creature can see regardless of whether it has working eyes.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==F==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| FANCIFUL
|
| Makes every civilization know about the creature. The creature won't occur in regular material preference lists. The tag also adds some art value modifiers. Used for things like dragons and other legendary creatures.

|-
| FEATURE_ATTACK_GROUP
|
| Found on subterranean animalmen.

|-
| FEATURE_BEAST
|
| Found on {{L|forgotten beast}}s.

|-
| FEMALE
|
| Inside a female caste, sets femaleness. Outside of a caste, sets all individuals female unless overridden by caste.

|-
| FIREBREATH
|
| The creature breathes long range fireballs and has a short range cone shaped fire breath attack.

|-
| FIREIMMUNE
|
| Renders a creature immune to being damaged by FIREBREATH's short range cone attack.

|-
| FIREIMMUNE_SUPER
|
| The creature is immune to DRAGONFIREBREATH. Implies FIREIMMUNE.

|-
| FISHITEM
|
| Needs to be cleaned at a fishery

|-
| FIXED_TEMP
| temperature
| The natural heat generated by the creature.

|-
| FLEEQUICK
|
| Determines how soon a creature flees in a losing battle.

|-
| FLIER
|
| Allows a creature to fly. Fortress Mode pathfinding only partially incorporates pathfinding - flying dwarves need a land path to exist between them and an area in order to access it, but as long as one such path exists, they do not need to use it, instead being able to fly over intervening obstacles.

|-
| FREQUENCY
|
*number, max 100
| Determines the time between creature spawns in Fortress Mode. Higher is more occurrences per time unit. Creatures without a frequency statement default to 50. Almost all others have either [FREQUENCY:5] or [FREQUENCY:100]. Not to be confused with POP_RATIO
|}

<div align="center">
{{alphabetical TOC}}
</div>

==G==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| GENERAL_BABY_NAME
| singular:plural
| name at creature level

|-
| GENERAL_CHILD_NAME
| singular:plural
| name at creature level

|-
| GENERATED
|
| Found on procedurally generated creatures like {{L|Forgotten beast}}s, (biome name) {{L|titan}}s, {{L|Demon}}s, and {{L|night creature}}s.

|-
| GETS_INFECTIONS_FROM_ROT
|
| Creature can get infections from necrotic tissue.

|-
| GETS_WOUND_INFECTIONS
|
| Creature's wounds can become infected.

|-
| GLOWCOLOR
|
*foreground
*background
*brightness
| The colour of the GLOWTILE of the creature.

|-
| GLOWTILE
| ascii character
| If present, the being glows in the dark (generally used for Adventure Mode). The tile is what replaces the being's current tile when it is obscured from your sight by darkness. The default setting for kobolds (a yellow quotation mark) provides a nice "glowing eyes" effect. The game is also hardcoded to automatically convert quotation mark GLOWTILES into apostrophes if the creature has lost one eye. This works at the generic creature level - for caste-specific glow tiles, use CASTE_GLOWTILE instead.

|-
| GNAWER
| verb (gnawed)
| The creature chews on food barrels and bags.

|-
| GO_TO_END
|
| When using tags from an existing creature, inserts new tags at the end of the creature.

|-
| GO_TO_START
|
| When using tags from an existing creature, inserts new tags at the beginning of the creature.

|-
| GO_TO_TAG
|
| When using tags from an existing creature, inserts new tags after the specified tag.

|-
| GOOD
|
| Determines whether creature can show up on "good" areas. Eg. unicorn.

|-
| GRASSTRAMPLE
| value
| The value determines how rapidly grass is trampled when a creature steps on it - a value of 0 causes the creature to never damage grass, while a value of 100 causes grass to be trampled as rapidly as possible. Defaults to 5.

|-
| GRAVITATE_BODY_SIZE
| target value
| Used in Creature Variants. This token changes the adult body size to the average of the old adult body size and the target value and scales all intermediate growth stages by the same factor.

|-
| GRAZER
|
*number
| Animals is a grazer. The higher the number, the less frequently it needs to eat in order to survive.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==H==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| HABIT
| type:probability
| Defines certain behaviors for the creature. The habit types are COLLECT_TROPHIES, COOK_PEOPLE, COOK_VERMIN, GRIND_VERMIN, COOK_BLOOD, GRIND_BONE_MEAL, EAT_BONE_PORRIDGE, USE_ANY_MELEE_WEAPON, GIANT_NEST, and COLLECT_WEALTH. These may require the creature to have a lair to work properly.

|-
| HABIT_NUM
| number or TEST_ALL
| Unknown. All lists of HABITs are preceded by [HABIT_NUM:TEST_ALL]

|-
| HAS_NERVES
|
| This makes the creature susceptible to severed motor and sensory nerves when muscles are torn in limb, grasp and stance parts. Some butchering yields nervous tissue.

|-
| HASSHELL
|
| The creature has a shell. Seemingly no longer used - holdover from previous versions.

|-
| HIVE_PRODUCT
|
*number
*{{L|time}}
*{{L|item token}}s
| What product is harvested from {{L|Beekeeping industry|beekeeping}}.

|-
| HOMEOTHERM
|
| Default 'NONE'. The creature's normal body {{L|temperature}}

|-
| HUNTS_VERMIN
|
| Creature hunts and kills nearby vermin.

|}

<div align="center">
{{alphabetical TOC}}
</div>

==I==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| IMMOBILE_LAND
|
| The creature is immobile while on land. Only works on AQUATIC creatures which can't breath on land.

|-
| IMMOLATE
|
| Will ignite, and potentially completely destroy, items the creature is standing on. Keep booze away from critters with this tag.

|-
| INTELLIGENT
|
| Implies CAN_SPEAK and CAN_LEARN. CAN_LEARN probably means the creature gets skills - including social skills - and professions. Not recommended for uncivilized monsters.

|-
| ITEMCORPSE
|
* {{L|item token}}:subtype
* {{L|material token}}
| Determines if the creature leaves behind a non-standard corpse (i.e. wood, statue, bars, ash from ghost etc).

|-
| ITEMCORPSE_QUALITY
|
| The quality of an item-type corpse left behind; 5 is masterpiece-level.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==L==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| LAIR
| type:probability
| Found on megabeasts, semimegabeasts, and night creatues. The creature will seek out sites of this type and take them as lairs. The lair types are SIMPLE_BURROW, SIMPLE_MOUND, WILDERNESS_LOCATION, SHRINE, and LABYRINTH.

|-
| LAIR_CHARACTERISTIC
| characteristic:probability
| Defines certain features of the creature's lair. The only valid characteristic is HAS_DOORS.

|-
| LAIR_HUNTER
|
| This creature will actively hunt adventurers in its lair.

|-
| LAIR_HUNTER_SPEECH
| speech file
| What this creature says while hunting adventurers in its lair.

|-
| LARGE_PREDATOR
|
| Will attack things that are smaller than it (like dwarves). Only one group of "large predators" will appear on any given map (possibly two groups on "savage" maps). In adventure mode, large predators will try to ambush and attack you (and your party will attack them back). Also, they can be mentioned in the intro paragraph when starting a fortress e.g. "ere the wolves get hungry."

|-
| LARGE_ROAMING
|
| In Fortress Mode, spawns outdoors and is not a vermin creature.

|-
| LAYS_EGGS
|
| Creature lays eggs instead of giving birth to live young.

|-
| LAYS_UNUSUAL_EGGS
|
* {{L|item token}}
* {{L|material token}}
| Creature lays a particular item instead of regular eggs.

|-
| LIGAMENTS
|
* {{L|material token}}
*healing rate
| Defines the material and healing rate of ligaments.

|-
| LIGHT_GEN
|
| The creature will generate light, such as in adventurer mode at night.

|-
| LIKES_FIGHTING
|
| The creature will attack enemies rather than flee from them. This tag has the same effect on player-controlled creatures - included modded dwarves.

|-
| LISP
|
| Creature uses "sssssnake talk" (multiplies 'S' when talking - "My name isss Recisssiz.")

|-
| LITTERSIZE
|
* minumum
* maximum
| Determines the random chance of how many creatures are generated when giving birth. [LITTERSIZE:1:2]

|-
| LOCKPICKER
|
| Lets a creature open doors that are set to forbidden in Fortress Mode.

|-
| LOOSE_CLUSTERS
|
| The creatures will scatter if they have this tag, or form tight packs if they don't.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==M==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| MAGICAL
|
| Unknown.

|-
| MAGMA_VISION
|
| Creature's able to see while covered in magma.

|-
| MALE
|
| The species or caste is all male.

|-
| MANNERISM_??
|
*occassionally body part
| Adds a possible mannerism to the creature's profile.
Refer to {{L|Creature mannerism token}}s

|-
| MATERIAL
|
*material id
| Begins defining a new material.{{verify}}

|-
| MATERIAL_BREATH_ATTACK
|
* {{L|material token}}
* breath attack type (TRAILING_DUST_FLOW, TRAILING_VAPOR_FLOW, TRAILING_GAS_FLOW, SOLID_GLOB, LIQUID_GLOB, UNDIRECTED_GAS, UNDIRECTED_VAPOR, UNDIRECTED_DUST)
| Creates an attack referencing a material, using a given type of breath attack.

|-
| MATUTINAL
|
| Sets if the creature is active in dawn.

|-
| MAXAGE
| min:max
| Range of time in years in which death from old age may occur. Once a creature reaches the min value, it has a random chance each season of dying from old age. Unknown if the chance increases with further age.

|-
| MEANDERER
|
| Gives a creature random movement.

|-
| MEGABEAST
|
| Appears on fortress territory in Fortress Mode occasionally. Can also be worshipped.

|-
|MENT_ATT_CAP_PERC
|
*ATTRIBUTE Token
*Cap %
|Default is 200. This means you can increase your attribute to 200% of its starting value (or the average value + your starting value if that is higher).

|-
| MENT_ATT_RANGE
|
*ATTRIBUTE
*lowest:lower:low:median:high:higher:highest
| Sets up a mental attribute's range of values (0-5000). All mental attribute ranges default to 200:800:900:1000:1100:1300:2000.

|-
| MENT_ATT_RATES
|
*ATTRIBUTE Token
*cost to improve
*unused counter rate
*rust counter rate
*demotion counter rate
| Mental attribute gain/decay rates. Defaults are 500:4:5:4.

|-
| MILKABLE
|
* {{L|material token}}
* frequency
| Allows the creature to be milked.

|-
| MISCHIEVIOUS
|
| Will pull any levers it comes across. Also makes creature spawn invisible and with several ranks in Ambusher. "They go on little missions to mess with various fortress buildings, not just levers."

|-
| MODVALUE
|
| Seemingly no longer used - holdover from previous versions.

|-
| MOUNT
|
| Creature may be used as a mount.

|-
| MOUNT_EXOTIC
|
| You need the Dungeon master noble to mount the creature.

|-
| MULTIPLE_LITTER_RARE
|
| Makes litters with more than one offspring rare.

|-
| MULTIPLY_VALUE
|
*Multiplier
| Multiplies value of materials.

|-
| MUNDANE
|
| Marks if the creature is an actual real-life creature. Only used for age-names at present, and determining whether a creature will attack creatures with the AT_PEACE_WITH_WILDLIFE token.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==N==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| NAME
| singular:plural:adjective
| The generic name for any creature of this type - will be used when distinctions between caste are unimportant. For names for specific castes, use CASTE_NAME instead.

|-
| NATURAL
|
| Animal is considered to be natural.

|-
| NATURAL_SKILL
| skill:value
| The creature possesses this skill at this level inherently. It begins with this skill at this level, and the skill may never rust below this level. Requires CAN_LEARN or INTELLIGENT to function (changed in .25 or earlier that CAN_LEARN is no longer required).

|-
| NIGHT_CREATURE_BOGEYMAN
|
| Found on bogeymen. Creatures with this tag will join other bogeymen in attacking adventurers at night, and will also adopt their other behaviors, such as vanishing in smoke upon being killed. Setting the number of night creatures to zero in the world gen parameters will remove only the randomly-generated bogeymen.

|-
| NIGHT_CREATURE_HUNTER
|
| If this creature has SPOUSE_CONVERTER, it will actively attempt to seek out potential conversion targets, abduct them, and convert them. Night creatures will seek out one SPOUSE_CONVERSION_TARGET <s>of the opposite sex</s>(seems to choose anyone of any sex of the caste/s that have the CONVERTED_SPOUSE tag), convert them, and then have children with them(if possible). NIGHT_CREATURE_HUNTERs without SPOUSE_CONVERTER will not be placed. Setting the number of night creatures to zero in the world gen parameters will remove only the randomly-generated night creatures.

|-
| NO_AUTUMN
|
| does not appear this season.

|-
| NO_DIZZINESS
|
| Creature cannot become dizzy

|-
| NO_DRINK
|
| Creature does not need to drink.

|-
| NO_EAT
|
| Creature does not need to eat.

|-
| NO_FEVERS
|
| Creature cannot suffer fevers

|-
| NO_GENDER
|
| Creature has no gender.

|-
| NO_SLEEP
|
| Creature does not need to sleep.

|-
| NO_SPRING
|
| does not appear this season.

|-
| NO_SUMMER
|
| does not appear this season.

|-
| NO_THOUGHT_CENTER_FOR_MOVEMENT
|
| Creatures doesn't require an organ with the [THOUGHT] tag to survive; generally used on creatures that don't have brains.

|-
| NO_WINTER
|
| does not appear this season.

|-
| NOBONES
|
| Creature has no bones.

|-
| NOBREATHE
|
| Creature doesn't need to breathe or have [BREATHE] parts in body. Cannot drown or be strangled.

|-
| NOCTURNAL
|
| Sets if the creature is active in night.

|-
| NOEMOTION
|
| The creature has no emotions, and does not rage.

|-
| NOEXERT
|
| Creature can't become tired or over-exerted.

|-
| NOFEAR
|
| Creature doesn't feel fear and will never run away from battle.

|-
| NOMEAT
|
| Creature will not drop meat on butcher.

|-
| NONAUSEA
|
| Creature can't vomit.

|-
| NOPAIN
|
| Creature doesn't feel pain.

|-
| NOSKIN
|
| Creature will not drop skin on butcher.

|-
| NOSKULL
|
| Creature will not drop skull on butcher, rot, or decay of severed head.

|-
| NOSMELLYROT
|
| Does not produce miasma when rotting

|-
| NOSTUCKINS
|
| Weapons can't be stuck in creature.

|-
| NOSTUN
|
| Creature can't be stunned. Creatures with this tag never wake up from sleep in Fortress Mode and stay drowsy. If this creature must eat and drink while playing, it WILL die.

|-
| NOT_BUTCHERABLE
|
| Cannot be butchered

|-
| NOTHOUGHT
|
| Creature doesn't think, or doesn't require a [BRAIN] body part.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==P==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| PACK_ANIMAL
|
| Allows the creature to be used as a pack animal. Currently only used by merchants.

|-
| PARALYZEIMMUNE
|
| The creature is immune to all paralyzing special attacks.

|-
| PATTERNFLIER
|
|

|-
| PEARL
|
| Creature will generate pearls.

|-
| PENETRATEPOWER
| value
| Controls the ability of vermin to find a way into containers when they are eating food from your stockpiles. Wood and cloth objects roll a 0-9 and if it's greater than the penetrate power, their contents escape for the time being. Other objects roll a 0-99.

|-
| PERSONALITY
|
*ATTRIBUTE
*lowest:median:highest
| Determines the range and chance of personality traits. Standard is 0:50:100. See [[DF2010:Personality_trait|Personality traits]] for more info.

|-
| PET
|
| Allows the creature to be tamed. Also allows all females of the species to breed regardless of marital status.

|-
| PET_EXOTIC
|
| You need a Dungeon master noble in your fortress for the creature to be tamable (but any Animal trainer can do the taming).

|-
| PETVALUE
| value
| How valuable a tamed animal/pet is. Actual cost in points in the embarking screen is (PETVALUE/2)+1 for an untrained animal, PETVALUE+1 for a trained(War or Hunting) one. Note that for an animal to be selectable in this screen, it must have the COMMON_DOMESTIC token.

|-
| PETVALUE_DIVISOR
| value
| Divides the creature's PETVALUE by the specified number. Used for bees to prevent a single hive from being worth a fortune.

|-
|PHYS_ATT_CAP_PERC
|
*ATTRIBUTE Token
*Cap %
|Default is 200. This means you can increase your attribute to 200% of its starting value (or the average value + your starting value if that is higher).

|-
| PHYS_ATT_RANGE
|
*ATTRIBUTE
*lowest:lower:low:median:high:higher:highest
| Sets up a physical attribute's range of values (0-5000). All physical attribute ranges default to 200:700:900:1000:1100:1300:2000.

|-
| PHYS_ATT_RATES
|
*ATTRIBUTE Token
*cost to improve
*unused counter rate
*rust counter rate
*demotion counter rate
| Physical attribute gain/decay rates. Defaults for STRENGTH, AGILITY, TOUGHNESS, and ENDURANCE are 500:3:4:3, while RECUPERATION and DISEASE_RESISTANCE default to 500:NONE:NONE:NONE.

|-
| PLUS_BP_GROUP
|
*BY_TYPE, BY_CATEGORY, or BY_TOKEN
*body type, category, or token
| Adds a body part group to selected body part group. Presumably used immediately after SET_BP_GROUP.

|-
| PLUS_MATERIAL
|
*material
| Adds a material to selected materials. Used immediately after SELECT_MATERIAL.

|-
| POP_RATIO
|
| Weighted population of caste; Lower is rarer. Not to be confused with FREQUENCY.

|-
| POPULATION_NUMBER
| min:max
| old guess: "The minimum/maximum numbers of how many of these creatures can show up on a map per year."<br>Toady: "Pop number is the number per square of the region, I think."

|-
| POWER
|
|Allows the being to represent itself as a deity. Requires CAN_SPEAK to actually do anything more than settle at a location.

|-
| PREFSTRING
| string
| Sets what other creatures like about this creature. "Urist likes dwarves for their beards." Multiple entries will be chosen from at random

|-
| PROFESSION_NAME
|
*Profession
*singular
*plural
| The generic name for members of this profession, at the creature level. In order to give members of specific castes different names for professions, use CASTE_PROFESSION_NAME instead.

|-
| PRONE_TO_RAGE
| number
| Untested effect, though it clearly affects how likely a creature is to become enraged. Number may be percentage chance of becoming enraged during combat. As described in file_changes.txt, creatures with this token "follow its normal behavior, but flip out on occasion, higher rate = more flipping out".

|-
| PUS
|
* {{L|material token}}
*matter state (LIQUID, GAS, SOLID)
| Specifies what the creature's wounds will ooze when infected.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==R==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| RELSIZE
|
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*body category, type, or token
*Relsize
| Specifies a new relative size for a part than what is stated in the body plan. For example, Dwarves have larger livers.

|-
| REMAINS
| singular:plural
| What creature's remains are called.

|-
| REMAINS_COLOR
|
| What color creature's remains are.

|-
| REMAINS_ON_VERMIN_BITE_DEATH
|
| Leaves remains when its attack causes it to die? Seems to go with DIE_WHEN_VERMIN_BITE.

|-
| REMAINS_UNDETERMINED
|
| Unknown.

|-
| REMOVE_MATERIAL
|
*material token
| Removes a material from a creature.

|-
| REMOVE_TISSUE
|
*material token
| Removes a tissue from a creature.

|-
| RETURNS_VERMIN_KILLS_TO_OWNER
|
| Used with HUNTS_VERMIN, causes the creature to return killed vermin to its owner.

|}

<div align="center">
{{alphabetical TOC}}
</div>

==S==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| SAVAGE
|
| Allows creature to show up on (and limits it to) "savage" maps.

|-
| SECRETION
|
* {{L|material token}}
*Material State
*location secreted from (by_type, by_category, by_token)
*body part
*tissue layer
| creates a secreted material on given tissue on a given part of the body.

|-
| SELECT_ADDITIONAL_CASTE
|
*caste name
| adds an additional previously defined caste to the selection. Used immediately after SELECT_CASTE.

|-
| SELECT_CASTE
|
*caste name, or ALL
| selects a previously defined caste

|-
| SELECT_MATERIAL
|
*Material token
| Selects a locally defined material. Can be ALL.

|-
| SEMIMEGABEAST
|
| Appears as boss creature in quests. Makes history by rampaging around towns. Possibly inhabits non-mountain caves.

|-
| SET_BP_GROUP
|
*selection criteria BY_TYPE, BY_CATEGORY, BY_TOKEN
*category, type, or token
| Begins a selection of body parts.

|-
| SET_TL_GROUP
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
*tissue
| begins a selection of tissue layers

|-
| SHEARABLE_TISSUE_LAYER
|
* tissue modifier
* required value
| Tissue layer can be sheared for its component material. The specified modifier must be at least of the desired value for shearing to be possible (a llama's wool must have a LENGTH of 300 before it is shearable).

|-
| SKILL_LEARN_RATE
| {{L|skill_token}}:percentage
| The rate at which this creature learns this skill. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SKILL_LEARN_RATES
| percentage
| The rate at which this creature learns all skills. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SKILL_RATE
| {{L|skill_token}}:percentage:value:value:value
| As SKILL_RATES for individual skills. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SKILL_RATES
|
*% of improvement points you get
*unused counter rate
*rust counter rate
*demotion counter rate
| Affects skill gain and decay. Lower numbers in the last three slots make decay occur faster ([SKILL_RATES:100:1:1:1] would cause rapid decay). The counter rates may also be replaced with NONE.
Default is [SKILL_RATES:100:8:16:16]. [SLOW_LEARNER] changes the 100 to a 50. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SKILL_RUST_RATE
| {{L|skill_token}}:value:value:value
| The rate at which this skill decays. Lower values cause the skill to decay faster. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SKILL_RUST_RATES
| value:value:value
| The rate at which all skills decay. Lower values cause the skills to decay faster. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SLOW_LEARNER
|
| Similar to [CAN_LEARN], but slower; skills are gained at a fraction of the rate. Present in the entries for ogres and giants; can be applied to civ or player races.

|-
| SMALL_REMAINS
|
| If a creature has this token, it'll leave "remains" instead of a corpse.

|-
| SOLDIER_ALTTILE
| 'character' or tile number
| If this creature is active in its civilization's military, it will blink between its default tile and this one.

|-
| SOUND
|
* Sound application (currently accepts ALERT or PEACEFUL_INTERMITTENT)
* Sound range (in tiles)
* Sound delay (lower values = sound is produced more often)
* VOCALIZATION or NONE (determines whether the sound requires breathing or not)
* First-person description
* Third-person description
* Description when out of sight
| Creature makes sounds periodically, which can be heard in Adventure mode.

|-
| SPECIFIC_FOOD
|
* PLANT or CREATURE
* Plant/creature ID
| Indicates that the creature is only capable of eating a particular type of food.

|-
| SPEECH
| speech file
| Boasting speeches relating to killing this creature. Examples include dwarf.txt and elf.txt in data\speech.

|-
| SPEECH_FEMALE
| speech file
| Boasting speeches relating to killing females of this creature.

|-
| SPEECH_MALE
| speech file
| Boasting speeches relating to killing males of this creature.

|-
| SPEED
| value
| Sets the creatures' movement and work speed, 1000/[100 + SPEED X] is the resulting effect on creatures movement and work rates from default. See {{L|Speed}} for more information.

|-
| SPHERE
|
*sphere name
| Sets what religious spheres the creature is aligned to, for purposes of being worshipped via the [POWER] token. Also affects the layout of hidden fun stuff, and the creature's name.

|-
| SPOUSE_CONVERSION_TARGET
|
| This creature can be converted by a night creature with SPOUSE_CONVERTED.

|-
| SPOUSE_CONVERTER
|
| Enables the creature to convert SPOUSE_CONVERSION_TARGETs into CONVERTED_SPOUSE castes of its species. The creature won't actually actively do this unless it also has NIGHT_CREATURE_HUNTER, however.

|-
| SWIM_SPEED
|
*speed
| How fast the creature swims. Typically 2500 (0.38 times the default speed).

|-
| SWIMS_INNATE
|
| The creature naturally knows how to swim, as opposed to [SWIMS_LEARNED] below. Currently, an AI bug prevents this from being useful on PC races in fortress mode.

|-
| SWIMS_LEARNED
|
| The creature doesn't know how to swim unless it has learned the skill. Requires [CAN_LEARN], obviously.

|}

<div align="center">
{{alphabetical TOC}}
</div>

==T==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| TENDONS
|
* {{L|material token}}
*healing rate
| Defines the material and healing rate of tendons.

|-
| THICKWEB
|
| The creature's webs can catch larger creatures.

|-
| TISSUE
| name
| Begins defining a tissue in the creature file.

|-
| TITAN
|
| Found on {{L|titan}}s.

|-
| TL_COLOR_MODIFIER
| COLOR:freq:COLOR:freq etc
| Creates a list of color patterns, giving each a frequency.

|-
| TLCM_GENETIC_MODEL
|
| tissue layer color modifier is passed to offspring genetically?

|-
| TLCM_IMPORTANCE
|
*number
| Presumably modifies the importance of the tissue layer color modifier, for description purposes.
HOWEVER using this appears to remove all mention of colour from creature descriptions. It does not appear in any default creatures.

|-
| TLCM_NOUN
|
*name
*SINGULAR or PLURAL
| names the tissue layer color modifier, and determines the noun

|-
| TLCM_TIMING
|
*ROOT
*start change window years:days:end change window years:days
| determines the point in the creature's life where the color change begins

|-
| TRADE_CAPACITY
|
| How much the creature can carry when used by merchants.

|-
| TRAINABLE
|
| Implies both [TRAINABLE_HUNTING] and [TRAINABLE_WAR].

|-
| TRAINABLE_HUNTING
|
| Can be trained as hunting beasts by way of kennels.

|-
| TRAINABLE_WAR
|
| Can be trained as war beasts by way of kennels.

|-
| TRANCES
|
| Allows the creature to go into martial trances.

|-
| TRAPAVOID
|
| The creature is immune to traps. Probably every procedurally generated megabeast has this.

|-
| TRIGGERABLE_GROUP
| min:max
| A large swarm of vermin can be disturbed, usually in Adventure mode.{{verify}}

|-
| TSU_NOUN
|
*noun
*SINGULAR or PLURAL
| Noun for the TISSUE_STYLE_UNIT, used in the description of the tissue layer's style.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==U==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| UBIQUITOUS
|
| Creature will occur in every region with the correct biome. Does not apply to evil/good tags.

|-
| UNDERGROUND_DEPTH
|
*mindepth
*maxdepth
| Depth the creature appears underground. Numbers can be from 1 to 5. Only magma creatures use 4 or 5 in the default raws. A single argument may be used instead of min and max. Dwarven civilizations will only export (via the embark screen or caravans) things that available at depth 1.

|-
| UNDERSWIM
|
| Creature swims under the water and can't be seen. Currently appears to have no effect as of 31.25.

|-
| UNIQUE_DEMON
|
| Typically found on generated {{L|demon}}s; causes the game to create a single named instance of the demon which will emerge from the underworld and take over civilizations during worldgen. Cannot be used for modder-defined creatures.

|-
| USE_CASTE
|
*new caste token
*old caste token
| Defines a new caste derived directly from a previous caste. The new caste inherits all properties of the old one. The effect of this tag is automatic if one has not yet defined any castes: "Any caste-level tag that occurs before castes are explicitly declared is saved up and placed on any caste that is declared later, unless the caste is explicitly derived from another caste."

|-
| USE_MATERIAL
|
*new material token
*old material id
| Defines a new local creature material and populates it with all properties defined in the specified material. Old material id accepts any valid material id, including INORGANIC:X, CREATURE_MAT:C:X, LOCAL_CREATURE_MAT:X, and others (where X is a material id from that set, and C is a valid creature id).{{verify}}

|-
| USE_MATERIAL_TEMPLATE
|
*new material token
*material template
| Defines a new local creature material and populates it with all properties defined in the specified template.

|-
| USE_TISSUE
|
*new tissue token
*old tissue id
| Defines a new local creature tissue and populates it with all properties defined in the local tissue specified in the second argument.

|-
| USE_TISSUE_TEMPLATE
|
*new tissue token
*tissue template
| Loads a tissue template listed in OBJECT:TISSUE_TEMPLATE files, such as tissue_template_default.txt.

|-
| UTTERANCES
|
| Changes the language of the creature into an unintelligible mess.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==V==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| VEGETATION
|
| unknown

|-
| VERMIN_BITE
|
*chance of occurance{{verify}}
*verb (bitten, stung, etc)
* {{L|material token}}
| Vermin bites, and injects something.

|-
| VERMIN_EATER
|
| The vermin creature will attempt to eat exposed food. See PENETRATEPOWER. Distict from VERMIN_ROTTER.

|-
| VERMIN_FISH
|
| The vermin appears in water and will attempt to swim around.

|-
| VERMIN_GROUNDER
|
| The creature appears in "general" surface ground locations. Note that this doesn't stop the creature from flying if it can (most vermin birds have this tag).

|-
| VERMIN_HATEABLE
|
| Some dwarves will hate the creature and get unhappy thoughts when around it.

|-
| VERMIN_MICRO
|
| This makes the creature move in a swarm of creatures of the same race as it. I.E. Swarm of flies, swarm of ants, etc.

|-
| VERMIN_NOFISH
|
| The creature cannot be caught by fishing.

|-
| VERMIN_NOROAM
|
| The creature will not be observed randomly roaming about the map.

|-
| VERMIN_NOTRAP
|
| The creature cannot be caught in baited animal traps; however, a "catch live land animal" task may still be able to capture one if a dwarf finds one roaming around.

|-
| VERMIN_ROTTER
|
| Present on flies, knuckle worms, acorn flies, and blood gnats. Probably means either the creature is attracted to rot, the creature speeds rotting, or both.

|-
| VERMIN_SOIL
|
| The creature randomly appears near dirt or mud.

|-
| VERMIN_SOIL_COLONY
|
| The vermin will appear in a single tile cluster of many vermin, such as a colony of ants.

|-
| VERMINHUNTER
|
| Implies AT_PEACE_WITH_WILDLIFE, RETURNS_VERMIN_KILLS_TO_OWNER, HUNTS_VERMIN, and ADOPTS_OWNER.

|-
| VESPERTINE
|
| Sets if the creature is active in evening.

|-
| VIEWRANGE
| value
| Value should determine how close you have to get to a critter before it attacks (or prevents adv mode travel etc.) Default is 20.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==W==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| WAGON_PULLER
|
| Allows the creature to pull caravan wagons.

|-
| WEBBER
|
* {{L|material token}}
| Allows the creature to create webs, and defines what the webs are made of.

|-
| WEBIMMUNE
|
| The creature will not get caught in thick webs.
|}

==Attack Tokens==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| ATTACK_SKILL
|
*skill used ({{L|Skill token}})
| defines the attack skill used

|-
| ATTACK_VERB
| 2nd person:3rd person
| descriptive text for the attack

|-
| ATTACK_CONTACT_PERC
|
*% value
| amount of available tissue used in attack

|-
| ATTACK_PENETRATION_PERC
|
*% value
| probably amount of material that makes contact when penetration is done

|-
| ATTACK_PRIORITY
|
*MAIN or SECOND
| use of the attack in combat. Secondary attacks are only used if main attacks are impossible.

|-
| ATTACK_VELOCITY_MODIFIER
| number
| Modifies the attack velocity. Believed to be percent based (so 100 would be "normal"). May be on same scale as weapon velocity (where 1000 is "normal").

|-
| ATTACK_FLAG_CANLATCH
|
| Enables an attacker to occasionally latch on with the bodypart used by an attack when an attack with this flag in its definition is made.

|-
| ATTACK_FLAG_WITH
|
| In adventure mode, displays the name of the body part used by an attack when announcing the attack.

|-
| ATTACK_FLAG_EDGE
|
| attack type

|-
| SPECIALATTACK_INJECT_EXTRACT
|
* {{L|material token}}
*state (SOLID, LIQUID, GAS)
*min:max
| attack type addition that injects a material into the victim.

|-
| SPECIALATTACK_SUCK_BLOOD
| min:max
| Successful attack draws out an amount of blood randomized between the min and max value.
|}

==Important Related Tokens==
These next groups of tokens include several tokens that are not technically classified as creature tokens in string dump, but bear mentioning in this as they are used frequently in creature raws. (Some regular creature tokens may also be reprinted for the sake of ease of navigation)

===Tissue Modification===
This next group of tokens deals setting and modifying tissue properties. (See also {{L|Tissue definition token}})

{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| INSULATION
|
*value
| Tissue supplies the creature with heat insulation. Higher values result in more insulation.

|-
| PLUS_TISSUE_LAYER
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
| Adds a tissue to those selected

|-
| PLUS_TL_GROUP
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
*tissue
| continues a selection of tissue layers

|-
| SELECT_TISSUE
|
*tissue token
| Selects a tissue for editing.

|-
| SELECT_TISSUE_LAYER
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token | Selects a tissue at a location
* (optional) FRONT, BACK, LEFT, RIGHT, TOP, BOTTOM, AROUND.
| Selects a tissue layer for descriptor and cosmetic purposes.

|-
| SET_LAYER_TISSUE
|
| Sets a tissue layer to be made of a different tissue.

|-
| TISSUE_LAYER
|
*BY_TYPE, BY_CATEGORY, BY_TOKEN
*TYPE,CATEGORY, or TOKEN
*TISSUE
*LOCATION
| Adds the tissue layer to wherever it is required.
Non-argument Locations can be FRONT, RIGHT, LEFT, TOP, BOTTOM. Argument locations are AROUND and CLEANS, requiring a further body part and a % of coverage/cleansing

|-
| TISSUE_LAYER_OVER
|
*BY_TYPE, BY_CATEGORY, BY_TOKEN
*TYPE,CATEGORY, or TOKEN
*TISSUE
*LOCATION
| Presumably a counterpart to TISSUE_LAYER_UNDER (see below).

|-
| TISSUE_LAYER_UNDER
|
*BY_TYPE, BY_CATEGORY, BY_TOKEN
*TYPE,CATEGORY, or TOKEN
*TISSUE
| Adds the tissue layer under a given part.
For example an Iron Man has a gaseous poison within and this tissue (GAS is its name) has the token [TISSUE_LEAKS] and its state is GAS so when you puncture the iron outside and damage this tissue it leaks gas (can have a syndrome by using a previous one in the creature sample.) [TISSUE_LAYER_UNDER:BY_CATEGORY:ALL:{tissue}] {tissue} is what will be under the TISSUE_LAYER here is an example Tissue from Iron Man
[TISSUE:GAS]
[TISSUE_NAME:gas:NP] [TISSUE_MATERIAL:LOCAL_CREATURE_MAT:GAS] [TISSUE_MAT_STATE:GAS] [RELATIVE_THICKNESS:50] [TISSUE_LEAKS] [TISSUE_SHAPE:LAYER]

|-
| TISSUE_LAYER_APPEARANCE_MODIFIER
|
*QUALITY
*lowest:lower:low:median:high:higher:highest
| sets the range of qualities, including LENGTH, DENSE, HIGH_POSITION, CURLY, GREASY, WRINKLY

|-
| TISSUE_LEAKS
|
| The selected tissue leaks out of the creature when the layers above it are pierced. As per an iron man's internal poison gas.

|-
| TISSUE_MATERIAL
|
*VALUE (material)
*MATERIAL (material subtype)
| Defines the tissue material. VALUE can be LOCAL_CREATURE_MAT, INORGANIC etc. MATERIAL is a subtype of the material, e.g. [TISSUE_MATERIAL:INORGANIC:BRONZE]

|-
| TISSUE_STYLE_UNIT
|
*tissue
*shaping
| sets tissue to be in a certain shape, mostly used with tissues HAIR, BEARD, MOUSTACHE, SIDEBURNS.

|-
| TL_COLOR_MODIFIER
| COLOR:freq:COLOR:freq etc
| Creates a list of color patterns, giving each a frequency.

|-
| TL_CONNECTS
|
| Presumably gives the CONNECTS attribute to selected layers.

|-
| TL_HEALING_RATE
|
| Presumably changes the HEALING_RATE of the selected tissue layers.

|-
| TL_MAJOR_ARTERIES
|
| Gives Major Artery attribute to selected layers.

|-
| TL_PAIN_RECEPTORS
|
| Seems to set new number of pain receptors for selected tissue layers.

|-
| TL_RELATIVE_THICKNESS
|
| Seems to set new relative thickness for selected tissue layers.

|-
| TL_VASCULAR
|
| Seems to set new a VASCULAR value (which modulates bleeding) for selected tissue layers.

|}

==See Also==
*{{L|Body detail plan token}}
*{{L|Body token}}
*{{L|Material definition token}}
*{{L|Syndrome}}
*{{L|Tissue definition token}}

{{Category|Modding}}
{{Category|Tokens}}

v0.31:Creature token

2011-11-06T18:48:17Z

I2amroy: /* U */

{{av}}{{Quality|Exceptional}}

A full list of all known creature tokens.

__NOTOC__

<div align="center">
{{alphabetical TOC}}
</div>

==A==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| ADOPTS_OWNER
|
| Tame creature cannot be made available for adoption, instead automatically adopting whoever it wants. It appears that the basic requirements for adoption are intact; for example, the creature is more likely to adopt an owner which likes creatures of that species.{{verify}}

|-
| ALCOHOL_DEPENDENT
|
| Creature needs alcohol to get through the working day.

|-
| ALL_ACTIVE
|
| Sets if the creature is active in day, night, and twilight. Seems to be a separate value from DIURNAL/NOCTURNAL/CREPUSCULAR, rather than implying them.

|-
| ALTTILE
|
| If set, the creature will blink between its [TILE] and its [ALTTILE].

|-
| AMBUSHPREDATOR
|
| Instead of charging relentlessly at prey, a creature with this tag will wait till the prey is within a few squares before charging.{{verify}}

|-
| AMPHIBIOUS
|
| Allows a creature to breathe with or without {{L| water}}. Implies [AQUATIC].

|-
| APP_MOD_DESC_RANGE
|
*Range
| [http://www.bay12forums.com/smf/index.php?topic=60554.msg1766793#msg1766793 Forum post describing how description ranges work]

|-
| APP_MOD_GENETIC_MODEL
|
*Model (Accepts DOMINANT_MORE, DOMINANT_LESS, and MIX)
| Defines a genetic model for the relevant appearance modifier(s). May or may not do anything significant at present.

|-
| APP_MOD_IMPORTANCE
|
*number
| Determines how important the appearance modifier is, for determining whether it shows up in the creature description.{{verify}}

|-
| APP_MOD_NOUN
|
*noun
*SINGULAR or PLURAL
| creates a noun for the appearance and whether it is singular or plural

|-
| APP_MOD_RATE
|
*Rate (integer)
*Scale (DAILY, YEARLY)
*min:max of growth
*start year:start day
*end year:end day
| setting the growth rate of the modifier. The last two tokens can be replaced by NO_END to have growth continue indefinitely.

|-
| APPLY_CREATURE_VARIATION
|
*CV TEMPLATE NAME
| Loads the Creature Variation Template specified.

|-
| APPLY_CURRENT_CREATURE_VARIATION
|
| Applies loaded Creature Variation

|-
| AQUATIC
|
| Allows a creature to breathe underwater, but causes it to "drown" out of {{L|water}}.

|-
| ARENA_RESTRICTED
|
| Does not appear in arena mode list

|-
| ARTIFICIAL_HIVEABLE
|
| Can be kept in artificial hives by beekeepers.

|-
| AT_PEACE_WITH_WILDLIFE
|
| Does not attack or frighten wildlife.

|-
| ATTACK
|
*token
*bodypart
*selection criteria
*location
| Defines the attack name, and the body part used. See [[#Attack Tokens|below]] for valid subtokens
'''Example:'''<br />
[ATTACK:GORE:BODYPART:BY_CATEGORY:HORN]<br />
''GORE'' : name of the attack<br />
''BODYPART:BY_CATEGORY:HORN'' : the horn is used to attack (presuming the creature has one)

|-
| ATTACK_TRIGGER
| pop:exported wealth:created wealth
| Specifies when a {{L|megabeast}} will attack the fortress.

|}

<div align="center">
{{alphabetical TOC}}
</div>

==B==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| BABY
| integer
| Age at which creature is considered a child. Default is zero. One can think of this as the duration of the baby stage.

|-
| BABYNAME
| singular:plural
| Defines a new name for a creature in baby state at the caste level. For non-caste-specific baby names, see GENERAL_BABY_NAME.

|-
| BEACH_FREQUENCY
|
| {{L|Whale}}s and {{L|Sea nettle jellyfish|jellyfish}} have this. Controls the beaching frequency of the creature.

|-
| BENIGN
|
| Determines whether creature can show up on "tame" maps (includes {{L|elephant}}s), which will generally avoid dwarves, although they may chase and/or attack them if they get too close).

|-
| BIOME
|
* {{L|biome token}}
| Select a {{L|Biome}} the creature may appear in.

|-
| BLOOD
|
* {{L|material token}}
*matter state (LIQUID, GAS, SOLID)
| Specifies what the creature's blood is made of.

|-
| BODY
| body parts
| Draws body parts from OBJECT:BODY files (such as body_default.txt)
'''Example:'''<br />
[BODY:BODY_WITH_HEAD_FLAG:HEART:GUTS:BRAIN:MOUTH] <br />
This is the body from a {{L|Purring maggot}}. It creates a body with head, a heart, some guts, a brain, and a mouth. Thats all a maggot needs.

|-
| BODY_APPEARANCE_MODIFIER
|
*ATTRIBUTE
*lowest:lower:low:median:high:higher:highest
| These body modifiers give individual creatures different characteristics. In the case of HEIGHT, BROADNESS and LENGTH, the modifier is also a percentage change to the BODY_SIZE of the individual creature. The seven numbers afterward give a distribution of ranges. Each interval has an equal chance of occurring.
'''Example:'''<br />
[BODY_APPEARANCE_MODIFIER:HEIGHT:90:95:98:100:102:105:110] <br />
''HEIGHT'' : marks the height to be changed <br />
''90:95:98:100:102:105:110'' : sets the range from the shortest (90% of the average height) to the tallest (110% of the average height) creature variation.

|-
| BODY_DETAIL_PLAN
| PlanName, PlanName:type:type:type:etc
| loads a plan listed OBJECT:BODY_DETAIL_PLAN files, such as b_detail_plan_default.txt. Mass applies USE_MATERIAL_TEMPLATE, mass alters RELSIZE, alters body part positions, and will allow tissue layers to be defined. Tissue layers are defined in order of skin to bone here.
'''Example:'''<br />
[BODY_DETAIL_PLAN:VERTEBRATE_TISSUE_LAYERS:SKIN:FAT:MUSCLE:BONE:CARTILAGE] <br />
This creates the detailed body of a {{L|fox}}, the skin, fat, muscle, bones and cartilage out of the vertebrate tissues.<br />
A {{L|Purring maggot|maggot}} would only need:<br />
''[BODY_DETAIL_PLAN:EXOSKELETON_TISSUE_LAYERS:SKIN:FAT:MUSCLE]''

|-
| BODY_SIZE
| years:days:size
| sets up size at a given time. Size is in cubic centimeters (milliliters), and for normal body materials is roughly equal to the creature's average weight in grams.
'''Example:'''<br />
[BODY_SIZE:0:0:10000]<br />
[BODY_SIZE:1:168:50000]<br />
[BODY_SIZE:12:0:220000]<br />
This describes the size of a {{L|minotaur}}. His birth size would be 10000 (10000 mL, ~10 kg). With 1 year and 168 days he would be 50000 tall (~50 kg). As an adult (with 12 years) he would weight roughly 220 kg

|-
| BODYGLOSS
| gloss
| Substitutes body part text with replacement text. Draws gloss information from OBJECT:BODY files (such as body_default.txt)

|-
| BONECARN
|
| Creature 'eats' bones. Eating bones makes their happiness go up, but can cause death (suffocation){{verify}}. Implies CARNIVORE.

|-
| BP_APPEARANCE_MODIFIER
|
*QUALITY
*lowest:lower:low:median:high:higher:highest
| sets up the breadth of possibilities for appearance qualities for a selected BP group. EG. Eyes (CLOSE_SET, DEEP_SET, ROUND_VS_NARROW, LARGE_IRIS),Lips (THICKNESS), Nose (BROADNESS, LENGTH, UPTURNED, CONVEX), Ear (SPLAYED_OUT, HANGING_LOBES, BROADNESS, HEIGHT), Tooth (GAPS), Skull (HIGH_CHEEKBONES, BROAD_CHIN, JUTTING CHIN, SQUARE_CHIN), Neck (DEEP_VOICE, RASPY_VOICE), Head (BROADNESS, HEIGHT)

|-
| BUILDINGDESTROYER
| 1 or 2
| Allows a creature to destroy furniture and buildings. Value [1] targets mostly doors, hatches, furniture and the like. Value [2] targets anything not made with the b + C commands.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==C==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| CAN_LEARN
|
| The creature gets skills and professions. Note that this token makes the creature unable to be butchered by an adventurer so it is not recommended for uncivilized monsters. Adventurers lacking this token can allocate but not increase attributes and skills. skills allocated will disappear on start.

|-
| CAN_SPEAK
|
| Can talk. Note that it is not necessary for a creature to gain social skills. If a member of a civilization (such as a pet) has this token, it'll need to eat and drink.{{verify}}

|-
| CANNOT_UNDEAD
|
| Cannot be turned into a zombie or skeletal undead. Also prevents ghosts of that creature appearing.

|-
| CANOPENDOORS
|
| Allows the creature to open doors.

|-
| CARNIVORE
|
| Creature ''only'' eats meat. Note that carnivorous species will not be able to survive worldgen if they do not also have NO_EAT.

|-
| CASTE
|
*name
| defines a caste

|-
| CASTE_ALTTILE
|
*tile number or "letter"
| Caste-specific alternate tile. Expects CASTE_TILE

|-
| CASTE_COLOR
|
*fg
*bg
*brightness
| Creature tile color of the caste.

|-
| CASTE_GLOWCOLOR
|
*fg
*bg
*brightness
| GLOWTILE color of the caste.

|-
| CASTE_GLOWTILE
|
*tile value or "letter"
| Caste-specific glowtile

|-
| CASTE_NAME
| singular:plural:adjective
| The name of the caste of the creature in the game.

|-
| CASTE_PROFESSION_NAME
|
*Profession
*singular
*plural
| alters the name of the given profession, caste-specific

|-
| CASTE_SOLDIER_ALTTILE
| 'character' or tile number
| Creatures of this caste active in their civilization's military will blink between their default tile and this one.

|-
| CASTE_SOLDIER_TILE
| 'character' or tile number
| Creatures of this caste active in their civilization's military will use this tile instead.

|-
| CASTE_SPEECH
| speech file?
| Possibly a caste-specific instance of the SPEECH token

|-
| CASTE_TILE
|
* tile number or "letter"
| Caste-specific creature tile.

|-
| CAVE_ADAPT
|
| Gives the creature a bonus in caves. Also causes [[Cave adaptation]].

|-
| CHANGE_BODY_SIZE_PERC
|
|

|-
| CHILD
| integer
| age at which creature is considered an adult. One can think of this as the duration of the child stage. Without this token, a creature will not reproduce in Fortress mode.

|-
| CHILDNAME
| singular:plural
| Defines a new name for a creature in child state at the caste level. For non-caste-specific child names, see GENERAL_CHILD_NAME.

|-
| CLUSTER_NUMBER
|
*min
*max
| The minimum/maximum numbers of how many creatures per spawned cluster. Certain vermin fish use this token in combination with temperate ocean and river biome tokens to perform seasonal migrations.
e.g. [CLUSTER_NUMBER:1:3]

|-
|CLUTCH_SIZE
|
*min
*max
|Number of eggs laid in one sitting.

|-
| COLONY_EXTERNAL
|
| Caste hovers around colony.

|-
| COLOR
| foreground:background:brightness
| Color of the creature's tile.

|-
| COMMON_DOMESTIC
|
| Allows the creature to be brought with immigrants and when creating a new fortress, as long as the creature also includes at least one of the following tokens: PET, PACK_ANIMAL, WAGON_PULLER, MOUNT. In addition, the creature must be NATURAL rather than FANCIFUL

|-
| CONVERTED_SPOUSE
|
| Found only at caste level. Creatures of this caste's species with the SPOUSE_CONVERTER and NIGHT_CREATURE_HUNTER tokens will kidnap SPOUSE_CONVERSION_TARGETs of an appropriate sex and convert them into castes with CONVERTED_SPOUSE.

|-
| COOKABLE_LIVE
|
| Set this to allow the creature to be cooked in meals without first being butchered / fishcleaned.

|-
| COPY_TAGS_FROM
|
*CREATURE NAME
| Copies tags from another specified creature.

|-
| CREATURE_CLASS
|
*classname
| Creature class. Can be anything, but only existing use is GENERAL_POISON. Appears to only be used for Syndromes. Supposedly can also be used for entity positions.

|-
| CREATURE_SOLDIER_TILE
| 'character' or tile number
| Creatures active in their civilization's military will use this tile instead.

|-
| CREATURE_TILE
| 'character' or tile number
| The symbol of the creature in ASCII mode.

|-
| CREPUSCULAR
|
| Sets if the creature is active at twilight.

|-
| CURIOUSBEAST_EATER
|
| Allows a creature to steal and eat edible items from a site.

|-
| CURIOUSBEAST_GUZZLER
|
| Allows a creature to (very quickly) drink your alcohol. Or spill the barrel to the ground. Also affects undead versions of the creature.

|-
| CURIOUSBEAST_ITEM
|
| Allows a creature to steal things (apparently the highest value it can find). Semimegabeast thievery is in Legends mode. Lightweight creatures can probably steal heavy items.

|-
| CV_ADD_TAG
|
*TAG NAME
| Adds a tag. Used in conjunction with creature variation templates.

|-
| CV_REMOVE_TAG
|
*TAG NAME
| Removes a tag. Used in conjunction with creature variation templates.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==D==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| DEMON
|
| Found on generated {{L|demon}}s; sets the creature as potential {{L|hell}} spawn

|-
| DESCRIPTION
| text
| A brief description of the creature type.

|-
| DIE_WHEN_VERMIN_BITE
|
| Dies upon attacking. Used for bee stings.

|-
| DIFFICULTY
| integer
| Toady: "Difficulty determines how deep it places them in adventure mode/reclaim caves, and the chance that they are wounded the first few river attacks." Also increases experience gain during adventure mode.

|-
| DIURNAL
|
| Sets if the creature is active in day.

|-
| DOES_NOT_EXIST
|
| Creature does not actually exist; used for fanciful creatures.

|-
| DRAGONFIREBREATH
|
| Creature breathes fire in a cone.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==E==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| EGG_MATERIAL
|
* {{L|material token}}
*state (SOLID, LIQUID, or GAS)
| Egg material. Egg-laying creatures will define this 3 times, using LOCAL_CREATURE_MAT:EGGSHELL, LOCAL_CREATURE_MAT:EGG_WHITE, and then LOCAL_CREATURE_MAT:EGG_YOLK. Eggs will be made out of eggshell. Edibility is determined by tags on whites or yolk, but they otherwise do not exist.

|-
| EGG_SIZE
|
*size
| Determines how long it takes for eggs to hatch{{verify}}. The larger the number, the longer it takes.

|-
| EQUIPMENT_WAGON
|
| Makes the creature into a large 3x3 creature responsible for carrying trade goods, pulled by two [WAGON_PULLER]s and driven by a merchant.

|-
| EQUIPS
|
| Allows the creature to wear or wield items.

|-
| EVIL
|
| Creature is considered evil and will only show up in evil biomes. Has no effect on cavern creatures.

|-
| EXTRACT
|
* {{L|material token}}
| Defines a creature extract which can be obtained via {{L|small animal dissection}}.

|-
| EXTRAVISION
|
| Creature can see regardless of whether it has working eyes.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==F==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| FANCIFUL
|
| Makes every civilization know about the creature. The creature won't occur in regular material preference lists. The tag also adds some art value modifiers. Used for things like dragons and other legendary creatures.

|-
| FEATURE_ATTACK_GROUP
|
| Found on subterranean animalmen.

|-
| FEATURE_BEAST
|
| Found on {{L|forgotten beast}}s.

|-
| FEMALE
|
| Inside a female caste, sets femaleness. Outside of a caste, sets all individuals female unless overridden by caste.

|-
| FIREBREATH
|
| The creature breathes fire projectiles (as opposed to DRAGONFIREBREATH, which is in a cone).

|-
| FIREIMMUNE
|
| ?

|-
| FIREIMMUNE_SUPER
|
| The creature is immune to DRAGONFIREBREATH. Implies FIREIMMUNE.

|-
| FISHITEM
|
| Needs to be cleaned at a fishery

|-
| FIXED_TEMP
| temperature
| The natural heat generated by the creature.

|-
| FLEEQUICK
|
| Determines how soon a creature flees in a losing battle.

|-
| FLIER
|
| Allows a creature to fly. Fortress Mode pathfinding only partially incorporates pathfinding - flying dwarves need a land path to exist between them and an area in order to access it, but as long as one such path exists, they do not need to use it, instead being able to fly over intervening obstacles.

|-
| FREQUENCY
|
*number, max 100
| Determines the time between creature spawns in Fortress Mode. Higher is more occurrences per time unit. Creatures without a frequency statement default to 50. Almost all others have either [FREQUENCY:5] or [FREQUENCY:100]. Not to be confused with POP_RATIO
|}

<div align="center">
{{alphabetical TOC}}
</div>

==G==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| GENERAL_BABY_NAME
| singular:plural
| name at creature level

|-
| GENERAL_CHILD_NAME
| singular:plural
| name at creature level

|-
| GENERATED
|
| Found on procedurally generated creatures like {{L|Forgotten beast}}s, (biome name) {{L|titan}}s, {{L|Demon}}s, and {{L|night creature}}s.

|-
| GETS_INFECTIONS_FROM_ROT
|
| Creature can get infections from necrotic tissue.

|-
| GETS_WOUND_INFECTIONS
|
| Creature's wounds can become infected.

|-
| GLOWCOLOR
|
*foreground
*background
*brightness
| The colour of the GLOWTILE of the creature.

|-
| GLOWTILE
| ascii character
| If present, the being glows in the dark (generally used for Adventure Mode). The tile is what replaces the being's current tile when it is obscured from your sight by darkness. The default setting for kobolds (a yellow quotation mark) provides a nice "glowing eyes" effect. The game is also hardcoded to automatically convert quotation mark GLOWTILES into apostrophes if the creature has lost one eye. This works at the generic creature level - for caste-specific glow tiles, use CASTE_GLOWTILE instead.

|-
| GNAWER
| verb (gnawed)
| The creature chews on food barrels and bags.

|-
| GO_TO_END
|
| When using tags from an existing creature, inserts new tags at the end of the creature.

|-
| GO_TO_START
|
| When using tags from an existing creature, inserts new tags at the beginning of the creature.

|-
| GO_TO_TAG
|
| When using tags from an existing creature, inserts new tags after the specified tag.

|-
| GOOD
|
| Determines whether creature can show up on "good" areas. Eg. unicorn.

|-
| GRASSTRAMPLE
| value
| The value determines how rapidly grass is trampled when a creature steps on it - a value of 0 causes the creature to never damage grass, while a value of 100 causes grass to be trampled as rapidly as possible. Defaults to 5.

|-
| GRAVITATE_BODY_SIZE
| target value
| Used in Creature Variants. This token changes the adult body size to the average of the old adult body size and the target value and scales all intermediate growth stages by the same factor.

|-
| GRAZER
|
*number
| Animals is a grazer. The higher the number, the less frequently it needs to eat in order to survive.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==H==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| HABIT
| type:probability
| Defines certain behaviors for the creature. The habit types are COLLECT_TROPHIES, COOK_PEOPLE, COOK_VERMIN, GRIND_VERMIN, COOK_BLOOD, GRIND_BONE_MEAL, EAT_BONE_PORRIDGE, USE_ANY_MELEE_WEAPON, GIANT_NEST, and COLLECT_WEALTH. These may require the creature to have a lair to work properly.

|-
| HABIT_NUM
| number or TEST_ALL
| Unknown. All lists of HABITs are preceded by [HABIT_NUM:TEST_ALL]

|-
| HAS_NERVES
|
| This makes the creature susceptible to severed motor and sensory nerves when muscles are torn in limb, grasp and stance parts. Some butchering yields nervous tissue.

|-
| HASSHELL
|
| The creature has a shell. Seemingly no longer used - holdover from previous versions.

|-
| HIVE_PRODUCT
|
*number
*{{L|time}}
*{{L|item token}}s
| What product is harvested from {{L|Beekeeping industry|beekeeping}}.

|-
| HOMEOTHERM
|
| Default 'NONE'. The creature's normal body {{L|temperature}}

|-
| HUNTS_VERMIN
|
| Creature hunts and kills nearby vermin.

|}

<div align="center">
{{alphabetical TOC}}
</div>

==I==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| IMMOBILE_LAND
|
| The creature is immobile while on land. Only works on AQUATIC creatures which can't breath on land.

|-
| IMMOLATE
|
| Will ignite, and potentially completely destroy, items the creature is standing on. Keep booze away from critters with this tag.

|-
| INTELLIGENT
|
| Implies CAN_SPEAK and CAN_LEARN. CAN_LEARN probably means the creature gets skills - including social skills - and professions. Not recommended for uncivilized monsters.

|-
| ITEMCORPSE
|
* {{L|item token}}:subtype
* {{L|material token}}
| Determines if the creature leaves behind a non-standard corpse (i.e. wood, statue, bars, ash from ghost etc).

|-
| ITEMCORPSE_QUALITY
|
| The quality of an item-type corpse left behind; 5 is masterpiece-level.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==L==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| LAIR
| type:probability
| Found on megabeasts, semimegabeasts, and night creatues. The creature will seek out sites of this type and take them as lairs. The lair types are SIMPLE_BURROW, SIMPLE_MOUND, WILDERNESS_LOCATION, SHRINE, and LABYRINTH.

|-
| LAIR_CHARACTERISTIC
| characteristic:probability
| Defines certain features of the creature's lair. The only valid characteristic is HAS_DOORS.

|-
| LAIR_HUNTER
|
| This creature will actively hunt adventurers in its lair.

|-
| LAIR_HUNTER_SPEECH
| speech file
| What this creature says while hunting adventurers in its lair.

|-
| LARGE_PREDATOR
|
| Will attack things that are smaller than it (like dwarves). Only one group of "large predators" will appear on any given map (possibly two groups on "savage" maps). In adventure mode, large predators will try to ambush and attack you (and your party will attack them back). Also, they can be mentioned in the intro paragraph when starting a fortress e.g. "ere the wolves get hungry."

|-
| LARGE_ROAMING
|
| In Fortress Mode, spawns outdoors and is not a vermin creature.

|-
| LAYS_EGGS
|
| Creature lays eggs instead of giving birth to live young.

|-
| LAYS_UNUSUAL_EGGS
|
* {{L|item token}}
* {{L|material token}}
| Creature lays a particular item instead of regular eggs.

|-
| LIGAMENTS
|
* {{L|material token}}
*healing rate
| Defines the material and healing rate of ligaments.

|-
| LIGHT_GEN
|
| The creature will generate light, such as in adventurer mode at night.

|-
| LIKES_FIGHTING
|
| The creature will attack enemies rather than flee from them. This tag has the same effect on player-controlled creatures - included modded dwarves.

|-
| LISP
|
| Creature uses "sssssnake talk" (multiplies 'S' when talking - "My name isss Recisssiz.")

|-
| LITTERSIZE
|
* minumum
* maximum
| Determines the random chance of how many creatures are generated when giving birth. [LITTERSIZE:1:2]

|-
| LOCKPICKER
|
| Lets a creature open doors that are set to forbidden in Fortress Mode.

|-
| LOOSE_CLUSTERS
|
| The creatures will scatter if they have this tag, or form tight packs if they don't.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==M==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| MAGICAL
|
| Unknown.

|-
| MAGMA_VISION
|
| Creature's able to see while covered in magma.

|-
| MALE
|
| The species or caste is all male.

|-
| MANNERISM_??
|
*occassionally body part
| Adds a possible mannerism to the creature's profile.
Refer to {{L|Creature mannerism token}}s

|-
| MATERIAL
|
*material id
| Begins defining a new material.{{verify}}

|-
| MATERIAL_BREATH_ATTACK
|
* {{L|material token}}
* breath attack type (TRAILING_DUST_FLOW, TRAILING_VAPOR_FLOW, TRAILING_GAS_FLOW, SOLID_GLOB, LIQUID_GLOB, UNDIRECTED_GAS, UNDIRECTED_VAPOR, UNDIRECTED_DUST)
| Creates an attack referencing a material, using a given type of breath attack.

|-
| MATUTINAL
|
| Sets if the creature is active in dawn.

|-
| MAXAGE
| min:max
| Range of time in years in which death from old age may occur. Once a creature reaches the min value, it has a random chance each season of dying from old age. Unknown if the chance increases with further age.

|-
| MEANDERER
|
| Gives a creature random movement.

|-
| MEGABEAST
|
| Appears on fortress territory in Fortress Mode occasionally. Can also be worshipped.

|-
|MENT_ATT_CAP_PERC
|
*ATTRIBUTE Token
*Cap %
|Default is 200. This means you can increase your attribute to 200% of its starting value (or the average value + your starting value if that is higher).

|-
| MENT_ATT_RANGE
|
*ATTRIBUTE
*lowest:lower:low:median:high:higher:highest
| Sets up a mental attribute's range of values (0-5000). All mental attribute ranges default to 200:800:900:1000:1100:1300:2000.

|-
| MENT_ATT_RATES
|
*ATTRIBUTE Token
*cost to improve
*unused counter rate
*rust counter rate
*demotion counter rate
| Mental attribute gain/decay rates. Defaults are 500:4:5:4.

|-
| MILKABLE
|
* {{L|material token}}
* frequency
| Allows the creature to be milked.

|-
| MISCHIEVIOUS
|
| Will pull any levers it comes across. Also makes creature spawn invisible and with several ranks in Ambusher. "They go on little missions to mess with various fortress buildings, not just levers."

|-
| MODVALUE
|
| Seemingly no longer used - holdover from previous versions.

|-
| MOUNT
|
| Creature may be used as a mount.

|-
| MOUNT_EXOTIC
|
| You need the Dungeon master noble to mount the creature.

|-
| MULTIPLE_LITTER_RARE
|
| Makes litters with more than one offspring rare.

|-
| MULTIPLY_VALUE
|
*Multiplier
| Multiplies value of materials.

|-
| MUNDANE
|
| Marks if the creature is an actual real-life creature. Only used for age-names at present, and determining whether a creature will attack creatures with the AT_PEACE_WITH_WILDLIFE token.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==N==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| NAME
| singular:plural:adjective
| The generic name for any creature of this type - will be used when distinctions between caste are unimportant. For names for specific castes, use CASTE_NAME instead.

|-
| NATURAL
|
| Animal is considered to be natural.

|-
| NATURAL_SKILL
| skill:value
| The creature possesses this skill at this level inherently. It begins with this skill at this level, and the skill may never rust below this level. Requires CAN_LEARN or INTELLIGENT to function (changed in .25 or earlier that CAN_LEARN is no longer required).

|-
| NIGHT_CREATURE_BOGEYMAN
|
| Found on bogeymen. Creatures with this tag will join other bogeymen in attacking adventurers at night, and will also adopt their other behaviors, such as vanishing in smoke upon being killed. Setting the number of night creatures to zero in the world gen parameters will remove only the randomly-generated bogeymen.

|-
| NIGHT_CREATURE_HUNTER
|
| If this creature has SPOUSE_CONVERTER, it will actively attempt to seek out potential conversion targets, abduct them, and convert them. Night creatures will seek out one SPOUSE_CONVERSION_TARGET <s>of the opposite sex</s>(seems to choose anyone of any sex of the caste/s that have the CONVERTED_SPOUSE tag), convert them, and then have children with them(if possible). NIGHT_CREATURE_HUNTERs without SPOUSE_CONVERTER will not be placed. Setting the number of night creatures to zero in the world gen parameters will remove only the randomly-generated night creatures.

|-
| NO_AUTUMN
|
| does not appear this season.

|-
| NO_DIZZINESS
|
| Creature cannot become dizzy

|-
| NO_DRINK
|
| Creature does not need to drink.

|-
| NO_EAT
|
| Creature does not need to eat.

|-
| NO_FEVERS
|
| Creature cannot suffer fevers

|-
| NO_GENDER
|
| Creature has no gender.

|-
| NO_SLEEP
|
| Creature does not need to sleep.

|-
| NO_SPRING
|
| does not appear this season.

|-
| NO_SUMMER
|
| does not appear this season.

|-
| NO_THOUGHT_CENTER_FOR_MOVEMENT
|
| Creatures doesn't require an organ with the [THOUGHT] tag to survive; generally used on creatures that don't have brains.

|-
| NO_WINTER
|
| does not appear this season.

|-
| NOBONES
|
| Creature has no bones.

|-
| NOBREATHE
|
| Creature doesn't need to breathe or have [BREATHE] parts in body. Cannot drown or be strangled.

|-
| NOCTURNAL
|
| Sets if the creature is active in night.

|-
| NOEMOTION
|
| The creature has no emotions, and does not rage.

|-
| NOEXERT
|
| Creature can't become tired or over-exerted.

|-
| NOFEAR
|
| Creature doesn't feel fear and will never run away from battle.

|-
| NOMEAT
|
| Creature will not drop meat on butcher.

|-
| NONAUSEA
|
| Creature can't vomit.

|-
| NOPAIN
|
| Creature doesn't feel pain.

|-
| NOSKIN
|
| Creature will not drop skin on butcher.

|-
| NOSKULL
|
| Creature will not drop skull on butcher, rot, or decay of severed head.

|-
| NOSMELLYROT
|
| Does not produce miasma when rotting

|-
| NOSTUCKINS
|
| Weapons can't be stuck in creature.

|-
| NOSTUN
|
| Creature can't be stunned. Creatures with this tag never wake up from sleep in Fortress Mode and stay drowsy. If this creature must eat and drink while playing, it WILL die.

|-
| NOT_BUTCHERABLE
|
| Cannot be butchered

|-
| NOTHOUGHT
|
| Creature doesn't think, or doesn't require a [BRAIN] body part.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==P==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| PACK_ANIMAL
|
| Allows the creature to be used as a pack animal. Currently only used by merchants.

|-
| PARALYZEIMMUNE
|
| The creature is immune to all paralyzing special attacks.

|-
| PATTERNFLIER
|
|

|-
| PEARL
|
| Creature will generate pearls.

|-
| PENETRATEPOWER
| value
| Controls the ability of vermin to find a way into containers when they are eating food from your stockpiles. Wood and cloth objects roll a 0-9 and if it's greater than the penetrate power, their contents escape for the time being. Other objects roll a 0-99.

|-
| PERSONALITY
|
*ATTRIBUTE
*lowest:median:highest
| Determines the range and chance of personality traits. Standard is 0:50:100. See [[DF2010:Personality_trait|Personality traits]] for more info.

|-
| PET
|
| Allows the creature to be tamed. Also allows all females of the species to breed regardless of marital status.

|-
| PET_EXOTIC
|
| You need a Dungeon master noble in your fortress for the creature to be tamable (but any Animal trainer can do the taming).

|-
| PETVALUE
| value
| How valuable a tamed animal/pet is. Actual cost in points in the embarking screen is (PETVALUE/2)+1 for an untrained animal, PETVALUE+1 for a trained(War or Hunting) one. Note that for an animal to be selectable in this screen, it must have the COMMON_DOMESTIC token.

|-
| PETVALUE_DIVISOR
| value
| Divides the creature's PETVALUE by the specified number. Used for bees to prevent a single hive from being worth a fortune.

|-
|PHYS_ATT_CAP_PERC
|
*ATTRIBUTE Token
*Cap %
|Default is 200. This means you can increase your attribute to 200% of its starting value (or the average value + your starting value if that is higher).

|-
| PHYS_ATT_RANGE
|
*ATTRIBUTE
*lowest:lower:low:median:high:higher:highest
| Sets up a physical attribute's range of values (0-5000). All physical attribute ranges default to 200:700:900:1000:1100:1300:2000.

|-
| PHYS_ATT_RATES
|
*ATTRIBUTE Token
*cost to improve
*unused counter rate
*rust counter rate
*demotion counter rate
| Physical attribute gain/decay rates. Defaults for STRENGTH, AGILITY, TOUGHNESS, and ENDURANCE are 500:3:4:3, while RECUPERATION and DISEASE_RESISTANCE default to 500:NONE:NONE:NONE.

|-
| PLUS_BP_GROUP
|
*BY_TYPE, BY_CATEGORY, or BY_TOKEN
*body type, category, or token
| Adds a body part group to selected body part group. Presumably used immediately after SET_BP_GROUP.

|-
| PLUS_MATERIAL
|
*material
| Adds a material to selected materials. Used immediately after SELECT_MATERIAL.

|-
| POP_RATIO
|
| Weighted population of caste; Lower is rarer. Not to be confused with FREQUENCY.

|-
| POPULATION_NUMBER
| min:max
| old guess: "The minimum/maximum numbers of how many of these creatures can show up on a map per year."<br>Toady: "Pop number is the number per square of the region, I think."

|-
| POWER
|
|Allows the being to represent itself as a deity. Requires CAN_SPEAK to actually do anything more than settle at a location.

|-
| PREFSTRING
| string
| Sets what other creatures like about this creature. "Urist likes dwarves for their beards." Multiple entries will be chosen from at random

|-
| PROFESSION_NAME
|
*Profession
*singular
*plural
| The generic name for members of this profession, at the creature level. In order to give members of specific castes different names for professions, use CASTE_PROFESSION_NAME instead.

|-
| PRONE_TO_RAGE
| number
| Untested effect, though it clearly affects how likely a creature is to become enraged. Number may be percentage chance of becoming enraged during combat. As described in file_changes.txt, creatures with this token "follow its normal behavior, but flip out on occasion, higher rate = more flipping out".

|-
| PUS
|
* {{L|material token}}
*matter state (LIQUID, GAS, SOLID)
| Specifies what the creature's wounds will ooze when infected.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==R==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| RELSIZE
|
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*body category, type, or token
*Relsize
| Specifies a new relative size for a part than what is stated in the body plan. For example, Dwarves have larger livers.

|-
| REMAINS
| singular:plural
| What creature's remains are called.

|-
| REMAINS_COLOR
|
| What color creature's remains are.

|-
| REMAINS_ON_VERMIN_BITE_DEATH
|
| Leaves remains when its attack causes it to die? Seems to go with DIE_WHEN_VERMIN_BITE.

|-
| REMAINS_UNDETERMINED
|
| Unknown.

|-
| REMOVE_MATERIAL
|
*material token
| Removes a material from a creature.

|-
| REMOVE_TISSUE
|
*material token
| Removes a tissue from a creature.

|-
| RETURNS_VERMIN_KILLS_TO_OWNER
|
| Used with HUNTS_VERMIN, causes the creature to return killed vermin to its owner.

|}

<div align="center">
{{alphabetical TOC}}
</div>

==S==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| SAVAGE
|
| Allows creature to show up on (and limits it to) "savage" maps.

|-
| SECRETION
|
* {{L|material token}}
*Material State
*location secreted from (by_type, by_category, by_token)
*body part
*tissue layer
| creates a secreted material on given tissue on a given part of the body.

|-
| SELECT_ADDITIONAL_CASTE
|
*caste name
| adds an additional previously defined caste to the selection. Used immediately after SELECT_CASTE.

|-
| SELECT_CASTE
|
*caste name, or ALL
| selects a previously defined caste

|-
| SELECT_MATERIAL
|
*Material token
| Selects a locally defined material. Can be ALL.

|-
| SEMIMEGABEAST
|
| Appears as boss creature in quests. Makes history by rampaging around towns. Possibly inhabits non-mountain caves.

|-
| SET_BP_GROUP
|
*selection criteria BY_TYPE, BY_CATEGORY, BY_TOKEN
*category, type, or token
| Begins a selection of body parts.

|-
| SET_TL_GROUP
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
*tissue
| begins a selection of tissue layers

|-
| SHEARABLE_TISSUE_LAYER
|
* tissue modifier
* required value
| Tissue layer can be sheared for its component material. The specified modifier must be at least of the desired value for shearing to be possible (a llama's wool must have a LENGTH of 300 before it is shearable).

|-
| SKILL_LEARN_RATE
| {{L|skill_token}}:percentage
| The rate at which this creature learns this skill. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SKILL_LEARN_RATES
| percentage
| The rate at which this creature learns all skills. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SKILL_RATE
| {{L|skill_token}}:percentage:value:value:value
| As SKILL_RATES for individual skills. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SKILL_RATES
|
*% of improvement points you get
*unused counter rate
*rust counter rate
*demotion counter rate
| Affects skill gain and decay. Lower numbers in the last three slots make decay occur faster ([SKILL_RATES:100:1:1:1] would cause rapid decay). The counter rates may also be replaced with NONE.
Default is [SKILL_RATES:100:8:16:16]. [SLOW_LEARNER] changes the 100 to a 50. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SKILL_RUST_RATE
| {{L|skill_token}}:value:value:value
| The rate at which this skill decays. Lower values cause the skill to decay faster. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SKILL_RUST_RATES
| value:value:value
| The rate at which all skills decay. Lower values cause the skills to decay faster. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SLOW_LEARNER
|
| Similar to [CAN_LEARN], but slower; skills are gained at a fraction of the rate. Present in the entries for ogres and giants; can be applied to civ or player races.

|-
| SMALL_REMAINS
|
| If a creature has this token, it'll leave "remains" instead of a corpse.

|-
| SOLDIER_ALTTILE
| 'character' or tile number
| If this creature is active in its civilization's military, it will blink between its default tile and this one.

|-
| SOUND
|
* Sound application (currently accepts ALERT or PEACEFUL_INTERMITTENT)
* Sound range (in tiles)
* Sound delay (lower values = sound is produced more often)
* VOCALIZATION or NONE (determines whether the sound requires breathing or not)
* First-person description
* Third-person description
* Description when out of sight
| Creature makes sounds periodically, which can be heard in Adventure mode.

|-
| SPECIFIC_FOOD
|
* PLANT or CREATURE
* Plant/creature ID
| Indicates that the creature is only capable of eating a particular type of food.

|-
| SPEECH
| speech file
| Boasting speeches relating to killing this creature. Examples include dwarf.txt and elf.txt in data\speech.

|-
| SPEECH_FEMALE
| speech file
| Boasting speeches relating to killing females of this creature.

|-
| SPEECH_MALE
| speech file
| Boasting speeches relating to killing males of this creature.

|-
| SPEED
| value
| Sets the creatures' movement and work speed, 1000/[100 + SPEED X] is the resulting effect on creatures movement and work rates from default. See {{L|Speed}} for more information.

|-
| SPHERE
|
*sphere name
| Sets what religious spheres the creature is aligned to, for purposes of being worshipped via the [POWER] token. Also affects the layout of hidden fun stuff, and the creature's name.

|-
| SPOUSE_CONVERSION_TARGET
|
| This creature can be converted by a night creature with SPOUSE_CONVERTED.

|-
| SPOUSE_CONVERTER
|
| Enables the creature to convert SPOUSE_CONVERSION_TARGETs into CONVERTED_SPOUSE castes of its species. The creature won't actually actively do this unless it also has NIGHT_CREATURE_HUNTER, however.

|-
| SWIM_SPEED
|
*speed
| How fast the creature swims. Typically 2500 (0.38 times the default speed).

|-
| SWIMS_INNATE
|
| The creature naturally knows how to swim, as opposed to [SWIMS_LEARNED] below. Currently, an AI bug prevents this from being useful on PC races in fortress mode.

|-
| SWIMS_LEARNED
|
| The creature doesn't know how to swim unless it has learned the skill. Requires [CAN_LEARN], obviously.

|}

<div align="center">
{{alphabetical TOC}}
</div>

==T==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| TENDONS
|
* {{L|material token}}
*healing rate
| Defines the material and healing rate of tendons.

|-
| THICKWEB
|
| The creature's webs can catch larger creatures.

|-
| TISSUE
| name
| Begins defining a tissue in the creature file.

|-
| TITAN
|
| Found on {{L|titan}}s.

|-
| TL_COLOR_MODIFIER
| COLOR:freq:COLOR:freq etc
| Creates a list of color patterns, giving each a frequency.

|-
| TLCM_GENETIC_MODEL
|
| tissue layer color modifier is passed to offspring genetically?

|-
| TLCM_IMPORTANCE
|
*number
| Presumably modifies the importance of the tissue layer color modifier, for description purposes.
HOWEVER using this appears to remove all mention of colour from creature descriptions. It does not appear in any default creatures.

|-
| TLCM_NOUN
|
*name
*SINGULAR or PLURAL
| names the tissue layer color modifier, and determines the noun

|-
| TLCM_TIMING
|
*ROOT
*start change window years:days:end change window years:days
| determines the point in the creature's life where the color change begins

|-
| TRADE_CAPACITY
|
| How much the creature can carry when used by merchants.

|-
| TRAINABLE
|
| Implies both [TRAINABLE_HUNTING] and [TRAINABLE_WAR].

|-
| TRAINABLE_HUNTING
|
| Can be trained as hunting beasts by way of kennels.

|-
| TRAINABLE_WAR
|
| Can be trained as war beasts by way of kennels.

|-
| TRANCES
|
| Allows the creature to go into martial trances.

|-
| TRAPAVOID
|
| The creature is immune to traps. Probably every procedurally generated megabeast has this.

|-
| TRIGGERABLE_GROUP
| min:max
| A large swarm of vermin can be disturbed, usually in Adventure mode.{{verify}}

|-
| TSU_NOUN
|
*noun
*SINGULAR or PLURAL
| Noun for the TISSUE_STYLE_UNIT, used in the description of the tissue layer's style.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==U==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| UBIQUITOUS
|
| Creature will occur in every region with the correct biome. Does not apply to evil/good tags.

|-
| UNDERGROUND_DEPTH
|
*mindepth
*maxdepth
| Depth the creature appears underground. Numbers can be from 1 to 5. Only magma creatures use 4 or 5 in the default raws. A single argument may be used instead of min and max. Dwarven civilizations will only export (via the embark screen or caravans) things that available at depth 1.

|-
| UNDERSWIM
|
| Creature swims under the water and can't be seen. Currently appears to have no effect as of 31.25.

|-
| UNIQUE_DEMON
|
| Typically found on generated {{L|demon}}s; causes the game to create a single named instance of the demon which will emerge from the underworld and take over civilizations during worldgen. Cannot be used for modder-defined creatures.

|-
| USE_CASTE
|
*new caste token
*old caste token
| Defines a new caste derived directly from a previous caste. The new caste inherits all properties of the old one. The effect of this tag is automatic if one has not yet defined any castes: "Any caste-level tag that occurs before castes are explicitly declared is saved up and placed on any caste that is declared later, unless the caste is explicitly derived from another caste."

|-
| USE_MATERIAL
|
*new material token
*old material id
| Defines a new local creature material and populates it with all properties defined in the specified material. Old material id accepts any valid material id, including INORGANIC:X, CREATURE_MAT:C:X, LOCAL_CREATURE_MAT:X, and others (where X is a material id from that set, and C is a valid creature id).{{verify}}

|-
| USE_MATERIAL_TEMPLATE
|
*new material token
*material template
| Defines a new local creature material and populates it with all properties defined in the specified template.

|-
| USE_TISSUE
|
*new tissue token
*old tissue id
| Defines a new local creature tissue and populates it with all properties defined in the local tissue specified in the second argument.

|-
| USE_TISSUE_TEMPLATE
|
*new tissue token
*tissue template
| Loads a tissue template listed in OBJECT:TISSUE_TEMPLATE files, such as tissue_template_default.txt.

|-
| UTTERANCES
|
| Changes the language of the creature into an unintelligible mess.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==V==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| VEGETATION
|
| unknown

|-
| VERMIN_BITE
|
*chance of occurance{{verify}}
*verb (bitten, stung, etc)
* {{L|material token}}
| Vermin bites, and injects something.

|-
| VERMIN_EATER
|
| The vermin creature will attempt to eat exposed food. See PENETRATEPOWER. Distict from VERMIN_ROTTER.

|-
| VERMIN_FISH
|
| The vermin appears in water and will attempt to swim around.

|-
| VERMIN_GROUNDER
|
| The creature appears in "general" surface ground locations. Note that this doesn't stop the creature from flying if it can (most vermin birds have this tag).

|-
| VERMIN_HATEABLE
|
| Some dwarves will hate the creature and get unhappy thoughts when around it.

|-
| VERMIN_MICRO
|
| This makes the creature move in a swarm of creatures of the same race as it. I.E. Swarm of flies, swarm of ants, etc.

|-
| VERMIN_NOFISH
|
| The creature cannot be caught by fishing.

|-
| VERMIN_NOROAM
|
| The creature will not be observed randomly roaming about the map.

|-
| VERMIN_NOTRAP
|
| The creature cannot be caught in baited animal traps; however, a "catch live land animal" task may still be able to capture one if a dwarf finds one roaming around.

|-
| VERMIN_ROTTER
|
| Present on flies, knuckle worms, acorn flies, and blood gnats. Probably means either the creature is attracted to rot, the creature speeds rotting, or both.

|-
| VERMIN_SOIL
|
| The creature randomly appears near dirt or mud.

|-
| VERMIN_SOIL_COLONY
|
| The vermin will appear in a single tile cluster of many vermin, such as a colony of ants.

|-
| VERMINHUNTER
|
| Implies AT_PEACE_WITH_WILDLIFE, RETURNS_VERMIN_KILLS_TO_OWNER, HUNTS_VERMIN, and ADOPTS_OWNER.

|-
| VESPERTINE
|
| Sets if the creature is active in evening.

|-
| VIEWRANGE
| value
| Value should determine how close you have to get to a critter before it attacks (or prevents adv mode travel etc.) Default is 20.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==W==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| WAGON_PULLER
|
| Allows the creature to pull caravan wagons.

|-
| WEBBER
|
* {{L|material token}}
| Allows the creature to create webs, and defines what the webs are made of.

|-
| WEBIMMUNE
|
| The creature will not get caught in thick webs.
|}

==Attack Tokens==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| ATTACK_SKILL
|
*skill used ({{L|Skill token}})
| defines the attack skill used

|-
| ATTACK_VERB
| 2nd person:3rd person
| descriptive text for the attack

|-
| ATTACK_CONTACT_PERC
|
*% value
| amount of available tissue used in attack

|-
| ATTACK_PENETRATION_PERC
|
*% value
| probably amount of material that makes contact when penetration is done

|-
| ATTACK_PRIORITY
|
*MAIN or SECOND
| use of the attack in combat. Secondary attacks are only used if main attacks are impossible.

|-
| ATTACK_VELOCITY_MODIFIER
| number
| Modifies the attack velocity. Believed to be percent based (so 100 would be "normal"). May be on same scale as weapon velocity (where 1000 is "normal").

|-
| ATTACK_FLAG_CANLATCH
|
| Enables an attacker to occasionally latch on with the bodypart used by an attack when an attack with this flag in its definition is made.

|-
| ATTACK_FLAG_WITH
|
| In adventure mode, displays the name of the body part used by an attack when announcing the attack.

|-
| ATTACK_FLAG_EDGE
|
| attack type

|-
| SPECIALATTACK_INJECT_EXTRACT
|
* {{L|material token}}
*state (SOLID, LIQUID, GAS)
*min:max
| attack type addition that injects a material into the victim.

|-
| SPECIALATTACK_SUCK_BLOOD
| min:max
| Successful attack draws out an amount of blood randomized between the min and max value.
|}

==Important Related Tokens==
These next groups of tokens include several tokens that are not technically classified as creature tokens in string dump, but bear mentioning in this as they are used frequently in creature raws. (Some regular creature tokens may also be reprinted for the sake of ease of navigation)

===Tissue Modification===
This next group of tokens deals setting and modifying tissue properties. (See also {{L|Tissue definition token}})

{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| INSULATION
|
*value
| Tissue supplies the creature with heat insulation. Higher values result in more insulation.

|-
| PLUS_TISSUE_LAYER
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
| Adds a tissue to those selected

|-
| PLUS_TL_GROUP
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
*tissue
| continues a selection of tissue layers

|-
| SELECT_TISSUE
|
*tissue token
| Selects a tissue for editing.

|-
| SELECT_TISSUE_LAYER
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token | Selects a tissue at a location
* (optional) FRONT, BACK, LEFT, RIGHT, TOP, BOTTOM, AROUND.
| Selects a tissue layer for descriptor and cosmetic purposes.

|-
| SET_LAYER_TISSUE
|
| Sets a tissue layer to be made of a different tissue.

|-
| TISSUE_LAYER
|
*BY_TYPE, BY_CATEGORY, BY_TOKEN
*TYPE,CATEGORY, or TOKEN
*TISSUE
*LOCATION
| Adds the tissue layer to wherever it is required.
Non-argument Locations can be FRONT, RIGHT, LEFT, TOP, BOTTOM. Argument locations are AROUND and CLEANS, requiring a further body part and a % of coverage/cleansing

|-
| TISSUE_LAYER_OVER
|
*BY_TYPE, BY_CATEGORY, BY_TOKEN
*TYPE,CATEGORY, or TOKEN
*TISSUE
*LOCATION
| Presumably a counterpart to TISSUE_LAYER_UNDER (see below).

|-
| TISSUE_LAYER_UNDER
|
*BY_TYPE, BY_CATEGORY, BY_TOKEN
*TYPE,CATEGORY, or TOKEN
*TISSUE
| Adds the tissue layer under a given part.
For example an Iron Man has a gaseous poison within and this tissue (GAS is its name) has the token [TISSUE_LEAKS] and its state is GAS so when you puncture the iron outside and damage this tissue it leaks gas (can have a syndrome by using a previous one in the creature sample.) [TISSUE_LAYER_UNDER:BY_CATEGORY:ALL:{tissue}] {tissue} is what will be under the TISSUE_LAYER here is an example Tissue from Iron Man
[TISSUE:GAS]
[TISSUE_NAME:gas:NP] [TISSUE_MATERIAL:LOCAL_CREATURE_MAT:GAS] [TISSUE_MAT_STATE:GAS] [RELATIVE_THICKNESS:50] [TISSUE_LEAKS] [TISSUE_SHAPE:LAYER]

|-
| TISSUE_LAYER_APPEARANCE_MODIFIER
|
*QUALITY
*lowest:lower:low:median:high:higher:highest
| sets the range of qualities, including LENGTH, DENSE, HIGH_POSITION, CURLY, GREASY, WRINKLY

|-
| TISSUE_LEAKS
|
| The selected tissue leaks out of the creature when the layers above it are pierced. As per an iron man's internal poison gas.

|-
| TISSUE_MATERIAL
|
*VALUE (material)
*MATERIAL (material subtype)
| Defines the tissue material. VALUE can be LOCAL_CREATURE_MAT, INORGANIC etc. MATERIAL is a subtype of the material, e.g. [TISSUE_MATERIAL:INORGANIC:BRONZE]

|-
| TISSUE_STYLE_UNIT
|
*tissue
*shaping
| sets tissue to be in a certain shape, mostly used with tissues HAIR, BEARD, MOUSTACHE, SIDEBURNS.

|-
| TL_COLOR_MODIFIER
| COLOR:freq:COLOR:freq etc
| Creates a list of color patterns, giving each a frequency.

|-
| TL_CONNECTS
|
| Presumably gives the CONNECTS attribute to selected layers.

|-
| TL_HEALING_RATE
|
| Presumably changes the HEALING_RATE of the selected tissue layers.

|-
| TL_MAJOR_ARTERIES
|
| Gives Major Artery attribute to selected layers.

|-
| TL_PAIN_RECEPTORS
|
| Seems to set new number of pain receptors for selected tissue layers.

|-
| TL_RELATIVE_THICKNESS
|
| Seems to set new relative thickness for selected tissue layers.

|-
| TL_VASCULAR
|
| Seems to set new a VASCULAR value (which modulates bleeding) for selected tissue layers.

|}

==See Also==
*{{L|Body detail plan token}}
*{{L|Body token}}
*{{L|Material definition token}}
*{{L|Syndrome}}
*{{L|Tissue definition token}}

{{Category|Modding}}
{{Category|Tokens}}

v0.31:Syndrome

2011-11-06T18:46:31Z

I2amroy: /* Creature effect tokens */

{{quality|Masterwork|21:09, 26 April 2011 (UTC)}}{{av}}

A '''syndrome''' is a disease or effect that a poor hapless creature might get through encountering certain creatures, extracts or vindictive modders. They generally cause unpleasant and frequently fatal {{L|symptoms}} over a short to long period of time, but some will clear up over time or with the assistance of a {{L|doctor}}. A {{L|Hospital}} is required to diagnose and potentially treat the syndrome. [[File:Snakebite.png|200px|thumb|right|An example of a syndrome in effect. This hippo did not ultimately survive the encounter despite one bite being the only injury sustained.]]

==List of syndromes==
{| {{prettytable}}
|- bgcolor="#dddddd"
! Syndrome
! Venom
! Acquired
! Short-term Symptoms
! Long-term Symptoms
! Chronic Symptoms
|-
| Blob blisters
| cave blob fluid<br />(contact)
| Touching a {{L|cave blob}}
| Mild pain<br/>Mild blisters
| None
| None
|-
| Cave floater sickness
| cave floater gas<br />(inhaled)
| Expelled from {{L|cave floater}}
| Mild nausea
| Fever<br/>Strong drowsiness (delayed)<br/>Strong dizziness (delayed)
| None
|-
| Cave spider bite
| cave spider venom<br />(injected)
| Being bitten by a {{L|cave spider}}
| None
| None
| Very mild dizziness
|-
| Phantom spider bite
| phantom spider venom<br />(injected)
| Being bitten by a {{L|phantom spider}}
| None
| Numbness and mild dizziness
| None
|-
| Giant cave spider bite
| giant cave spider venom<br />(injected)
| Being bitten by a {{L|giant cave spider}}
| Complete paralysis<sup>1</sup><br/>'''Being eaten by the GCS'''
| None, not that it really matters.
| None
|-
| Gnomeblight
| {{L|gnomeblight}}<br />(contact, inhaled, or injected)
| Unknown. Affects gnomes only
| None
| Severe systemic necrosis<sup>2</sup>
| None
|-
| Giant desert scorpion sting
| giant desert scorpion<br />(injected)
| Being stung by a {{L|giant desert scorpion}}
| None
| Necrosis of the brain and nervous system<sup>2</sup>
| None
|-
| Helmet snake bite
| helmet snake venom<br />(injected)
| Being bitten by a {{L|helmet snake}}
| Minor bleeding
| Fever<br/>Nausea<br/>Dizziness<br/>Localized swelling<br/>Localized oozing<br/>Localized bruising<br/>Strong pain<br/>Intense localized necrosis<br/>Possible loss of limb
| None
|-
| Iron man cough
| iron man gas<br />(inhaled)
| Expelled by {{L|iron man}}
| Coughing blood
| None
| None
|-
| Platypus sting
| platypus venom<br />(injected)
| Being kicked by a {{L|platypus}}, {{L|giant platypus}} or {{L|platypus man}}
| Pain and swelling
| Extreme pain, swelling possibly to the point of necrosis
| None
|-
| Serpent man bite
| serpent man venom<br />(injected)
| Being bitten by a {{L|serpent man}}
| Complete paralysis<sup>1</sup>
| None
| None
|-
| beast sickness<sup>3</sup>
| random
| Encounters with {{L|forgotten beast}}s
| random
| random
| random
|-
| titan sickness<sup>3</sup>
| random
| Encounters with {{L|titan}}s
| random
| random
| random
|-
| demon sickness<sup>3</sup>
| random
| Encounters with {{L|demon}}s
| random
| random
| random
|}
:<small>1. For small creatures such as humans and dwarves, paralysis tends to result in suffocation.</small>
:<small>2. Necrosis of the brain will eventually result in instant death once the brain rots away completely.</small>
:<small>3. {{L|Titan}}s, {{L|forgotten beast}}s, and {{L|demon}}s have a chance to have a randomized syndrome. These range from pointless (mild blisters from inhaling boiling blood) to instantly deadly (Severe necrosis from a contact poison attached to a breath weapon/creature made of blood.</small>

==The anatomy of a syndrome==
Mechanically, syndromes are bundles of tokens attached to a material - they're confined to creature materials in vanilla DF, but it's a simple matter to add them to inorganic materials. When the material is injected, touched or inhaled (depending on the syndrome), the creature suffers the predations of a nasty disease or poison. Here's an example syndrome, taken from the Giant Cave Spider raws.

If you are having troubles getting the syndromes to work (ie, in combat reports, getting "'''supersnake''' n/a splatters~etc"), then simply throw the venom template into the actual creature's raw, which is what the LOCAL_CREATURE_MAT actually calls on; the venom being in the same file.

[USE_MATERIAL_TEMPLATE:POISON:CREATURE_EXTRACT_TEMPLATE]
[STATE_NAME:ALL_SOLID:frozen giant cave spider venom]
[STATE_ADJ:ALL_SOLID:frozen giant cave spider venom]
[STATE_NAME:LIQUID:giant cave spider venom]
[STATE_ADJ:LIQUID:giant cave spider venom]
[STATE_NAME:GAS:boiling giant cave spider venom]
[STATE_ADJ:GAS:boiling giant cave spider venom]
[PREFIX:NONE]
[ENTERS_BLOOD]
[SYNDROME]
[SYN_NAME:giant cave spider bite]
[SYN_AFFECTED_CLASS:GENERAL_POISON]
[SYN_IMMUNE_CREATURE:SPIDER_CAVE:ALL]
[SYN_INJECTED]
[CE_PARALYSIS:SEV:100:PROB:100:RESISTABLE:SIZE_DILUTES:START:5:PEAK:10:END:20]

The first line, USE_MATERIAL_TEMPLATE, is creating a new material, called POISON, using the CREATURE_EXTRACT_TEMPLATE as the basis. After this, the STATE_NAME and STATE_ADJ tokens are used to define the names and adjectives assigned to different states of the material - GAS, LIQUID and ALL_SOLID, in this case, though ALL is also a valid token. At this stage, you can use any material tags like MAT_FIXED_TEMP or similar to set further material properties, though this usually isn't necessary.

ENTERS_BLOOD
This tag determines whether a poison enters the blood or not. If it is not included, the poison will splatter (if liquid) or flow (if gas) over the affected body part instead when injected. If you're using a contact poison, leave this out. Necessary for injected poisons.
SYNDROME
This tag ends the material details and begins the definition of the actual syndrome.
SYN_NAME
This one is self-explanatory - the name of the syndrome as it will appear in-game.
SYN_AFFECTED_CLASS
This token defines what CREATURE_CLASS will be affected by the syndrome. Most creatures are classed under GENERAL_POISON. Multiple tokens can be used in a single syndrome.
SYN_IMMUNE_CLASS
As above, but makes class immune.
SYN_IMMUNE_CREATURE
This token defines which creatures CANNOT be affected by the syndrome - useful for addressing specific instances within a population, such as a specific caste or an individual creature that falls under GENERAL_POISON. Syntax is [SYN_IMMUNE_CREATURE:creature:caste]. ALL can be used for the caste.
SYN_AFFECTED_CREATURE
As above, but makes creature or caste susceptible.

SYN_INJECTED, SYN_CONTACT, SYN_INHALED
This token determines the method of infection - injected syndromes must be injected via a creature attack, while contact syndromes result from any contamination of a creature by material splatter (such as blood) and inhaled syndromes must be inhaled in gaseous form, such as from boiling or a creature breath attack. Any combination of these tags can be used. A fun variation on the usual creature injection routine is to create a material with a SYN_CONTACT syndrome and have a creature use it for blood - this tends to end poorly for any predator that chooses to attack them.

[SPECIALATTACK_INJECT_EXTRACT:LOCAL_CREATURE_MAT:VENOM:LIQUID:100:100]
This is one method for getting a poison into a creature. If [ENTERS_BLOOD] is applied, it will be injected into the bloodstream. Otherwise, it will just splatter over the area. Put this on a creature attack. Substance type (gas, liquid, solid) does not appear to have an effect. The numbers on the end are minimum and maximum.

CE_X, or creature effect tokens, are the real meat and bones of your syndrome. They're detailed below.

==Creature effect tokens==
Each and every syndrome has a number of creature effect tokens, represented by CE_X - these lovely little beauties determine exactly how the poor creature suffering from the syndrome is affected. An example CE token is as follows:

[CE_NECROSIS:SEV:100:PROB:100:LOCALIZED:VASCULAR_ONLY:RESISTABLE:START:50:PEAK:1000:END:2000]

In this example, we have an effect that will always cause severe necrosis in whichever bodypart it touches, so long as that bodypart is vascular and that the creature is not able to resist it in some manner. The effect begins shortly after the syndrome is contracted, peaks 1000 {{L|time|time units}} afterwards, and finally ceases another 1000 time units later.

As a general rule of thumb, so long as CE_X starts the string and START/PEAK/END end it, the order of the intervening tokens isn't important.

*CE_X
The effect type. This can be a number of different tokens, as detailed in the table below this list.
*SEV:X
The severity of the effect. Higher values appear to be worse, with SEV:1000 CE_NECROSIS causing a part to near-instantly become rotten.
*PROB:X
The probability of the effect actually manifesting in the victim, as a percentage. 100 means always, 1 means a 1 in 100 chance.
*LOCALIZED (Overwrites BP tokens)
This tag causes an effect to ignore all BP tokens and then forces the game to attempt to apply the effect to the limb that came into contact with the contagion - ie. the part that was bitten by the creature injecting the syndrome material, or the one that was splattered by a contact contagion. If an effect can not be applied to the contacted limb (i.e. IMPAIR_FUNCTION on a non-organ) then this token makes the syndrome have no effect. This token also makes inhaled syndromes have no effect.
*BP:BODY_PART:TISSUE (Overwritten by LOCALIZED)
Specifies which body parts and tissues are to be affected by the syndrome. BODY_PART can be BY_CATEGORY:x to target body parts with a matching [CATEGORY:x] {{L|body token}} (or ALL to affect everything), BY_TYPE:x to target body parts having a particular type (UPPERBODY, LOWERBODY, HEAD, GRASP, or STANCE), or BY_TOKEN:x to target individual body parts by their ID (as specified in the [BP] token). For example, if you wanted to target the lungs of a creature, you would use BP:BY_CATEGORY:LUNG:ALL. The syndrome would act on all bodyparts within the creature with the CATEGORY tag LUNG and affect all tissue layers. For another example, say you wanted to cause the skin to rot off a creature - you could use BP:BY_CATEGORY:ALL:SKIN, targeting the SKIN tissue on all bodyparts. Multiple targets can be given in one syndrome by placing the BP tokens end to end. This is one of the most powerful and useful aspects of the syndrome system, as it allows you to selectively target bodyparts relevant to the contagion, like lungs for coal dust inhalation, or the eyes for exposure to an acid gas. Not everything takes a target!
*VASCULAR_ONLY (Optional)
This syndrome only affects tissue layers with the VASCULAR token.
*MUSCULAR_ONLY (Optional)
This syndrome only affects tissue layers with the MUSCULAR token. Are you seeing a trend here?
*SIZE_DILUTES (Optional)
This token presumably causes the effects of the syndrome to scale with the size of the creature compared to the size of the dose of contagion they received, but has yet to be extensively tested.
*SIZE_DELAYS (Optional)
As above, this token has yet to be tested but presumably delays the onset of a syndrome according to the size of the victim.

The details of this table are still being thrashed out by modders, so if you have anything to add, please don't hesitate to hit the edit button!

Non-targeted syndromes will ignore any BP tokens and LOCALIZED tokens.
{| {{prettytable}}
|- bgcolor="Bisque"
! Token
! Accepts Target
! Description
|-
| CE_PAIN
| Yes
| Afflicts the targeted bodypart with intense pain.
|-
| CE_SWELLING
| Yes
| Causes the targeted bodypart to swell up. Extreme swelling may lead to necrosis.
|-
| CE_OOZING
| Yes
| Causes pus to ooze from the afflicted bodypart.
|-
| CE_BRUISING
| Yes
| Causes the targeted bodypart to undergo bruising.
|-
| CE_BLISTERS
| Yes
| Covers the targeted bodypart with blisters.
|-
| CE_NUMBNESS
| Yes
| Causes numbness in the affected body part, blocking pain. Extreme numbness may lead to sensory nerve damage.
|-
| CE_PARALYSIS
| Yes
| Causes paralysis in the affected body part. Targeted causes sluggishness and significantly reduces speed. Untargeted paralysis is 'complete paralysis' and will cause suffocation in smaller creatures.
|-
| CE_FEVER
| No
| Causes the Fever condition.
|-
| CE_BLEEDING
| Yes
| Causes the targeted bodypart to start bleeding, with heavy enough bleeding resulting in the death of the sufferer. Some conditions seem to cause bleeding to be fatal no matter how weak.
|-
| CE_COUGH_BLOOD
| No
| This effect results in the sufferer periodically coughing blood, which stains the tile they're on and requires cleanup. It doesn't appear to be lethal, but may cause minor bleeding damage.
|-
| CE_VOMIT_BLOOD
| No
| This effect results in the sufferer periodically vomiting blood, which stains the tile they're on and requires cleanup. It doesn't appear to be lethal, but may cause minor bleeding damage.
|-
| CE_NAUSEA
| No
| Causes the Nausea condition, and heavy vomiting. Can eventually lead to dehydration and death.
|-
| CE_UNCONSCIOUSNESS
| No
| Renders unconscious.
|-
| CE_NECROSIS
| Yes
| Causes the targeted bodypart to rot, with associated tissue damage and miasma. Badly necrotic limbs will require amputation and heavy rot will eventually result in bleeding. Necrosis has some strange behavior involving bleeding to death that isn't fully understood; a 100% necrotic creature can survive fine with no non-yellow bodyparts but will die of bleeding as soon as they end a round of combat, even if they never take a hit. Because of this, fairly useless unless targeting the lungs or eyes.
|-
| CE_IMPAIR_FUNCTION
| Yes
| An organ afflicted with this CE is rendered inoperable - for example, if both lungs are impaired the creature can't breathe and will suffocate. This token only affects organs, not limbs.
|-
| CE_DROWSINESS
| No
| Causes the Drowsiness condition.
|-
| CE_DIZZINESS
| No
| Inflicts the Dizziness condition, occasional fainting and a general slowdown in movement and work speed.
|}

==Inorganic syndromes and you!==
It's perfectly possible - and quite simple - to add a nasty syndrome to a type of rock or metal - you simply add the syndrome tokens to the material definition in the same manner that you would add them to a creature material definition. The only catch is that since your hapless dwarves will only normally encounter the material in metal, gem or boulder form, a bit of creativity must be used to actually get them inside your citizens - that is, you need to make them 'explosively boil' as soon as they're mined or produced. This has the sad side effect of destroying the actual item - sorry, no highly radioactive uranium this release.

The easiest way to accomplish this is to assign the material a low boiling point, usually just under room temperature, and make sure its temperature is fixed to a point above it.
[MAT_FIXED_TEMP:9001]
[BOILING_POINT:9000]
Now, as soon as this substance hits the open air - by being mined, smelted or reaction-produced at a custom workshop - it will EXPLOSIVELY BOIL, flooding a small area with delicious syndrome-rich gas. Creatures who inhale the gas will be immediately hit with the syndrome you thoughtfully attached to the material definition earlier!

There are a number of other tokens you can use to control the colour and naming conventions of your syndrome material, referred to as MATERIAL tokens.

==Breath attacks==
If you want to really make a creature deadly, you can give it a breath attack to shoot your neurotoxin at your hapless dwarves from range. Some of these attacks have the unfortunate side effect of preventing a critter from using its regular attacks unless the enemy is ''on the same tile.'' You decide if it's worth it.

To use a breath attack, place something like the following anywhere in your creature entry:

[MATERIAL_BREATH_ATTACK:LOCAL_CREATURE_MAT:SPITTER_SPIT:SOLID_GLOB]

The LOCAL_CREATURE_MAT:SPITTER_SPIT refers to the material the breath attack will be made of - in this case, it is another material defined within the creature entry.

===Breath Attack Types===

{| {{prettytable}}
|- bgcolor="#ddd"
! | Token
! | Description
|-
| TRAILING_GAS_FLOW
| Shoots a trail of gas substance at the creature. Fairly easy to dodge. Creature will attack as normal.
|-
| TRAILING_VAPOR_FLOW
| Similar to the trailing gas, but easier to breathe in, and condensed, so it will collect on creatures. Creature will attack as normal.
|-
| TRAILING_DUST_FLOW
| Lets out a cloud of solid dust. Appears to use cave-in dust physics, causing this to fling around anything it comes in contact with, making it capable of smashing creatures into the ground and flinging them over walls. Creature will attack as normal.
|-
| SOLID_GLOB
| Shoots a solid glob of spinning substance at the creature, leaving symbols similar to broken arrows. Essentially a projectile weapon. Some creatures with this breath attack will not move, preferring instead to stay and shoot globs at you, even when you are literally right next to them.
|-
| LIQUID_GLOB
| Shoots a '''solid''' glob of spinning substance at the creature. Essentially the same as SOLID_GLOB. May do less damage.
|-
| UNDIRECTED_GAS
| Creature occasionally releases a cloud of substance. Similar to TRAILING_GAS_FLOW, but undirected, thus affecting a larger area but losing the distance. Creature will attack as normal.
|-
| UNDIRECTED_VAPOR
| Creature occasionally releases a cloud of substance. Similar to TRAILING_VAPOR_FLOW, but undirected, thus affecting a larger area but losing the distance. Creature will attack as normal.
|-
| UNDIRECTED_DUST
| Creature occasionally releases a large cloud of substance, which will spread and dissipate. Similar to TRAILING_DUST_FLOW, but undirected, thus affecting a larger area but losing the distance - range is roughly the same as that of a cave-in. Creature will attack as normal. <s>DO NOT USE THIS TAG UNLESS YOU WANT TO KILL THE CREATURE AND EVERYTHING NEAR IT AND SEND PEOPLE FLYING.</s> You know you want to.
|}

Keep in mind that you can use multiple breath attacks, which appears to make the creature choose between them at random.

{{Category|Modding}}
[[ru:DF2010:Syndrome]]

v0.31:Herring

2011-10-15T19:36:34Z

I2amroy:

{{D for Dwarf}}{{Quality|Exceptional|23:32, 9 June 2010 (UTC)}}
{{verminlookup/0}}
{{av}}
{{creaturedesc}}

[[File:Vermin-Herring.jpg|thumb|left|Admired for its massive schools.]]

'''Herring''' are a type of {{L|vermin}} {{L|fish}}. They are found in {{L|biome|arctic}} and {{L|temperate}} {{L|ocean|oceans}}, and are a ready source of {{L|food}} when {{L|fish cleaning|cleaned}} at a {{L|fishery}}.

Herring are not a suitable replacement for a battle axe for performing the woodcutting labor. Despite what strange knights state, some {{L|Quarry bush|shrubberies}} will suffice.

{{gamedata}}
{{Vermin}}

v0.31:Dragon

2011-10-15T19:33:06Z

I2amroy:

{{quality|Exceptional|11:47, 2 October 2010 (UTC)}}
{{Creaturelookup/0
|bone=110
|meat=139
|fat=65
|lung=18
|heart=4
|intestine=27
|liver=9
|tripe=9
|sweetbread=4
|spleen=4
|kidney=8
|brain=5
|skull=1
|skin=scale
}}
{{av}}
{{creaturedesc}}

'''Dragons''' are gigantic fire-breathing [[:Megabeast|Megabeasts]], eventually becoming the largest beings in the world. Cannot fly. Immune to fire and magma (and is not harmed by being immersed in it). Breathes out a jet of "dragonfire", which can still injure things that are immune to normal fire, such as the {{L|Bronze colossus}} (dragonfire is, however, a blockable attack if its victim is using a shield). Only Dragons and {{L|Cave dragon|Cave Dragons}} are naturally immune to dragonfire.

==Dragon Size==

Dragons can grow to be the largest creatures in the game, eventually reaching their adult size of 25,000,000 cm<sup>3</sup> after 1000 years. As a hatchling, dragons are quite tiny, at exactly 1/10th an adult dwarf's size, but they grow very rapidly, at roughly 25,000 cm<sup>3</sup> per year. Dragons reach dwarf size shortly after its second birthday, are more than double a dwarf at about year 5, and add another dwarf in size roughly every two years after that.

*At 23 years, a dragon is the size of a [[giant cheetah]].
*At 80 years, a dragon is the size of an adolescent [[Roc]].
*At 200 years, a dragon is the size of an adult [[elephant]].
*At 320 years, a dragon is the size of a [[Hydra]].
*At 800 years, a dragon is the size of a [[Bronze Colossus]] or an adult [[Roc]].
*Thereafter, a dragon is the largest being alive.

==Defense Strategies==

Dragonfire can be blocked if the victim is using a shield, and it often will be. Dragons are also massively powerful in melee combat, so they can be hard to take down without a good military. Possibly the best defense is to use piercing weapons like crossbows and especially spears and hope you get lucky and hit a vital organ which can bring it down immediately. An alternative is quickly building one or multiple cage traps which will probably cage the dragon making it harmless.

==Domestication==

Dragons can be captured in cage traps and made as pets if you're lucky enough to catch one. You need a {{L|dungeon master}} to tame a Dragon, but if you can do it, you'll have a massively valuable pet that can lay {{L|egg}}s. Dragons can also be trained as war or hunting animals at the {{L|kennel}}. You may have to watch out, though, as a Dragon can seriously damage a fortress with one blast of ill-timed dragonfire. See {{L|fire}} for details.

==Irregularities, Bugs, and Future Plans==
Dragons have been observed to occasionally wear some armour (breastplates, greaves, leggings and boots). This armor is specified as "Large [metal][armor type]" and gives the dragon the same protection as any other species might get from it.

Toady has mentioned that he plans to eventually extend the random creature generator of the game to create different species and varieties of dragon within certain constraints, calling it "Half-Random", with ideas for variants including just about anything dragons have been given in literature, such as acidic blood, while maintaining a basic draconic structure.<sup>([http://www.bay12forums.com/smf/index.php?topic=30026.msg1012311#msg1012311])</sup>

One of the [[Consolidated Development: Arcs, core-items, bloats, Reqs and Powergoals#Power Goals|old power goals]] referenced stealing dragon eggs as part of an adventure mode quest.
{{gamedata}}
{{Creatures}}
{{Category|Megabeasts}}

v0.31:Dragon

2011-10-15T19:30:12Z

I2amroy: Verified

{{quality|Exceptional|11:47, 2 October 2010 (UTC)}}
{{Creaturelookup/0
|bone=110
|meat=139
|fat=65
|lung=18
|heart=4
|intestine=27
|liver=9
|tripe=9
|sweetbread=4
|spleen=4
|kidney=8
|brain=5
|skull=1
|skin=scale
}}
{{av}}
{{creaturedesc}}

'''Dragons''' are gigantic fire-breathing [[:Megabeast|Megabeasts]], eventually becoming the largest beings in the world. Cannot fly. Immune to fire and magma (and is not harmed by being immersed in it). Breathes out a jet of "dragonfire", which can still injure things that are immune to normal fire, such as the {{L|Bronze colossus}} (dragonfire is, however, a blockable attack if its victim is using a shield). Only Dragons and Cave Dragons are naturally immune to dragonfire.

==Dragon Size==

Dragons can grow to be the largest creatures in the game, eventually reaching their adult size of 25,000,000 cm<sup>3</sup> after 1000 years. As a hatchling, dragons are quite tiny, at exactly 1/10th an adult dwarf's size, but they grow very rapidly, at roughly 25,000 cm<sup>3</sup> per year. Dragons reach dwarf size shortly after its second birthday, are more than double a dwarf at about year 5, and add another dwarf in size roughly every two years after that.

*At 23 years, a dragon is the size of a [[giant cheetah]].
*At 80 years, a dragon is the size of an adolescent [[Roc]].
*At 200 years, a dragon is the size of an adult [[elephant]].
*At 320 years, a dragon is the size of a [[Hydra]].
*At 800 years, a dragon is the size of a [[Bronze Colossus]] or an adult [[Roc]].
*Thereafter, a dragon is the largest being alive.

==Defense Strategies==

Dragonfire can be blocked if the victim is using a shield, and it often will be. Dragons are also massively powerful in melee combat, so they can be hard to take down without a good military. Possibly the best defense is to use piercing weapons like crossbows and especially spears and hope you get lucky and hit a vital organ which can bring it down immediately. An alternative is quickly building one or multiple cage traps which will probably cage the dragon making it harmless.

==Domestication==

Dragons can be captured in cage traps and made as pets if you're lucky enough to catch one. You need a {{L|dungeon master}} to tame a Dragon, but if you can do it, you'll have a massively valuable pet that can lay {{L|egg}}s. Dragons can also be trained as war or hunting animals at the {{L|kennel}}. You may have to watch out, though, as a Dragon can seriously damage a fortress with one blast of ill-timed dragonfire. See {{L|fire}} for details.

==Irregularities, Bugs, and Future Plans==
Dragons have been observed to occasionally wear some armour (breastplates, greaves, leggings and boots). This armor is specified as "Large [metal][armor type]" and gives the dragon the same protection as any other species might get from it.

Toady has mentioned that he plans to eventually extend the random creature generator of the game to create different species and varieties of dragon within certain constraints, calling it "Half-Random", with ideas for variants including just about anything dragons have been given in literature, such as acidic blood, while maintaining a basic draconic structure.<sup>([http://www.bay12forums.com/smf/index.php?topic=30026.msg1012311#msg1012311])</sup>

One of the [[Consolidated Development: Arcs, core-items, bloats, Reqs and Powergoals#Power Goals|old power goals]] referenced stealing dragon eggs as part of an adventure mode quest.
{{gamedata}}
{{Creatures}}
{{Category|Megabeasts}}

v0.31:Dimple cup

2011-10-15T19:12:49Z

I2amroy:

{{Quality|Exceptional|09:20, 9 June 2010 (UTC)}}
{{plantlookup/0|uses=
* {{L|Dye}}
|other_products=
* {{L|Dimple dye}} (Mill)}}
{{av}}

'''Dimple cup''' is a {{L|underground|subterranean}} {{L|crop}}. It can be {{L|farming|grown}} year-round and can be {{L|milling|milled}} into {{l|dye|blue dimple dye}}.

* Grow time: 500
* Plant value: 2
* Mill value: 20
* Dye color: Midnight Blue
* Seasons: All

==See Also==
*{{L|List of crops}}
*{{L|Textile industry}}

{{gamedata}}
{{Plants}}

v0.31:Blade weed

2011-10-15T19:08:10Z

I2amroy: lack of a GROWDUR tokens gives a grow time of 300

{{quality|Exceptional|15:58, 30 September 2010 (UTC)}}
{{plantlookup/0|uses=
* {{L|Dye}}
|other_products=
* {{L|Dye|Emerald dye}} (Mill)}}
{{av}}

'''Blade weed''' is a plant used only to make emerald {{L|dye}} at a {{L|millstone|mill}} or {{L|quern}}. They can be planted outdoors any time of year and can be collected by {{L|gather plants|gathering plants}} in any dry non-freezing {{L|biome}}.

* Grow time: 300
* Plant value: 2
* Mill value: 20
* Dye color: Emerald
* Seasons: All

==See Also==
*{{L|List of crops}}
*{{L|Textile industry}}

{{gamedata}}
{{Plants}}

v0.31:Advanced world generation

2011-10-15T18:54:37Z

I2amroy: /* Year to Begin Checking Megabeast Percentage */

{{quality|Exceptional|23:35, 30 March 2011 (UTC)}}{{av}}
{{buggy}}

:''This article contains information on advanced world generation. For information on basic world generation, see {{L|World generation}}.''
:''See {{L|World token}} to more easily find information by the names used in the world_gen.txt file.''
:''See {{L|World rejection}} for information on solving problems related to worlds always being rejected.''
:''See {{L|Worldgen examples}} for example worlds.''

When you want more control of what your world looks like, it's time for '''advanced world generation'''. A detailed reference with advice is provided below. This article assumes that you are already familiar with {{L|World generation|'''basic''' world generation}}. If you are not then please read about that first.

= Advanced World Generation Screen =

Once you select {{DFtext|Design New World With Advanced Parameters}} from the main menu, a screen that looks something like this will appear:

[[File:AdvancedWorldGen.png‎]]

This screen is relatively intuitive but some parts could use some explanation.

== Parameter Sets ==

The list of already defined parameter sets is in the upper right corner. You can select the current set that you want to work with using the up and down directional keys.

Hitting {{K|a}} will add a new set to the end of the list. You can also {{K|c}}opy an existing set to a new one allowing you to base a new set on an existing one. Using {{K|t}} you can change the name of the parameter set but note that this will not affect the name of the world that is generated.

Parameter sets are stored in the <tt>data/init/world_gen.txt</tt> file in the main DF directory. The {{K|F1}} and {{K|F6}} keys will load and save '''all''' of the parameter sets to this file. You will need to save the world gen parameters to this file before you hit {{K|Enter}} to generate the world.

The <tt>world_gen.txt</tt> file can also be edited with a text editor. This is particularly useful because people will often post their parameter sets on the forum or wiki in text form. (See below for more info.) The {{K|F1}} key comes in handy when editing this file while the game is still running.

The tokens used in <tt>world_gen.txt</tt> are at the bottom of each parameter description. Here's the one for title.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[TITLE: <name>]</nowiki></tt>
| <tt><nowiki>[TITLE:MEDIUM ISLAND]</nowiki></tt>
| Required
|}

== World Name ==

As previously mentioned, the title of the parameter set doesn't affect the name of the world. You can force a particular name for your world using {{K|n}} or set it back to the default random setting using {{K|N}}.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[CUSTOM_NAME: <name>]</nowiki></tt>
| <tt><nowiki>[CUSTOM_NAME:Realm of Cheese Engravings]</nowiki></tt>
| For a random name, simply don't use this token.
|}

== World Dimensions ==

The size of the map to be generated can be selected with {{K|u}} {{K|i}} {{K|o}} {{K|p}}. Larger maps take longer to generate and may limit {{L|Frames per second|FPS}} in game.

Changing the dimensions of the world will reset the parameters because many of them have different defaults depending on the surface area available.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[DIM:<width>:<height>]</nowiki></tt>
| <tt><nowiki>[DIM:129:129]</nowiki></tt>
| Valid values are 17,33,65,129, and 257. Others may not work.
|}

== Seed Values ==

The world generation process uses a PRNG (Pseudo Random Number Generator) algorithm. A PRNG will produce a sequence of numbers that "looks" random even though the actual sequence of numbers will always be the same if the PRNG is started with the same seed value. Basically this means that if you run word generation with a certain seed value on your computer, and someone else runs world generation with the same seed value on their computer, the same sequence of random numbers will be generated on both computers. The practical impact of this is that someone else can generate exactly the same world that you generated by entering the same seed value that you used.

A specific seed value can be entered with {{K|s}}. This will change '''all''' of the seed values to the value you enter. If you need to enter different seed values for each type of seed, use {{K|e}}.

In order to find out what seed values were used for the last world you generated you can look at this screen. If you want to be able to tell someone else how to generate exactly the same world that you just generated, they will need all of the seed value listed under Last Param Set.

Normally you don't enter these seed values and the world generation process comes up with seed values based on some sort of "true" random information from things like random values in uninitialized memory, the current date/time, etc. If you have entered a seed value you can revert back to all seeds being random using {{K|S}}.

== Entering Advanced Parameters and Generating a World ==

Unless you're using an already defined parameter set you will probably want to {{K|e}}dit the parameters. Select the set you want to edit using the up/down directional keys and press {{K|e}}. Information about each parameter is documented below.

Once you are happy with the parameters you have set, hit {{K|Esc}} to get back to this screen, hit {{K|F6}} to save the values you just edited, and hit {{K|Enter}} to start. The rest of the process is the same as basic {{L|World generation}}.

The phases of the world generation process are (this order is not completely correct):
* Preparing elevation...
* Setting temperature...
* Running rivers...
* Forming lakes and minerals...
* Growing vegetation...
* Verifying terrain...
* Importing wildlife...
* Recounting legends...
* Placing civilizations...
* Making cave civilizations...
* Making cave pops...
* Placing other beasts...
* Placing megabeasts...
* Placing good/evil...
* Placing caves...
* Prehistory generation
* Finalizing civ mats...
* Finalizing art...
* Finalizing uniforms...
* Finalizing sites...

== World Painter ==
:''Main article {{L|World painter}}
The '''world painter''' tool allows you to paint features onto a map that is then used when generating a world. It is very difficult to use properly, and tends to result in endless rejected worlds, unless you loosen or remove the restrictions placed on biomes and civilizations in the advanced settings. That being said it is also a very powerful tool, and allows you to generate worlds more to your liking.

To access the world painter, hit {{k|e}} to start editing the advanced parameters and finally hit {{k|p}} to open world painter. How to use the world painter is not entirely obvious so please check out the {{L|World painter}} documentation to avoid frustration. (Losing may be fun, but frustration is not.)

== Editing the Parameters Init File Directly ==

Parameter sets are stored in ''world_gen.txt'' in the ''\data\init'' folder, using {{L|world token}}. You can copy and paste other player's sets of parameters into your ''world_gen.txt'' to use their parameter sets, and some are provided at [[Pregenerated worlds]]. Another place to find parameter sets is the [http://www.bay12games.com/forum/index.php?topic=20638.0 Worldgen cookbook] thread on the official forums.

= Advanced Parameters =

To access advanced parameters, press {{key|e}} when at the screen for creating new worlds with parameters screen. This will bring you to an editable list of various guidelines the world-gen process will use when creating your new world.

The parameters are described below in the order that they appear in the list in the UI, not necessarily the other they appear in the configuration file. See {{L|world token}} for an index that will help you look things up by token name.

== Seed Values ==

Here you can enter specific seed values for different parts of the world generation process. Different sequences of pseudorandom numbers are used for different parts, so you can use this to reproduce only the particular part of world generation from some previously generated world if you want.

Normally you will want to leave all of these set to Random unless you're specifically trying to reproduce the results of another world generation run.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[SEED:<number>]</nowiki></tt>
| <tt><nowiki>[SEED:31337]</nowiki></tt>
| rowspan="4" |
For each of these not in the config file, a random seed will be used.
|-
| <tt><nowiki>[HISTORY_SEED:<number>]</nowiki></tt>
| <tt><nowiki>[HISTORY_SEED:31337]</nowiki></tt>
|-
| <tt><nowiki>[NAME_SEED:<number>]</nowiki></tt>
| <tt><nowiki>[NAME_SEED:31337]</nowiki></tt>
|-
| <tt><nowiki>[CREATURE_SEED:<number>]</nowiki></tt>
| <tt><nowiki>[CREATURE_SEED:31337]</nowiki></tt>
|}

== Embark Points ==

This controls the number of points that you have for skills and equipment when you embark in fortress mode. Turning this value up will allow games started in this world to start with more skilled dwarves with better equipment. Normally you can do just fine by leaving this value set to default, but you might want to up it for experimental/testing purposes or to help dwarves survive in a particularly evil world.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[EMBARK_POINTS:<number>]</nowiki></tt>
| <tt><nowiki>[EMBARK_POINTS:1274]</nowiki></tt>
| Required
|}

== End Year ==

This is how many years of history are generated for the world. This is basically the same as the History parameter in basic world gen, except that you can enter an exact value for number of years. See {{L|World_generation#History|History}} for more info.

History is divided into "ages" which are determined by the ''percentage'' of megabeasts and semi-megabeasts killed at various points. One can attempt to make a world go through the ages more quickly by pumping up the ratio of semimegabeast to megabeast caves, the former of which are usually more killable than the regular megabeasts. This will net you more "Age of Legends", "Age of Heroes", etc.

For more information on the history aspect of the game, see {{L|Legends}} and {{L|Calendar#Ages|Ages}}.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[END_YEAR:<number>]</nowiki></tt>
| <tt><nowiki>[END_YEAR:1050]</nowiki></tt>
| Required
|}

== Population Cap After Civ Creation ==

This determines the maximum possible population of civilization member beings on the map. It should usually be kept the same value as the appropriate sized standard map. Turning the value up will result in larger civilizations. You can enter -1 to make population unlimited in which case populations will only be limited by factors like biome, space, number of sites, and per-civilization population caps.

Each race may have up to 100 civilizations each, and each civilization a maximum population of 10,000. This means that '''if you set this parameter to -1 ("No cap"), you can quickly be overrun''' by sites and population. Civilizations, known as ''entities'' in the {{L|Raw file|raw files}}, have 3 or 4 basic variables that will greatly affect their final placement on the world map, in respect to this kind of unchecked growth. See {{L|Entity_token#Population|Population (Entity Token)}} for more information on interpreting/editing the raws if you need more precise control of civilization placement.

Huge populations can cause the size of history data to explode, cause history generation to take forever, lower FPS, and generally slow down the game.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[TOTAL_CIV_POPULATION:<number>]</nowiki></tt>
| <tt><nowiki>[TOTAL_CIV_POPULATION:15000]</nowiki></tt>
| Required
|}

== Site Cap After Civ Creation ==

This controls the maximum number of towns and similar sites on the entire map. Raising the number will allow for more towns, etc though the number of sites will ultimately still be limited by things like space, terrain, and population cap.

Note that '''this parameter controls only "civilization" sites''' like towns. Other sites such as lairs will be added on to this maximum. After civilizations reach this cap, they will not spread out anymore to place new cities.

By default, the raws limit each civilization site to a population of 120 regardless of the race of the civilization. Therefore, without editing the raws, the total population on the map can't go above site cap x 120.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[SITE_CAP:<number>]</nowiki></tt>
| <tt><nowiki>[SITE_CAP:1040]</nowiki></tt>
| Required
|}

== Beast Control ==

These parameters don't usually matter too much, but may matter for small numbers of beasts.

=== Percentage of Beasts Dead for Stoppage ===

The world starts out with a certain number of megabeasts in existence. If this percentage of megabeasts dies during history generation, then history generation will stop early. For example if the value is 80, if history starts with 200 megabeasts and 160 of them are killed by historical events or otherwise die before End Year is reached, history generation will stop early.

=== Year to Begin Checking Megabeast Percentage ===

The percentage of dead megabeasts for stoppage will not be checked until this year is reached in history generation. This can be used to insure that a world reaches a certain year even if all of the megabeasts in the world are slain earlier.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[BEAST_END_YEAR:<year>:<percentage or -1>]</nowiki></tt>
| <tt><nowiki>[BEAST_END_YEAR:200:80]</nowiki></tt>
| Use -1 as percentage to disable. Year must still be at least 2.
|}

== Cull Unimportant Historical Figures ==

Whether or not the game ignores unimportant figures in history generation. The culling is many CPU-intensive steps in history generation but it saves memory and will speed up loading/saving games a bit. This does mean that the "unimportant" figures will not appear in Legends mode or in things like dwarf engravings, but they might not appear in engravings anyway.

Unimportant figures are people or creatures who suffer early deaths, never having offspring or killing anything named during history generation. For example, residents of goblin towers may get murdered by demons at a young age. After culling unimportant figures, Legends mode would say something like the demon has killed "a creature at Eviltower in the year 102."

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[CULL_HISTORICAL_FIGURES:<0 or 1>]</nowiki></tt>
| <tt><nowiki>[CULL_HISTORICAL_FIGURES:0]</nowiki></tt>
| 0 = No, 1 = Yes
|}

== Reveal All Historical Events ==

Setting this to Yes will allow access to all information about the history of the world in Legends mode. If set to No, then you will have to discover historical information in adventure mode or by instructing dwarves to make engravings.{{Verify}}

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[REVEAL_ALL_HISTORY:<0 or 1>]</nowiki></tt>
| <tt><nowiki>[REVEAL_ALL_HISTORY::1]</nowiki></tt>
| 0 = No, 1 = Yes
|}

== Terrain Parameters ==

These determine how random values for terrain elevation, rainfall, temperature, drainage, volcanism, and savagery are generated. What biomes exist are then determined by how these factors overlap with each other.

=== Minimum and Maximums ===

These are the absolute minimum and maximum values that can ever be generated for a particular map square characteristic. Changing these can cause the occurrence of certain {{L|Biome|biomes}} to become impossible, so modify these with care. Because of this problem, you may want to use [[#Weighted Ranges|Weighted Ranges]] instead.

By ''subtly'' tweaking the min and max values, vastly different maps can be made.

=== X and Y Variance ===

These control how wildly things like elevation and rainfall can vary between adjacent map squares. For example, if these values are set to the maximum of 3,200 for elevation then you will end up with more very low areas right next to very high areas. The number for X determines the east-west variance and the number for Y determines the north-south variance. By setting only one of these to a high value you can, for example, create horizontal or vertical bands of areas which are more similar to each other.

Generally speaking, raising both of these values will create a more random "patchwork" of many small biomes while setting both x and y values to 0 will cause every square on the map to use a single random value for the given characteristic.

For "patchwork" worlds to avoid being rejected, [[#Maximum_Number_of_Subregions|Maximum Number of Subregions]] will probably need to be increased from the default.

=== Elevation ===

This controls the range of terrain elevations that can occur in the world.

Usually you just want to leave the min/max values alone. Raising the minimum elevation can, for example, make it impossible for oceans to exist. This does '''not''' directly control the number of available Z-levels at a particular site, though high maximum values may contribute to peaks which can raise the number of above ground Z-levels. In other words, a maximum elevation of 400 and minimum of 1 does not mean you get 400 Z-levels but it might increase the number of Z-levels somewhat in some regions compared to others.

Raising the variance will result in a more bumpy uneven landscape.

Some biomes/features that are impacted by elevation:
* A high minimum (above 99) means no oceans as they need elevations below 100.
* A low maximum (below 300) means no mountains as mountains need elevations above 300.
* River start locations need a minimum elevation of 300. Therefore, a world with a maximum elevation of 299 everywhere prevents river generation, but rivers can still occur if maximum elevation is set to 300.
*Mountain peaks can only form in squares with an elevation of 400.

=== Rainfall ===

Controls the amount of rainfall in each map square/area. Setting the minimum too high or the maximum too low can make the formation of certain biomes impossible. Rainfall causes it to {{L|Rain}} more in a given area, which can have various effects.

Also makes more rivers appear on the world map.

Note that if [[DF2010:Advanced world generation#Do Orthographic Precipitation and Rain Shadows|orthographic precipitation and rain shadows]] is on then mountains will cause additional variance in rainfall, so (for example) rainfall below the specified minimum can occur in the shadow of a mountain. If you want the minimum and maximum for this parameter to be absolutely respected you must turn off the orthographic precipitation option.

=== Temperature ===

These parameters control how hot or cold various areas will be. If you lower the minimum and maximum values, the world will be colder overall, for example. As with the others, changing these values too much could make it impossible for certain biomes to exist. See {{L|Climate}} for more info.

Temperature appears to always be a vertical gradient of some sort no matter how these parameters are set, but if the values are lower then the gradient could be from "cold" to "colder" rather than "cold" to "warm" for example.

So, the value from the temperature rolling process is ''not the absolute temperature value the region will get, but rather local variation.'' The "base" temperature for an area is derived from its latitude (and maybe elevation{{Verify}}), and then the random value determined by these parameters are applied to it to make it vary a bit. The local variation is fairly small compared to the base temperature, which appears to be hard coded.

=== Drainage ===

Changing drainage parameters will change the way water-affected biomes are formed. Low drainage will contribute to the formation of {{L|Lake|lakes}}, {{L|River|rivers}}, and {{L|Swamp|swamps}}. High drainage will cause water to sink into the ground rather than sit on the surface, which is important for forming hills.

Lower drainage values have been reported to contribute to the formation of thicker soil layers though it is currently unknown exactly how other factors (such as elevation or perhaps rain) impact soil formation.

=== Volcanism ===

Volcanism controls the occurrence of Igneous {{L|Layer|Layers}}, and the formation of volcanoes. For a volcano to form, a square must have a volcanism value of 100 so reducing the maximum from 100 will make volcanoes impossible. Rising the minimum will increase the rarity of non-igneous layers.

Setting minimum to high value is not a good way to produce multiple volcanoes as you are likely to get a "Volcanism not evenly distributed" rejection. Instead use the Minimum Number of Volcanoes parameter and possibly adjust the weighted ranges for volcanism as described below.

=== Savagery ===

These parameters control the level of {{L|Surroundings#Savage|savagery}} on the map. Raising the minimum savagery too high may make it impossible for certain races to exist, and similarly lowering the maximum too far can make it impossible for certain creatures to exist. The largest chance of having unusable maps comes from too high of a savagery value.

=== Configuration Tokens ===

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[ELEVATION:<min>:<max>:<x variance>:<y variance>]</nowiki></tt>
| <tt><nowiki>[ELEVATION:1:400:401:401]</nowiki></tt>
| Range: 0 to 400<br/>Maximum of 400 required for mountain peaks.
|-
| <tt><nowiki>[RAINFALL:<min>:<max>:<x variance>:<y variance>]</nowiki></tt>
| <tt><nowiki>[RAINFALL:0:100:200:200]</nowiki></tt>
| Range: 0 to 100
|-
| <tt><nowiki>[TEMPERATURE:<min>:<max>:<x variance>:<y variance>]</nowiki></tt>
| <tt><nowiki>[TEMPERATURE:25:75:200:200]</nowiki></tt>
| Range: -1000 to 1000
|-
| <tt><nowiki>[DRAINAGE:<min>:<max>:<x variance>:<y variance>]</nowiki></tt>
| <tt><nowiki>[DRAINAGE:0:100:200:200]</nowiki></tt>
| Range: 0 to 100
|-
| <tt><nowiki>[VOLCANISM:<min>:<max>:<x variance>:<y variance>]</nowiki></tt>
| <tt><nowiki>[VOLCANISM:1:100:200:200]</nowiki></tt>
| Range: 0 to 100<br/>Maximum of 100 required for volcanoes.
|-
| <tt><nowiki>[SAVAGERY:<min>:<max>:<x variance>:<y variance>]</nowiki></tt>
| <tt><nowiki>[SAVAGERY:1:100:200:200]</nowiki></tt>
| Range: 0 to 100
|}

== Terrain Mesh Sizes and Weights ==

These parameters make it possible to influence the number of squares in a particular range without making conditions outside of that range impossible. For example, you can make it possible for more many more low elevation squares to exist without making it impossible for high elevations to form. Changing these parameters is often preferable to simply changing the min/max values.

[[File:World_map-large-32x32-elevation-mesh.png|thumb|300px|A large world generated with an Elevation Mesh Size of 32x32 and range weights set to 1:0:0:0:1 (i.e., only extreme high and low elevations). Notice that with this coarse mesh, the terrain seems to appear almost like a grid of "pyramids" that are smoothed together. With a finer mesh size, these pyramids will be smaller, more numerous, smoother, and less apparent.]]
=== Mesh Size ===

Mesh size determines how "finely grained" weighted ranges will be applied. Setting this to Ignore will cause the weighted range settings to be ignored for that terrain characteristic.

Mesh Size affects the smoothing brush in the world painter.

=== Weighted Ranges ===

If mesh size is set to something other than Ignore, these weights will be applied at the granularity of the selected mesh size for purposes of generating random values in each range. This allows random number generation to be non-linear for the given terrain characteristic.

For example, if the Elevation Weighted Range parameters were set to (starting with the 0-20 range) 60:10:10:10:10 (these values do not have to add up to any particular number) then about 60% of the map squares (on average) will have an elevation in the range of 0-20, and the other ranges will be represented by around 10% of the map squares each. The exact distribution is still left up to chance though ''on average'' it will be close to this specification.

The way the process appears to work is that the map is divided into a "wireframe mesh" where the lines are Mesh Size number of tiles apart. Each intersection of the "wires" is randomly assigned an elevation (or whatever) and then the tiles between these points are smoothed out. See the image on the right for an example.

Weighted ranges do not make rejection checks, although they can be responsible for many rejections if you neglect to adjust or disable some of the [[#Minimum Number of Mid/Low/High Characteristic Squares|Minimum Number of Mid/Low/High Characteristic Squares]] for example.

=== Configuration Tokens ===

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[ELEVATION_FREQUENCY:<mesh>:<0-20 weight>:<20-40 weight>:<40-60 weight>:<60-80 weight>:<80-100 weight>]</nowiki></tt>
| <tt><nowiki>[ELEVATION_FREQUENCY:2:1:2:3:4:5]</nowiki></tt>
| rowspan="6" | Valid mesh values:

1 = Ignore

2 = 2x2

3 = 4x4

4 = 8x8

5 = 16x16

6 = 32x32

(limited by world size)
|-
| <tt><nowiki>[RAIN_FREQUENCY:<mesh>:<0-20 weight>:<20-40 weight>:<40-60 weight>:<60-80 weight>:<80-100 weight>]</nowiki></tt>
| <tt><nowiki>[RAIN_FREQUENCY:3:1:2:3:4:5]</nowiki></tt>
|-
| <tt><nowiki>[DRAINAGE_FREQUENCY:<mesh>:<0-20 weight>:<20-40 weight>:<40-60 weight>:<60-80 weight>:<80-100 weight>]</nowiki></tt>
| <tt><nowiki>[DRAINAGE_FREQUENCY:4:1:2:3:4:5]</nowiki></tt>
|-
| <tt><nowiki>[TEMPERATURE_FREQUENCY:<mesh>:<0-20 weight>:<20-40 weight>:<40-60 weight>:<60-80 weight>:<80-100 weight>]</nowiki></tt>
| <tt><nowiki>[TEMPERATURE_FREQUENCY:1:1:1:1:1:1]</nowiki></tt>
|-
| <tt><nowiki>[SAVAGERY_FREQUENCY:<mesh>:<0-20 weight>:<20-40 weight>:<40-60 weight>:<60-80 weight>:<80-100 weight>]</nowiki></tt>
| <tt><nowiki>[SAVAGERY_FREQUENCY:5:1:2:3:4:5]</nowiki></tt>
|-
| <tt><nowiki>[VOLCANISM_FREQUENCY:<mesh>:<0-20 weight>:<20-40 weight>:<40-60 weight>:<60-80 weight>:<80-100 weight>]</nowiki></tt>
| <tt><nowiki>[VOLCANISM_FREQUENCY:1:1:1:1:1:1]</nowiki></tt>
|}

== Minimum Mountain Peak Number ==

This will cause the world to be rejected if fewer than this many peaks (based on elevation) are present on the map. Elevations of 400 must be possible for mountain peaks to occur. If set to zero then worlds will not be rejected based on number of peaks.

You may need to adjust elevation parameters, such as the highest weighted range, in order to get the desired number of elevation 400 squares needed for larger numbers of peaks. Like volcanoes, mountain peaks can make embark zones more interesting but other than that they don't appear to "do" anything special. Reportedly they do increase the highest Z-level above ground in all embark zones in the same region even if the selected embark zone does not include the peak.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[PEAK_NUMBER_MIN:<number>]</nowiki></tt>
| <tt><nowiki>[PEAK_NUMBER_MIN:20]</nowiki></tt>
| Elevations of 400 must occur for peaks to form.
|}

== Minimum Partial Edge Oceans ==

This will cause a world to be rejected unless there are at least this many oceans touching an edge of the map. If set to zero then worlds will not be rejected based on this criterion. Setting both this parameter and Minimum Complete Edge Oceans to values that total more than 4 when added together may cause all worlds to be rejected as you can't have both a partial and complete edge ocean on a given edge.{{Verify}}

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[PARTIAL_OCEAN_EDGE_MIN:<number>]</nowiki></tt>
| <tt><nowiki>[PARTIAL_OCEAN_EDGE_MIN:2]</nowiki></tt>
| Maximum of 4
|}

== Minimum Complete Edge Oceans ==

This will cause a world to be rejected unless there are at least this many oceans which completely cover an edge of the map. Since a square map only has 4 edges, the maximum value possible is 4. If set to zero then worlds will not be rejected based on this criterion but still might end up with complete edge oceans by chance.

Note that the ability for this many edge oceans to exist will be limited by elevation. Therefore to actually create large oceans you will probably need to change things like the Elevation Mesh Size and Weighted Ranges to increase the number and distribution of very low elevation squares on the map.

Given appropriate weight, range, and variance values for things like elevation, a setting of:
*1 results in a world that seems like a chunk of coastline. One edge of the map will be completely underwater and there will be ocean taking up much of the map on that side. Think the east or west coast of the United States, the north coast of Canada, or southern Europe. If your edge ocean happens to pick your world's frozen side most of it will be glacier.
*2 results in another coastline along with the first one. The map could end up looking something like Panama if the oceans pick opposite sides of the map.
*3 results in a peninsula, like Florida in the US. There will be oceans surrounding 3 sides of the map, and land touching only one side of the map.
*4 results in one or more island(s) depending on things like elevation variance and weights. Regardless of whether you get one island or multiple islands, the entire map will be surrounded by water.
Unfortunately there's no easy way to control which oceans end up on which edges, except perhaps setting X and Y variance to different values.

Edge oceans will take up part of the other edges too. For example a full edge ocean on the east side will have part of the north and south sides underwater, but that does ''not'' add to the ''partial'' edge oceans count.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[COMPLETE_OCEAN_EDGE_MIN:<number>]</nowiki></tt>
| <tt><nowiki>[COMPLETE_OCEAN_EDGE_MIN:0]</nowiki></tt>
| Maximum of 4
|}

== Minimum Volcano Number ==

Worlds with less than this number of volcanoes will be rejected. Note that this will not just create this many volcanoes at random; there must be at least this many squares with a Volcanism of 100. Therefore adjusting Weighted Range for 80-100 to some higher value is recommended if you want to facilitate a large number of volcanoes. In addition, Maximum Volcanism must be set to 100 or squares with volcanism of 100 will be impossible making volcanoes impossible.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[VOLCANO_MIN:<number>]</nowiki></tt>
| <tt><nowiki>[VOLCANO_MIN:15]</nowiki></tt>
| Volcanoes require a volcanism of 100 to occur.
|}

== Mineral Scarcity ==

Controls the frequency at which minerals occur. Setting this value lower will increase the amount of ore present on a map, the number of different types of ore, and the number/types of gems. The default value will result in a maximum of 2-4 metal ores per map (assuming you choose a good embark location) which may be limiting until the economy is fully implemented and desired metals can be traded for.

According to research by [http://www.bay12forums.com/smf/index.php?action=profile;u=36045 Shandra] on v0.31.25, this is the relationship between the value of this setting and the approximate number of gems and ore:

[[File:MineralSetting_v25_limit10k.png]]

This is for the same 8x8 embark region in a world which is otherwise the same except for the mineral scarcity parameter. See [http://www.bay12forums.com/smf/index.php?topic=79018.msg2063804#msg2063804 this forum thread] for detailed information on peoples' experiments and possible changes to newer versions.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[MINERAL_SCARCITY:<number>]</nowiki></tt>
| <tt><nowiki>[MINERAL_SCARCITY:2500]</nowiki></tt>
| Range: 100 to 100,000
|}

== Max Megabeast Caves ==

This is the maximum number of caves that will be inhabited by {{L|Megabeast|megabeasts}}. Even though the parameter uses the word "caves" it appears to impact the number of sites (lairs) of different types.{{Verify}} If there are more megabeasts than "caves", megabeasts will suffer from a housing shortage and you may end up with things like 10 dragons sharing a lair. Which could make for a {{L|Fun}} world.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[MEGABEAST_CAP:<number>]</nowiki></tt>
| <tt><nowiki>[MEGABEAST_CAP:75]</nowiki></tt>
| Number of caves/labyrinths/lairs, not beasts.
|}

== Max Semi-Megabeast Caves ==

The maximum number of caves that will be inhabited by {{L|Creature#Semi-Megabeasts|semi-megabeasts}}. If there are more semi-megabeasts than caves, semi-megabeasts will be forced to cohabitate and you may end up with 10 minotaurs in one labyrinth (for example).

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[SEMIMEGABEAST_CAP:<number>]</nowiki></tt>
| <tt><nowiki>[SEMIMEGABEAST_CAP:150]</nowiki></tt>
| Number of caves/labyrinths/lairs, not beasts.
|}

== Titan Parameters ==

=== Number ===

This controls the number of megabeasts and semi-megabeasts that exist at the beginning of history. Note that they can get killed or die later due to events during history generation. The number of forgotten beasts is unaffected by this parameter.

Note: One can generate more historical ages by pumping up the amount of semimegabeasts, who are usually more killable than the regular megabeasts.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[TITAN_NUMBER:<number>]</nowiki></tt>
| <tt><nowiki>[TITAN_NUMBER:33]</nowiki></tt>
| 0 is a valid number
|}

=== Attack Population Requirement ===

Megabeasts will begin to attack your fort once at least this many dwarves inhabit it, regardless of whether any other attack criteria have been met. This number defaults to 80 which isn't usually too difficult to deal with.

=== Exported Wealth Requirement ===

Megabeasts will begin to attack your fort once you have exported at least this many {{L|Currency|dwarfbucks}} worth of merchandise, regardless of whether or not any other criteria have been met. This parameter defaults to None (disabled).

=== Created Wealth Requirement ===

Megabeasts will begin to attack your fort once the fort's total wealth has reached this many {{L|Currency|dwarfbucks}} in value. This happens regardless of whether any of the other criteria, such as population, have been met. Therefore even with 1 dwarf a fort could be attacked if the fort were worth at least this value.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[TITAN_ATTACK_TRIGGER:<population>:<exp wealth>:<created wealth>]</nowiki></tt>
| <tt><nowiki>[TITAN_ATTACK_TRIGGER:80:0:100000]</nowiki></tt>
| 0 = None (disabled). Only one requirement must be met for an attack.
|}

== Number of Demon Types ==

{{L|Demon|Demons}} are similar to titans and forgotten beasts in that they are procedurally generated, but unlike titans they are not unique. Thus many different types of demons will exist in the world but there will be many members of each type. Setting this to zero means no demons will exist, limiting the amount of fun you can have.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[DEMON_NUMBER:<number>]</nowiki></tt>
| <tt><nowiki>[DEMON_NUMBER:52]</nowiki></tt>
| 0 to 1000
|}

== Number of Night Creature Types ==

The number of different {{L|Night creature|night creatures}} that will exist in the world. Setting this to zero means that the world will have no night creatures.

A setting of zero also means that there will be no {{L|Bogeyman|Bogeymen}} in adventure mode, though any modded creatures with the [NIGHT_CREATURE:BOGEYMAN] tag will still exist.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[NIGHT_CREATURE_NUMBER:<number>]</nowiki></tt>
| <tt><nowiki>[NIGHT_CREATURE_NUMBER:52]</nowiki></tt>
| 0 to 1000
|}

== Desired Good/Evil Square Counts ==

These values change the amount of {{L|Surroundings#Good|good or evil}} tiles on the map, depending on the size of the region they are being considered for.

Though the exact size of small, medium, and large are unknown, the counts used here will always be restricted to regions of the given size no matter how large the number. Also, the count is more of a goal than a minimum or maximum. As a result you can end up with many more or many fewer than the requested number of squares in some situations.

In particular, if you have something like case where only 3 large regions exists in a world, and you request "1 evil square" in large regions, you will end up with one of the large regions being ''entirely evil''. So any non-zero value in one of these settings essentially means "force at least one region of this size to be all good/evil."

Note that the "evilness" of evil biomes is also impacted by savagery.

Certain civilizations can not exist in good and/or evil squares, so too many of one or the other may limit the size of certain types of civilizations. Dwarves, for example, need non-aligned biomes.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[GOOD_SQ_COUNTS:<small region>:<med region>:<lg region>]</nowiki></tt>
| <tt><nowiki>[GOOD_SQ_COUNTS:100:1000:2000]</nowiki></tt>
| rowspan="2" | Set count to zero to disable for that region size.
|-
| <tt><nowiki>[EVIL_SQ_COUNTS:<small region>:<med region>:<lg region>]</nowiki></tt>
| <tt><nowiki>[EVIL_SQ_COUNTS:100:1000:2000]</nowiki></tt>
|}

== Minimum Biome Square Counts ==

These numbers control whether or not a world will be rejected based on a lack of different {{L|biome|biomes}}. Raising these numbers will '''not''' automatically generate the given number of squares of the given biome! For a biome to exist, certain conditions like elevation and rainfall must exist.

These parameters simply filter out worlds that (for example) randomly fail to have enough high elevation squares to support a given number of mountains, etc. Some settings may cause worlds to always be rejected. For example, if for some reason the maximum elevation parameter is set to a value below what will support mountain biomes, it will be impossible to satisfy a non-zero requirement for mountain squares. The same principle goes for other conditions and biomes such as low elevations and oceans, etc.

Certain civilizations require different biomes to exist (such as dwarves and mountains), so eliminating certain biomes will make it impossible for certain civilizations to form.

These parameters often result in infinite world rejection problems. See {{L|World rejection}} for information on solving problems related to worlds always being rejected due to one or more of these parameters.

0 means no minimum for rejection. Setting to 0 does not guarantee 0 squares of that biome.

=== Biome Type Requirement Table ===

Terrain requirements for various biomes are described below.{{Verify}} Note that some of the exact ranges are unknown.

{| {{prettytable}}
|- bgcolor="#dddddd"
! rowspan="2" | Biome
! colspan="4" | Terrain Requirement
|-
! Elevation
! Rainfall
! Temperature
! Drainage
|-
| Swamp/Marsh
| 100-299
| 33-100
| Non-Freezing
| 0-32
|-
| Desert/Badland
| 100-299
| 0-10(?)
| non-freezing
| N/A (1)
|-
| Forest
| 100-299
| 66-100
| non-freezing
| 66-100
|-
| Mountains
| 300-400
| N/A
| N/A
| N/A
|-
| Ocean
| 0-99
| N/A
| N/A
| N/A
|-
| Glacier
| 100-299
| N/A
| Freezing
| 80(?)-100
|-
| Tundra
| 100-299
| N/A
| Freezing
| 0-66
|-
| Grassland
| 100-299
| 0-66
| Non-Freezing
| 0-66
|-
| Hills
| 100-299
| 0-66
| Non-Freezing
| 66-100
|}

(1) might affect the [[desert]] subtype, though - needs to be verified; low drainage seems to correlate with sand deserts

=== Minimum Initial Square Count ===

This is the minimum number of squares of the given biome that must exist before things like erosion take place.

One thing to keep in mind is the maximum number of squares on a map of a given size. If the total number of squares on a map is lower than the sum of all square count parameters then you will get infinite world rejection.

To determine the number of squares on a map, just multiply the dimensions. In practice these parameters will need to sum to lower than the maximum because some space is needed for "slack".

{| {{prettytable}}
|- bgcolor="#dddddd"
! Map Size
! Number of Squares
|-
| 17x17
| 289
|-
| 33x33
| 1089
|-
| 65x65
| 4225
|-
| 129x129
| 16614
|-
| 257x257
| 66049
|}

=== Minimum Initial Region Count ===

This is the minimum number of regions of contiguous biome squares that must exist before other processes such as erosion take place.

=== Minimum Final Region Count ===

This many regions of the given biome must exist after erosion and similar phases of generation have been completed.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
|-
| <tt><nowiki>[REGION_COUNTS:SWAMP:<init sq>:<init rg>:<final rg>]</nowiki></tt>
| <tt><nowiki>[REGION_COUNTS:SWAMP:1032:7:6]</nowiki></tt>
|-
| <tt><nowiki>[REGION_COUNTS:DESERT:<init sq>:<init rg>:<final rg>]</nowiki></tt>
| <tt><nowiki>[REGION_COUNTS:DESERT:1032:7:6]</nowiki></tt>
|-
| <tt><nowiki>[REGION_COUNTS:FOREST:<init sq>:<init rg>:<final rg>]</nowiki></tt>
| <tt><nowiki>[REGION_COUNTS:FOREST:4128:13:12]</nowiki></tt>
|-
| <tt><nowiki>[REGION_COUNTS:MOUNTAINS:<init sq>:<init rg>:<final rg>]</nowiki></tt>
| <tt><nowiki>[REGION_COUNTS:MOUNTAINS:8256:9:9]</nowiki></tt>
|-
| <tt><nowiki>[REGION_COUNTS:OCEAN:<init sq>:<init rg>:<final rg>]</nowiki></tt>
| <tt><nowiki>[REGION_COUNTS:OCEAN:8256:7:6]</nowiki></tt>
|-
| <tt><nowiki>[REGION_COUNTS:GLACIER:<init sq>:<init rg>:<final rg>]</nowiki></tt>
| <tt><nowiki>[REGION_COUNTS:GLACIER:0:0:0]</nowiki></tt>
|-
| <tt><nowiki>[REGION_COUNTS:TUNDRA:<init sq>:<init rg>:<final rg>]</nowiki></tt>
| <tt><nowiki>[REGION_COUNTS:TUNDRA:0:0:0]</nowiki></tt>
|-
| <tt><nowiki>[REGION_COUNTS:GRASSLAND:<init sq>:<init rg>:<final rg>]</nowiki></tt>
| <tt><nowiki>[REGION_COUNTS:GRASSLAND:8256:13:12]</nowiki></tt>
|-
| <tt><nowiki>[REGION_COUNTS:HILLS:<init sq>:<init rg>:<final rg>]</nowiki></tt>
| <tt><nowiki>[REGION_COUNTS:HILLS:8256:13:12]</nowiki></tt>
|}

== Erosion Cycle Count ==

Tells the world-generator how long the world has to erode its tall peaks down to mountainsides during the 'running rivers...' stage of world creation. The higher this number, the less jagged the world will be, and the more wide the major rivers will be. If you use the maximum number, your mountains will dissolve before your eyes into plains which can lead to rejections if there aren't enough mountains to use for river start points and dwarven civilization origin points.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[EROSION_CYCLE_COUNT:<number>]</nowiki></tt>
| <tt><nowiki>[EROSION_CYCLE_COUNT:250]</nowiki></tt>
| Range: 0 to 1000
|}

== Minimum/Desired River Start Locations ==

This is the minimum number of riverheads that must exist before and after erosion takes place. Worlds will be rejected if they fail to meet these numbers. As with minimum biome counts, raising this number doesn't automatically create this many riverheads. Other conditions like terrain and rainfall must exist for rivers to form.

Extremely high pre-erosion values speed erosion greatly, while low post erosion values are useful for limiting rejects due to lack of river origin points. One can try the 800 value to get more lakes.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[RIVER_MINS:<min pre-erosion>:<des post-erosion>]</nowiki></tt>
| <tt><nowiki>[RIVER_MINS:200:400]</nowiki></tt>
| Range: 0 to 800
|}

== Periodically Erode Extreme Cliffs ==

If enabled, makes every impassable rock wall into a series of ramps. Some prefer to pump up erosion to about 250, and turn the "Desired pre-erosion river count" to 0 for good erosion and no extra canyons.

Normally this is set to Yes (1).

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[PERIODICALLY_ERODE_EXTREMES:<1 or 0>]</nowiki></tt>
| <tt><nowiki>[PERIODICALLY_ERODE_EXTREMES:1]</nowiki></tt>
| 1/0 = Yes/No
|}

== Do Orographic Precipitation and Rain Shadows ==

Toggle that allows terrain height to affect rainfall. For example, moist air coming from the ocean blows over the land. As the terrain gets higher, it forces the moist air up, causing it to rain on the seaward side of a mountain. Eventually, all the rain has fallen if the mountain is tall enough. So, when the breeze goes over the top, there's no moisture left to fall on the other side, creating a rain-shadow. This should create a tendency for more extreme rainfall in regions, creating more forests, deserts, marshlands, and grasslands. Turning it off should result in more controllable, less complex rainfall conditions based on rainfall parameters as it adds a random element which can distort or otherwise mess up the climates on a pregenerated map.

This should be disabled if you're importing a map or using a preset map file that has weather.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[OROGRAPHIC_PRECIPITATION:<1 or 0>]</nowiki></tt>
| <tt><nowiki>[OROGRAPHIC_PRECIPITATION:1]</nowiki></tt>
| 1/0 = Yes/No
|}

== Maximum Number of Subregions ==

This is the number of separate biomes (the flashing regions you see on embark when you hit F1, F2, etc when there's more than one biome on the embark location) that are allowed to exist on the entire map.

Setting this to very low values will result in numerous rejections depending on [[#X and Y Variance|variance parameters]]. If variance values are set to high numbers, many small biomes will be created causing rejection if this parameter value is not increased beyond the default.

Increasing the value of this tag is often a must when generating "patchwork" worlds with lots of biome variance, but simply increasing it without increasing variance parameters will not guarantee more biomes.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[SUBREGION_MAX:<number>]</nowiki></tt>
| <tt><nowiki>[SUBREGION_MAX:2750]</nowiki></tt>
| Range: 1 to 5000
|}

== Cavern Parameters ==
[[File:Open00Density100.jpg|thumb|200px|Cavern slice with Openness of 0 and Density of 100]]
[[File:Open100Density00.jpg|thumb|200px|Cavern slice with Openness of 100 and Density of 0]]
[[File:Open100Density100.jpg|thumb|left|200px|Cavern slice with Openness of 100 and Density of 100]]
[[File:Open50Density50.jpg|thumb|left|200px|Cavern slice with Openness of 50 and Density of 50]]

{{L|Caverns}} are the hollow areas underground which dwarves tend to encounter when they're digging around.

=== Cavern Layer Number ===

This parameter determines how many cavern systems will be generated, not including the Magma layer or the Bottom layer. Defaults to three. Setting it to lower values could help FPS.

'''Warning:''' If this is 0 then you will not have caverns on your map. Note that disabling caverns will make it impossible to grow any underground plants because none will exist for your civilization to cultivate. (Underground plants will not be available on embark.)

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[CAVERN_LAYER_COUNT:<number>]</nowiki></tt>
| <tt><nowiki>[CAVERN_LAYER_COUNT:3]</nowiki></tt>
| Range: 0 to 3
|}

=== Cavern Layout Parameters ===

Open caverns and dense passageways are not mutually exclusive. When both are raised, bizarre results can occur, such as layers showing a combination of open caverns, a cluster of network passages, and natural walls sprinkling the inside of an otherwise open cavern. [http://www.bay12forums.com/smf/index.php?topic=76355.msg1936859#msg1936859 Reference]

If you want the largest open spaces possible, then decrease the density and increase the openness. If you want a labyrinth of passageways, lower the openness and raise the passage density.

Another interesting note about the cavern layers is that the seed and number of demon types affect the layout of the caverns.

==== Layer Openness Min/Max ====

Dictates the size of cavern passages. When Passage Density (see below) is set to minimum (0), caverns will be open expanses. Raising the maximum will increase the size of the caverns.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[CAVERN_LAYER_OPENNESS_MIN:<number>]</nowiki></tt>
| <tt><nowiki>[CAVERN_LAYER_OPENNESS_MIN:0]</nowiki></tt>
| rowspan="2" | Range: 0 to 100
|-
| <tt><nowiki>[CAVERN_LAYER_OPENNESS_MAX:<number>]</nowiki></tt>
| <tt><nowiki>[CAVERN_LAYER_OPENNESS_MAX:100]</nowiki></tt>
|}

==== Layer Passage Density Min/Max ====

This determines how many passages form the cavern. If openness (see above) is set to minimum and density increased then you will get a maze like network of small criss-crossing passages. Raising the values further increases the number of the maze-like passages.

Caverns will be large, open spaces at 0, and comprised of many small vertical shafts of rock at 100. Setting both values to be the same results in a uniform look for the caverns.{{Verify}}

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[CAVERN_LAYER_PASSAGE_DENSITY_MIN:<number>]</nowiki></tt>
| <tt><nowiki>[CAVERN_LAYER_PASSAGE_DENSITY_MIN:0]</nowiki></tt>
| rowspan="2" | Range: 0 to 100
|-
| <tt><nowiki>[CAVERN_LAYER_PASSAGE_DENSITY_MAX:<number>]</nowiki></tt>
| <tt><nowiki>[CAVERN_LAYER_PASSAGE_DENSITY_MAX:100]</nowiki></tt>
|}

See [http://www.bay12forums.com/smf/index.php?topic=76355.0 this forum thread] for more information on openness and density including many more images.

==== Layer Water min\max ====

Determines how many caverns will have water at the bottom. Note that, even at 100, there will be some amount of ground in caverns, but each cavern 'bubble' will contain some amount of water.

At 0, there will be no water in your caverns. This may impact future underground plant growth, although maps will still start with underground flora.{{Verify}}

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[CAVERN_LAYER_WATER_MIN:<number>]</nowiki></tt>
| <tt><nowiki>[CAVERN_LAYER_WATER_MIN:0]</nowiki></tt>
| rowspan="2" | Range: 0 to 100
|-
| <tt><nowiki>[CAVERN_LAYER_WATER_MAX:<number>]</nowiki></tt>
| <tt><nowiki>[CAVERN_LAYER_WATER_MAX:100]</nowiki></tt>
|}

=== Magma Layer ===

This parameter controls whether the {{L|magma sea}} exists.

Setting 1/Yes causes the magma layer to exist, value 0/No prevents it. Appears not have impact on volcanoes, nor vulcanism, so even if 0/No there will still be embark locations with magma. If a {{L|volcano}} exists, it appears to always tap the magma sea, but the magma sea will not be revealed by revealing the volcano.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
|-
| <tt><nowiki>[HAVE_BOTTOM_LAYER_1:<1 or 0>]</nowiki></tt>
| <tt><nowiki>[HAVE_BOTTOM_LAYER_1:1]</nowiki></tt>
|}

=== Bottom Layer ===

Determines if the space below the magma sea exists. If Yes the "HFS" layer is always present. Normally you want to leave this set to Yes for maximum fun.

If enabled, this will force the magma layer above it. (Unknown whether this has any impact on occurrence of HFS "temple".){{Verify}}

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
|-
| <tt><nowiki>[HAVE_BOTTOM_LAYER_2:<1 or 0>]</nowiki></tt>
| <tt><nowiki>[HAVE_BOTTOM_LAYER_2:1]</nowiki></tt>
|}

== Z Levels (Depth) Settings ==

These parameters control the "thickness" of various "layers" on the map. Note that a "layer" in this case does not refer to one Z-level, but refers to a number of related Z-levels such as "levels above ground".

The following table assumes that you have 3 cavern layers. The Levels Above Layer settings control how many Z-Levels are above each layer. A layer may itself consist of multiple Z-Levels (and almost always does).

{|style="margin:1em 1em 1em 0;background:#F9F9F9;border:1px #AAA solid;border-collapse:collapse;" class="wikitable"
|-style="background:#F2F2F2;text-align:center;"
!style="border:1px #AAA solid;padding:0.2em;" width="120"|Setting Name
!style="border:1px #AAA solid;padding:0.2em;" width="200"|Token
!style="border:1px #AAA solid;padding:0.2em;"| Description
|-
|style="border:1px #AAA solid;padding:0.2em;"| Above Ground
|style="border:1px #AAA solid;padding:0.2em;"| <nowiki>[LEVELS_ABOVE_GROUND:<number>]</nowiki>
|style="border:1px #AAA solid;padding:0.2em;"| The number of Z-Levels of air above the highest surface level.<br />Has no impact on how many Z-levels deep the surface layer is.
|-
|style="border:1px #AAA solid;padding:0.2em;"| Above layer 1
|style="border:1px #AAA solid;padding:0.2em;"| <nowiki>[LEVELS_ABOVE_LAYER_1:<number>]</nowiki>
|style="border:1px #AAA solid;padding:0.2em;"| Z-Levels of stone above the first cavern layer. Making this higher will guarantee ''at least'' this many levels to build your fortress, but will have no impact on how many z-levels thick the surface layer is. Also, the top of a cavern may be higher than the rest of a cavern, so in practice there will be more "solid" levels than this above the cavern.
|-
|style="border:1px #AAA solid;padding:0.2em;"| Above Layer 2
|style="border:1px #AAA solid;padding:0.2em;"| <nowiki>[LEVELS_ABOVE_LAYER_2:<number>]</nowiki>
|style="border:1px #AAA solid;padding:0.2em;"| Z-levels of earth between very top of second cavern and very bottom of first cavern.
|-
|style="border:1px #AAA solid;padding:0.2em;"| Above Layer 3
|style="border:1px #AAA solid;padding:0.2em;"| <nowiki>[LEVELS_ABOVE_LAYER_3:<number>]</nowiki>
|style="border:1px #AAA solid;padding:0.2em;"| Z-levels of earth between very top of third cavern and very bottom of second cavern.
|-
|style="border:1px #AAA solid;padding:0.2em;"| Above Layer 4
|style="border:1px #AAA solid;padding:0.2em;"| <nowiki>[LEVELS_ABOVE_LAYER_4:<number>]</nowiki>
|style="border:1px #AAA solid;padding:0.2em;"| Z-Levels of earth between very highest magma and very bottom of third cavern.<br />Spoiler Hidden (select invisible text to read): <span style='color:#eee;'>Making this high will give a large area for HFS veins, so that it never touches caverns, giving more to mine '''if''' it was impacting the cavern previously.</span>
|-
|style="border:1px #AAA solid;padding:0.2em;"| Above Layer 5
|style="border:1px #AAA solid;padding:0.2em;"| <nowiki>[LEVELS_ABOVE_LAYER_5:<number>]</nowiki>
|style="border:1px #AAA solid;padding:0.2em;"| Uncertain. May control the number of levels of "Semi Molten Rock" between HFS and Magma, may control number of levels of magma, may impact both.<br />In experimentation, the overall depth of all magma sea and semi-molten rock levels appears to increase, but not consistent enough to say for certain.<br />Only valid if Magma Layer present.<br />Spoiler Hidden:<span style='color:#eee;'>Often the HFS vein will only extend as high as the highest magma, making this the only guaranteed way to increase amount of HFS to mine, but unfortunately also creating enormous useless semi-molten z-levels</span>
|-
|style="border:1px #AAA solid;padding:0.2em;"| At Bottom
|style="border:1px #AAA solid;padding:0.2em;"| <nowiki>[LEVELS_AT_BOTTOM:<number>]</nowiki>
|style="border:1px #AAA solid;padding:0.2em;"| Appears to be number of levels of HFS chamber.<br />Only valid if Bottom Layer present.<br />Often has no impact.<br />Values larger than default results in strange things.
|}

Some implications:
* The number of surface layers (e.g. soil), at this time, can not be controlled. For example, on a map with 1 layer of Peat, then a layer of Silt, then a layer of Obsidian, there is no control to let you increase either one to be, say, 20 z-levels. (though you may get lucky with the Obsidian).
* There can be multiple stone layers between the cavern and the surface. So increasing Levels Above Layer 1 may give you more Conglomerate, or more Granite, and you have no control over which stone layer spans those Z-Levels.
* The layers shown on embark span across the cavern layers in an unknown and inconsistent way. Sometimes those 10 different layers of stone are evenly distributed over your 400 z-level deep map, sometimes the first 9 get 1 z-level each and the last gets the other 391 levels. No way to control found yet.
* The HFS temple, if present, will always extend into the rock layers, and appears to always make contact with the bottom cave. Large values for levels above layer 5 and layer 4 can result in enormous temples, but the number of levels at the top (the part with undead) appears to be unaffected.
* Unconfirmed whether number of levels between caverns has any impact on cavern height. There will be connecting ramps and/or shafts between cavern layers no matter how many levels are between them.
* '''Very Important''': These values appear to apply across a whole 16x16 Region, not just embark areas. That means that if a 16x16 region is completely flat, but has one tall mountain in one far corner, even if you set Levels Above Ground low (e.g. 2 z-levels) you still have all the empty air of the highest mountain in every embark tile (e.g. 200 z-levels). Also can happen to the semi-molten layer, and can lead to unexpected behavior.
* Very large values can cause strange things to happen. Even more true for small values.

== Cave Parameters ==

Caves are sort of like caverns except that they have a passage to the surface and are generally much smaller. Caves can connect to caverns if they are sufficiently deep.

=== Minimum/Maximum Natural Cave Size ===

These parameters appear to control the length and depth of caves.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[CAVE_MIN_SIZE:<number>]</nowiki></tt>
| <tt><nowiki>[CAVE_MIN_SIZE:5]</nowiki></tt>
| rowspan="2" | Range: 1 to 500
|-
| <tt><nowiki>[CAVE_MAX_SIZE:<number>]</nowiki></tt>
| <tt><nowiki>[CAVE_MAX_SIZE:25]</nowiki></tt>
|}

=== Number of (Non-)Mountain Caves ===

These are the numbers of mountain and non-mountain caves that will be placed. These parameters will cause this number of caves to be placed, but rejections may occur if a world has an insufficient number of mountain or non-mountain squares to place the caves in.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[MOUNTAIN_CAVE_MIN:<number>]</nowiki></tt>
| <tt><nowiki>[MOUNTAIN_CAVE_MIN:100]</nowiki></tt>
| rowspan="2" | Range: 1 to 800
|-
| <tt><nowiki>[NON_MOUNTAIN_CAVE_MIN:<number>]</nowiki></tt>
| <tt><nowiki>[NON_MOUNTAIN_CAVE_MIN:200]</nowiki></tt>
|}

=== Make Caves Visible ===

If set to no (default) then the location of caves will not be marked on the map. If set to yes, caves will appear on the map as {{Raw Tile|•|#808080|#00DD00}} symbols so that they may be sought out or avoided as desired.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[ALL_CAVES_VISIBLE:<1 or 0>]</nowiki></tt>
| <tt><nowiki>[ALL_CAVES_VISIBLE:0]</nowiki></tt>
| 1/0 = Yes/No
|}

== Allow Init Options to Show Tunnels ==

This parameter doesn't do anything in DF2010.{{Verify}} In older versions, tunnels could be built between dwarven settlements and these could appear on the map similarly to roads.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[SHOW_EMBARK_TUNNEL:<0-2>]</nowiki></tt>
| <tt><nowiki>[SHOW_EMBARK_TUNNEL:2]</nowiki></tt>
| 0 = No<br/>1 = Only in Finder<br/>2 = Always
|}

== Number of Civilizations ==

This number of civilizations will be placed on the map before history generation begins. These civilizations may later die out due to historical events.

Note that a high value here can cause lots of map rejections, particularly on smaller maps as there simply isn't enough room or regions to put them all in.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[TOTAL_CIV_NUMBER:<number>]</nowiki></tt>
| <tt><nowiki>[TOTAL_CIV_NUMBER:40]</nowiki></tt>
| Range: 0 to 300
|}

== Playable Civilization Required ==

If this is set to yes (default) then worlds will be rejected if no civilization with {{L|Entity token|CIV_CONTROLLABLE}} can be placed. In an unmodded game, only the dwarves have this token.

If set to no, the result may be a world that cannot be played in Fortress Mode.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[PLAYABLE_CIVILIZATION_REQUIRED:<1 or 0>]</nowiki></tt>
| <tt><nowiki>[PLAYABLE_CIVILIZATION_REQUIRED:1]</nowiki></tt>
| 1/0 = Yes/No
|}

== Minimum Number of Mid/Low/High Characteristic Squares ==

Sets the minimum possible number of squares of certain ranges of each of the region qualities, such as elevation, rain, drainage, volcanism, savagery, and temperature. These need to be changed to reflect your regional meshes and weights. These are responsible for a HUGE number of map rejections. These values can all be set to 0 for much fewer map rejections, particularly in the case of more wacky, non-standard maps.

These values will cause worlds to be rejected unless at least the given number of squares of the given type are randomly generated. Setting these values too high could result in worlds always being rejected if other parameters such as the maximum/minimums for elevation, etc, don't allow enough of those squares to get generated.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Example
! Notes
|-
| <tt><nowiki>[ELEVATION_RANGES:<low sq>:<mid sq>:<high sq>]</nowiki></tt>
| <tt><nowiki>[ELEVATION_RANGES:8256:16512:8256]</nowiki></tt>
| rowspan="5" | Minimum number of squares that must have low, medium, and high amounts of the given attribute.<br/>
0 = No minimum
|-
| <tt><nowiki>[RAIN_RANGES:<low sq>:<mid sq>:<high sq>]</nowiki></tt>
| <tt><nowiki>[RAIN_RANGES:8256:16512:8256]</nowiki></tt>
|-
| <tt><nowiki>[DRAINAGE_RANGES:<low sq>:<mid sq>:<high sq>]</nowiki></tt>
| <tt><nowiki>[DRAINAGE_RANGES:8256:16512:8256]</nowiki></tt>
|-
| <tt><nowiki>[SAVAGERY_RANGES:<low sq>:<mid sq>:<high sq>]</nowiki></tt>
| <tt><nowiki>[SAVAGERY_RANGES:8256:16512:8256]</nowiki></tt>
|-
| <tt><nowiki>[VOLCANISM_RANGES:<low sq>:<mid sq>:<high sq>]</nowiki></tt>
| <tt><nowiki>[VOLCANISM_RANGES:8256:16512:8256]</nowiki></tt>
|}

="The World Generator is having trouble placing..."=

:''Main article {{L|World rejection}}''

If you are having the common problem of your generated worlds always being rejected by the world generator, see {{L|World_rejection#Solving_World_Rejection_Problems|Solving World Rejection Problems}} as it contains many detailed suggestions on how to troubleshoot and solve these issues.

= Default Worldgen Parameters =

There is no single default for each parameter. Several advanced world generation profiles come with the game by default. See {{L|world_gen.txt|Default world_gen.txt}} to take a look at this file.

= Parameter Set Examples =

If you're trying to do something specific then the {{L|Worldgen examples|}} might be helpful. These are complete parameter sets that can be copied directly into your ''world_gen.txt'' file and customized as desired.
If they have nothing for you try {{L|Worldgen Tricks|}}, for known tricks and tips on making a world just right for you.

For many many more examples see:
* [http://www.bay12forums.com/smf/index.php?topic=64032.0 DF2010 WorldGen "Cookbook" Thread]

= Bugs =
*Magma sea breaching into {{L|HFS}}{{bug|1791}}
*Embark on a mountain of Slade, with Eerie Pits immediately revealed{{bug|3356}}
*Anti-Gravity Ants - Floating ant hills above river{{bug|3054}}

{{World}}
[[Category:World]]

v0.31:Material definition token

2011-10-15T18:25:17Z

I2amroy: /* Material Properties */

{{quality|Exceptional|18:11, 28 April 2011 (UTC)}}{{av}}

The following tokens can be used in material templates, as well as materials defined in other raw files.

==Material Properties==
{| {{prettytable}}
|- bgcolor="#C0C0C0"
! Token
! Arguments
! Description

|-
| PREFIX
|
| Applies a prefix to all items made from the material. For PLANT and CREATURE materials, this defaults to the plant/creature name. Not permitted in material template definitions.

|-
| STONE_NAME
|
| Overrides the name of mined out stones (used for native copper/silver/gold/platinum to make them be called "nuggets").

|-
| IS_GEM
|
* name
* plural
* state
| Used to indicate that said material is a gemstone - when tiles are mined out, rough gems will be yielded instead of boulders. Plural can be "STP" to automatically append an "s" to the singular form, and OVERWRITE_SOLID will override the relevant STATE_NAME and STATE_ADJ values.

|-
| TEMP_DIET_INFO
|
| Unknown

|-
| POWDER_DYE
| {{L|color}} token
| Defines the material as a type of dye.

|-
| TILE
| [[Character table|tile]]
| Specifies the tile that will be used to represent unmined tiles made of this material. Generally only used with stones. Defaults to 219 ('█').

|-
| ITEM_SYMBOL
| tile
| Specifies the tile that will be used to represent BOULDER objects made of this material. Generally only used with stones. Defaults to 7 ('•').

|-
| DISPLAY_COLOR
|
*foreground color
*background color
*foreground brightness
| The on-screen color of the material. Uses a standard 3-digit {{L|Color|color token}}. Equivalent to [TILE_COLOR:a:b:c], [BUILD_COLOR:b:a:X] (X = 1 if 'a' equals 'b', 0 otherwise), and [BASIC_COLOR:a:c]

|-
| BUILD_COLOR
|
*foreground color
*background color
*foreground brightness
| The color of objects made of this material which use both the foreground and background color: {{L|door}}s, {{L|floodgate}}s, {{L|hatch cover}}s, {{L|bin}}s, {{L|barrel}}s, and {{L|cage}}s. Defaults to 7:7:1 (white).

|-
| TILE_COLOR
|
*foreground color
*background color
*foreground brightness
| The color of unmined tiles containing this material (for stone and soil), as well as {{L|engraving}}s in this material. Defaults to 7:7:1 (white).

|-
| BASIC_COLOR
|
*color
*brightness
| The color of objects made of this material which use only the foreground color, including workshops, floors and boulders, and smoothed walls. Defaults to 7:1 (white).

|-
| STATE_COLOR
|
*state
*color
| The state may be SOLID, LIQUID, GAS, POWDER/SOLID_POWDER, PASTE/SOLID_PASTE, PRESSED/SOLID_PRESSED, ALL_SOLID, or ALL.
Color comes from descriptor_color_standard.txt and is used to indicate the color of the material. The nearest color value is used to display contaminants and body parts made of this material.
[STATE_COLOR:ALL_SOLID:GREY]

|-
| STATE_NAME
|
*state
*name
| The name of the material as displayed in-game.
[STATE_NAME:ALL_SOLID:stone]

|-
| STATE_NAME_ADJ
|
*state
*name/adjective
| Sets both STATE_NAME and STATE_ADJ at the same time.

|-
| STATE_ADJ
|
*state
*adjective
| Like STATE_NAME, but used in different situations. Equipment made from the material uses the state adjective and not the state name.

|-
| ABSORPTION
|
*value
| The material's tendency to absorb liquids. Containers made of materials with nonzero absorption cannot hold liquids unless they have been {{L|glaze}}d. Defaults to 0.

|-
| IMPACT_YIELD
|
*value
| Specifies how hard of an impact the material can withstand before it will deform. Used for blunt-force combat. Defaults to 10000.

|-
| IMPACT_FRACTURE
|
*value
| Specifies how hard of an impact the material can withstand before it will break. Used for blunt-force combat. Defaults to 10000.

|-
| IMPACT_STRAIN_AT_YIELD or IMPACT_ELASTICITY
|
*value
| Specifies how much the material will deform when subjected to an impact.{{verify}} Used for blunt-force combat. Defaults to 0. Apparently affects in combat whether the corresponding tissue is bruised (value >= 50000), torn (value between 25000 and 49999), or fractured (value <= 24999)

|-
| COMPRESSIVE_YIELD
|
*value
| Specifies how hard the material can be compressed before it will deform. [http://www.bay12forums.com/smf/index.php?topic=30026.msg1007133;topicseen#msg1007133 Supposedly used only during wrestling.] Defaults to 10000.

|-
| COMPRESSIVE_FRACTURE
|
*value
| Specifies how hard the material can be compressed before it will break. [http://www.bay12forums.com/smf/index.php?topic=30026.msg1007133;topicseen#msg1007133 Supposedly used only during wrestling.] Defaults to 10000.

|-
| COMPRESSIVE_STRAIN_AT_YIELD or COMPRESSIVE_ELASTICITY
|
*value
| Specifies how much the material will deform when compressed.{{verify}} [http://www.bay12forums.com/smf/index.php?topic=30026.msg1007133;topicseen#msg1007133 Supposedly used only during wrestling.] Defaults to 0.

|-
| TENSILE_YIELD
|
*value
| Specifies how hard the material can be stretched before it will deform. [http://www.bay12forums.com/smf/index.php?topic=30026.msg1007133;topicseen#msg1007133 Supposedly used only during wrestling.] Defaults to 10000.

|-
| TENSILE_FRACTURE
|
*value
| Specifies how hard the material can be stretched before it will break. [http://www.bay12forums.com/smf/index.php?topic=30026.msg1007133;topicseen#msg1007133 Supposedly used only during wrestling.] Defaults to 10000.

|-
| TENSILE_STRAIN_AT_YIELD or TENSILE_ELASTICITY
|
*value
| Specifies how much the material will deform when stretched.{{verify}} [http://www.bay12forums.com/smf/index.php?topic=30026.msg1007133;topicseen#msg1007133 Supposedly used only during wrestling.] Defaults to 0.

|-
| TORSION_YIELD
|
*value
| Specifies how hard the material can be twisted before it will deform. [http://www.bay12forums.com/smf/index.php?topic=30026.msg1007133;topicseen#msg1007133 Supposedly used only during wrestling.] Defaults to 10000.

|-
| TORSION_FRACTURE
|
*value
| Specifies how hard the material can be twisted before it will break. [http://www.bay12forums.com/smf/index.php?topic=30026.msg1007133;topicseen#msg1007133 Supposedly used only during wrestling.] Defaults to 10000.

|-
| TORSION_STRAIN_AT_YIELD or TORSION_ELASTICITY
|
*value
| Specifies how much the material will deform when twisted.{{verify}} [http://www.bay12forums.com/smf/index.php?topic=30026.msg1007133;topicseen#msg1007133 Supposedly used only during wrestling.] Defaults to 0.

|-
| SHEAR_YIELD
|
*value
| Specifies how hard the material can be sheared before it will deform. Used for cutting calculations. Defaults to 10000.

|-
| SHEAR_FRACTURE
|
*value
| Specifies how hard the material can be sheared before it will break. Used for cutting calculations. Defaults to 10000.

|-
| SHEAR_STRAIN_AT_YIELD or SHEAR_ELASTICITY
|
*value
| Specifies how much the material will deform when sheared.{{verify}} Used for cutting calculations. Defaults to 0.

|-
| BENDING_YIELD
|
*value
| Specifies how hard the material can be bent before it will deform. [http://www.bay12forums.com/smf/index.php?topic=30026.msg1007133;topicseen#msg1007133 Supposedly used only during wrestling.] Defaults to 10000.

|-
| BENDING_FRACTURE
|
*value
| Specifies how hard the material can be bent before it will break. [http://www.bay12forums.com/smf/index.php?topic=30026.msg1007133;topicseen#msg1007133 Supposedly used only during wrestling.] Defaults to 10000.

|-
| BENDING_STRAIN_AT_YIELD or BENDING_ELASTICITY
|
*value
| Specifies how much the material will deform when bent.{{verify}} [http://www.bay12forums.com/smf/index.php?topic=30026.msg1007133;topicseen#msg1007133 Supposedly used only during wrestling.] Defaults to 0.

|-
| MAX_EDGE
|
*value
| How sharp the material is. Used in cutting calculations. Applying a value of at least 10000 to a stone will allow weapons to be made from that stone. Defaults to 10000.

|-
| MATERIAL_VALUE
|
*value
| Value modifier for the material. Defaults to 1. This number can be made negative by placing a "-" in front, resulting in things that you are paid to buy and must pay to sell.

|-
| MULTIPLY_VALUE
|
*value
| Multiplies the value of the material. Not permitted in material template definitions.

|-
| SPEC_HEAT
|
*specific heat capacity
| Rate at which the material heats up or cools down. See {{L|SPEC HEAT}} for more information. Defaults to NONE.

|-
| HEATDAM_POINT
|
*temperature
| Temperature above which the material takes damage from heat. May be set to NONE. If the material has an ignite point but no heatdam point, it may burn for a very long time (around 9-10 months). Defaults to NONE.

|-
| COLDDAM_POINT
|
*temperature
| Temperature below which the material takes damage from cold. Defaults to NONE.

|-
| IGNITE_POINT
|
*temperature
| Temperature at which the material will catch fire. Defaults to NONE.

|-
| MELTING_POINT
|
*temperature
| Temperature at which the material melts. Defaults to NONE.

|-
| BOILING_POINT
|
*temperature
| Temperature at which the material boils. Defaults to NONE.

|-
| MAT_FIXED_TEMP
|
*temperature
| Constant temperature emitted by the material. Defaults to NONE.

|-
| IF_EXISTS_SET_HEATDAM_POINT
|
*temperature
| Changes a material's HEATDAM_POINT, but only if it was not set to NONE.

|-
| IF_EXISTS_SET_COLDDAM_POINT
|
*temperature
| Changes a material's COLDDAM_POINT, but only if it was not set to NONE.

|-
| IF_EXISTS_SET_IGNITE_POINT
|
*temperature
| Changes a material's IGNITE_POINT, but only if it was not set to NONE.

|-
| IF_EXISTS_SET_MELTING_POINT
|
*temperature
| Changes a material's MELTING_POINT, but only if it was not set to NONE.

|-
| IF_EXISTS_SET_BOILING_POINT
|
*temperature
| Changes a material's BOILING_POINT, but only if it was not set to NONE.

|-
| IF_EXISTS_SET_MAT_FIXED_TEMP
|
*temperature
| Changes a material's MAT_FIXED_TEMP, but only if it was not set to NONE.

|-
| SOLID_DENSITY
|
*density
| Specifies the density (in kilograms per cubic meter) of the material when in solid form. Also affects combat calculations; affects blunt-force damage and ability of edged weapons to pierce tissue layers{{verify}}. Defaults to NONE.

|-
| LIQUID_DENSITY
|
*density
| Specifies the density of the material when in liquid form. Defaults to NONE.

|-
| MOLAR_MASS
|
*value
| Supposedly not used. Defaults to NONE.

|-
| EXTRACT_STORAGE
| BARREL or FLASK
| Specifies the type of container used to store the material. Used in conjunction with the [EXTRACT_BARREL], [EXTRACT_VIAL], or [EXTRACT_STILL_VIAL] {{L|plant token}}s. Defaults to BARREL.

|-
| BUTCHER_SPECIAL
|
*{{L|item token}}
| Specifies the item type used for butchering results made of this material. Stock raws use GLOB:NONE for fat and MEAT:NONE for other meat materials.

|-
| MEAT_NAME
|
*prefix
*name
*adjective?
| When a creature is butchered, meat yielded from organs made from this material will be named via this token.

|-
| BLOCK_NAME
|
*singular
*plural
| Specifies the name of {{L|block}}s made from this material.

|-
| MATERIAL_REACTION_PRODUCT
|
*reaction reference
*{{L|material token}}
| Used with reaction raws to associate a reagent material with a product material. The first argument is used by HAS_MATERIAL_REACTION_PRODUCT and GET_MATERIAL_FROM_REAGENT in reaction raws. The remainder is a material reference, generally LOCAL_CREATURE_MAT:SUBTYPE or LOCAL_PLANT_MAT:SUBTYPE or INORGANIC:STONETYPE.
[MATERIAL_REACTION_PRODUCT:TAN_MAT:LOCAL_CREATURE_MAT:LEATHER]

|-
| REACTION_CLASS
|
*reaction reference
| Used to classify all items made of the material so that reactions can use them as generic reagents.

|-
| HARDENS_WITH_WATER
|
* {{L|material token}}
| Allows the material to be used to make {{L|healthcare|casts}}.

|-
| SOAP_LEVEL
|
*value
| Unknown. Defaults to 0.
|}

==Material Usage Tokens==
{| {{prettytable}}
|- bgcolor="#C0C0C0"
! Token
! Arguments
! Description

|-
| IMPLIES_ANIMAL_KILL
|
| Lets the game know that an animal was likely killed in the production of this item. Elves (and other entities that are ethically opposed to killing animals) will likely not bring these for trade.

|-
| ALCOHOL_PLANT or ALCOHOL
|
| Classifies the material as plant alcohol, allowing it to be stored in food stockpiles under "Drink (Plant)".

|-
| ALCOHOL_CREATURE
|
| Classifies the material as creature alcohol, allowing it to be stored in food stockpiles under "Drink (Animal)".

|-
| CHEESE_PLANT
|
| Classifies the material as plant cheese, allowing it to be stored in food stockpiles under "Cheese (Plant)".

|-
| CHEESE_CREATURE or CHEESE
|
| Classifies the material as creature cheese, allowing it to be stored in food stockpiles under "Cheese (Animal)".

|-
| POWDER_MISC_PLANT or POWDER_MISC
|
| Classifies the material as plant powder, allowing it to be stored in food stockpiles under "Milled Plant".

|-
| POWDER_MISC_CREATURE
|
| Classifies the material as creature powder, allowing it to be stored in food stockpiles under "Bone Meal".

|-
| STOCKPILE_GLOB or STOCKPILE_GLOB_SOLID
|
| Permits globs of the material in solid form to be stored in food stockpiles under "Fat" - without it, dwarves will come by and "clean" the items, destroying them (unless [DO_NOT_CLEAN_GLOB] is also included).

|-
| STOCKPILE_GLOB_PASTE
|
| Permits globs of the material in paste form to be stored in food stockpiles under "Paste".

|-
| STOCKPILE_GLOB_PRESSED
|
| Permits globs of the material in pressed form to be stored in food stockpiles under "Pressed Material".

|-
| LIQUID_MISC_PLANT or LIQUID_MISC
|
| Classifies the material as a plant extract, allowing it to be stored in food stockpiles under "Extract (Plant)".

|-
| LIQUID_MISC_CREATURE
|
| Classifies the material as a creature extract, allowing it to be stored in food stockpiles under "Extract (Animal)".

|-
| LIQUID_MISC_OTHER
|
| Classifies the material as a miscellaneous liquid, allowing it to be stored in food stockpiles under "Misc. Liquid" along with lye.

|-
| STRUCTURAL_PLANT_MAT
|
| Classifies the material as plant, allowing it to be stored in food stockpiles under "Plants".

|-
| SEED_MAT
|
| Classifies the material as plant seed, allowing it to be stored in food stockpiles under "Seeds".{{verify}}

|-
| LEAF_MAT
|
| Classifies the material as plant leaf, allowing it to be stored in food stockpiles under "Leaves".{{verify}}

|-
| BONE
|
| Classifies the material as bone, allowing it to be used by craftsdwarves.{{verify}}

|-
| WOOD
|
| Classifies the material as wood, allowing it to be used by carpenters.{{verify}} May also make elves angry if you try to trade it to them.

|-
| THREAD_PLANT
|
| Classifies the material as plant fiber, permitting thread and cloth to be stored in cloth stockpiles under "Thread (Plant)" and "Cloth (Plant)".

|-
| TOOTH
|
| Classifies the material as tooth, allowing it to be used by craftsdwarves.{{verify}}

|-
| HORN
|
| Classifies the material as horn, allowing it to be used by craftsdwarves.{{verify}}

|-
| PEARL
|
| Classifies the material as pearl, allowing it to be used by craftsdwarves.{{verify}}

|-
| SHELL
|
| Classifies the material as shell, allowing it to be used by craftsdwarves.{{verify}}

|-
| LEATHER
|
| Classifies the material as leather, allowing it to be used by craftsdwarves.{{verify}}

|-
| SILK
|
| Classifies the material as silk, permitting thread and cloth to be stored in cloth stockpiles under "Thread (Silk)" and "Cloth (Silk)".

|-
| SOAP
|
| Classifies the material as soap, permitting it to be stored in Bar/Block stockpiles with Soap enabled.{{verify}}

|-
| GENERATES_MIASMA
|
| Material generates miasma when it rots

|-
| MEAT
|
| Classifies the material as edible meat.{{verify}}

|-
| ROTS
|
| Material will rot if not stockpiled appropriately

|-
| BLOOD_MAP_DESCRIPTOR
|
| Tells the game to classify contaminants of this material as being "blood", both in Adventurer mode tile descriptions ("Here we have a Dwarf in a slurry of blood.") and for unhappy thoughts from drinking water ("He was forced to drink bloody water lately").

|-
| ICHOR_MAP_DESCRIPTOR
|
| Tells the game to classify contaminants of this material as being "ichor".

|-
| GOO_MAP_DESCRIPTOR
|
| Tells the game to classify contaminants of this material as being "goo".

|-
| SLIME_MAP_DESCRIPTOR
|
| Tells the game to classify contaminants of this material as being "slime".

|-
| PUS_MAP_DESCRIPTOR
|
| Tells the game to classify contaminants of this material as being "pus".

|-
| ENTERS_BLOOD
|
| Used for materials which cause {{L|syndrome}}s, causes it to enter the creature's blood instead of simply spattering on the surface.

|-
| EDIBLE_VERMIN
|
| Can be eaten by vermin.

|-
| EDIBLE_RAW
|
| Can be eaten raw.

|-
| EDIBLE_COOKED
|
| Can be cooked and then eaten.

|-
| DO_NOT_CLEAN_GLOB
|
| Prevents globs made of this material from being cleaned up and destroyed.

|-
| NO_STONE_STOCKPILE
|
| Prevents the material from showing up in Stone stockpile settings.

|-
| ITEMS_METAL
|
| Effect unknown

|-
| ITEMS_BARRED
|
| {{L|Bone}} items (clothes with [BARRED]) can be made from this material.

|-
| ITEMS_SCALED
|
| {{L|Shell}} items (clothes with [SCALED]) can be made from this material.

|-
| ITEMS_LEATHER
|
| {{L|Leather}} items (clothes with [LEATHER]) can be made from this material.

|-
| ITEMS_SOFT
|
| Soft clothing items, backpacks and quivers, and siege engine parts can be made from this material.

|-
| ITEMS_HARD
|
| Furniture, medical supplies, and crafts can be made out of this material.

|-
| IS_STONE
|
| Used to define that said material is stone. Allows storage in stone stockpiles, among other effects.

|-
| UNDIGGABLE
|
| Used for a stone that cannot be dug into.

|-
| DISPLAY_UNGLAZED
|
| Causes containers made of this material to be prefixed with "unglazed" if they have not yet been {{L|glaze}}d.

|-
| YARN
|
| Classifies the material as yarn, permitting thread and cloth to be stored in cloth stockpiles under "Thread (Yarn)" and "Cloth (Yarn)".

|-
| STOCKPILE_THREAD_METAL
|
| Classifies the material as metal thread, permitting thread and cloth to be stored in cloth stockpiles under "Thread (Metal)" and "Cloth (Metal)".

|-
| IS_METAL
|
| Defines the material as being metal, allowing it to be used at forges.

|-
| IS_GLASS
|
| Used internally by green glass, clear glass, and crystal glass.

|-
| CRYSTAL_GLASSABLE
|
| Can be used in the production of crystal glass.

|-
| ITEMS_WEAPON
|
| Melee {{L|Weapon#Manufactured weapons|weapons}} can be made out of this material.

|-
| ITEMS_WEAPON_RANGED
|
| Ranged weapons can be made out of this material.

|-
| ITEMS_ANVIL
|
| {{L|Anvil}}s can be made out of this material.

|-
| ITEMS_AMMO
|
| {{L|Weapon#Ammunition|Ammunition}} can be made out of this material.

|-
| ITEMS_DIGGER
|
| {{L|Weapon#Dwarf-manufactured weapons|Picks}} can be made out of this material.

|-
| ITEMS_ARMOR
|
| {{L|Armor}} can be made out of this material.

|-
| ITEMS_DELICATE
|
| Used internally by amber and coral.

|-
| ITEMS_SIEGE_ENGINE
|
| Siege engine parts can be made out of this material. Does not appear to work.

|-
| ITEMS_QUERN
|
| Querns and millstones can be made out of this material.{{verify}}
|}

==Syndrome tokens==

{| {{prettytable}}
|- bgcolor="#C0C0C0"
! Token
! Arguments
! Description

|-
| SYN_NAME
| text
| defines the name of the syndrome

|-
| SYN_INJECTED
|
| syndrome can be contracted by injection (by a creature)

|-
| SYN_CONTACT
|
| syndrome can be contracted on contact (e.g. poison dust or liquid)

|-
| SYN_INHALED
|
| syndrome can be contracted by inhalation (e.g. poison vapor or gas)

|-
| SYN_AFFECTED_CLASS
|
| adds a class of creatures to those affected, such as CREATURE_CLASS:GENERAL_POISON

|-
| SYN_IMMUNE_CLASS
|
| makes the class of creatures immune to the syndrome

|-
| SYN_AFFECTED_CREATURE
| creature
| adds a specific creature to those affected.

|-
| SYN_IMMUNE_CREATURE
| creature
| makes the creature immune to the syndrome

|-
| CE_PAIN<br />CE_SWELLING<br />CE_OOZING<br />CE_BRUISING<br />CE_BLISTERS<br />CE_NUMBNESS<br />CE_PARALYSIS<br />CE_FEVER<br />CE_BLEEDING<br />CE_COUGH_BLOOD<br />CE_VOMIT_BLOOD<br />CE_NAUSEA<br />CE_UNCONSCIOUSNESS<br />CE_NECROSIS<br />CE_IMPAIR_FUNCTION<br />CE_DROWSINESS<br />CE_DIZZINESS
|
*SEV:<value> (severity, higher is worse)
*PROB:<value(1-100)> (probability)
*RESISTABLE (optional) allows resistance
*SIZE_DILUTES (optional) lessens effect based on size
Place affected:
*LOCALIZED (optional)
*VASCULAR_ONLY (optional)
*MUSCULAR_ONLY (optional)
*BP:BY_CATEGORY:category:tissue (optional)
*BP:BY_TYPE:type:tissue (optional)
*BP:BY_TOKEN:token:tissue (optional)
Timeline:
*Start:effect start time
*Peak:effect peak time
*End:effect end time
| Specifies the way that a syndrome affects a creature -- more detail can be found on the {{L|Syndrome#Creature effect tokens|Syndromes page}}

|}

==See Also==
* {{L|Inorganic material definition token}}
* {{L|Syndrome}}

{{Category|Modding}}
{{Category|Tokens}}

v0.31:Plant token

2011-10-08T22:39:01Z

I2amroy: /* Crop Tokens */

{{quality|Exceptional|21:01, 30 March 2011 (UTC)}}{{av}}
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.

{| {{prettytable}}
|- style='background-color:#ddd'
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | 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
|
* {{L|Material token|material}}
| 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.

{| {{prettytable}}
|- style='background-color:#ddd'
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| UNDERGROUND_DEPTH
|
*minimum
*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. 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
|
*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 {{L|biome token|biome}} this plant appears in.

|}

==Tree Tokens==
These tokens are used only for trees.

{| {{prettytable}}
|- style='background-color:#ddd'
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| TREE
|
* {{L|Material token|material}}
| Makes the plant into a {{L|tree}}. 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 {{L|color}} of the tree on the map. Defaults to 2:0:0 (dark green).

|-
| DEAD_TREE_COLOR
|
*foreground
*background
*bright
| The {{L|color}} of the tree on the map when (un)dead. Defaults to 0:0:1 (dark gray).

|-
| SAPLING_COLOR
|
*foreground
*background
*bright
| The {{L|color}} of saplings of this tree. Defaults to 2:0:0 (dark green).

|-
| DEAD_SAPLING_COLOR
|
*foreground
*background
*bright
| The {{L|color}} of dead saplings of this tree. Defaults to 0:0:1 (dark gray).

|-
| 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.

{| {{prettytable}}
|- style='background-color:#ddd'
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | 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 {{l|Time}}. Defaults to 300.

|-
| VALUE
|
*value
| Value of harvested plant. Defaults to 1. (Currently appears to do nothing in .25, unknown if this is a bug or intended)

|-
| 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 {{l|color}} of the plant in farms. Defaults to 2:0:0 (dark green).

|-
| DEAD_PICKED_COLOR
|
*foreground
*background
*bright
| The {{l|color}} of the plant when wilted. Defaults to 0:0:1 (dark gray).

|-
| SHRUB_COLOR
|
*foreground
*background
*bright
| The {{l|color}} of shrubs bearing this plant. Defaults to 2:0:0 (dark green).

|-
| DEAD_SHRUB_COLOR
|
*foreground
*background
*bright
|The {{l|color}} of dead shrubs that bore this plant. Defaults to 6:0:0 (brown).

|-
| SHRUB_DROWN_LEVEL
|
*depth
| The water depth at which shrubs of this plant will drown. Exact behavior is unknown. Defaults to 4.

|-
| DRINK
|
* {{L|Material token|material}}
| Permits brewing the plant into {{L|alcohol}} made of this material. Said material should have [ALCOHOL_PLANT] to permit proper stockpiling.

|-
| MILL
|
* {{L|Material token|material}}
| Permits milling the plant at a {{L|quern}} or {{L|millstone}} into a powder made of this material. Said material should have [POWDER_MISC_PLANT] to permit proper stockpiling.

|-
| THREAD
|
* {{L|Material token|material}}
| Permits processing the plant at a {{L|farmer's workshop}} to yield threads made of this material. Said material should have [THREAD_PLANT] to permit proper stockpiling.

|-
| SEED
|
*name
*name_plural
*foreground
*background
*bright
*{{L|Material token|material}}
| 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
*{{L|Material token|material}}
| Permits processing the plant into a {{L|bag}} at a {{L|farmer's workshop}} to yield leaves made of this material and having these properties. Said material should have [LEAF_MAT] to permit proper stockpiling.

|-
| EXTRACT_STILL_VIAL
|
* {{L|Material token|material}}
| Permits processing the plant into a {{L|vial}} at a {{L|still}} to yield extract made of this material. Said material should have [EXTRACT_STORAGE:FLASK].

|-
| EXTRACT_VIAL
|
*{{L|Material token|material}}
| Permits processing the plant into a {{L|vial}} at a {{L|farmer's workshop}} to yield extract made of this material. Said material should have [EXTRACT_STORAGE:FLASK].

|-
| EXTRACT_BARREL
|
* {{L|Material token|material}}
| Permits processing the plant into a {{L|barrel}} at a {{L|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 {{L|grass}}es.

{| {{prettytable}}
|- style='background-color:#ddd'
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | 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).
|}

{{Category|Modding}}
{{Category|Tokens}}

v0.31:Farming

2011-10-06T22:09:22Z

I2amroy: /* Farm plots in action */

{{quality|Exceptional|19:03, 16 April 2011 (UTC)}}{{av}}
[[Image:Df-crops-diagram.png|thumb|200px|General farming flowchart.]]

'''Farming''' is the action of growing {{l|crops}} for {{l|food}}, {{l|alcohol}} production and {{l|cloth}} manufacturing. While small forts can easily be sustained by plant gathering, {{l|hunting}} and trading, farming is vital to large settlements.

Farming is done at a '''farm plot''' building ({{k|b}}-{{k|p}}, resize with {{k|u}}{{k|m}}{{k|k}}{{k|h}}). It requires {{l|seeds}} and a worker with the "Farming (Fields)" {{l|labor}} enabled.

Depending on where the farm plot is constructed, different crops may be planted. Farm plots built {{l|above ground}} are not suitable for the crops grown on {{L|subterranean}} farm plots and vice versa. Note that the attributes {{DFtext|Inside |6:0:0}}, {{DFtext|Dark |0:0:1}}, {{DFtext|Outside|3:0:1}} and {{DFtext|Light|6:0:1}} are of no relevance.

See the article on {{L|crop}}s for details on the conditions needed to grow the available plants.

== Introduction to Farming ==

After building a farm plot building ({{k|b}}-{{k|p}}, resize with {{k|u}}{{k|m}}{{k|k}}{{k|h}}), you must select which crops to plant there.

Press {{k|q}} and move the cursor over the farm, you will see a list of crops you can select to grow in the current season. You can change which season is displayed by pressing {{k|a}},{{k|b}},{{k|c}}, or {{k|d}}. Move the blue selector up and down with {{k|-}} and {{k|+}}, and press {{k|Enter}} to choose a crop to plant during that season (highlighted in white).

You must have the appropriate {{L|seed}}s to plant a crop there. To easily see how many of each seeds you have you can go to the Kitchen menu ({{k|z}} {{k|right}} {{k|Enter}}). {{L|Plump helmet}}s are a good beginning crop for a first cave farm, and {{L|wild strawberries}} are a good choice for outdoor fields. Check the {{L|crop}}s page for details on different seeds. Only some plants are edible so make sure the seeds you're using will produce food. It's often a good idea to pick a seed which produces a plant which can be {{L|brew}}ed. This will create {{L|alcohol}} and also give you a seed to plant again next season.

Instructing a plot to remain fallow {{k|z}} during a particular season will instruct dwarves not to plant in that plot during that season.

=== Fertilization ===
<Table BORDER=1 align="right"><tr><td align="center">Farm Size</td><td>Potash</td><td>Per Square</td></tr>
<tr><td align="center">1</td><td align="center">1</td><td align="center">1.000</td></tr>
<tr><td align="center">2</td><td align="center">1</td><td align="center">0.500</td></tr>
<tr><td align="center">3</td><td align="center">1</td><td align="center">0.333</td></tr>
<tr><td align="center">4</td><td align="center">2</td><td align="center">0.500</td></tr>
<tr><td align="center">5</td><td align="center">2</td><td align="center">0.400</td></tr>
<tr><td align="center">6</td><td align="center">2</td><td align="center">0.333</td></tr>
<tr><td align="center">7</td><td align="center">2</td><td align="center">0.286</td></tr>
<tr><td align="center">8</td><td align="center">3</td><td align="center">0.375</td></tr></table>

Pressing {{k|f}} lets you toggle fertilization on or off. To fertilize a farm plot, one needs {{L|potash}}, which is produced by processing {{L|ash}}. It greatly increases the yield of a plot (approx. multiplied by four). However fertilization only lasts for one season, and requires plot size / 4 (round down) + 1 of {{L|potash}} for saturation. Therefore fully fertilizing a farm would require burning a large amount of trees each season. The table on the right illustrates the effect of the formula on potash needed per square. Generally, larger farms use less, approaching a limit of 1/4 bar per square. The worst sizes are multiples of 4, it's better to have plots one or two less than a multiple of 4. While costly, fertilization enhances productivity of not only farmers, but many industries down the line, e.g. brewing, cooking, milling and threshing, due to the large increase in stack size of the plants, which are still processed in a single action.

=== Subterranean Farming ===

To grow the six "dwarven" plants, including the {{l|plump helmet}}, you will need an underground farm plot. The seeds and spawn available to your dwarves at embark will only grow underground. Underground farm plots must be placed on soil or {{L|mud}}dy stone.{{version|0.31.19}}

Muddying a stone floor requires temporarily covering it with water: common methods include a bucket brigade or '''controlled''' flooding (see: {{l|Irrigation}}) by temporarily diverting a river or pool, using a floodgate or door to stop the flow. You may also find a muddied area in a {{L|cavern}}, but note that each tile underneath the farm plot must be muddied. Most caverns have entire open areas which will be permanently covered in mud, but if you dig into the walls of a cavern or chisel away a pillar, the freshly cut floor area will not be muddied until you get it wet. Underground caverns are dirty, and frequently contain {{L|Mud|piles of mud}} that are perfect for quickly setting up farms. However, given the wide variety of creatures found in caverns, you may want to take precautions. Consider keeping a {{L|squad}} close at hand to guard the farm, or walling off a muddied area for your dwarves' exclusive use.

Underground farming is not restricted to soil layers and caverns: underground floor of any material -- rough stone, smoothed stone, ore, gem -- can support subterranean farm plots once there is a layer of mud covering it. See {{L|irrigation}} for tips on getting the right amount of water to the farm plots.

=== Above Ground Farming ===
*Above ground crops farming is impossible in {{L|Ocean}} and {{L|Mountain}} biomes, even if the farm is built on mud.

Above ground farming is basically the same as underground farming, with the simplifying distinction that above ground plots typically do not require preparatory work. However, there are some complications.

The first complication is that seeds cannot be chosen at embark, as dwarven civilizations do not have access to those sort of plants. They can be bought from {{L|Elves|elven}} and {{L|human}} caravans; above-ground plants can be gathered using the {{L|Plant gathering}} designation, and then {{L|brewer|brewed}}, {{L|mill}}ed, {{L|thresher|threshed}} or {{L|dining hall|eaten}} directly (depending on the plant) to produce seeds.

The second complication is that the farming must be done on {{L|soil}} or muddied rock, being {{L|above ground}}. Typically, it is done on the surface, which is dangerous (due to aggressive animals, ambushes and sieges). However, any land which has ever been exposed to sunlight becomes permanently marked as "above ground". So, if you have multiple Z-layers of soil, you can channel some above-ground land, remove the resulting ramps, then construct a floor above, where the surface once was. The (now inside and protected) lower soil will still be suitable for farming outdoor plants like {{L|wild strawberry|wild strawberries}}, {{L|longland grass}}, {{L|rope reed}}, and anything else you may find. If your soil is not thick enough, you may still get a secure above ground farm by doing the same with any rock and muddying it. Alternatively, you may build a greenhouse around some soil.

Above ground farms built on unmuddied rock layers will show the message "No seeds available for this location", and you ''will not'' be able to plant anything in them.

Some crops require a particular temperature range to grow; so although it may be possible to plant them in any season, to obtain optimal usage of farm plots it may be necessary to coordinate planting with seasonal temperature variations.

== Farm plots in action ==

Once a farm plot has been built and crops have been selected for the current season, dwarves with the {{l|growing}} labor enabled will begin planting the selected seed. Farmers will not start planting if the tile they would start on is not muddy, even if all other tiles in the plot are.<sup>Verify</sup> The higher a Dwarf's grower skill in planting, the more plants will be harvested from each seed planted. The farming labor is fairly low in priority, so if you want a full time farmer, it is best to disable all other labors.

Plants take time to grow, depending on their type. Once a plant is fully grown, a dwarf will harvest it. By default, any dwarf will do this. Harvesting plants is not affected by any skill, although it provides a small amount of grower experience. So it's a good idea to set only your planters to harvest, not anyone. To do that, set option "Only Farmers Harvest" {{k|o}}{{k|h}}.

Plants that remain in the field for too long will wither. These plants will eventually {{L|rot}} away. There's no use for withered plants.
Also any plants that are still growing when their growing seasons end will be removed. As in DF 2010 farmers will plant up until the last day of the growing season, it might be a good idea to disable the last season of each crop so that seeds are not lost.

Depending on the number of growers and their experience and the rate at which the plant grows, not all squares of large plots may be used. {{verify}}

Any farm plot that has both Above Ground and Subterranean tile attributes within the plot will only be partially planted, if at all. Verify using {{k|k}} over each square of the plot and remake as needed to follow the proper attributes.

== Management ==

Create a custom {{L|stockpile}} near your {{L|farm}} which will only accept {{L|seed}}s. This will consolidate your seeds into one place, instead of having them littered all through the {{L|dining room}}. As a single barrel can hold up to 10 seed {{L|bag}}s (each of which can hold 100 seeds of a specific type), this stockpile can be only three or four tiles. Alternately, you can make a more traditional sized custom stockpile, which only accepts seeds and bars of {{L|potash}} for fertilizing. It may also be a good idea to set aside a few seeds from each type of crop and {{L|forbid}} them, as a seed bank in case of catastrophe.

You can also create a custom stockpile that will only accept {{L|plant}}s, to avoid having it all mixed up with your {{L|meat}} and {{L|drink}}s. It would be a good idea to have this stockpile near your {{L|still}}, {{L|farmer's workshop}}, {{L|kitchen}}, etc. If you suffer from plump helmet overflow, create a plump-helmet-only stockpile, forbid plump helmets from all other food stockpiles, and let the crops in the field die if they can't be picked. It is worth noting that withering crops in the field do not produce miasma.

Use the {{L|stocks}} menu, and go to the Kitchen tab. From here you can see how many of each kind of food you have. If you're running out of a certain kind of seed, toggle the corresponding plant "Cook" setting to red. {{L|Cooking}} plants doesn't leave a seed. If you have too many of a certain kind of seed, toggle the seed "Cook" setting to blue. Just make sure you check on the stocks and toggle it back before you run out, or use the seed bank idea above.

{{Farming FAQ}}

== See also ==
* {{L|Irrigation}}
* {{L|Tile attributes}}
* {{L|Crops}}

{{Category|Buildings}}

v0.31:Item quality/Table

2011-09-28T15:50:06Z

I2amroy:

{|
! style="padding-right: 35px;" | '''Designation''' || style="text-align: left;" | '''Description''' || style="padding-right: 20px; padding-left: 15px; text-align: center;" | '''Value <br>Modifier''' || style="text-align: center;" | ''' Weapon To-Hit /<br>Armor Deflect Modifier'''
|-
|  Item Name || style="text-align: center;" | —     || 1x || 1x || style="text-align: center;" | || style="text-align: center;" |
|-
| -Item Name- || Well-crafted || 2x || ''unknown '' || style="text-align: center;" | || style="text-align: center;" |
|-
| +Item Name+ || Finely-crafted || 3x || ''unknown '' || style="text-align: center;" | || style="text-align: center;" |
|-
| *Item Name* || Superior quality || 4x || ''unknown '' ||style="text-align: center;" | || style="text-align: center;" |
|-
| ≡Item Name≡ || Exceptional || 5x || ''unknown '' || style="text-align: center;" | || style="text-align: center;" |
|-
| ☼Item Name☼ || Masterful || 12x || 2x || style="text-align: center;" | || style="text-align: center;" |
|-
| ''Unique name'' || Artifact || 120x || 3x || style="text-align: center;" |
|-
| «Item Name» || {{L|decoration|Decorated}} object || Varies || ''unknown '' || style="text-align: center;" | || style="text-align: center;" |
|}

v0.31:Item quality/Table

2011-09-28T15:48:42Z

I2amroy:

{|
! style="padding-right: 35px;" | '''Designation''' || style="text-align: left;" | '''Description''' || style="padding-right: 20px; padding-left: 15px; text-align: center;" | '''Value <br>Modifier''' || style="text-align: center;" | ''' Weapon To-Hit /<br>Armor Deflect Modifier'''
|-
|  Item Name || style="text-align: center;" | —     || 1x || 1x || style="text-align: center;" | || style="text-align: center;" |
|-
| -Item Name- || Well-crafted || 2x || ''unknown '' || style="text-align: center;" | || style="text-align: center;" |
|-
| +Item Name+ || Finely-crafted || 3x || ''unknown '' || style="text-align: center;" | || style="text-align: center;" |
|-
| *Item Name* || Superior quality || 4x || ''unknown '' ||style="text-align: center;" | || style="text-align: center;" |
|-
| ≡Item Name≡ || Exceptional || 5x || ''unknown '' || style="text-align: center;" | || style="text-align: center;" |
|-
| ☼Item Name☼ || Masterful || 12x || 2x || style="text-align: center;" | || style="text-align: center;" |
|-
| ''Unique name'' || Artifact || 120x || 3x || style="text-align: center;" |
|-
| «Item Name» || {{L|decoration|Decorated}} object || Varies || 1x || style="text-align: center;" | || style="text-align: center;" |
|}

v0.31:Item quality/Table

2011-09-28T15:44:07Z

I2amroy:

{|
! style="padding-right: 35px;" | '''Designation''' || style="text-align: left;" | '''Description''' || style="padding-right: 20px; padding-left: 15px; text-align: center;" | '''Value <br>Modifier''' || style="text-align: center;" | ''' Weapon To-Hit /<br>Armor Deflect Modifier'''
|-
|  Item Name || style="text-align: center;" | —     || 1x || 1x || style="text-align: center;" | || style="text-align: center;" |
|-
| -Item Name- || Well-crafted || 2x || ''unknown '' || style="text-align: center;" | || style="text-align: center;" |
|-
| +Item Name+ || Finely-crafted || 3x || ''unknown '' || style="text-align: center;" | || style="text-align: center;" |
|-
| *Item Name* || Superior quality || 4x || ''unknown '' ||style="text-align: center;" | || style="text-align: center;" |
|-
| ≡Item Name≡ || Exceptional || 5x || ''unknown '' || style="text-align: center;" | || style="text-align: center;" |
|-
| ☼Item Name☼ || Masterful || 12x || 2x || style="text-align: center;" | || style="text-align: center;" |
|-
| ''Unique name'' || Artifact || 120x || 3x || style="text-align: center;" |
|-
| «Item Name» || Object is {{L|decoration|decorated}} || || || style="text-align: center;" | || style="text-align: center;" |
|}

v0.31:Creature token

2011-08-19T21:21:47Z

I2amroy: /* P */

{{av}}{{Quality|Exceptional}}

A full list of all known creature tokens.

__NOTOC__

<div align="center">
{{alphabetical TOC}}
</div>

==A==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| ADOPTS_OWNER
|
| Tame creature cannot be made available for adoption, instead automatically adopting whoever it wants. It appears that the basic requirements for adoption are intact; for example, the creature is more likely to adopt an owner which likes creatures of that species.{{verify}}

|-
| ALCOHOL_DEPENDENT
|
| Creature needs alcohol to get through the working day.

|-
| ALL_ACTIVE
|
| Sets if the creature is active in day, night, and twilight. Seems to be a separate value from DIURNAL/NOCTURNAL/CREPUSCULAR, rather than implying them.

|-
| ALTTILE
|
| If set, the creature will blink between its [TILE] and its [ALTTILE].

|-
| AMBUSHPREDATOR
|
| Instead of charging relentlessly at prey, a creature with this tag will wait till the prey is within a few squares before charging.{{verify}}

|-
| AMPHIBIOUS
|
| Allows a creature to breathe with or without {{L| water}}. Implies [AQUATIC].

|-
| APP_MOD_DESC_RANGE
|
*Range
| [http://www.bay12forums.com/smf/index.php?topic=60554.msg1766793#msg1766793 Forum post describing how description ranges work]

|-
| APP_MOD_GENETIC_MODEL
|
*Model (Accepts DOMINANT_MORE, DOMINANT_LESS, and MIX)
| Defines a genetic model for the relevant appearance modifier(s). May or may not do anything significant at present.

|-
| APP_MOD_IMPORTANCE
|
*number
| Determines how important the appearance modifier is, for determining whether it shows up in the creature description.{{verify}}

|-
| APP_MOD_NOUN
|
*noun
*SINGULAR or PLURAL
| creates a noun for the appearance and whether it is singular or plural

|-
| APP_MOD_RATE
|
*Rate (integer)
*Scale (DAILY, YEARLY)
*min:max of growth
*start year:start day
*end year:end day
| setting the growth rate of the modifier. The last two tokens can be replaced by NO_END to have growth continue indefinitely.

|-
| APPLY_CREATURE_VARIATION
|
*CV TEMPLATE NAME
| Loads the Creature Variation Template specified.

|-
| APPLY_CURRENT_CREATURE_VARIATION
|
| Applies loaded Creature Variation

|-
| AQUATIC
|
| Allows a creature to breathe underwater, but causes it to "drown" out of {{L|water}}.

|-
| ARENA_RESTRICTED
|
| Does not appear in arena mode list

|-
| ARTIFICIAL_HIVEABLE
|
| Can be kept in artificial hives by beekeepers.

|-
| AT_PEACE_WITH_WILDLIFE
|
| Does not attack or frighten wildlife.

|-
| ATTACK
|
*token
*bodypart
*selection criteria
*location
| Defines the attack name, and the body part used. See [[#Attack Tokens|below]] for valid subtokens
'''Example:'''<br />
[ATTACK:GORE:BODYPART:BY_CATEGORY:HORN]<br />
''GORE'' : name of the attack<br />
''BODYPART:BY_CATEGORY:HORN'' : the horn is used to attack (presuming the creature has one)

|-
| ATTACK_TRIGGER
| pop:exported wealth:created wealth
| Specifies when a {{L|megabeast}} will attack the fortress.

|}

<div align="center">
{{alphabetical TOC}}
</div>

==B==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| BABY
| integer
| Age at which creature is considered a child. Default is zero. One can think of this as the duration of the baby stage.

|-
| BABYNAME
| singular:plural
| Defines a new name for a creature in baby state at the caste level. For non-caste-specific baby names, see GENERAL_BABY_NAME.

|-
| BEACH_FREQUENCY
|
| {{L|Whale}}s and {{L|Sea nettle jellyfish|jellyfish}} have this. Controls the beaching frequency of the creature.

|-
| BENIGN
|
| Determines whether creature can show up on "tame" maps (includes {{L|elephant}}s), which will generally avoid dwarves, although they may chase and/or attack them if they get too close).

|-
| BIOME
|
* {{L|biome token}}
| Select a {{L|Biome}} the creature may appear in.

|-
| BLOOD
|
* {{L|material token}}
*matter state (LIQUID, GAS, SOLID)
| Specifies what the creature's blood is made of.

|-
| BODY
| body parts
| Draws body parts from OBJECT:BODY files (such as body_default.txt)
'''Example:'''<br />
[BODY:BODY_WITH_HEAD_FLAG:HEART:GUTS:BRAIN:MOUTH] <br />
This is the body from a {{L|Purring maggot}}. It creates a body with head, a heart, some guts, a brain, and a mouth. Thats all a maggot needs.

|-
| BODY_APPEARANCE_MODIFIER
|
*ATTRIBUTE
*lowest:lower:low:median:high:higher:highest
| These body modifiers give individual creatures different characteristics. In the case of HEIGHT, BROADNESS and LENGTH, the modifier is also a percentage change to the BODY_SIZE of the individual creature. The seven numbers afterward give a distribution of ranges. Each interval has an equal chance of occurring.
'''Example:'''<br />
[BODY_APPEARANCE_MODIFIER:HEIGHT:90:95:98:100:102:105:110] <br />
''HEIGHT'' : marks the height to be changed <br />
''90:95:98:100:102:105:110'' : sets the range from the shortest (90% of the average height) to the tallest (110% of the average height) creature variation.

|-
| BODY_DETAIL_PLAN
| PlanName, PlanName:type:type:type:etc
| loads a plan listed OBJECT:BODY_DETAIL_PLAN files, such as b_detail_plan_default.txt. Mass applies USE_MATERIAL_TEMPLATE, mass alters RELSIZE, alters body part positions, and will allow tissue layers to be defined. Tissue layers are defined in order of skin to bone here.
'''Example:'''<br />
[BODY_DETAIL_PLAN:VERTEBRATE_TISSUE_LAYERS:SKIN:FAT:MUSCLE:BONE:CARTILAGE] <br />
This creates the detailed body of a {{L|fox}}, the skin, fat, muscle, bones and cartilage out of the vertebrate tissues.<br />
A {{L|Purring maggot|maggot}} would only need:<br />
''[BODY_DETAIL_PLAN:EXOSKELETON_TISSUE_LAYERS:SKIN:FAT:MUSCLE]''

|-
| BODY_SIZE
| years:days:size
| sets up size at a given time. Size is in cubic centimeters (milliliters), and for normal body materials is roughly equal to the creature's average weight in grams.
'''Example:'''<br />
[BODY_SIZE:0:0:10000]<br />
[BODY_SIZE:1:168:50000]<br />
[BODY_SIZE:12:0:220000]<br />
This describes the size of a {{L|minotaur}}. His birth size would be 10000 (10000 mL, ~10 kg). With 1 year and 168 days he would be 50000 tall (~50 kg). As an adult (with 12 years) he would weight roughly 220 kg

|-
| BODYGLOSS
| gloss
| Substitutes body part text with replacement text. Draws gloss information from OBJECT:BODY files (such as body_default.txt)

|-
| BONECARN
|
| Creature 'eats' bones. Eating bones makes their happiness go up, but can cause death (suffocation){{verify}}. Implies CARNIVORE.

|-
| BP_APPEARANCE_MODIFIER
|
*QUALITY
*lowest:lower:low:median:high:higher:highest
| sets up the breadth of possibilities for appearance qualities for a selected BP group. EG. Eyes (CLOSE_SET, DEEP_SET, ROUND_VS_NARROW, LARGE_IRIS),Lips (THICKNESS), Nose (BROADNESS, LENGTH, UPTURNED, CONVEX), Ear (SPLAYED_OUT, HANGING_LOBES, BROADNESS, HEIGHT), Tooth (GAPS), Skull (HIGH_CHEEKBONES, BROAD_CHIN, JUTTING CHIN, SQUARE_CHIN), Neck (DEEP_VOICE, RASPY_VOICE), Head (BROADNESS, HEIGHT)

|-
| BUILDINGDESTROYER
| 1 or 2
| Allows a creature to destroy furniture and buildings. Value [1] targets mostly doors, hatches, furniture and the like. Value [2] targets anything not made with the b + C commands.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==C==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| CAN_LEARN
|
| The creature gets skills and professions. Note that this token makes the creature unable to be butchered by an adventurer so it is not recommended for uncivilized monsters. Adventurers lacking this token can allocate but not increase attributes and skills. skills allocated will disappear on start.

|-
| CAN_SPEAK
|
| Can talk. Note that it is not necessary for a creature to gain social skills. If a member of a civilization (such as a pet) has this token, it'll need to eat and drink.{{verify}}

|-
| CANNOT_UNDEAD
|
| Cannot be turned into a zombie or skeletal undead. Also prevents ghosts of that creature appearing.

|-
| CANOPENDOORS
|
| Allows the creature to open doors.

|-
| CARNIVORE
|
| Creature ''only'' eats meat. Note that carnivorous species will not be able to survive worldgen if they do not also have NO_EAT.

|-
| CASTE
|
*name
| defines a caste

|-
| CASTE_ALTTILE
|
*tile number or "letter"
| Caste-specific alternate tile. Expects CASTE_TILE

|-
| CASTE_COLOR
|
*fg
*bg
*brightness
| Creature tile color of the caste.

|-
| CASTE_GLOWCOLOR
|
*fg
*bg
*brightness
| GLOWTILE color of the caste.

|-
| CASTE_GLOWTILE
|
*tile value or "letter"
| Caste-specific glowtile

|-
| CASTE_NAME
| singular:plural:adjective
| The name of the caste of the creature in the game.

|-
| CASTE_PROFESSION_NAME
|
*Profession
*singular
*plural
| alters the name of the given profession, caste-specific

|-
| CASTE_SOLDIER_ALTTILE
| 'character' or tile number
| Creatures of this caste active in their civilization's military will blink between their default tile and this one.

|-
| CASTE_SOLDIER_TILE
| 'character' or tile number
| Creatures of this caste active in their civilization's military will use this tile instead.

|-
| CASTE_SPEECH
| speech file?
| Possibly a caste-specific instance of the SPEECH token

|-
| CASTE_TILE
|
* tile number or "letter"
| Caste-specific creature tile.

|-
| CAVE_ADAPT
|
| Gives the creature a bonus in caves. Also causes [[Cave adaptation]].

|-
| CHANGE_BODY_SIZE_PERC
|
|

|-
| CHILD
| integer
| age at which creature is considered an adult. One can think of this as the duration of the child stage. Without this token, a creature will not reproduce in Fortress mode.

|-
| CHILDNAME
| singular:plural
| Defines a new name for a creature in child state at the caste level. For non-caste-specific child names, see GENERAL_CHILD_NAME.

|-
| CLUSTER_NUMBER
|
*min
*max
| The minimum/maximum numbers of how many creatures per spawned cluster. Certain vermin fish use this token in combination with temperate ocean and river biome tokens to perform seasonal migrations.
e.g. [CLUSTER_NUMBER:1:3]

|-
|CLUTCH_SIZE
|
*min
*max
|Number of eggs laid in one sitting.

|-
| COLONY_EXTERNAL
|
| Caste hovers around colony.

|-
| COLOR
| foreground:background:brightness
| Color of the creature's tile.

|-
| COMMON_DOMESTIC
|
| Allows the creature to be brought with immigrants and when creating a new fortress, as long as the creature also includes at least one of the following tokens: PET, PACK_ANIMAL, WAGON_PULLER, MOUNT. In addition, the creature must be NATURAL rather than FANCIFUL

|-
| CONVERTED_SPOUSE
|
| Found only at caste level. Creatures of this caste's species with the SPOUSE_CONVERTER and NIGHT_CREATURE_HUNTER tokens will kidnap SPOUSE_CONVERSION_TARGETs of an appropriate sex and convert them into castes with CONVERTED_SPOUSE.

|-
| COOKABLE_LIVE
|
| Set this to allow the creature to be cooked in meals without first being butchered / fishcleaned.

|-
| COPY_TAGS_FROM
|
*CREATURE NAME
| Copies tags from another specified creature.

|-
| CREATURE_CLASS
|
*classname
| Creature class. Can be anything, but only existing use is GENERAL_POISON. Appears to only be used for Syndromes. Supposedly can also be used for entity positions.

|-
| CREATURE_SOLDIER_TILE
| 'character' or tile number
| Creatures active in their civilization's military will use this tile instead.

|-
| CREATURE_TILE
| 'character' or tile number
| The symbol of the creature in ASCII mode.

|-
| CREPUSCULAR
|
| Sets if the creature is active at twilight.

|-
| CURIOUSBEAST_EATER
|
| Allows a creature to steal and eat edible items from a site.

|-
| CURIOUSBEAST_GUZZLER
|
| Allows a creature to (very quickly) drink your alcohol. Or spill the barrel to the ground. Also affects undead versions of the creature.

|-
| CURIOUSBEAST_ITEM
|
| Allows a creature to steal things (apparently the highest value it can find). Semimegabeast thievery is in Legends mode. Lightweight creatures can probably steal heavy items.

|-
| CV_ADD_TAG
|
*TAG NAME
| Adds a tag. Used in conjunction with creature variation templates.

|-
| CV_REMOVE_TAG
|
*TAG NAME
| Removes a tag. Used in conjunction with creature variation templates.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==D==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| DEMON
|
| Found on generated {{L|demon}}s; sets the creature as potential {{L|hell}} spawn

|-
| DESCRIPTION
| text
| A brief description of the creature type.

|-
| DIE_WHEN_VERMIN_BITE
|
| Dies upon attacking. Used for bee stings.

|-
| DIFFICULTY
| integer
| Toady: "Difficulty determines how deep it places them in adventure mode/reclaim caves, and the chance that they are wounded the first few river attacks." Also increases experience gain during adventure mode.

|-
| DIURNAL
|
| Sets if the creature is active in day.

|-
| DOES_NOT_EXIST
|
| Creature does not actually exist; used for fanciful creatures.

|-
| DRAGONFIREBREATH
|
| Creature breathes fire in a cone.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==E==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| EGG_MATERIAL
|
* {{L|material token}}
*state (SOLID, LIQUID, or GAS)
| Egg material. Egg-laying creatures will define this 3 times, using LOCAL_CREATURE_MAT:EGGSHELL, LOCAL_CREATURE_MAT:EGG_WHITE, and then LOCAL_CREATURE_MAT:EGG_YOLK. Eggs will be made out of eggshell. Edibility is determined by tags on whites or yolk, but they otherwise do not exist.

|-
| EGG_SIZE
|
*size
| Determines how long it takes for eggs to hatch{{verify}}. The larger the number, the longer it takes.

|-
| EQUIPMENT_WAGON
|
| Makes the creature into a large 3x3 creature responsible for carrying trade goods, pulled by two [WAGON_PULLER]s and driven by a merchant.

|-
| EQUIPS
|
| Allows the creature to wear or wield items.

|-
| EVIL
|
| Determines whether creature can show up on "evil" maps

|-
| EXTRACT
|
* {{L|material token}}
| Defines a creature extract which can be obtained via {{L|small animal dissection}}.

|-
| EXTRAVISION
|
| Creature can see regardless of whether it has working eyes.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==F==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| FANCIFUL
|
| Makes every civilization know about the creature. The creature won't occur in regular material preference lists. The tag also adds some art value modifiers. Used for things like dragons and other legendary creatures.

|-
| FEATURE_ATTACK_GROUP
|
| Found on subterranean animalmen.

|-
| FEATURE_BEAST
|
| Found on {{L|forgotten beast}}s.

|-
| FEMALE
|
| Inside a female caste, sets femaleness. Outside of a caste, sets all individuals female unless overridden by caste.

|-
| FIREBREATH
|
| The creature breathes fire projectiles (as opposed to DRAGONFIREBREATH, which is in a cone).

|-
| FIREIMMUNE
|
| ?

|-
| FIREIMMUNE_SUPER
|
| The creature is immune to DRAGONFIREBREATH. Implies FIREIMMUNE.

|-
| FISHITEM
|
| Needs to be cleaned at a fishery

|-
| FIXED_TEMP
| temperature
| The natural heat generated by the creature.

|-
| FLEEQUICK
|
| Determines how soon a creature flees in a losing battle.

|-
| FLIER
|
| Allows a creature to fly. Fortress Mode pathfinding only partially incorporates pathfinding - flying dwarves need a land path to exist between them and an area in order to access it, but as long as one such path exists, they do not need to use it, instead being able to fly over intervening obstacles.

|-
| FREQUENCY
|
*number, max 100
| Determines the time between creature spawns in Fortress Mode. Higher is more occurrences per time unit. Creatures without a frequency statement default to 50. Almost all others have either [FREQUENCY:5] or [FREQUENCY:100]. Not to be confused with POP_RATIO
|}

<div align="center">
{{alphabetical TOC}}
</div>

==G==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| GENERAL_BABY_NAME
| singular:plural
| name at creature level

|-
| GENERAL_CHILD_NAME
| singular:plural
| name at creature level

|-
| GENERATED
|
| Found on procedurally generated creatures like {{L|Forgotten beast}}s, (biome name) {{L|titan}}s, {{L|Demon}}s, and {{L|night creature}}s.

|-
| GETS_INFECTIONS_FROM_ROT
|
| Creature can get infections from necrotic tissue.

|-
| GETS_WOUND_INFECTIONS
|
| Creature's wounds can become infected.

|-
| GLOWCOLOR
|
*foreground
*background
*brightness
| The colour of the GLOWTILE of the creature.

|-
| GLOWTILE
| ascii character
| If present, the being glows in the dark (generally used for Adventure Mode). The tile is what replaces the being's current tile when it is obscured from your sight by darkness. The default setting for kobolds (a yellow quotation mark) provides a nice "glowing eyes" effect. The game is also hardcoded to automatically convert quotation mark GLOWTILES into apostrophes if the creature has lost one eye. This works at the generic creature level - for caste-specific glow tiles, use CASTE_GLOWTILE instead.

|-
| GNAWER
| verb (gnawed)
| The creature chews on food barrels and bags.

|-
| GO_TO_END
|
| When using tags from an existing creature, inserts new tags at the end of the creature.

|-
| GO_TO_START
|
| When using tags from an existing creature, inserts new tags at the beginning of the creature.

|-
| GO_TO_TAG
|
| When using tags from an existing creature, inserts new tags after the specified tag.

|-
| GOOD
|
| Determines whether creature can show up on "good" areas. Eg. unicorn.

|-
| GRASSTRAMPLE
| value
| Determines the percentage chance (or possibly wait time until next trample) of trampling and killing grass when a creature steps on it. Delete the tag to make the creature never trample grass.

|-
| GRAVITATE_BODY_SIZE
| target value
| Used in Creature Variants. This token changes the body size to the average of the old body size and the target value. Unknown how it interacts with growth stages.{{verify}}

|-
| GRAZER
|
*number
| Animals is a grazer. The higher the number, the less frequently it needs to eat in order to survive.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==H==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| HABIT
| type:probability
| Defines certain behaviors for the creature. The habit types are COLLECT_TROPHIES, COOK_PEOPLE, COOK_VERMIN, GRIND_VERMIN, COOK_BLOOD, GRIND_BONE_MEAL, EAT_BONE_PORRIDGE, USE_ANY_MELEE_WEAPON, GIANT_NEST, and COLLECT_WEALTH. These may require the creature to have a lair to work properly.

|-
| HABIT_NUM
| number or TEST_ALL
| Unknown. All lists of HABITs are preceded by [HABIT_NUM:TEST_ALL]

|-
| HAS_NERVES
|
| This makes the creature susceptible to severed motor and sensory nerves when muscles are torn in limb, grasp and stance parts. Some butchering yields nervous tissue.

|-
| HASSHELL
|
| The creature has a shell. Seemingly no longer used - holdover from previous versions.

|-
| HIVE_PRODUCT
|
*number
*{{L|time}}
*{{L|item token}}s
| What product is harvested from {{L|Beekeeping industry|beekeeping}}.

|-
| HOMEOTHERM
|
| Default 'NONE'. The creature's normal body {{L|temperature}}

|-
| HUNTS_VERMIN
|
| Creature hunts and kills nearby vermin.

|}

<div align="center">
{{alphabetical TOC}}
</div>

==I==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| IMMOBILE_LAND
|
| The creature is immobile while on land. Only works on AQUATIC creatures which can't breath on land.

|-
| IMMOLATE
|
| Will ignite, and potentially completely destroy, items the creature is standing on. Keep booze away from critters with this tag.

|-
| INTELLIGENT
|
| Implies CAN_SPEAK and CAN_LEARN. CAN_LEARN probably means the creature gets skills - including social skills - and professions. Not recommended for uncivilized monsters.

|-
| ITEMCORPSE
|
* {{L|item token}}:subtype
* {{L|material token}}
| Determines if the creature leaves behind a non-standard corpse (i.e. wood, statue, bars, ash from ghost etc).

|-
| ITEMCORPSE_QUALITY
|
| The quality of an item-type corpse left behind; 5 is masterpiece-level.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==L==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| LAIR
| type:probability
| Found on megabeasts, semimegabeasts, and night creatues. The creature will seek out sites of this type and take them as lairs. The lair types are SIMPLE_BURROW, SIMPLE_MOUND, WILDERNESS_LOCATION, SHRINE, and LABYRINTH.

|-
| LAIR_CHARACTERISTIC
| characteristic:probability
| Defines certain features of the creature's lair. The only known valid characteristic is HAS_DOORS.

|-
| LAIR_HUNTER
|
| This creature will actively hunt adventurers in its lair.

|-
| LAIR_HUNTER_SPEECH
| speech file
| What this creature says while hunting adventurers in its lair.

|-
| LARGE_PREDATOR
|
| Will attack things that are smaller than it (like dwarves). Only one group of "large predators" will appear on any given map (possibly two groups on "savage" maps). In adventure mode, large predators will try to ambush and attack you (and your party will attack them back). Also, they can be mentioned in the intro paragraph when starting a fortress e.g. "ere the wolves get hungry."

|-
| LARGE_ROAMING
|
| In Fortress Mode, spawns outdoors and is not a vermin creature.

|-
| LAYS_EGGS
|
| Creature lays eggs instead of giving birth to live young.

|-
| LAYS_UNUSUAL_EGGS
|
* {{L|item token}}
* {{L|material token}}
| Creature lays a particular item instead of regular eggs.

|-
| LIGAMENTS
|
* {{L|material token}}
*healing rate
| Defines the material and healing rate of ligaments.

|-
| LIGHT_GEN
|
| The creature will generate light, such as in adventurer mode at night.

|-
| LIKES_FIGHTING
|
| The creature will attack enemies rather than flee from them. This tag has the same effect on player-controlled creatures - included modded dwarves.

|-
| LISP
|
| Creature multiplies 'S' when talking. Ex: "My name isss Recisssiz."

|-
| LITTERSIZE
|
* minumum
* maximum
| Determines the random chance of how many creatures are generated when giving birth. [LITTERSIZE:1:2]

|-
| LOCKPICKER
|
| Lets a creature open doors that are set to forbidden in Fortress Mode.

|-
| LOOSE_CLUSTERS
|
| The creatures will scatter if they have this tag, or form tight packs if they don't.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==M==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| MAGICAL
|
| Unknown.

|-
| MAGMA_VISION
|
| Creature's able to see while covered in magma.

|-
| MALE
|
| The species or caste is all male.

|-
| MANNERISM_??
|
*occassionally body part
| Adds a possible mannerism to the creature's profile.
Refer to {{L|Creature mannerism token}}s

|-
| MATERIAL
|
*material id
| Begins defining a new material.{{verify}}

|-
| MATERIAL_BREATH_ATTACK
|
* {{L|material token}}
* breath attack type (TRAILING_DUST_FLOW, TRAILING_VAPOR_FLOW, TRAILING_GAS_FLOW, SOLID_GLOB, LIQUID_GLOB, UNDIRECTED_GAS, UNDIRECTED_VAPOR, UNDIRECTED_DUST)
| Creates an attack referencing a material, using a given type of breath attack.

|-
| MATUTINAL
|
| Sets if the creature is active in dawn.

|-
| MAXAGE
| min:max
| Range of time in years in which death from old age may occur. Once a creature reaches the min value, it has a random chance each season of dying from old age. Unknown if the chance increases with further age.

|-
| MEANDERER
|
| Gives a creature random movement.

|-
| MEGABEAST
|
| Appears on fortress territory in Fortress Mode occasionally. Can also be worshipped.

|-
|MENT_ATT_CAP_PERC
|
*ATTRIBUTE Token
*Cap %
|Default is 200. This means you can increase your attribute to 200% of its starting value (or the average value + your starting value if that is higher).

|-
| MENT_ATT_RANGE
|
*ATTRIBUTE
*lowest:lower:low:median:high:higher:highest
| Sets up a mental attribute's range of values (0-5000). All mental attribute ranges default to 200:800:900:1000:1100:1300:2000.

|-
| MENT_ATT_RATES
|
*ATTRIBUTE Token
*cost to improve
*unused counter rate
*rust counter rate
*demotion counter rate
| Mental attribute gain/decay rates. Defaults are 500:4:5:4.

|-
| MILKABLE
|
* {{L|material token}}
* frequency
| Allows the creature to be milked.

|-
| MISCHIEVIOUS
|
| Will pull any levers it comes across. Also makes creature spawn invisible and with several ranks in Ambusher. "They go on little missions to mess with various fortress buildings, not just levers."

|-
| MODVALUE
|
| Seemingly no longer used - holdover from previous versions.

|-
| MOUNT
|
| Creature may be used as a mount.

|-
| MOUNT_EXOTIC
|
| You need the Dungeon master noble to mount the creature.

|-
| MULTIPLE_LITTER_RARE
|
| Makes litters with more than one offspring rare.

|-
| MULTIPLY_VALUE
|
*Multiplier
| Multiplies value of materials.

|-
| MUNDANE
|
| Marks if the creature is an actual real-life creature. Only used for age-names at present, and determining whether a creature will attack creatures with the AT_PEACE_WITH_WILDLIFE token.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==N==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| NAME
| singular:plural:adjective
| The generic name for any creature of this type - will be used when distinctions between caste are unimportant. For names for specific castes, use CASTE_NAME instead.

|-
| NATURAL
|
| Animal is considered to be natural.

|-
| NATURAL_SKILL
| skill:value
| The creature possesses this skill at this level inherently. It begins with this skill at this level, and the skill may never rust below this level. Requires CAN_LEARN or INTELLIGENT to function (changed in .25 or earlier that CAN_LEARN is no longer required).

|-
| NIGHT_CREATURE_BOGEYMAN
|
| Found on bogeymen. Creatures with this tag will join other bogeymen in attacking adventurers at night, and will also adopt their other behaviors, such as vanishing in smoke upon being killed. Setting the number of night creatures to zero in the world gen parameters will remove only the randomly-generated bogeymen.

|-
| NIGHT_CREATURE_HUNTER
|
| If this creature has SPOUSE_CONVERTER, it will actively attempt to seek out potential conversion targets, abduct them, and convert them. Night creatures will seek out one SPOUSE_CONVERSION_TARGET <s>of the opposite sex</s>(seems to choose anyone of any sex of the caste/s that have the CONVERTED_SPOUSE tag), convert them, and then have children with them(if possible). NIGHT_CREATURE_HUNTERs without SPOUSE_CONVERTER will not be placed. Setting the number of night creatures to zero in the world gen parameters will remove only the randomly-generated night creatures.

|-
| NO_AUTUMN
|
| does not appear this season.

|-
| NO_DIZZINESS
|
| Creature cannot become dizzy

|-
| NO_DRINK
|
| Creature does not need to drink.

|-
| NO_EAT
|
| Creature does not need to eat.

|-
| NO_FEVERS
|
| Creature cannot suffer fevers

|-
| NO_GENDER
|
| Creature has no gender.

|-
| NO_SLEEP
|
| Creature does not need to sleep.

|-
| NO_SPRING
|
| does not appear this season.

|-
| NO_SUMMER
|
| does not appear this season.

|-
| NO_THOUGHT_CENTER_FOR_MOVEMENT
|
| Creatures doesn't require an organ with the [THOUGHT] tag to survive; generally used on creatures that don't have brains.

|-
| NO_WINTER
|
| does not appear this season.

|-
| NOBONES
|
| Creature has no bones.

|-
| NOBREATHE
|
| Creature doesn't need to breathe or have [BREATHE] parts in body. Cannot drown or be strangled.

|-
| NOCTURNAL
|
| Sets if the creature is active in night.

|-
| NOEMOTION
|
| The creature has no emotions, and does not rage.

|-
| NOEXERT
|
| Creature can't become tired or over-exerted.

|-
| NOFEAR
|
| Creature doesn't feel fear and will never run away from battle.

|-
| NOMEAT
|
| Creature will not drop meat on butcher.

|-
| NONAUSEA
|
| Creature can't vomit.

|-
| NOPAIN
|
| Creature doesn't feel pain.

|-
| NOSKIN
|
| Creature will not drop skin on butcher.

|-
| NOSKULL
|
| Creature will not drop skull on butcher, rot, or decay of severed head.

|-
| NOSMELLYROT
|
| Does not produce miasma when rotting

|-
| NOSTUCKINS
|
| Weapons can't be stuck in creature.

|-
| NOSTUN
|
| Creature can't be stunned. Creatures with this tag never wake up from sleep in Fortress Mode and stay drowsy. If this creature must eat and drink while playing, it WILL die.

|-
| NOT_BUTCHERABLE
|
| Cannot be butchered

|-
| NOTHOUGHT
|
| Creature doesn't think, or doesn't require a [BRAIN] body part.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==P==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| PACK_ANIMAL
|
| Allows the creature to be used as a pack animal. Currently only used by merchants.

|-
| PARALYZEIMMUNE
|
| The creature is immune to all paralyzing special attacks.

|-
| PATTERNFLIER
|
|

|-
| PEARL
|
| Creature will generate pearls.

|-
| PENETRATEPOWER
| value
| Controls the ability of vermin to find a way into containers when they are eating food from your stockpiles. Wood and cloth objects roll a 0-9 and if it's greater than the penetrate power, their contents escape for the time being. Other objects roll a 0-99.

|-
| PERSONALITY
|
*ATTRIBUTE
*lowest:median:highest
| Determines the range and chance of personality traits. Standard is 0:50:100. See [[DF2010:Personality_trait|Personality traits]] for more info.

|-
| PET
|
| Allows the creature to be tamed. Also allows all females of the species to breed regardless of marital status.

|-
| PET_EXOTIC
|
| You need a Dungeon master noble in your fortress for the creature to be tamable (but any Animal trainer can do the taming).

|-
| PETVALUE
| value
| How valuable a tamed animal/pet is. Actual cost in points in the embarking screen is (PETVALUE/2)+1 for an untrained animal, PETVALUE+1 for a trained(War or Hunting) one. Note that for an animal to be selectable in this screen, it must have the COMMON_DOMESTIC token.

|-
| PETVALUE_DIVISOR
| value
| Divides the creature's PETVALUE by the specified number. Used for bees to prevent a single hive from being worth a fortune.

|-
|PHYS_ATT_CAP_PERC
|
*ATTRIBUTE Token
*Cap %
|Default is 200. This means you can increase your attribute to 200% of its starting value (or the average value + your starting value if that is higher).

|-
| PHYS_ATT_RANGE
|
*ATTRIBUTE
*lowest:lower:low:median:high:higher:highest
| Sets up a physical attribute's range of values (0-5000). All physical attribute ranges default to 200:700:900:1000:1100:1300:2000.

|-
| PHYS_ATT_RATES
|
*ATTRIBUTE Token
*cost to improve
*unused counter rate
*rust counter rate
*demotion counter rate
| Physical attribute gain/decay rates. Defaults for STRENGTH, AGILITY, TOUGHNESS, and ENDURANCE are 500:3:4:3, while RECUPERATION and DISEASE_RESISTANCE default to 500:NONE:NONE:NONE.

|-
| PLUS_BP_GROUP
|
*BY_TYPE, BY_CATEGORY, or BY_TOKEN
*body type, category, or token
| Adds a body part group to selected body part group. Presumably used immediately after SET_BP_GROUP.

|-
| PLUS_MATERIAL
|
*material
| Adds a material to selected materials. Used immediately after SELECT_MATERIAL.

|-
| POP_RATIO
|
| Weighted population of caste; Lower is rarer. Not to be confused with FREQUENCY.

|-
| POPULATION_NUMBER
| min:max
| old guess: "The minimum/maximum numbers of how many of these creatures can show up on a map per year."<br>Toady: "Pop number is the number per square of the region, I think."

|-
| POWER
|
|Allows the being to represent itself as a deity. Requires CAN_SPEAK to actually do anything more than settle at a location.

|-
| PREFSTRING
| string
| Sets what other creatures like about this creature. "Urist likes dwarves for their beards." Multiple entries will be chosen from at random

|-
| PROFESSION_NAME
|
*Profession
*singular
*plural
| The generic name for members of this profession, at the creature level. In order to give members of specific castes different names for professions, use CASTE_PROFESSION_NAME instead.

|-
| PRONE_TO_RAGE
| number
| Untested effect, though it clearly affects how likely a creature is to become enraged. Number may be percentage chance of becoming enraged during combat. As described in file_changes.txt, creatures with this token "follow its normal behavior, but flip out on occasion, higher rate = more flipping out".

|-
| PUS
|
* {{L|material token}}
*matter state (LIQUID, GAS, SOLID)
| Specifies what the creature's wounds will ooze when infected.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==R==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| RELSIZE
|
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*body category, type, or token
*Relsize
| Specifies a new relative size for a part than what is stated in the body plan. For example, Dwarves have larger livers.

|-
| REMAINS
| singular:plural
| What creature's remains are called.

|-
| REMAINS_COLOR
|
| What color creature's remains are.

|-
| REMAINS_ON_VERMIN_BITE_DEATH
|
| Leaves remains when its attack causes it to die? Seems to go with DIE_WHEN_VERMIN_BITE.

|-
| REMAINS_UNDETERMINED
|
| Unknown.

|-
| REMOVE_MATERIAL
|
*material token
| Removes a material from a creature.

|-
| REMOVE_TISSUE
|
*material token
| Removes a tissue from a creature.

|-
| RETURNS_VERMIN_KILLS_TO_OWNER
|
| Used with HUNTS_VERMIN, causes the creature to return killed vermin to its owner.

|}

<div align="center">
{{alphabetical TOC}}
</div>

==S==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| SAVAGE
|
| Allows creature to show up on (and limits it to) "savage" maps.

|-
| SECRETION
|
* {{L|material token}}
*Material State
*location secreted from (by_type, by_category, by_token)
*body part
*tissue layer
| creates a secreted material on given tissue on a given part of the body.

|-
| SELECT_ADDITIONAL_CASTE
|
*caste name
| adds an additional previously defined caste to the selection. Used immediately after SELECT_CASTE.

|-
| SELECT_CASTE
|
*caste name, or ALL
| selects a previously defined caste

|-
| SELECT_MATERIAL
|
*Material token
| Selects a locally defined material. Can be ALL.

|-
| SEMIMEGABEAST
|
| Appears as boss creature in quests. Makes history by rampaging around towns. Possibly inhabits non-mountain caves.

|-
| SET_BP_GROUP
|
*selection criteria BY_TYPE, BY_CATEGORY, BY_TOKEN
*category, type, or token
| Begins a selection of body parts.

|-
| SET_TL_GROUP
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
*tissue
| begins a selection of tissue layers

|-
| SHEARABLE_TISSUE_LAYER
|
* tissue modifier
* required value
| Tissue layer can be sheared for its component material. The specified modifier must be at least of the desired value for shearing to be possible (a llama's wool must have a LENGTH of 300 before it is shearable).

|-
| SKILL_LEARN_RATE
| {{L|skill_token}}:percentage
| The rate at which this creature learns this skill. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SKILL_LEARN_RATES
| percentage
| The rate at which this creature learns all skills. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SKILL_RATE
| {{L|skill_token}}:percentage:value:value:value
| As SKILL_RATES for individual skills. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SKILL_RATES
|
*% of improvement points you get
*unused counter rate
*rust counter rate
*demotion counter rate
| Affects skill gain and decay. Lower numbers in the last three slots make decay occur faster ([SKILL_RATES:100:1:1:1] would cause rapid decay). The counter rates may also be replaced with NONE.
Default is [SKILL_RATES:100:8:16:16]. [SLOW_LEARNER] changes the 100 to a 50. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SKILL_RUST_RATE
| {{L|skill_token}}:value:value:value
| The rate at which this skill decays. Lower values cause the skill to decay faster. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SKILL_RUST_RATES
| value:value:value
| The rate at which all skills decay. Lower values cause the skills to decay faster. Requires CAN_LEARN or INTELLIGENT to function.

|-
| SLOW_LEARNER
|
| Similar to [CAN_LEARN], but slower; skills are gained at a fraction of the rate. Present in the entries for ogres and giants; can be applied to civ or player races.

|-
| SMALL_REMAINS
|
| If a creature has this token, it'll leave "remains" instead of a corpse.

|-
| SOLDIER_ALTTILE
| 'character' or tile number
| If this creature is active in its civilization's military, it will blink between its default tile and this one.

|-
| SOUND
|
* Sound application (currently accepts ALERT or PEACEFUL_INTERMITTENT)
* Sound range (in tiles)
* Sound delay (lower values = sound is produced more often)
* VOCALIZATION or NONE (determines whether the sound requires breathing or not)
* First-person description
* Third-person description
* Description when out of sight
| Creature makes sounds periodically, which can be heard in Adventure mode.

|-
| SPECIFIC_FOOD
|
* PLANT or CREATURE
* Plant/creature ID
| Indicates that the creature is only capable of eating a particular type of food.

|-
| SPEECH
| speech file
| Boasting speeches relating to killing this creature. Examples include dwarf.txt and elf.txt in data\speech.

|-
| SPEECH_FEMALE
| speech file
| Boasting speeches relating to killing females of this creature.

|-
| SPEECH_MALE
| speech file
| Boasting speeches relating to killing males of this creature.

|-
| SPEED
| value
| Sets the creatures' movement and work speed, 1000/[100 + SPEED X] is the resulting effect on creatures movement and work rates from default. See {{L|Speed}} for more information.

|-
| SPHERE
|
*sphere name
| Sets what religious spheres the creature is aligned to, for purposes of being worshipped via the [POWER] token. Also affects the layout of hidden fun stuff, and the creature's name.

|-
| SPOUSE_CONVERSION_TARGET
|
| This creature can be converted by a night creature with SPOUSE_CONVERTED.

|-
| SPOUSE_CONVERTER
|
| Enables the creature to convert SPOUSE_CONVERSION_TARGETs into CONVERTED_SPOUSE castes of its species. The creature won't actually actively do this unless it also has NIGHT_CREATURE_HUNTER, however.

|-
| SWIM_SPEED
|
*speed
| How fast the creature swims. Typically 2500 (0.38 times the default speed).

|-
| SWIMS_INNATE
|
| The creature naturally knows how to swim, as opposed to [SWIMS_LEARNED] below. Currently, an AI bug prevents this from being useful on PC races in fortress mode.

|-
| SWIMS_LEARNED
|
| The creature doesn't know how to swim unless it has learned the skill. Requires [CAN_LEARN], obviously.

|}

<div align="center">
{{alphabetical TOC}}
</div>

==T==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| TENDONS
|
* {{L|material token}}
*healing rate
| Defines the material and healing rate of tendons.

|-
| THICKWEB
|
| The creature's webs can catch larger creatures.

|-
| TISSUE
| name
| Begins defining a tissue in the creature file.

|-
| TITAN
|
| Found on {{L|titan}}s.

|-
| TL_COLOR_MODIFIER
| COLOR:freq:COLOR:freq etc
| Creates a list of color patterns, giving each a frequency.

|-
| TLCM_GENETIC_MODEL
|
| tissue layer color modifier is passed to offspring genetically?

|-
| TLCM_IMPORTANCE
|
*number
| Presumably modifies the importance of the tissue layer color modifier, for description purposes.
HOWEVER using this appears to remove all mention of colour from creature descriptions. It does not appear in any default creatures.

|-
| TLCM_NOUN
|
*name
*SINGULAR or PLURAL
| names the tissue layer color modifier, and determines the noun

|-
| TLCM_TIMING
|
*ROOT
*start change window years:days:end change window years:days
| determines the point in the creature's life where the color change begins

|-
| TRADE_CAPACITY
|
| How much the creature can carry when used by merchants.

|-
| TRAINABLE
|
| Implies both [TRAINABLE_HUNTING] and [TRAINABLE_WAR].

|-
| TRAINABLE_HUNTING
|
| Can be trained as hunting beasts by way of kennels.

|-
| TRAINABLE_WAR
|
| Can be trained as war beasts by way of kennels.

|-
| TRANCES
|
| Allows the creature to go into martial trances.

|-
| TRAPAVOID
|
| The creature is immune to traps. Probably every procedurally generated megabeast has this.

|-
| TRIGGERABLE_GROUP
| min:max
| A large swarm of vermin can be disturbed, usually in Adventure mode.{{verify}}

|-
| TSU_NOUN
|
*noun
*SINGULAR or PLURAL
| Noun for the TISSUE_STYLE_UNIT, used in the description of the tissue layer's style.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==U==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| UBIQUITOUS
|
| Creature will occur in every region with the correct biome. Does not apply to evil/good tags.

|-
| UNDERGROUND_DEPTH
|
*mindepth
*maxdepth
| Depth the creature appears underground. Numbers can be from 1 to 5. Only magma creatures use 4 or 5 in the default raws. A single argument may be used instead of min and max. Dwarven civilizations will only export (via the embark screen or caravans) things that available at depth 1.

|-
| UNDERSWIM
|
| Creature swims under the water and can't be seen.{{verify}}

|-
| UNIQUE_DEMON
|
| Typically found on generated {{L|demon}}s; causes the game to create a single named instance of the demon which will emerge from the underworld and take over civilizations during worldgen. Cannot be used for modder-defined creatures.

|-
| USE_CASTE
|
*new caste token
*old caste token
| Defines a new caste derived directly from a previous caste. The new caste inherits all properties of the old one. The effect of this tag is automatic if one has not yet defined any castes: "Any caste-level tag that occurs before castes are explicitly declared is saved up and placed on any caste that is declared later, unless the caste is explicitly derived from another caste."

|-
| USE_MATERIAL
|
*new material token
*old material id
| Defines a new local creature material and populates it with all properties defined in the specified material. Old material id accepts any valid material id, including INORGANIC:X, CREATURE_MAT:C:X, LOCAL_CREATURE_MAT:X, and others (where X is a material id from that set, and C is a valid creature id).{{verify}}

|-
| USE_MATERIAL_TEMPLATE
|
*new material token
*material template
| Defines a new local creature material and populates it with all properties defined in the specified template.

|-
| USE_TISSUE
|
*new tissue token
*old tissue id
| Defines a new local creature tissue and populates it with all properties defined in the local tissue specified in the second argument.

|-
| USE_TISSUE_TEMPLATE
|
*new tissue token
*tissue template
| Loads a tissue template listed in OBJECT:TISSUE_TEMPLATE files, such as tissue_template_default.txt.

|-
| UTTERANCES
|
| Changes the language of the creature into an unintelligible mess.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==V==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| VEGETATION
|
| unknown

|-
| VERMIN_BITE
|
*chance of occurance{{verify}}
*verb (bitten, stung, etc)
* {{L|material token}}
| Vermin bites, and injects something.

|-
| VERMIN_EATER
|
| The vermin creature will attempt to eat exposed food. See PENETRATEPOWER. Distict from VERMIN_ROTTER.

|-
| VERMIN_FISH
|
| The vermin appears in water and will attempt to swim around.

|-
| VERMIN_GROUNDER
|
| The creature appears in "general" surface ground locations. Note that this doesn't stop the creature from flying if it can (most vermin birds have this tag).

|-
| VERMIN_HATEABLE
|
| Some dwarves will hate the creature and get unhappy thoughts when around it.

|-
| VERMIN_MICRO
|
| This makes the creature move in a swarm of creatures of the same race as it. I.E. Swarm of flies, swarm of ants, etc.

|-
| VERMIN_NOFISH
|
| The creature cannot be caught by fishing.

|-
| VERMIN_NOROAM
|
| The creature will not be observed randomly roaming about the map.

|-
| VERMIN_NOTRAP
|
| The creature cannot be caught in baited animal traps; however, a "catch live land animal" task may still be able to capture one if a dwarf finds one roaming around.

|-
| VERMIN_ROTTER
|
| Present on flies, knuckle worms, acorn flies, and blood gnats. Probably means either the creature is attracted to rot, the creature speeds rotting, or both.

|-
| VERMIN_SOIL
|
| The creature randomly appears near dirt or mud.

|-
| VERMIN_SOIL_COLONY
|
| The vermin will appear in a single tile cluster of many vermin, such as a colony of ants.

|-
| VERMINHUNTER
|
| Implies AT_PEACE_WITH_WILDLIFE, RETURNS_VERMIN_KILLS_TO_OWNER, HUNTS_VERMIN, and ADOPTS_OWNER.

|-
| VESPERTINE
|
| Sets if the creature is active in evening.

|-
| VIEWRANGE
| value
| Value should determine how close you have to get to a critter before it attacks (or prevents adv mode travel etc.) Default is 20.
|}

<div align="center">
{{alphabetical TOC}}
</div>

==W==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| WAGON_PULLER
|
| Allows the creature to pull caravan wagons.

|-
| WEBBER
|
* {{L|material token}}
| Allows the creature to create webs, and defines what the webs are made of.

|-
| WEBIMMUNE
|
| The creature will not get caught in thick webs.
|}

==Attack Tokens==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| ATTACK_SKILL
|
*skill used ({{L|Skill token}})
| defines the attack skill used

|-
| ATTACK_VERB
| 2nd person:3rd person
| descriptive text for the attack

|-
| ATTACK_CONTACT_PERC
|
*% value
| amount of available tissue used in attack

|-
| ATTACK_PENETRATION_PERC
|
*% value
| probably amount of material that makes contact when penetration is done

|-
| ATTACK_PRIORITY
|
*MAIN or SECOND
| use of the attack in combat. Secondary attacks are only used if main attacks are impossible.

|-
| ATTACK_VELOCITY_MODIFIER
| number
| Modifies the attack velocity. Believed to be percent based (so 100 would be "normal"). May be on same scale as weapon velocity (where 1000 is "normal").

|-
| ATTACK_FLAG_CANLATCH
|
| Enables an attacker to occasionally latch on with the bodypart used by an attack when an attack with this flag in its definition is made.

|-
| ATTACK_FLAG_WITH
|
| In adventure mode, displays the name of the body part used by an attack when announcing the attack.

|-
| ATTACK_FLAG_EDGE
|
| attack type

|-
| SPECIALATTACK_INJECT_EXTRACT
|
* {{L|material token}}
*state (SOLID, LIQUID, GAS)
*min:max
| attack type addition that injects a material into the victim.

|-
| SPECIALATTACK_SUCK_BLOOD
| min:max
| Successful attack draws out an amount of blood randomized between the min and max value.
|}

==Important Related Tokens==
These next groups of tokens include several tokens that are not technically classified as creature tokens in string dump, but bear mentioning in this as they are used frequently in creature raws. (Some regular creature tokens may also be reprinted for the sake of ease of navigation)

===Tissue Modification===
This next group of tokens deals setting and modifying tissue properties. (See also {{L|Tissue definition token}})

{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| INSULATION
|
*value
| Tissue supplies the creature with heat insulation. Higher values result in more insulation.

|-
| PLUS_TISSUE_LAYER
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
| Adds a tissue to those selected

|-
| PLUS_TL_GROUP
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
*tissue
| continues a selection of tissue layers

|-
| SELECT_TISSUE
|
*tissue token
| Selects a tissue for editing.

|-
| SELECT_TISSUE_LAYER
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token | Selects a tissue at a location
* (optional) FRONT, BACK, LEFT, RIGHT, TOP, BOTTOM, AROUND.
| Selects a tissue layer for descriptor and cosmetic purposes.

|-
| SET_LAYER_TISSUE
|
| Sets a tissue layer to be made of a different tissue.

|-
| TISSUE_LAYER
|
*BY_TYPE, BY_CATEGORY, BY_TOKEN
*TYPE,CATEGORY, or TOKEN
*TISSUE
*LOCATION
| Adds the tissue layer to wherever it is required.
Non-argument Locations can be FRONT, RIGHT, LEFT, TOP, BOTTOM. Argument locations are AROUND and CLEANS, requiring a further body part and a % of coverage/cleansing

|-
| TISSUE_LAYER_OVER
|
*BY_TYPE, BY_CATEGORY, BY_TOKEN
*TYPE,CATEGORY, or TOKEN
*TISSUE
*LOCATION
| Presumably a counterpart to TISSUE_LAYER_UNDER (see below).

|-
| TISSUE_LAYER_UNDER
|
*BY_TYPE, BY_CATEGORY, BY_TOKEN
*TYPE,CATEGORY, or TOKEN
*TISSUE
| Adds the tissue layer under a given part.
For example an Iron Man has a gaseous poison within and this tissue (GAS is its name) has the token [TISSUE_LEAKS] and its state is GAS so when you puncture the iron outside and damage this tissue it leaks gas (can have a syndrome by using a previous one in the creature sample.) [TISSUE_LAYER_UNDER:BY_CATEGORY:ALL:{tissue}] {tissue} is what will be under the TISSUE_LAYER here is an example Tissue from Iron Man
[TISSUE:GAS]
[TISSUE_NAME:gas:NP] [TISSUE_MATERIAL:LOCAL_CREATURE_MAT:GAS] [TISSUE_MAT_STATE:GAS] [RELATIVE_THICKNESS:50] [TISSUE_LEAKS] [TISSUE_SHAPE:LAYER]

|-
| TISSUE_LAYER_APPEARANCE_MODIFIER
|
*QUALITY
*lowest:lower:low:median:high:higher:highest
| sets the range of qualities, including LENGTH, DENSE, HIGH_POSITION, CURLY, GREASY, WRINKLY

|-
| TISSUE_LEAKS
|
| The selected tissue leaks out of the creature when the layers above it are pierced. As per an iron man's internal poison gas.

|-
| TISSUE_MATERIAL
|
*VALUE (material)
*MATERIAL (material subtype)
| Defines the tissue material. VALUE can be LOCAL_CREATURE_MAT, INORGANIC etc. MATERIAL is a subtype of the material, e.g. [TISSUE_MATERIAL:INORGANIC:BRONZE]

|-
| TISSUE_STYLE_UNIT
|
*tissue
*shaping
| sets tissue to be in a certain shape, mostly used with tissues HAIR, BEARD, MOUSTACHE, SIDEBURNS.

|-
| TL_COLOR_MODIFIER
| COLOR:freq:COLOR:freq etc
| Creates a list of color patterns, giving each a frequency.

|-
| TL_CONNECTS
|
| Presumably gives the CONNECTS attribute to selected layers.

|-
| TL_HEALING_RATE
|
| Presumably changes the HEALING_RATE of the selected tissue layers.

|-
| TL_MAJOR_ARTERIES
|
| Gives Major Artery attribute to selected layers.

|-
| TL_PAIN_RECEPTORS
|
| Seems to set new number of pain receptors for selected tissue layers.

|-
| TL_RELATIVE_THICKNESS
|
| Seems to set new relative thickness for selected tissue layers.

|-
| TL_VASCULAR
|
| Seems to set new a VASCULAR value (which modulates bleeding) for selected tissue layers.

|}

==See Also==
*{{L|Body detail plan token}}
*{{L|Body token}}
*{{L|Material definition token}}
*{{L|Syndrome}}
*{{L|Tissue definition token}}

{{Category|Modding}}
{{Category|Tokens}}

v0.34:Goblinite

2011-07-25T06:02:05Z

I2amroy:

{{D for Dwarf}}
'''Goblinite''' is an important ore of [[iron]] (and sometimes [[copper]], [[bronze]], and [[silver]], depending on your version). Unlike other ores, goblinite is not restricted to any particular layer, though it is most often found on or near the surface. It occurs in [[Thief|small clusters]], which can sometimes be dealt with by a solitary dwarf with a [[pick]], and [[Ambush|veins]] and [[Siege|large clusters]] which require greater effort to yield. The discovery of a large vein of goblinite is cause for celebration, a holiday known as [[Goblin christmas]].

Once the [[Combat|mining]] is complete, the goblinite can be [[Forbid|unforbidden]] and your dwarfs can carry it off to the [[stockpile]]. To yield the precious metal, each piece of ore must be designated for [[melt]]ing and processed at a [[smelter]]; the yield is typically less than that of normal ores of iron and copper, but can be an important resource in a particularly metal-poor location ([[glacier]], [[desert]], etc.) provided you have sufficient [[fuel]]. Many [[caravans]] prize raw goblinite, along with its attendant wrappings.

As of the current version dwarves and goblins have the same adult body size, therefore allowing goblinite to be quipped directly without melting and reforging as an early or cheap source of low quality armor for a fortress.

v0.31:Creature token

2010-04-04T17:05:31Z

I2amroy: /* V */ removed duplicate tag

Tentative at best in some cases. Legacy stuff unlisted.

__NOTOC__

=Tokens=
==A==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| ALCOHOL_DEPENDENT
|
| Creature needs alcohol to get through the working day.

|-
| ALL_ACTIVE
|
| Sets if the creature is active in day, night, and twilight. Seems to be a separate value from DIURNAL/NOCTURNAL/CREPUSCULAR, rather than implying them.

|-
| ALTTILE
|
| If set, the creature will blink between its [TILE] and its [ALTTILE].

|-
| AMBUSHPREDATOR
|
| Makes the creature start out hidden. Used by giant cave spiders. May make webs hidden too

|-
| AMPHIBIOUS
|
| Allows a creature to breathe with or without water.

|-
| APP_MOD_NOUN
|
*noun
*SINGULAR or PLURAL
| creates a noun for the appearance and whether it is singular or plural

|-
| APP_MOD_RATE
|
*Rate (integer)
*Scale (DAILY, YEARLY)
*min:max of growth
*start year:end year
| setting the growth rate of the modifier

|-
| APPLY_CREATURE_VARIATION
|
*CV TEMPLATE NAME
| Loads the CV Template specified.

|-
| APPLY_CURRENT_CREATURE_VARIATION
|
| Applies loaded CV

|-
| AQUATIC
|
| Allows a creature to breathe underwater, but causes it to "drown" out of water.

|-
| ARENA_RESTRICTED
|
| Does not appear in arena mode list

|-
| ATTACK
|
*token
*bodypart
*selection criteria
*location
| Defines the attack name, and the body part used.

|-
| ATTACK_CONTACT_PERC
|
*% value
| amount of available tissue used in attack

|-
| ATTACK_FLAG_CANLATCH
|
| amount of material that makes contact when attack is made.

|-
| ATTACK_FLAG_EDGE
|
| attack type

|-
| ATTACK_FLAG_WITH
|
| attack type

|-
| ATTACK_PENETRATION_PERC
|
*% value
| probably amount of material that makes contact when penetration is done

|-
| ATTACK_PRIORITY
|
*MAIN or SECOND
| use of the attack in combat. Second attacks only used if main impossible.

|-
| ATTACK_SKILL
|
*skill used
| defines the attack skill used

|-
| ATTACK_TRIGGER
| min:median:max
| Probably stages when a dragon will attack a site

|-
| ATTACK_VERB
| 2nd person:3rd person
| descriptive text for the attack

|}

==B==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| BABY
| integer
| age at which creature is considered a child

|-
| BABYNAME
| singular:plural
| name at caste level

|-
| BEACH_FREQUENCY
|
| Whales and jellyfish have this. Controls the beaching frequency of the creature.

|-
| BENIGN
|
| Determines whether creature can show up on "tame" maps (includes elephants), which will generally avoid dwarves, although they may chase and/or attack them if they get too close).

|-
| BIOME
|
*BIOME
| Select Biomes the creature may appear in

|-
| BLOOD, PUS, OTHER MATERIAL state definition
|
*selection criteria. Often LOCAL_CREATURE_MAT, although other selection criteria may work too.
*selected material
*matter state (LIQUID, GAS, ALL_SOLID) | Controls bleeding behaviour

|-
| BODY
| body parts
| Draws body parts from OBJECT:BODY files (such as body_default.txt)

|-
| BODY_APPEARANCE_MODIFIER
|
*ATTRIBUTE
*lowest:lower:low:median:high:higher:highest | These body modifiers give individual dwarves different characteristics. In the case of HEIGHT, BROADNESS and LENGTH, the modifier is also a percentage change to the BODY_SIZE of the individual creature. The seven numbers afterward give a distribution of ranges. Each interval has an equal chance of occurring.

|-
| BODY_DETAIL_PLAN
| PlanName, PlanName:type:type:type:etc
| loads a plan listed OBJECT:BODY_DETAIL_PLAN files, such as b_detail_plan_default.txt. Mass applies USE_MATERIAL_TEMPLATE, mass alters RELSIZE, alters body part positions, and will allow tissue layers to be defined. Tissue layers are defined in order of skin to bone here.

|-
| BODY_SIZE_PLAN
| years:days:size
| sets up size at a given time

|-
| BODYGLOSS
| gloss
| Substitutes body part text with replacement text. Draws gloss information from OBJECT:BODY files (such as body_default.txt)

|-
| BONECARN
|
| Creature 'eats' bones. Eating bones makes their happiness go up, but can cause death (suffocation). This tag implies CARNIVORE.

|-
| BP_APPEARANCE_MODIFIER
|
*QUALITY
*lowest:lower:low:median:high:higher:highest
| sets up the breadth of possibilities for appearance qualities for a selected BP group. EG. Eyes (CLOSE_SET, DEEP_SET, ROUND_VS_NARROW, LARGE_IRIS),Lips (THICKNESS), Nose (BROADNESS, LENGTH, UPTURNED, CONVEX), Ear (SPLAYED_OUT, HANGING_LOBES, BROADNESS, HEIGHT), Tooth (GAPS), Skull (HIGH_CHEEKBONES, BROAD_CHIN, JUTTING CHIN, SQUARE_CHIN), Neck (DEEP_VOICE, RASPY_VOICE), Head (BROADNESS, HEIGHT)

|-
| BUILDINGDESTROYER
| 1 or 2
| Allows a creature to destroy furniture and buildings. Value [1] targets mostly doors, hatches, furniture and the like. Value [2] targets anything not made with the b + C commands.
|}

==C==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| CAN_LEARN
|
| CAN_LEARN

|-
| CAN_SPEAK
|
| Can talk. Note that it is not necessary for a creature to gain social skills.

|-
| CANNOT_UNDEAD
|
| Cannot be turned into a zombie or skeletal undead

|-
| CANOPENDOORS
|
| Allows the creature to open doors.

|-
| CARNIVORE
|
| Creature eats meat

|-
| CASTE
|
*name
| defines a caste

|-
| CASTE_NAME
| singular:plural:adjective
| The name of the caste of the creature in the game.

|-
| CAVE_ADAPT
|
| Gives the creature a bonus in caves. Also causes Cave adaptation.

|-
| CE_X
|
*SEV:<value(1-100)> (severity)
*PROB:<value(1-100)> (probability)
*RESISTABLE (optional) allows resistance
*SIZE_DILUTES (optional) lessens effect based on size
Place effected:
*LOCALIZED (optional)
*VASCULAR_ONLY (optional)
*BP:(select BY_CATEGORY, BY_TYPE, or BY_TOKEN):category, type or token:tissues affected (specific or ALL) (optional)
Timeline:
*Start:Time at which effect starts
*Peak:Time at which effect peaks
*End:Time at which effect ends.
| specifies the aspects of the Creature Effect in Syndromes. This includes the severity of the effect, the likelihood of it taking effect, whether it is resistable, and if the size of a creature effects it, where the creture is effected and the timeline of the effect. CEs include: CE_FEVER, CE_NAUSEA, CE_DIZZINESS, CE_SWELLING, CE_OOZING, CE_BRUISING, CE_BLEEDING, CE_NECROSIS, CE_DROWSINESS, CE_PAIN, CE_BLISTERS, CE_COUGH_BLOOD

|-
| CHILD
| integer
| age at which creature is considered an adult

|-
| CHILD_BODYPART_GROUP
|
*master selection, BY_CATEGORY, BY_TYPE, BY_TOKEN.
*master location
*specific selection, BY_CATEGORY, BY_TYPE, BY_TOKEN.
*specific location
| selects all parts of a group to be used.

|-
| CHILDNAME
| singular:plural
| name at caste level

|-
| CLUSTER_NUMBER
| min:max
| The minimum/maximum numbers of how many creatures per spawned cluster. Certain vermin fish use this token in combination with temperate ocean and river biome tokens to perform seasonal migrations.
e.g. [CLUSTER_NUMBER:1:3]

|-
| COLDDAM_POINT
| value
| The minimum temperature limit before the creature starts taking damage from freezing.

|-
| COLOR
| foreground:background:brightness
| Color of the creature's tile.

|-
| COMMON_DOMESTIC
|
| Allows the creature to be brought with immigrants and when creating a new fortress, as long as the creature also includes at least one of the following tokens: PET, PACK_ANIMAL, WAGON_PULLER, MOUNT

|-
| COOKABLE_LIVE
|
| Set this to allow the creature to be cooked in meals without first being cleaned.

|-
| COPY_TAGS_FROM
|
*CREATURE NAME
| Copies tags from another specified creature.

|-
| CREATURE
| name
| What the game looks for when generating creatures.

|-
| CREATURE_CLASS
| Classname | Creature class. Can be anything, but only existing use is GENERAL_POISON. Appears to only be used for Syndromes.

|-
| CREATURE_TILE
| 'character' or tile number
| The symbol of the creature in ASCII mode.

|-
| CREPUSCULAR
|
| Sets if the creature is active in twilight. This tag functions as a combination of the two tags VEPERTINE and MATUTINAL.

|-
| CURIOUSBEAST_EATER
|
| Allows a creature to steal and eat edible items from you.

|-
| CURIOUSBEAST_GUZZLER
|
| Allows a creature to (very quickly) drink your alcohol. Also affects undead versions of the creature.

|-
| CURIOUSBEAST_ITEM
|
| Allows a creature to steal things (apparently the highest value it can find).

|-
| CV_ADD_TAG
|
*TAG NAME
| Adds a tag

|-
| CV_REMOVE_TAG
|
*TAG NAME
| removes a tag
|}

==D==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| DESCRIPTION
| text
| A brief description of the creature type.

|-
| DIFFICULTY
| integer
| Toady: "Difficulty determines how deep it places them in adventure mode/reclaim caves, and the chance that they are wounded the first few river attacks." Also increases experience gain during adventure mode.

|-
| DIURNAL
|
| Sets if the creature is active in day.

|-
| DOES_NOT_EXIST
|
| Creature does not actually exist

|-
| DRAGONFIREBREATH
|
| Creature breathes fire in a cone.
|}

==E==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| EQUIPMENT_WAGON
|
| Implies two unknown flags, NOSTUN, NONAUSEA, NOBLEED, NOEMOTION, NOSTUCKINS, SEVERONBREAKS, NOSKULL, NOSKIN, NOBONES, NOMEAT, PARALYZEIMMUNE, NOFEAR, NOSMELLYROT, NOTHOUGHT, NO_GENDER.

|-
| EQUIPS
|
| Allows the creature to wear or wield items.

|-
| EVIL
|
| Determines whether creature can show up on "evil" maps

|-
| EXTRAVISION
|
| Creature can see regardless of whether it has working eyes.
|}

==F==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| FANCIFUL
|
| Makes every civilization know about the creature. The creature won't occur in regular material preference lists. The tag also adds some art value modifiers. Used for things like dragons and other legendary creatures.

|-
| FEMALE
|
| all female

|-
| FIREBREATH
|
| The creature breathes fire projectiles (as opposed to DRAGONFIREBREATH, which is in a cone).

|-
| FIREIMMUNE
|
| As of the current versionv0.28.181.40d, the FIREIMMUNE token has no effect on a creature's resistance to flame or heat. However, it does affect ability to swim in magma in adventure mode, as well as display of "You are caught in a pool of magma!" warning messages.

|-
| FIREIMMUNE_SUPER
|
| The creature is immune to DRAGONFIREBREATH. AI acts as if FIREIMMUNE. May or may not imply FIREIMMUNE.

|-
| FISHITEM
|
| Needs to be cleaned at a fishery

|-
| FIXED_TEMP
| temperature
| The natural heat generated by the creature.

|-
| FLEEQUICK
|
| Determines how soon a creature flees in a losing battle.

|-
| FLIER
|
| Allows a creature to fly. Currently, an AI bug prevents this from being useful on PC races in fortress mode.

|-
| FREQUENCY
|
| Determines the time between creature spawns in Fortress Mode. Higher is more occurrences per time unitVerify. Creatures without a frequency statement appear to be on the map at all times. Almost all others have either [FREQUENCY:5] or [FREQUENCY:100]. "High frequency means you get more when the number is high, so 100 would be the most common. If you don't enter a number, it uses 50."
|}

==G==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| GENERAL_BABY_NAME
| singular:plural
| name at creature level

|-
| GENERAL_CHILD_NAME
| singular:plural
| name at creature level

|-
| GETS_INFECTIONS_FROM_ROT
|
| can be infected by rot

|-
| GETS_WOUND_INFECTIONS
|
| can be infected from wounds

|-
| GLOWCOLOR
|
*foreground
*background
*brightness
| The colour of the GLOWTILE of the creature

|-
| GLOWTILE
| ascii character
| If present, the being glows in the dark (generally used for Adventure Mode). The tile is what replaces the being's current tile when it is obscured from your sight by darkness. The default setting for kobolds (a yellow quotation mark) provides a nice "glowing eyes" effect.

|-
| GNAWER
| verb (gnawed)
| The creature chews on food storage containers.

|-
| GO_TO_END
|
| uncertain use, definitely refers to Creature Variants template

|-
| GO_TO_START
|
| uncertain use, definitely refers to Creature Variants template

|-
| GOOD
|
| Determines whether creature can show up on "good" maps

|-
| GRASSTRAMPLE
| value
| Determines the percentage chance of trampling and killing grass when a creature steps on it. Set [GRASSTRAMPLE:0] to make grass never trampled by the creature.
|}

==H==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| HAS_NERVES
|
| This makes the creature susceptible to severed nerves when muscles are torn in limb, grasp and stance parts.

|-
| HEATDAM_POINT
| value
| The maximum temperature limit before the creature will start recieving damage from heat.

|-
| HOMEOTHERM
|
| Default 'NONE'. The creature's normal body temperature
|}

==I==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| IF_EXISTS_SET_BOILING_POINT
| value
| The temperature at which the creature boils into goo.

|-
| IF_EXISTS_SET_MELTING_POINT
| value
| The temperature at which the creature will melt into goo.

|-
| IGNITE_POINT
| value
| The temperature at which the creature will burst into flames

|-
| IMMOBILE_LAND
|
| The creature is immobile while on land

|-
| IMMOLATE
|
| Will ignite, and potentially completely destroy, items the creature is standing on. Keep booze away from critters with this tag.

|-
| INSULATION
| value
| increases the insulation of a selected material

|-
| INTELLIGENT
|
| Implies CAN_CIV, CAN_SPEAK, CAN_LEARN.

|-
| ITEMCORPSE
|
* Item token
* subtype
NO_SUBTYPE
* matgloss token
* NO_RACEGLOSS
USE_RACEGLOSS USE_SHARPSTONE
| Determines if the creature leaves behind a non-standard corpse (i.e. wood, statue, bars, etc). The first parameter determines the item type; the second parameter is the subtype indicated in the raw file (such as WEAPON_WHIP); the third indicates the material type if the item type takes a specific material (e.g. ""IRON"" if the corpse type is ""STATUE""). USE_RACEGLOSS applies if the creature has a material glossary assigned by the ""HAS_RACEGLOSS:"" flag and will select neccesary adjectives and material from that glossary.

|-
| ITEMCORPSE_QUALITY
|
| The quality of an item-type corpse left behind; 5 is masterpiece-level.
|}

==L==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| LARGE_PREDATOR
|
| Will attack things that are smaller than it (like dwarves). Only one group of "large predators" will appear on any given map (possibly two groups on "savage" maps). In adventure mode, large predators will try to ambush and attack you (and your party will attack them back). Also, they can be mentioned in the intro paragraph when starting a fortress e.g. "ere the wolves get hungry."

|-
| LARGE_ROAMING
|
| In Fortress Mode, spawns outdoors and is not a vermin creature.

|-
| LIGAMENTS
|
*selection criteria. Often LOCAL_CREATURE_MAT, although other selection criteria may work too.
*selected material
*healing rate
| defines the qualities of ligaments"

|-
| LIGHT_GEN
|
| The creature will generate light, such as in adventurer mode at night.

|-
| LIKES_FIGHTING
|
| The creature will attack enemies rather than flee from them. This tag has the same effect on player-controlled creatures - included modded dwarves.

|-
| LISP
|
| Creature multiplies 'S' when talking. Ex: "My name isss Recisssiz."

|-
| LOCKPICKER
|
| Lets a creature open doors that are set to forbidden in Fortress Mode.

|-
| LOOSE_CLUSTERS
|
| The creatures will scatter if they have this tag, or form tight packs if they don't.
|}

==M==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| MAGMA_VISION
|
| Creature's able to see while covered in magma.

|-
| MALE
|
| all male

|-
| MANNERISM_??
|
*occassionally body part
| Adds a possible mannerism to the creature's profile.
Refer to [[DF2010:Creature_Token_Mannerisms|Mannerisms]]

|-
| MATERIAL_BREATH_ATTACK
|
*MATERIAL TYPE (TISSUE, INORGANIC)
*MATERIAL NAME
*MATERIAL STATE (TRAILING_DUST_FLOW, TRAILING_VAPOR_FLOW, TRAILING_GAS_FLOW, SOLID_GLOB, LIQUID_GLOB, UNDIRECTED_GAS, UNDIRECTED_VAPOR, UNDIRECTED_DUST)
| Creates an attack referencing a material, using a given type of breath attack.

|-
| MAXAGE
| min:max
| range of time in which death from old age may occur

|-
| MEANDERER
|
| Gives a creature random movement.

|-
| MEGABEAST
|
| Appears on fortress territory in Fortress Mode occasionally. Implies SEMIMEGABEAST. Also can be worshipped

|-
| MENT_ATT_RANGE
|
*ATTRIBUTE
*lowest:lower:low:median:high:higher:highest | sets up a mental attribute's range of values

|-
| MILKABLE
|
*LOCAL_CREATURE_MAT:MILK:amount
| Allows the creature to be milked.

|-
| MISCHIEVIOUS
|
| Will pull any levers it comes across (requires confirmation). "They go on little missions to mess with various fortress buildings, not just levers."

|-
| MOUNT
|
| Creature may be used as a mount

|-
| MOUNT_EXOTIC
|
| You need the Dungeon master noble to mount the creature.

|-
| MULTIPLE_LITTER_RARE
|
| Makes litters with more than one offspring rare.

|-
| MULTIPLY_VALUE
|
*Multiplier
| multiplies value of materials

|-
| MUNDANE
|
| Marks if the creature is an actual real-life creature. Only used for age-names at present.
|}

==N==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| NAME
| singular:plural:adjective
| What the creature is actually called in game.

|-
| NATURAL
|
| Animal is considered to be natural.

|-
| NO_AUTUMN
|
| does not appear this season.

|-
| NO_DIZZINESS
|
| Creature cannot become dizzy

|-
| NO_DRINK
|
| Creature does not need to drink.

|-
| NO_EAT
|
| Creature does not need to eat.

|-
| NO_FEVERS
|
| Creature cannot suffer fevers

|-
| NO_SLEEP
|
| Creature does not need to sleep.

|-
| NO_SPRING
|
| does not appear this season.

|-
| NO_SUMMER
|
| does not appear this season.

|-
| NO_THOUGHT_CENTER_FOR_MOVEMENT
|
| Probably shorthand for movement being unaffected by damage in general.

|-
| NO_WINTER
|
| does not appear this season.

|-
| NOBONES
|
| Creature has no bones.

|-
| NOBREATHE
|
| Creature doesn't need to breathe or have [BREATHE] parts in body. Cannot drown or be strangled.

|-
| NOCTURNAL
|
| Sets if the creature is active in night.

|-
| NOEMOTION
|
| The creature has no emotions, and does not rage.

|-
| NOEXERT
|
| Creature can't become tired or over-exerted.

|-
| NOFEAR
|
| Creature doesn't feel fear and will never run away from battle.

|-
| NOMEAT
|
| Creature will not drop meat on butcher.

|-
| NONAUSEA
|
| Creature can't vomit.

|-
| NOPAIN
|
| Creature doesn't feel pain.

|-
| NOSKIN
|
| Creature will not drop skin on butcher.

|-
| NOSKULL
|
| Creature will not drop skull on butcher, rot, or decay of severed head.

|-
| NOSMELLYROT
|
| Does not produce miasma when rotting

|-
| NOSTUCKINS
|
| Weapons can't be stuck in creature.

|-
| NOSTUN
|
| Creature can't be stunned.

|-
| NOT_BUTCHERABLE
|
| Cannot be butchered

|-
| NOTHOUGHT
|
| Creature doesn't think, or doesn't require a [BRAIN] body part.
|}

==P==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| PACK_ANIMAL
|
| Allows the creature to be used as a pack animal. Currently only used by merchants.

|-
| PARALYZEIMMUNE
|
| The creature is immune to all paralyzing special attacks.

|-
| PEARL
|
| Creature will generate pearls.

|-
| PENETRATEPOWER
| value
| Controls the ability of vermin to find a way into containers when they are eating food from your stockpiles. Wood and cloth objects roll a 0-9 and if it greater than the penetrate power, their contents escape for the time being. Other objects roll a 0-99.

|-
| PERSONALITY
|
*ATTRIBUTE
*lowest:median:highest
| Determines chance of personality traits. Standard is 0:50:100. See Personality traits for more info.

|-
| PET
|
| Allows the creature to be tamed.

|-
| PET_EXOTIC
|
| You need a Dungeon master noble in your fortress for the creature to be tamable (but any Animal trainer can do the taming).

|-
| PETVALUE
| value
| How valuable a tamed animal/pet is. Actual cost in points in the embarking screen is (PETVALUE/2)+1 for an untrained animal, PETVALUE+1 for a trained(War or Hunting) one. Note that for an animal to be selectable in this screen, it must have the COMMON_DOMESTIC token.

|-
| PHYS_ATT_RANGE
|
*ATTRIBUTE
*lowest:lower:low:median:high:higher:highest
| sets up a physical attribute's range of values

|-
| PLUS_TISSUE_LAYER
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
| Adds a tissue to those selected

|-
| PLUS_TL_GROUP
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
*tissue
| continues a selection of tissue layers

|-
| POP_RATIO
|
| Weighted population of caste

|-
| POPULATION_NUMBER
| min:max
| The minimum/maximum numbers of how many of these creatures can show up on a map per year.

|-
| PREFSTRING
| object
| Sets what other creatures like about this creature. "Blarghh likes dwarves for their beards." Multiple entries will be chosen from at random

|-
| PROFESSION_NAME
|
*Profession
*singular
*plural
| alters the name of the given profession
|}

==R==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| RELSIZE
|
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Relsize
| Specifies a new relative size

|-
| REMOVE_MATERIAL
|
*MATERIAL NAME
| Removes a material from a creature
|}

==S==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| SAVAGE
|
| Allows creature to show up on (and limits it to) "savage" maps.

|-
| SECRETION
|
*MATERIAL REF (eg LOCAL_CREATURE_MAT
*Material name
*Material State
*location secreted from (by_type, by_category, by_token)
*body part
*tissue layer
| creates a secreted material on given tissue on a given part of the body."

|-
| SELECT_CASTE
|
*caste name, or ALL
| selects a caste

|-
| SELECT_MATERIAL
|
*MATERIAL NAME
| selects the material

|-
| SELECT_TISSUE_LAYER
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token | Selects a tissue at a location"

|-
| SEMIMEGABEAST
|
| Appears as boss creature in quests.

|-
| SET_BP_GROUP
|
*selection criteria BY_TYPE, BY_CATEGORY, BY_TOKEN
*category, type, or token
| selection token"

|-
| SET_TL_GROUP
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
*tissue
| begins a selection of tissue laters

|-
| SLOW_LEARNER
|
| Presumably similar to [CAN_LEARN], but slower. Present in the entries for ogres and giants

|-
| SMALL_REMAINS
|
| If a creature has this token, it'll leave a small corpse that only rots once, and without miasma.

|-
| SPEC_HEAT
| value
| Amount of energy required for the creature to heat up or cool down.

|-
| SPECIALATTACK_INJECT_EXTRACT
|
*LOCAL_CREATURE_MAT
*MATERIAL eg.POISON
*MATTERSTATE (ALL_SOLID, LIQUID, GAS)
*min:max
| attack type addition that injects a material into the victim.

|-
| SPEECH
| speech file
| boasting speeches relating to killing this creature

|-
| SPEED
| value
| Sets the creatures' movement and work speed, 1000/[100 + SPEED X] is the resulting effect on creatures movement and work rates from default. See Speed for more information.

|-
| SPHERE
|
*sphere name
| Sets what religious spheres the creature is aligned to, for purposes of being worshipped via the [POWER] token. Also affects the layout of hidden fun stuff, and the creature's name.

|-
| SWIM_SPEED
|
*speed
| How fast the creature swims. Typically 2500 (0.38 times the default speed).

|-
| SWIMS_INNATE
|
| The creature naturally knows how to swim, as opposed to [SWIMS_LEARNED] below. Currently, an AI bug prevents this from being useful on PC races in fortress mode.

|-
| SWIMS_LEARNED
|
| The creature must learn to swim. Requires [CAN_LEARN], obviously.

|-
| SYN_AFFECTED_CLASS
|
| adds a class of creatures to those affected, such as CREATURE_CLASS:GENERAL_POISON

|-
| SYN_AFFECTED_CREATURE
| Creature Name
| adds a specific creature to those affected.

|-
| SYN_CONTACT
|
| syndrome can be contracted on contact

|-
| SYN_IMMUNE_CREATURE
|
| creates an exception for the creature so that it not affected by the syndrome.

|-
| SYN_INHALED
|
| syndrome can be contracted by inhaled.

|-
| SYN_INJECTED
|
| syndrome can be contracted by injection.

|-
| SYN_NAME
| text
| defines the name of the syndrome

|-
| SYNDROME
|
| begins definition of a Syndrome for poison use
|}

==T==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| TENDONS
|
*selection criteria. Often LOCAL_CREATURE_MAT, although other selection criteria may work too.
*selected tissue
*healing rate
| Defines the qualities of tendons

|-
| THICKWEB
|
| The creature's webs can catch larger creatures. May imply [AMBUSHPREDATOR]

|-
| TISSUE
| name
| Begins defining a tissue in the creature file.

|-
| TISSUE_LAYER
|
*BY_TYPE, BY_CATEGORY, BY_TOKEN
*TYPE,CATEGORY, or TOKEN
*TISSUE
*LOCATION
| Adds the tissue layer to wherever it is required.
Non-argument Locations can be FRONT, RIGHT, LEFT. Argument locations are AROUND and CLEANS, requiring a further body part and a % of coverage/cleansing

|-
| TISSUE_LAYER_APPEARANCE_MODIFIER
|
*QUALITY
*lowest:lower:low:median:high:higher:highest
| sets the range of qualities, including LENGTH, DENSE, HIGH_POSITION, CURLY, GREASY, WRINKLY

|-
| TISSUE_STYLE_UNIT
|
*tissue
*shaping
| sets tissue to be in a certain shape"

|-
| TL_COLOR_MODIFIER
| COLOR:FREQ:COLOR:FREQ etc
| Creates a list of color patterns, giving each a frequency

|-
| TL_MAJOR_ARTERIES
|
| Gives Major Artery attribute to selected layers.

|-
| TLCM_NOUN
|
*name
*SINGULAR or PLURAL | names the tissue layer color modifier, and determines the noun"

|-
| TLCM_TIMING
|
*ROOT
*start change window years:days:end change window years:days | determines the point in the creature's life where the color change begins"

|-
| TRADE_CAPACITY
|
| How much the creature can carry when used by merchants.

|-
| TRAINABLE
|
| Allows a tame creature to be trained into a "War" or "Hunting" variation by way of Kennels.

|-
| TRAINABLE_HUNTING
|
| Can be trained as hunting beasts

|-
| TRANCES
|
| Allows the creature to go into martial trances.

|-
| TRAPAVOID
|
| The creature is immune to traps.

|-
| TRIGGERABLE_GROUP
| min:max
| unknown

|-
| TSU_NOUN
|
*noun
*SINGULAR or PLURAL
| creates a noun for the tissue used and whether it is singular or plural"
|}

==U==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| UNDERGROUND_DEPTH
| mindepth:maxdepth
| Depth the creature appears underground

|-
| UNDERSWIM
|
| Creature swims under the water and can't be seen.

|-
| USE_MATERIAL_TEMPLATE
| token:material template
| Loads a material, and gives it a shortname for later reference

|-
| USE_TISSUE_TEMPLATE
| Template Name
| Loads a tissue template listed in OBJECT:TISSUE_TEMPLATE files, such as tissue_template_default.txt.

|-
| UTTERANCES
|
| Changes the language of the creature into an unintelligible mess.
|}

==V==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| VEGETATION
|
| unknown

|-
| VERMIN_BITE
|
*amount
*verb (bitten, stung)
*LOCAL_CREATURE_MAT
*MATERIAL
| vermin bites, and injects something.

|-
| VERMIN_FISH
|
| Acts like a fish

|-
| VERMIN_GROUNDER
|
| The creature can be picked up if you stand over it. (Requires confirmation)
'I think this is a habitat flag like VERMIN_SOIL, VERMIN_CHASM, etc. It seems to appear on creatures that don't otherwise have one. – Peristarkawan 17:27, 24 May 2007 (EDT)'

|-
| VERMIN_HATEABLE
|
| Some dwarves will hate the creature and get unhappy thoughts when around it.

|-
| VERMIN_MICRO
|
| This makes the creature move in a swarm of creatures of the same race as it. I.E. Swarm of flies, swarm of ants, etc.

|-
| VERMIN_NOFISH
|
| The creature cannot be caught by fishing.

|-
| VERMIN_NOROAM
|
| The creature will not be observed randomly roaming about the map.

|-
| VERMIN_NOTRAP
|
| The creature cannot be caught by trappers or animal traps. However, this may not work in all cases, as both dragonflies and fairies can be caught by trappers. This is possibly overridden by the VERMIN_GROUNDER token, allowing trappers set to Catch a Live Land Animal to pick up and thus trap the animal. (speculation by Flippantelf 04:45, 15 June 2009 (UTC))

|-
| VERMIN_ROTTER
|
| Present on flies, knuckle worms, acorn flies, and blood gnats. Probably means either the creature is attracted to rot, the creature speeds rotting, or both.

|-
| VERMIN_SOIL
|
| The creature randomly appears near dirt or mud.

|-
| VERMIN_SOIL_COLONY
|
| The vermin will appear in a single tile cluster of many vermin, such as a colony of ants.

|-
| VERMINHUNTER
|
| A creature with this tag will hunt down vermin and kill them. Sometimes they will eat the vermin, but most of the time they will bring it to their owner. This tag also makes impossible to assign an owner to the animal. The animal chooses it's own owner instead (like a cat). If assigned to a playable race, members of that race will ONLY be able to eat vermin.

|-
| VESPERTINE
|
| Sets if the creature is active in evening.
|}

==W==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| WAGON_PULLER
|
| Allows the creature to pull caravan wagons.

|-
| WEBBER
| LOCAL_CREATURE_MAT_SILK
| allows the cerature to web, and defines what the webs are made of.

|-
| WEBIMMUNE
|
| The creature will not get caught in webs.
|}

v0.31:Creature token

2010-04-04T17:03:25Z

I2amroy: /* S */ typo

Tentative at best in some cases. Legacy stuff unlisted.

__NOTOC__

=Tokens=
==A==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| ALCOHOL_DEPENDENT
|
| Creature needs alcohol to get through the working day.

|-
| ALL_ACTIVE
|
| Sets if the creature is active in day, night, and twilight. Seems to be a separate value from DIURNAL/NOCTURNAL/CREPUSCULAR, rather than implying them.

|-
| ALTTILE
|
| If set, the creature will blink between its [TILE] and its [ALTTILE].

|-
| AMBUSHPREDATOR
|
| Makes the creature start out hidden. Used by giant cave spiders. May make webs hidden too

|-
| AMPHIBIOUS
|
| Allows a creature to breathe with or without water.

|-
| APP_MOD_NOUN
|
*noun
*SINGULAR or PLURAL
| creates a noun for the appearance and whether it is singular or plural

|-
| APP_MOD_RATE
|
*Rate (integer)
*Scale (DAILY, YEARLY)
*min:max of growth
*start year:end year
| setting the growth rate of the modifier

|-
| APPLY_CREATURE_VARIATION
|
*CV TEMPLATE NAME
| Loads the CV Template specified.

|-
| APPLY_CURRENT_CREATURE_VARIATION
|
| Applies loaded CV

|-
| AQUATIC
|
| Allows a creature to breathe underwater, but causes it to "drown" out of water.

|-
| ARENA_RESTRICTED
|
| Does not appear in arena mode list

|-
| ATTACK
|
*token
*bodypart
*selection criteria
*location
| Defines the attack name, and the body part used.

|-
| ATTACK_CONTACT_PERC
|
*% value
| amount of available tissue used in attack

|-
| ATTACK_FLAG_CANLATCH
|
| amount of material that makes contact when attack is made.

|-
| ATTACK_FLAG_EDGE
|
| attack type

|-
| ATTACK_FLAG_WITH
|
| attack type

|-
| ATTACK_PENETRATION_PERC
|
*% value
| probably amount of material that makes contact when penetration is done

|-
| ATTACK_PRIORITY
|
*MAIN or SECOND
| use of the attack in combat. Second attacks only used if main impossible.

|-
| ATTACK_SKILL
|
*skill used
| defines the attack skill used

|-
| ATTACK_TRIGGER
| min:median:max
| Probably stages when a dragon will attack a site

|-
| ATTACK_VERB
| 2nd person:3rd person
| descriptive text for the attack

|}

==B==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| BABY
| integer
| age at which creature is considered a child

|-
| BABYNAME
| singular:plural
| name at caste level

|-
| BEACH_FREQUENCY
|
| Whales and jellyfish have this. Controls the beaching frequency of the creature.

|-
| BENIGN
|
| Determines whether creature can show up on "tame" maps (includes elephants), which will generally avoid dwarves, although they may chase and/or attack them if they get too close).

|-
| BIOME
|
*BIOME
| Select Biomes the creature may appear in

|-
| BLOOD, PUS, OTHER MATERIAL state definition
|
*selection criteria. Often LOCAL_CREATURE_MAT, although other selection criteria may work too.
*selected material
*matter state (LIQUID, GAS, ALL_SOLID) | Controls bleeding behaviour

|-
| BODY
| body parts
| Draws body parts from OBJECT:BODY files (such as body_default.txt)

|-
| BODY_APPEARANCE_MODIFIER
|
*ATTRIBUTE
*lowest:lower:low:median:high:higher:highest | These body modifiers give individual dwarves different characteristics. In the case of HEIGHT, BROADNESS and LENGTH, the modifier is also a percentage change to the BODY_SIZE of the individual creature. The seven numbers afterward give a distribution of ranges. Each interval has an equal chance of occurring.

|-
| BODY_DETAIL_PLAN
| PlanName, PlanName:type:type:type:etc
| loads a plan listed OBJECT:BODY_DETAIL_PLAN files, such as b_detail_plan_default.txt. Mass applies USE_MATERIAL_TEMPLATE, mass alters RELSIZE, alters body part positions, and will allow tissue layers to be defined. Tissue layers are defined in order of skin to bone here.

|-
| BODY_SIZE_PLAN
| years:days:size
| sets up size at a given time

|-
| BODYGLOSS
| gloss
| Substitutes body part text with replacement text. Draws gloss information from OBJECT:BODY files (such as body_default.txt)

|-
| BONECARN
|
| Creature 'eats' bones. Eating bones makes their happiness go up, but can cause death (suffocation). This tag implies CARNIVORE.

|-
| BP_APPEARANCE_MODIFIER
|
*QUALITY
*lowest:lower:low:median:high:higher:highest
| sets up the breadth of possibilities for appearance qualities for a selected BP group. EG. Eyes (CLOSE_SET, DEEP_SET, ROUND_VS_NARROW, LARGE_IRIS),Lips (THICKNESS), Nose (BROADNESS, LENGTH, UPTURNED, CONVEX), Ear (SPLAYED_OUT, HANGING_LOBES, BROADNESS, HEIGHT), Tooth (GAPS), Skull (HIGH_CHEEKBONES, BROAD_CHIN, JUTTING CHIN, SQUARE_CHIN), Neck (DEEP_VOICE, RASPY_VOICE), Head (BROADNESS, HEIGHT)

|-
| BUILDINGDESTROYER
| 1 or 2
| Allows a creature to destroy furniture and buildings. Value [1] targets mostly doors, hatches, furniture and the like. Value [2] targets anything not made with the b + C commands.
|}

==C==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| CAN_LEARN
|
| CAN_LEARN

|-
| CAN_SPEAK
|
| Can talk. Note that it is not necessary for a creature to gain social skills.

|-
| CANNOT_UNDEAD
|
| Cannot be turned into a zombie or skeletal undead

|-
| CANOPENDOORS
|
| Allows the creature to open doors.

|-
| CARNIVORE
|
| Creature eats meat

|-
| CASTE
|
*name
| defines a caste

|-
| CASTE_NAME
| singular:plural:adjective
| The name of the caste of the creature in the game.

|-
| CAVE_ADAPT
|
| Gives the creature a bonus in caves. Also causes Cave adaptation.

|-
| CE_X
|
*SEV:<value(1-100)> (severity)
*PROB:<value(1-100)> (probability)
*RESISTABLE (optional) allows resistance
*SIZE_DILUTES (optional) lessens effect based on size
Place effected:
*LOCALIZED (optional)
*VASCULAR_ONLY (optional)
*BP:(select BY_CATEGORY, BY_TYPE, or BY_TOKEN):category, type or token:tissues affected (specific or ALL) (optional)
Timeline:
*Start:Time at which effect starts
*Peak:Time at which effect peaks
*End:Time at which effect ends.
| specifies the aspects of the Creature Effect in Syndromes. This includes the severity of the effect, the likelihood of it taking effect, whether it is resistable, and if the size of a creature effects it, where the creture is effected and the timeline of the effect. CEs include: CE_FEVER, CE_NAUSEA, CE_DIZZINESS, CE_SWELLING, CE_OOZING, CE_BRUISING, CE_BLEEDING, CE_NECROSIS, CE_DROWSINESS, CE_PAIN, CE_BLISTERS, CE_COUGH_BLOOD

|-
| CHILD
| integer
| age at which creature is considered an adult

|-
| CHILD_BODYPART_GROUP
|
*master selection, BY_CATEGORY, BY_TYPE, BY_TOKEN.
*master location
*specific selection, BY_CATEGORY, BY_TYPE, BY_TOKEN.
*specific location
| selects all parts of a group to be used.

|-
| CHILDNAME
| singular:plural
| name at caste level

|-
| CLUSTER_NUMBER
| min:max
| The minimum/maximum numbers of how many creatures per spawned cluster. Certain vermin fish use this token in combination with temperate ocean and river biome tokens to perform seasonal migrations.
e.g. [CLUSTER_NUMBER:1:3]

|-
| COLDDAM_POINT
| value
| The minimum temperature limit before the creature starts taking damage from freezing.

|-
| COLOR
| foreground:background:brightness
| Color of the creature's tile.

|-
| COMMON_DOMESTIC
|
| Allows the creature to be brought with immigrants and when creating a new fortress, as long as the creature also includes at least one of the following tokens: PET, PACK_ANIMAL, WAGON_PULLER, MOUNT

|-
| COOKABLE_LIVE
|
| Set this to allow the creature to be cooked in meals without first being cleaned.

|-
| COPY_TAGS_FROM
|
*CREATURE NAME
| Copies tags from another specified creature.

|-
| CREATURE
| name
| What the game looks for when generating creatures.

|-
| CREATURE_CLASS
| Classname | Creature class. Can be anything, but only existing use is GENERAL_POISON. Appears to only be used for Syndromes.

|-
| CREATURE_TILE
| 'character' or tile number
| The symbol of the creature in ASCII mode.

|-
| CREPUSCULAR
|
| Sets if the creature is active in twilight. This tag functions as a combination of the two tags VEPERTINE and MATUTINAL.

|-
| CURIOUSBEAST_EATER
|
| Allows a creature to steal and eat edible items from you.

|-
| CURIOUSBEAST_GUZZLER
|
| Allows a creature to (very quickly) drink your alcohol. Also affects undead versions of the creature.

|-
| CURIOUSBEAST_ITEM
|
| Allows a creature to steal things (apparently the highest value it can find).

|-
| CV_ADD_TAG
|
*TAG NAME
| Adds a tag

|-
| CV_REMOVE_TAG
|
*TAG NAME
| removes a tag
|}

==D==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| DESCRIPTION
| text
| A brief description of the creature type.

|-
| DIFFICULTY
| integer
| Toady: "Difficulty determines how deep it places them in adventure mode/reclaim caves, and the chance that they are wounded the first few river attacks." Also increases experience gain during adventure mode.

|-
| DIURNAL
|
| Sets if the creature is active in day.

|-
| DOES_NOT_EXIST
|
| Creature does not actually exist

|-
| DRAGONFIREBREATH
|
| Creature breathes fire in a cone.
|}

==E==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| EQUIPMENT_WAGON
|
| Implies two unknown flags, NOSTUN, NONAUSEA, NOBLEED, NOEMOTION, NOSTUCKINS, SEVERONBREAKS, NOSKULL, NOSKIN, NOBONES, NOMEAT, PARALYZEIMMUNE, NOFEAR, NOSMELLYROT, NOTHOUGHT, NO_GENDER.

|-
| EQUIPS
|
| Allows the creature to wear or wield items.

|-
| EVIL
|
| Determines whether creature can show up on "evil" maps

|-
| EXTRAVISION
|
| Creature can see regardless of whether it has working eyes.
|}

==F==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| FANCIFUL
|
| Makes every civilization know about the creature. The creature won't occur in regular material preference lists. The tag also adds some art value modifiers. Used for things like dragons and other legendary creatures.

|-
| FEMALE
|
| all female

|-
| FIREBREATH
|
| The creature breathes fire projectiles (as opposed to DRAGONFIREBREATH, which is in a cone).

|-
| FIREIMMUNE
|
| As of the current versionv0.28.181.40d, the FIREIMMUNE token has no effect on a creature's resistance to flame or heat. However, it does affect ability to swim in magma in adventure mode, as well as display of "You are caught in a pool of magma!" warning messages.

|-
| FIREIMMUNE_SUPER
|
| The creature is immune to DRAGONFIREBREATH. AI acts as if FIREIMMUNE. May or may not imply FIREIMMUNE.

|-
| FISHITEM
|
| Needs to be cleaned at a fishery

|-
| FIXED_TEMP
| temperature
| The natural heat generated by the creature.

|-
| FLEEQUICK
|
| Determines how soon a creature flees in a losing battle.

|-
| FLIER
|
| Allows a creature to fly. Currently, an AI bug prevents this from being useful on PC races in fortress mode.

|-
| FREQUENCY
|
| Determines the time between creature spawns in Fortress Mode. Higher is more occurrences per time unitVerify. Creatures without a frequency statement appear to be on the map at all times. Almost all others have either [FREQUENCY:5] or [FREQUENCY:100]. "High frequency means you get more when the number is high, so 100 would be the most common. If you don't enter a number, it uses 50."
|}

==G==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| GENERAL_BABY_NAME
| singular:plural
| name at creature level

|-
| GENERAL_CHILD_NAME
| singular:plural
| name at creature level

|-
| GETS_INFECTIONS_FROM_ROT
|
| can be infected by rot

|-
| GETS_WOUND_INFECTIONS
|
| can be infected from wounds

|-
| GLOWCOLOR
|
*foreground
*background
*brightness
| The colour of the GLOWTILE of the creature

|-
| GLOWTILE
| ascii character
| If present, the being glows in the dark (generally used for Adventure Mode). The tile is what replaces the being's current tile when it is obscured from your sight by darkness. The default setting for kobolds (a yellow quotation mark) provides a nice "glowing eyes" effect.

|-
| GNAWER
| verb (gnawed)
| The creature chews on food storage containers.

|-
| GO_TO_END
|
| uncertain use, definitely refers to Creature Variants template

|-
| GO_TO_START
|
| uncertain use, definitely refers to Creature Variants template

|-
| GOOD
|
| Determines whether creature can show up on "good" maps

|-
| GRASSTRAMPLE
| value
| Determines the percentage chance of trampling and killing grass when a creature steps on it. Set [GRASSTRAMPLE:0] to make grass never trampled by the creature.
|}

==H==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| HAS_NERVES
|
| This makes the creature susceptible to severed nerves when muscles are torn in limb, grasp and stance parts.

|-
| HEATDAM_POINT
| value
| The maximum temperature limit before the creature will start recieving damage from heat.

|-
| HOMEOTHERM
|
| Default 'NONE'. The creature's normal body temperature
|}

==I==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| IF_EXISTS_SET_BOILING_POINT
| value
| The temperature at which the creature boils into goo.

|-
| IF_EXISTS_SET_MELTING_POINT
| value
| The temperature at which the creature will melt into goo.

|-
| IGNITE_POINT
| value
| The temperature at which the creature will burst into flames

|-
| IMMOBILE_LAND
|
| The creature is immobile while on land

|-
| IMMOLATE
|
| Will ignite, and potentially completely destroy, items the creature is standing on. Keep booze away from critters with this tag.

|-
| INSULATION
| value
| increases the insulation of a selected material

|-
| INTELLIGENT
|
| Implies CAN_CIV, CAN_SPEAK, CAN_LEARN.

|-
| ITEMCORPSE
|
* Item token
* subtype
NO_SUBTYPE
* matgloss token
* NO_RACEGLOSS
USE_RACEGLOSS USE_SHARPSTONE
| Determines if the creature leaves behind a non-standard corpse (i.e. wood, statue, bars, etc). The first parameter determines the item type; the second parameter is the subtype indicated in the raw file (such as WEAPON_WHIP); the third indicates the material type if the item type takes a specific material (e.g. ""IRON"" if the corpse type is ""STATUE""). USE_RACEGLOSS applies if the creature has a material glossary assigned by the ""HAS_RACEGLOSS:"" flag and will select neccesary adjectives and material from that glossary.

|-
| ITEMCORPSE_QUALITY
|
| The quality of an item-type corpse left behind; 5 is masterpiece-level.
|}

==L==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| LARGE_PREDATOR
|
| Will attack things that are smaller than it (like dwarves). Only one group of "large predators" will appear on any given map (possibly two groups on "savage" maps). In adventure mode, large predators will try to ambush and attack you (and your party will attack them back). Also, they can be mentioned in the intro paragraph when starting a fortress e.g. "ere the wolves get hungry."

|-
| LARGE_ROAMING
|
| In Fortress Mode, spawns outdoors and is not a vermin creature.

|-
| LIGAMENTS
|
*selection criteria. Often LOCAL_CREATURE_MAT, although other selection criteria may work too.
*selected material
*healing rate
| defines the qualities of ligaments"

|-
| LIGHT_GEN
|
| The creature will generate light, such as in adventurer mode at night.

|-
| LIKES_FIGHTING
|
| The creature will attack enemies rather than flee from them. This tag has the same effect on player-controlled creatures - included modded dwarves.

|-
| LISP
|
| Creature multiplies 'S' when talking. Ex: "My name isss Recisssiz."

|-
| LOCKPICKER
|
| Lets a creature open doors that are set to forbidden in Fortress Mode.

|-
| LOOSE_CLUSTERS
|
| The creatures will scatter if they have this tag, or form tight packs if they don't.
|}

==M==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description

|-
| MAGMA_VISION
|
| Creature's able to see while covered in magma.

|-
| MALE
|
| all male

|-
| MANNERISM_??
|
*occassionally body part
| Adds a possible mannerism to the creature's profile.
Refer to [[DF2010:Creature_Token_Mannerisms|Mannerisms]]

|-
| MATERIAL_BREATH_ATTACK
|
*MATERIAL TYPE (TISSUE, INORGANIC)
*MATERIAL NAME
*MATERIAL STATE (TRAILING_DUST_FLOW, TRAILING_VAPOR_FLOW, TRAILING_GAS_FLOW, SOLID_GLOB, LIQUID_GLOB, UNDIRECTED_GAS, UNDIRECTED_VAPOR, UNDIRECTED_DUST)
| Creates an attack referencing a material, using a given type of breath attack.

|-
| MAXAGE
| min:max
| range of time in which death from old age may occur

|-
| MEANDERER
|
| Gives a creature random movement.

|-
| MEGABEAST
|
| Appears on fortress territory in Fortress Mode occasionally. Implies SEMIMEGABEAST. Also can be worshipped

|-
| MENT_ATT_RANGE
|
*ATTRIBUTE
*lowest:lower:low:median:high:higher:highest | sets up a mental attribute's range of values

|-
| MILKABLE
|
*LOCAL_CREATURE_MAT:MILK:amount
| Allows the creature to be milked.

|-
| MISCHIEVIOUS
|
| Will pull any levers it comes across (requires confirmation). "They go on little missions to mess with various fortress buildings, not just levers."

|-
| MOUNT
|
| Creature may be used as a mount

|-
| MOUNT_EXOTIC
|
| You need the Dungeon master noble to mount the creature.

|-
| MULTIPLE_LITTER_RARE
|
| Makes litters with more than one offspring rare.

|-
| MULTIPLY_VALUE
|
*Multiplier
| multiplies value of materials

|-
| MUNDANE
|
| Marks if the creature is an actual real-life creature. Only used for age-names at present.
|}

==N==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| NAME
| singular:plural:adjective
| What the creature is actually called in game.

|-
| NATURAL
|
| Animal is considered to be natural.

|-
| NO_AUTUMN
|
| does not appear this season.

|-
| NO_DIZZINESS
|
| Creature cannot become dizzy

|-
| NO_DRINK
|
| Creature does not need to drink.

|-
| NO_EAT
|
| Creature does not need to eat.

|-
| NO_FEVERS
|
| Creature cannot suffer fevers

|-
| NO_SLEEP
|
| Creature does not need to sleep.

|-
| NO_SPRING
|
| does not appear this season.

|-
| NO_SUMMER
|
| does not appear this season.

|-
| NO_THOUGHT_CENTER_FOR_MOVEMENT
|
| Probably shorthand for movement being unaffected by damage in general.

|-
| NO_WINTER
|
| does not appear this season.

|-
| NOBONES
|
| Creature has no bones.

|-
| NOBREATHE
|
| Creature doesn't need to breathe or have [BREATHE] parts in body. Cannot drown or be strangled.

|-
| NOCTURNAL
|
| Sets if the creature is active in night.

|-
| NOEMOTION
|
| The creature has no emotions, and does not rage.

|-
| NOEXERT
|
| Creature can't become tired or over-exerted.

|-
| NOFEAR
|
| Creature doesn't feel fear and will never run away from battle.

|-
| NOMEAT
|
| Creature will not drop meat on butcher.

|-
| NONAUSEA
|
| Creature can't vomit.

|-
| NOPAIN
|
| Creature doesn't feel pain.

|-
| NOSKIN
|
| Creature will not drop skin on butcher.

|-
| NOSKULL
|
| Creature will not drop skull on butcher, rot, or decay of severed head.

|-
| NOSMELLYROT
|
| Does not produce miasma when rotting

|-
| NOSTUCKINS
|
| Weapons can't be stuck in creature.

|-
| NOSTUN
|
| Creature can't be stunned.

|-
| NOT_BUTCHERABLE
|
| Cannot be butchered

|-
| NOTHOUGHT
|
| Creature doesn't think, or doesn't require a [BRAIN] body part.
|}

==P==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| PACK_ANIMAL
|
| Allows the creature to be used as a pack animal. Currently only used by merchants.

|-
| PARALYZEIMMUNE
|
| The creature is immune to all paralyzing special attacks.

|-
| PEARL
|
| Creature will generate pearls.

|-
| PENETRATEPOWER
| value
| Controls the ability of vermin to find a way into containers when they are eating food from your stockpiles. Wood and cloth objects roll a 0-9 and if it greater than the penetrate power, their contents escape for the time being. Other objects roll a 0-99.

|-
| PERSONALITY
|
*ATTRIBUTE
*lowest:median:highest
| Determines chance of personality traits. Standard is 0:50:100. See Personality traits for more info.

|-
| PET
|
| Allows the creature to be tamed.

|-
| PET_EXOTIC
|
| You need a Dungeon master noble in your fortress for the creature to be tamable (but any Animal trainer can do the taming).

|-
| PETVALUE
| value
| How valuable a tamed animal/pet is. Actual cost in points in the embarking screen is (PETVALUE/2)+1 for an untrained animal, PETVALUE+1 for a trained(War or Hunting) one. Note that for an animal to be selectable in this screen, it must have the COMMON_DOMESTIC token.

|-
| PHYS_ATT_RANGE
|
*ATTRIBUTE
*lowest:lower:low:median:high:higher:highest
| sets up a physical attribute's range of values

|-
| PLUS_TISSUE_LAYER
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
| Adds a tissue to those selected

|-
| PLUS_TL_GROUP
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
*tissue
| continues a selection of tissue layers

|-
| POP_RATIO
|
| Weighted population of caste

|-
| POPULATION_NUMBER
| min:max
| The minimum/maximum numbers of how many of these creatures can show up on a map per year.

|-
| PREFSTRING
| object
| Sets what other creatures like about this creature. "Blarghh likes dwarves for their beards." Multiple entries will be chosen from at random

|-
| PROFESSION_NAME
|
*Profession
*singular
*plural
| alters the name of the given profession
|}

==R==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| RELSIZE
|
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Relsize
| Specifies a new relative size

|-
| REMOVE_MATERIAL
|
*MATERIAL NAME
| Removes a material from a creature
|}

==S==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| SAVAGE
|
| Allows creature to show up on (and limits it to) "savage" maps.

|-
| SECRETION
|
*MATERIAL REF (eg LOCAL_CREATURE_MAT
*Material name
*Material State
*location secreted from (by_type, by_category, by_token)
*body part
*tissue layer
| creates a secreted material on given tissue on a given part of the body."

|-
| SELECT_CASTE
|
*caste name, or ALL
| selects a caste

|-
| SELECT_MATERIAL
|
*MATERIAL NAME
| selects the material

|-
| SELECT_TISSUE_LAYER
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token | Selects a tissue at a location"

|-
| SEMIMEGABEAST
|
| Appears as boss creature in quests.

|-
| SET_BP_GROUP
|
*selection criteria BY_TYPE, BY_CATEGORY, BY_TOKEN
*category, type, or token
| selection token"

|-
| SET_TL_GROUP
|
*TISSUE
*BY_CATEGORY, BY_TYPE, BY_TOKEN
*Location - category, type, or token
*tissue
| begins a selection of tissue laters

|-
| SLOW_LEARNER
|
| Presumably similar to [CAN_LEARN], but slower. Present in the entries for ogres and giants

|-
| SMALL_REMAINS
|
| If a creature has this token, it'll leave a small corpse that only rots once, and without miasma.

|-
| SPEC_HEAT
| value
| Amount of energy required for the creature to heat up or cool down.

|-
| SPECIALATTACK_INJECT_EXTRACT
|
*LOCAL_CREATURE_MAT
*MATERIAL eg.POISON
*MATTERSTATE (ALL_SOLID, LIQUID, GAS)
*min:max
| attack type addition that injects a material into the victim.

|-
| SPEECH
| speech file
| boasting speeches relating to killing this creature

|-
| SPEED
| value
| Sets the creatures' movement and work speed, 1000/[100 + SPEED X] is the resulting effect on creatures movement and work rates from default. See Speed for more information.

|-
| SPHERE
|
*sphere name
| Sets what religious spheres the creature is aligned to, for purposes of being worshipped via the [POWER] token. Also affects the layout of hidden fun stuff, and the creature's name.

|-
| SWIM_SPEED
|
*speed
| How fast the creature swims. Typically 2500 (0.38 times the default speed).

|-
| SWIMS_INNATE
|
| The creature naturally knows how to swim, as opposed to [SWIMS_LEARNED] below. Currently, an AI bug prevents this from being useful on PC races in fortress mode.

|-
| SWIMS_LEARNED
|
| The creature must learn to swim. Requires [CAN_LEARN], obviously.

|-
| SYN_AFFECTED_CLASS
|
| adds a class of creatures to those affected, such as CREATURE_CLASS:GENERAL_POISON

|-
| SYN_AFFECTED_CREATURE
| Creature Name
| adds a specific creature to those affected.

|-
| SYN_CONTACT
|
| syndrome can be contracted on contact

|-
| SYN_IMMUNE_CREATURE
|
| creates an exception for the creature so that it not affected by the syndrome.

|-
| SYN_INHALED
|
| syndrome can be contracted by inhaled.

|-
| SYN_INJECTED
|
| syndrome can be contracted by injection.

|-
| SYN_NAME
| text
| defines the name of the syndrome

|-
| SYNDROME
|
| begins definition of a Syndrome for poison use
|}

==T==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| TENDONS
|
*selection criteria. Often LOCAL_CREATURE_MAT, although other selection criteria may work too.
*selected tissue
*healing rate
| Defines the qualities of tendons

|-
| THICKWEB
|
| The creature's webs can catch larger creatures. May imply [AMBUSHPREDATOR]

|-
| TISSUE
| name
| Begins defining a tissue in the creature file.

|-
| TISSUE_LAYER
|
*BY_TYPE, BY_CATEGORY, BY_TOKEN
*TYPE,CATEGORY, or TOKEN
*TISSUE
*LOCATION
| Adds the tissue layer to wherever it is required.
Non-argument Locations can be FRONT, RIGHT, LEFT. Argument locations are AROUND and CLEANS, requiring a further body part and a % of coverage/cleansing

|-
| TISSUE_LAYER_APPEARANCE_MODIFIER
|
*QUALITY
*lowest:lower:low:median:high:higher:highest
| sets the range of qualities, including LENGTH, DENSE, HIGH_POSITION, CURLY, GREASY, WRINKLY

|-
| TISSUE_STYLE_UNIT
|
*tissue
*shaping
| sets tissue to be in a certain shape"

|-
| TL_COLOR_MODIFIER
| COLOR:FREQ:COLOR:FREQ etc
| Creates a list of color patterns, giving each a frequency

|-
| TL_MAJOR_ARTERIES
|
| Gives Major Artery attribute to selected layers.

|-
| TLCM_NOUN
|
*name
*SINGULAR or PLURAL | names the tissue layer color modifier, and determines the noun"

|-
| TLCM_TIMING
|
*ROOT
*start change window years:days:end change window years:days | determines the point in the creature's life where the color change begins"

|-
| TRADE_CAPACITY
|
| How much the creature can carry when used by merchants.

|-
| TRAINABLE
|
| Allows a tame creature to be trained into a "War" or "Hunting" variation by way of Kennels.

|-
| TRAINABLE_HUNTING
|
| Can be trained as hunting beasts

|-
| TRANCES
|
| Allows the creature to go into martial trances.

|-
| TRAPAVOID
|
| The creature is immune to traps.

|-
| TRIGGERABLE_GROUP
| min:max
| unknown

|-
| TSU_NOUN
|
*noun
*SINGULAR or PLURAL
| creates a noun for the tissue used and whether it is singular or plural"
|}

==U==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| UNDERGROUND_DEPTH
| mindepth:maxdepth
| Depth the creature appears underground

|-
| UNDERSWIM
|
| Creature swims under the water and can't be seen.

|-
| USE_MATERIAL_TEMPLATE
| token:material template
| Loads a material, and gives it a shortname for later reference

|-
| USE_TISSUE_TEMPLATE
| Template Name
| Loads a tissue template listed in OBJECT:TISSUE_TEMPLATE files, such as tissue_template_default.txt.

|-
| UTTERANCES
|
| Changes the language of the creature into an unintelligible mess.
|}

==V==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| VEGETATION
|
| unknown

|-
| VERMIN_BITE
|
*amount
*verb (bitten, stung)
*LOCAL_CREATURE_MAT
*MATERIAL
| vermin bites, and injects something.

|-
| VERMIN_FISH
|
| Acts like a fish

|-
| VERMIN_GROUNDER
|
| The creature can be picked up if you stand over it. (Requires confirmation)
'I think this is a habitat flag like VERMIN_SOIL, VERMIN_CHASM, etc. It seems to appear on creatures that don't otherwise have one. – Peristarkawan 17:27, 24 May 2007 (EDT)'

|-
| VERMIN_HATEABLE
|
| Some dwarves will hate the creature and get unhappy thoughts when around it.

|-
| VERMIN_MICRO
|
| This makes the creature move in a swarm of creatures of the same race as it. I.E. Swarm of flies, swarm of ants, etc.

|-
| VERMIN_NOFISH
|
| The creature cannot be caught by fishing.

|-
| VERMIN_NOROAM
|
| The creature will not be observed randomly roaming about the map.

|-
| VERMIN_NOTRAP
|
| The creature cannot be caught by trappers or animal traps. However, this may not work in all cases, as both dragonflies and fairies can be caught by trappers. This is possibly overridden by the VERMIN_GROUNDER token, allowing trappers set to Catch a Live Land Animal to pick up and thus trap the animal. (speculation by Flippantelf 04:45, 15 June 2009 (UTC))

|-
| VERMIN_ROTTER
|
| Present on flies, knuckle worms, acorn flies, and blood gnats. Probably means either the creature is attracted to rot, the creature speeds rotting, or both.

|-
| VERMIN_ROTTER
|
| Present on flies, knuckle worms, acorn flies, and blood gnats. Probably means either the creature is attracted to rot, the creature speeds rotting, or both.

|-
| VERMIN_SOIL
|
| The creature randomly appears near dirt or mud.

|-
| VERMIN_SOIL_COLONY
|
| The vermin will appear in a single tile cluster of many vermin, such as a colony of ants.

|-
| VERMINHUNTER
|
| A creature with this tag will hunt down vermin and kill them. Sometimes they will eat the vermin, but most of the time they will bring it to their owner. This tag also makes impossible to assign an owner to the animal. The animal chooses it's own owner instead (like a cat). If assigned to a playable race, members of that race will ONLY be able to eat vermin.

|-
| VESPERTINE
|
| Sets if the creature is active in evening.
|}

==W==
{| {{prettytable}}
|- bgcolor="#ddd"
! width="20%" | Token
! width="20%" | Arguments
! width="60%" | Description
|-
| WAGON_PULLER
|
| Allows the creature to pull caravan wagons.

|-
| WEBBER
| LOCAL_CREATURE_MAT_SILK
| allows the cerature to web, and defines what the webs are made of.

|-
| WEBIMMUNE
|
| The creature will not get caught in webs.
|}