Dwarf Fortress Wiki - User contributions [en]

Entity token

2018-04-23T02:51:36Z

AVK: /* Behavior */ mixed VALUE definition behavior

{{Quality|Exceptional|19:21, 13 October 2015 (UTC)}}
{{av}}
'''Entity tokens''' define entities, or civilizations, in entity_*.txt files.

== Gameplay ==
{| {{prettytable}}
|- bgcolor="#ddd"
! Token
! Arguments
! Description

|-
| {{text anchor|ALL_MAIN_POPS_CONTROLLABLE}}{{version|0.42.01}} / {{text anchor|ADVENTURE_TIER}}
| order
| Allows adventure mode for entities with sites. Dwarves, Elves, and Humans take up tier 3, 2, and 1 respectively. Order doesn't need to be maintained; a custom entity can have a tier of 3000 and still work even if it's the only custom entity.

[ADVENTURE_TIER:4]

Adventure tiers were removed in [[:Category:Version 0.42.01|Version 0.42.01]], effectively replaced by ALL_MAIN_POPS_CONTROLLABLE.

|-
| {{text anchor|INDIV_CONTROLLABLE}}
|
| Allows the race to be played as an "outsider" in adventure mode. Not having this specified in one of the entities will cause the Adventure mode option to disappear. Note that ADVENTURE_TIER is not required if this token is included, and that this cannot be applied to civilizations that were not in an entity_*.txt file during world gen.

Removed in [[:Category:Version 0.42.01|Version 0.42.01]], in favor of the [[Creature token]] OUTSIDER_CONTROLLABLE.

|-
| {{text anchor|SITE_CONTROLLABLE}}{{version|0.42.01}} / {{text anchor|CIV_CONTROLLABLE}}
|
| Allows fortress mode. If multiple entities have the CIV_CONTROLLABLE token, then in embark mode the specific civs can be chosen by + or - on the civ list screen (by pressing tab), though it will not state what entity the civs belong to. To check which one, tab to the neighbors screen: the entity's race will be at the top. At least one civilization must have this token.

|-
| {{text anchor|CREATURE}}
| creature
|The type of creature that will inhabit the civilization. If multiple creature types are specified, each civilization will randomly choose one of the creatures.
[CREATURE:DWARF]

|-
| {{text anchor|SOURCE_HFID}}
| integer (or generic token?)
| Found on generated [[angel]] entities. Appears to draw from creatures with this HFID, which associates the entity with a historical figure of the same ID corresponding to a [[deity]].

|}

== Placement ==

{| {{prettytable}}
|- bgcolor="#ddd"
! Token
! Arguments
! Description

|-
| {{text anchor|BIOME_SUPPORT}}
|
* [[Biome token|biome]]
* frequency
| Higher numbers make the entity more likely to settle there.
[BIOME_SUPPORT:ANY_GRASSLAND:4]

|-
| {{text anchor|START_BIOME}}
| [[Biome token|biome]]
| Birth of the civilization can be performed on this biome.
[START_BIOME:ANY_FOREST]

|-
| {{text anchor|EXCLUSIVE_START_BIOME}}
| [[Biome token|biome]]
| Birth of the civilization only occurs in this biome.
[EXCLUSIVE_START_BIOME:MOUNTAIN]

|-
| {{text anchor|SETTLEMENT_BIOME}}
| [[Biome token|biome]]
| This civ will create small settlements on this biome, not too far from the EXCLUSIVE_START_BIOME. Used for dwarven hillocks.
[SETTLEMENT_BIOME:ANY_GRASSLAND]

|-
| {{text anchor|DEFAULT_SITE_TYPE}}
| site type
| Valid site types are DARK_FORTRESS (π), CAVE (•), CAVE_DETAILED (Ω), TREE_CITY (î), and CITY (#). Also recognizes PLAYER_FORTRESS, and MONUMENT, though these likely will not work. FORTRESS is no longer a valid entry, instead castles are controlled by BUILDS_OUTDOOR_FORTIFICATIONS. Defaults to CITY. Selecting CAVE causes the classic kobold behavior of not showing of on the "neighbors" section of the site selection screen. Selecting DARK_FORTRESS also allows generation of [[underworld spire|certain other structures]].
[DEFAULT_SITE_TYPE:CAVE_DETAILED]

|-
| {{text anchor|LIKES_SITE}}
| site type
| Most residents will try to move to this site type, unless already at one.
[LIKES_SITE:CAVE_DETAILED]

|-
| {{text anchor|TOLERATES_SITE}}
| site type
| Some residents will try to move to this site type, unless already at one.
[TOLERATES_SITE:CITY]

|-
| {{text anchor|WORLD_CONSTRUCTION}}
| construction
| Controls which constructions the civ will build on the world map. Valid constructions are ROAD, TUNNEL, BRIDGE, and WALL.
[WORLD_CONSTRUCTION:BRIDGE]
[WORLD_CONSTRUCTION:ROAD]
[WORLD_CONSTRUCTION:TUNNEL]
[WORLD_CONSTRUCTION:WALL]

|}

== Population ==

{| {{prettytable}}
|- bgcolor="#ddd"
! Token
! Arguments
! Description

|-
| {{text anchor|MAX_POP_NUMBER}}
| number
| Max historical population '''per entity'''. Multiply this by max starting civ to get the total maximum historical population of the species. Defaults to 500.
[MAX_POP_NUMBER:500]

|-
| {{text anchor|MAX_SITE_POP_NUMBER}}
| number
| Max historical population per individual site. Defaults to 50.
[MAX_SITE_POP_NUMBER:200]

|-
| {{text anchor|MAX_STARTING_CIV_NUMBER}}
| number
| Max number of entities to spawn at world generation. Worldgen picks civs in some sequential order from the raws. Once it reaches the end of the list, it will begin again at the top. Setting this number lower than 100, like say, 7, will cause worldgen to skip over this civ for placement if there are already 7 civs of this type. Note that if all civs are set to lower numbers, and the number of starting civs is set higher than the maximum possible amount of civs in total, it will gracefully stop placing civs and get down to the history aspect of worldgen. Defaults to 3.
[MAX_STARTING_CIV_NUMBER:3]

|}

== Flavor ==
{| {{prettytable}}
|- bgcolor="#ddd"
! Token
! Arguments
! Description

|-
| {{text anchor|PERMITTED_BUILDING}}
| building name
| The named, custom building can be built by a civilization in Fortress Mode.
[PERMITTED_BUILDING:SOAP_MAKER]

|-
| {{text anchor|PERMITTED_JOB}}
| [[Unit type token|profession]]
| Allows this job type to be selected. This applies to worldgen creatures, in the embark screen, and in play. Certain professions also influence the availability of materials for trade.
[PERMITTED_JOB:MINER]

|-
| {{text anchor|PERMITTED_REACTION}}
| reaction name
| Allows this reaction to be used by a civilization. It is used primarily in Fortress Mode, but also allow certain resources, such as [[steel]], to be available to a race. When creating custom reactions, this token MUST be present or the player will not be able to use the reaction in Fortress Mode.
[PERMITTED_REACTION:TAN_A_HIDE]

|-
| {{text anchor|CURRENCY_BY_YEAR}}
|
| Causes the civ's currency to be numbered with the year it was minted.

|-
| {{text anchor|CURRENCY}}
|
* inorganic material
* value
| What kind of metals the civ uses for coin minting as well as the value of the coin.
[CURRENCY:SILVER:5]

|-
| {{text anchor|ART_FACET_MODIFIER}}
|
* type
* number
| OWN_RACE, FANCIFUL, EVIL, GOOD
Number goes from 0 to 25600 where 256 is the default.
[ART_FACET_MODIFIER:OWN_RACE:512]

|-
| {{text anchor|ART_IMAGE_ELEMENT_MODIFIER}}
|
* item
* number
| CREATURE, PLANT, TREE, SHAPE, ITEM 0-25600

Determines the chance of each image occurring in that entity's artwork, such as engravings and on artifacts, for default (non-historical) artwork.

[ART_IMAGE_ELEMENT_MODIFIER:TREE:512]

|-
| {{text anchor|ITEM_IMPROVEMENT_MODIFIER}}
|
* item
* number
| ART_IMAGE, COVERED or GLAZED, RINGS_HANGING, BANDS, SPIKES, ITEMSPECIFIC, THREAD, CLOTH, SEWN_IMAGE 0-25600

Determines the chance of the entity using that particular artwork method, such as "encircled with bands" or "menaces with spikes".

[ITEM_IMPROVEMENT_MODIFIER:SPIKES:0]

This also seems to change the amount that the entity will pay for items that are improved in the ways in their tokens.

|-
| {{text anchor|TRANSLATION}}
| language
| What language raw the entity uses.
* If an entity lacks this tag, translations are drawn randomly from all translation files. Multiple translation tags will only result in the last one being used.
* If GEN_DIVINE is entered, the entity will use a generated divine language, that is, the same language that is used for the names of [[angel]]s.
[TRANSLATION:DWARF]

|-
| {{text anchor|SELECT_SYMBOL}}
|
* noun
* symbol
| ALL, REMAINING, BATTLE, BRIDGE, CIV, LIBRARY{{version|0.42.01}}, MILITARY_UNIT, RELIGION, ROAD, SIEGE, SITE, TEMPLE, TUNNEL, VESSEL, WALL, WAR
Causes the entity to more often use these symbols in the particular SYM set.
[SELECT_SYMBOL:ALL:PEACE]

|-
| {{text anchor|SUBSELECT_SYMBOL}}
|
* noun
* symbol
| Causes the symbol set to be preferred as adjectives by the civilization. Used in vanilla to put violent names in sieges and batttles.
[SELECT_SYMBOL:SIEGE:NAME_SIEGE]
[SUBSELECT_SYMBOL:SIEGE:VIOLENT]

|-
| {{text anchor|CULL_SYMBOL}}
|
* noun
* symbol
| Causes the entity to not use the words in these SYM sets.
[CULL_SYMBOL:ALL:UGLY]

|-
| {{text anchor|FRIENDLY_COLOR}}
| see [[color]]
|
The color of this entity's civilization settlements in the world gen and embark screens, also used when announcing arrival of their caravan. Defaults to 7:0:1.

[FRIENDLY_COLOR:1:0:1]

|}

== Religion ==
{| {{prettytable}}
|- bgcolor="#ddd"
! Token
! Arguments
! Description

|-
| {{text anchor|RELIGION}}
| type
|
* REGIONAL_FORCE: The creatures will worship a single force associated with the terrain of their initial biome.
* PANTHEON: The creatures will worship a group of gods, each aligned with their spheres and other appropriate ones as well.

[RELIGION:PANTHEON]

|-
| {{text anchor|RELIGION_SPHERE}}
| sphere
| Can be any available [[Sphere]]. Multiple entries are possible. Choosing a religious sphere will automatically make its opposing sphere not possible for the species to have: adding WATER, for example, means the species will never get FIRE as a religious sphere. Note that the DEATH sphere favours the appearance of necromancers (and therefore, towers) in the race.

[RELIGION_SPHERE:FORTRESSES]

|-
| {{text anchor|SPHERE_ALIGNMENT}}
|
* type
* number
|
This token forces an entity to favor or disfavor particular religious spheres, causing them to acquire those spheres more often when generating a pantheon.

[SPHERE_ALIGNMENT:TREES:512]

|}

== Leadership ==
{| {{prettytable}}
|- bgcolor="#ddd"
! Token
! Arguments
! Description

|-
| {{text anchor|POSITION}}
| string
| Defines a leader/noble position for a civilization. These replace previous tags such as [MAYOR] and [CAN_HAVE_SITE_LEADER] and so on. To define a position further, see [[Position token]].

|-
| {{text anchor|LAND_HOLDER_TRIGGER}}
|
* land holder number
* population
* wealth exported
* created wealth
| Defines when a particular land-holding noble (baron, count, duke in vanilla) will arrive at a fortress.

|-
| {{text anchor|SITE_VARIABLE_POSITIONS}}
| Position responsibility or ALL
| Allows a site responsibility to be taken up by a dynamically generated position (lords, hearthpersons, etc). Any defined positions holding a given responsibility will take precedence over generated positions for that responsibility. Also appears to cause site disputes.{{Verify}}

|-
| {{text anchor|VARIABLE_POSITIONS}}
| Position responsibility or ALL
| Allows a responsibility to be taken up by a dynamically generated position (such as Law-maker). Any defined positions holding a given responsibility will take precedence over generated positions for that responsibility.

|}

== Behavior ==
{| {{prettytable}}
|- bgcolor="#ddd"
! Token
! Arguments
! Description

|-
| {{text anchor|ETHIC}}
|
*behavior
*reaction
| Sets the civ's view of [[ethic]]s (certain behaviors), from capital punishment to completely acceptable. This also causes the civ to look upon opposing ethics with disfavor, if their reaction to it is opposing, and when at extremes (one ACCEPTABLE, another civ UNTHINKABLE for example) they will often go to war over it.
[ETHIC:EAT_SAPIENT_KILL:ACCEPTABLE]

|-
| {{text anchor|VALUE}}
|
*value
*number
| Sets the civ's [[personality trait|cultural values]]. Numbers range from -50 (completely anathema) to 0 (neutral) to 50 (highly valued).
[VALUE:CRAFTSMANSHIP:50]

|-
| {{text anchor|VARIABLE_VALUE}}{{version|0.42.01}}
|
*value or ALL
*min
*max
| Makes values randomized rather than specified.
This tag overrides the VALUE tag. Using [VARIABLE_VALUE:ALL:x:y] and then overwriting single values with further [VARIABLE_VALUE:value:x:y] tags works.

|-
| {{text anchor|WILL_ACCEPT_TRIBUTE}}
|
| Makes the civ's traders accept offered goods.

|-
| {{text anchor|WANDERER}}, {{text anchor|BEAST_HUNTER}}, {{text anchor|SCOUT}}, {{text anchor|MERCENARY}}
|
| The civ will send out these sorts of adventurers in worldgen. This seems to increase Tracker skill. These types of adventurers will sometimes be seen leading a battle (instead of war leaders or generals) in remote locations during world-gen, in charge of the defenders.

If the civ sends out mercenaries, they may come to the player's fort to enlist in the military.{{version|0.42.01}}

|-
| {{text anchor|ABUSE_BODIES}}
|
| The civilization will mutilate bodies when they are the victors in history-gen warfare, such as hanging bodies from trees, putting them on spikes, and so forth. Adventurers killed in Adventurer mode will sometimes be impaled on spikes wherever they died, with or without this token, and regardless of whether they actually antagonized the townspeople.

|-
| {{text anchor|ACTIVE_SEASON}}
| season
| The season when the civ is most active: when they will trade, interact with you via diplomats, and/or invade you. Civs can have multiple season entries. Note: If multiple caravans arrive at the same time, you are able to select which civ to trade with at the depot menu. ACTIVE_SEASON tags may be changed for a currently active fort.
[ACTIVE_SEASON:AUTUMN]

|-
| {{text anchor|AMBUSHER}}
|
| When invading sneaks around and shoots at straggling members of your society. They will spawn on the edge of the map and will only be visible when one of their party are spotted; this can be quite dangerous to undefended trade depots. If the civilization also has the SIEGER token, they will eventually ramp it up to less subtle means of warfare.

|-
| {{text anchor|AT_PEACE_WITH_WILDLIFE}}
|
| Will not attack wildlife, and will not be attacked by them, even if you have them in your party. This can be somewhat disconcerting when attacked by bears in the forest, and your elven ally sits back and does nothing.

|-
| {{text anchor|BABYSNATCHER}}
|
| Sends thieves to steal babies. Without this tag (or AMBUSHER, or ITEM_THIEF), enemy civs will only siege (if capable), and will siege as early as they would otherwise babysnatch. This can happen as early as the first year of the fort! In addition, babysnatcher civs will snatch children during worldgen, allowing them to become part of the civ if they do not escape.

Note: If the playable civ in Fortress Mode has this tag (e.g. you add BABYSNATCHER to the Dwarf entity) then the roles will be reversed and elves and humans will siege and ambush and goblins will be friendly to you. However, animals traded away to one's own caravan will count as snatched, reported upon the animal leaving the map, and the animal will not count as having been exported.

|-
| {{text anchor|BUILDS_OUTDOOR_FORTIFICATIONS}}
|
| Makes the civilization build castles from [[mead hall]]s, and (unlike older versions) only functions when the type of site built is a hamlet/town. This, combined with the correct type of [[position token|position]] associated with a site, is why adventurers can only lay claim to human sites. {{bug|8001}}

|-
| {{text anchor|BUILDS_OUTDOOR_TOMBS}}
|
| Makes the civilization build tombs.

|-
| {{text anchor|BANDITRY}}
| percentage
| Sets a percentage of the entity population to be used as bandits.

|-
| {{text anchor|DIPLOMAT_BODYGUARDS}}
|
| Visiting diplomats are accompanied by a pair of soldiers.
|-
| {{text anchor|GENERATED}}
|
| Found on generated divine "HF Guardian Entities". Cannot be used in user-defined raws.

|-
| {{text anchor|INVADERS_IGNORE_NEUTRALS}}
|
| Causes invaders to ignore visiting caravans and other neutral creatures.{{verify}}

|-
| {{text anchor|ITEM_THIEF}}
|
| Sends thieves to steal items. This will also occur in history generation, and thieves will have the "thief" profession. Items stolen in history gen will be scattered around that creature's home. Also causes that civ to be hostile to any entity without this token. Without this tag (or AMBUSHER, or BABYSNATCHER), enemy civs will only siege (if capable), and will siege as early as they would otherwise steal.

Note: If the playable civ in Fortress Mode has this tag (e.g. you add ITEM_THIEF to the Dwarf entity) then the roles will be reversed and elves and humans will siege and ambush and kobolds will be friendly to you. However, ALL items traded away to one's own caravan will count as stolen, reported when the items leave the map, and the stolen items will not count as exported.

|-
| {{text anchor|LOCAL_BANDITRY}}
|
| Causes the entity to send out patrols that can ambush adventurers. Said patrols will be hostile to any adventurers they encounter, regardless of race or nationality.

|-
| {{text anchor|MERCHANT_BODYGUARDS}}
|
| Caravan merchants are accompanied by soldiers.

|-
| {{text anchor|MERCHANT_NOBILITY}}
|
| Effect unknown - in previous versions, this resulted in the civ having a Guild Representative / Merchant Baron / Merchant Prince, but now this is controlled solely by positions.

|-
| {{text anchor|PROGRESS_TRIGGER_POPULATION}}
| level
| 0 to 5, civ will come to site once population at site has reached that level. If multiple progress triggers exist for a civ, it will come when any one of them is fulfilled instead of waiting for all of them to be reached. A value of 0 disables the trigger. 1 corresponds to 20 dwarves, 2 to 50 dwarves, 3 to 80, 4 to 110, and 5 to 140. Progress triggers may be changed, added, or deleted for a currently active fort. Note: hostile civs require that the population trigger be fulfilled as well as at least one other trigger before attacking.

|-
| {{text anchor|PROGRESS_TRIGGER_PRODUCTION}}
| level
| 0 to 5, civ will come to site once created wealth has reached that level. If multiple progress triggers exist for a civ, it will come when any one of them is fulfilled instead of waiting for all of them to be reached. A value of 0 disables the trigger. 1 corresponds to 5000☼ created wealth, 2 to 25000☼, 3 to 100000☼, 4 to 200000☼, and 5 to 300000☼. Progress triggers may be changed, added, or deleted for a currently active fort.

|-
| {{text anchor|PROGRESS_TRIGGER_TRADE}}
| level
| 0 to 5, civ will come to site once exported goods has reached that level. If multiple progress triggers exist for a civ, it will come when any one of them is fulfilled instead of waiting for all of them to be reached. A value of 0 disables the trigger. 1 corresponds to 500☼ exported wealth, 2 to 2500☼, 3 to 10000☼, 4 to 20000☼, and 5 to 30000☼. Progress triggers may be changed, added, or deleted for a currently active fort.

|-
| {{text anchor|PROGRESS_TRIGGER_POP_SIEGE}}
| level
| 0 to 5, civ will begin to send sieges against the player civ when this level is reached if it is hostile.

If multiple progress triggers exist for a civ, it will come when any one of them is fulfilled instead of waiting for all of them to be reached. A value of 0 disables the trigger.

|-
| {{text anchor|PROGRESS_TRIGGER_PROD_SIEGE}}
| level
| 0 to 5, civ will begin to send sieges against the player civ when this level is reached if it is hostile.

|-
| {{text anchor|PROGRESS_TRIGGER_TRADE_SIEGE}}
| level
| 0 to 5, civ will begin to send sieges against the player civ when this level is reached if it is hostile.

|-
| {{text anchor|SIEGER}}
|
| Will start campfires and wait around at the edge of your map for a month or two before rushing in to attack. This will occur when the progress triggers for sieging are reached. If the civ lacks smaller methods of conflict (AMBUSHER, BABYSNATCHER, ITEM_THIEF), they will instead send smaller-scale sieges when their triggers for "first contact" are reached.

|-
| {{text anchor|SITE_GUARDIAN}}
|
| Guards certain special sites, such as a [[vault]] belonging to a [[demon]] allied with a [[deity]]. Used in generated divine entities.

|-
| {{text anchor|SKULKING}}
|
| This makes the severity of attacks depend on the extent of item/baby thievery rather than the passage of time. Designed to go with ITEM_THIEF, may or may not work with BABYSNATCHER.

|-
| {{text anchor|TREE_CAP_DIPLOMACY}}
|
| Visiting diplomats impose tree cutting quotas; without this, they will simply compliment your fortress and leave. Also causes the diplomat to make unannounced first contact at the very beginning of the first Spring after your fortress becomes a land holder.

|-
| {{text anchor|LAYER_LINKED}}
|
| Defines if a civilization is a hidden subterranean entity, such as [[bat man]] civilizations. May spawn in any of three caverns, in groups of 5-10 soldiers who will hunt down nearby cavern creatures.

|-
| {{text anchor|UNDEAD_CANDIDATE}}
|
| Unknown. Possibly makes this creature available as a "Corpse" (e.g. Human Corpse) for necromancers in adventure mode.

|-
| {{text anchor|GENERATE_KEYBOARD_INSTRUMENTS}}, {{text anchor|GENERATE_PERCUSSION_INSTRUMENTS}}, {{text anchor|GENERATE_STRINGED_INSTRUMENTS}}, {{text anchor|GENERATE_WIND_INSTRUMENTS}}, {{text anchor|GENERATE_DANCE_FORMS}}, {{text anchor|GENERATE_MUSICAL_FORMS}}, {{text anchor|GENERATE_POETIC_FORMS}}{{version|0.42.01}}
|
| Makes civilizations generate the given instruments/forms.

|-
| {{text anchor|SCHOLAR}}{{version|0.42.01}}
| scholar type
| ALL, ASTRONOMER, CHEMIST, DOCTOR, ENGINEER, GEOGRAPHER, HISTORIAN, MATHEMATICIAN, NATURALIST, PHILOSOPHER

|-
| {{text anchor|SET_SCHOLARS_ON_VALUES_AND_JOBS}}{{version|0.42.01}}
|
| Generates scholars based on the values generated with the VARIABLE_VALUE tag.

|-
| {{text anchor|NO_ARTIFACT_CLAIMS}}{{version|0.44.01}}
|
| Used for kobolds.

|}

== Available Resources ==
{| {{prettytable}}
|- bgcolor="#ddd"
! Token
! Arguments
! Description

|-
| {{text anchor|AMMO}}
| item token
|
[AMMO:ITEM_AMMO_BOLTS]

|-
| {{text anchor|ARMOR}}
|
* item token
* rarity
|Rarity is optional. Permitted rarity values are RARE, UNCOMMON, FORCED (anything else is treated as COMMON).
[ARMOR:ITEM_ARMOR_PLATEMAIL:COMMON]

|-
| {{text anchor|DIGGER}}
| item token
| Causes the selected weapon to fall under the "digging tools" section of the embark screen. Also forces the weapon to be made out of metal, which can cause issues if a modded entity has access to picks without access to metal. For those cases, listing the pick under the [WEAPON] token works just as well. Note that this tag is neither necessary nor sufficient to allow use of that item as a mining tool -- for that, the item itself needs to be a weapon with [SKILL:MINING].
[DIGGER:ITEM_WEAPON_PICK]

|-
| {{text anchor|GLOVES}}
|
* item token
* rarity
| Rarity is optional. Permitted rarity values are RARE, UNCOMMON, FORCED (anything else is treated as COMMON).
[GLOVES:ITEM_GLOVES_GLOVES:COMMON]

|-
| {{text anchor|HELM}}
|
* item token
* rarity
| Rarity is optional. Permitted rarity values are RARE, UNCOMMON, FORCED (anything else is treated as COMMON).
[HELM:ITEM_HELM_HELM:COMMON]

|-
| {{text anchor|INSTRUMENT}}
| item token
| No longer used as of [[:Category:Version 0.42.01|Version 0.42.01]] due to the ability to generate instruments in world generation. It is still usable if pre-defined instruments are modded in, and generated musical forms are capable of selecting pre-defined instruments to use. However, reactions for making instruments, instrument parts, and/or assembling such instruments need to be added as well, as this token no longer adds such instruments to the craftdwarf's workshop menu.
[INSTRUMENT:ITEM_INSTRUMENT_FLUTE]

|-
| {{text anchor|PANTS}}
|
* item token
* rarity
| Rarity is optional. Permitted rarity values are RARE, UNCOMMON, FORCED (anything else is treated as COMMON).
[PANTS:ITEM_PANTS_PANTS:COMMON]

|-
| {{text anchor|SHIELD}}
| item token
|
[SHIELD:ITEM_SHIELD_SHIELD]

|-
| {{text anchor|SHOES}}
|
* item token
* rarity
| Rarity is optional. Permitted rarity values are RARE, UNCOMMON, FORCED (anything else is treated as COMMON).
[SHOES:ITEM_SHOES_SHOES:COMMON]

|-
| {{text anchor|SIEGEAMMO}}
| item token
|
[SIEGEAMMO:ITEM_SIEGEAMMO_BALLISTA]

|-
| {{text anchor|TOOL}}
| item token
|
[TOOL:ITEM_TOOL_NEST_BOX]

|-
| {{text anchor|TOY}}
| item token
|
[TOY:ITEM_TOY_PUZZLEBOX]

|-
| {{text anchor|TRAPCOMP}}
| item token
|
[TRAPCOMP:ITEM_TRAPCOMP_GIANTAXEBLADE]

|-
| {{text anchor|WEAPON}}
| item token
|
[WEAPON:ITEM_WEAPON_AXE_BATTLE]

|-
| {{text anchor|USE_ANIMAL_PRODUCTS}}
|
| Allows civilization to use products made from animals. All relevant creatures will be able to provide wool, silk, and extracts (including milk and venom) for trade, and non-sentient creatures (unless ethics state otherwise) will be able to provide eggs, caught fish, meat, leather, bone, shell, pearl, horn, and ivory.

|-
| {{text anchor|USE_ANY_PET_RACE}}
|
| Any creature in the civilization's list of usables (from the surrounding 7x7 or so of squares and map features in those squares) which has PET or PET_EXOTIC will be available as a pet, pack animal (with PACK_ANIMAL), wagon puller (with WAGON_PULLER), mount (with MOUNT or MOUNT_EXOTIC), or siege minion (with TRAINABLE_WAR and ''without'' CAN_LEARN). This notion of the initial usable creature list, which then gets pared down or otherwise considered, applies below as well. All common domestic and equipment creatures are also added to the initial list.

|-
| {{text anchor|USE_CAVE_ANIMALS}}
|
| If they don't have it, creatures with exclusively subterranean biomes are skipped. If they have it, cave creatures with PET will also be available as pets, pack animals (with PACK_ANIMAL), wagon pullers (with WAGON_PULLER), mounts (with MOUNT or MOUNT_EXOTIC), and siege minions (with TRAINABLE_WAR and ''without'' CAN_LEARN).

|-
| {{text anchor|USE_EVIL_ANIMALS}}
|
| Don't have it -> EVIL creatures skipped. If they have it, evil creatures with SLOW_LEARNER or ''without'' CAN_LEARN will be also available as pets (with PET), pack animals (with PACK_ANIMAL), wagon pullers (with WAGON_PULLER), mounts (with MOUNT or MOUNT_EXOTIC), and siege minions (with TRAINABLE_WAR or SLOW_LEARNER), even the normally untameable species.

|-
| {{text anchor|USE_EVIL_PLANTS}}
|
| As EVIL creatures for all uses of plants.

|-
| {{text anchor|USE_EVIL_WOOD}}
|
| As EVIL creatures for all uses of wood.

|-
| {{text anchor|USE_GOOD_ANIMALS}}
|
| Don't have it -> GOOD creatures skipped. If they have it, good creatures ''without'' CAN_LEARN will also be available as pets (with PET), pack animals (with PACK_ANIMAL), wagon pullers (with WAGON_PULLER), mounts (with MOUNT or MOUNT_EXOTIC), and siege minions (with TRAINABLE_WAR), even the normally untameable species.

|-
| {{text anchor|USE_GOOD_PLANTS}}
|
| As GOOD creatures for all uses of plants.

|-
| {{text anchor|USE_GOOD_WOOD}}
|
| As GOOD creatures for all uses of wood.

|-
| {{text anchor|USE_MISC_PROCESSED_WOOD_PRODUCTS}}
|
| If the relevant professions are permitted, controls availability of lye (LYE_MAKING), charcoal (BURN_WOOD), and potash (POTASH_MAKING).

|-
| {{text anchor|COMMON_DOMESTIC_MOUNT}}
|
| Gives the civilization access to creatures with COMMON_DOMESTIC and MOUNT. Additionally, all available (based on USE_ANY_PET_RACE, USE_CAVE_ANIMALS, USE_GOOD_ANIMALS, and USE_EVIL_ANIMALS) creature with MOUNT and PET will be allowed for use as mounts during combat.

|-
| {{text anchor|COMMON_DOMESTIC_PACK}}
|
| Gives the civilization access to creatures with COMMON_DOMESTIC and PACK_ANIMAL. Additionally, all available (see above) creatures with PACK_ANIMAL and PET will be allowed for use during trade as pack animals.

|-
| {{text anchor|COMMON_DOMESTIC_PET}}
|
| Gives the civilization access to creatures with COMMON_DOMESTIC and PET. Additionally, all available (see above) creatures with PET will be allowed for use as pets.

|-
| {{text anchor|COMMON_DOMESTIC_PULL}}
|
| Gives the civilization access to creatures with COMMON_DOMESTIC and WAGON_PULLER. Additionally, all available (see above) creatures with WAGON_PULLER and PET will be allowed for use during trade to pull [[wagon]]s.

|-
| {{text anchor|RIVER_PRODUCTS}}
|
| Allow civ to use river products in the goods it has available for trade.

|-
| {{text anchor|OCEAN_PRODUCTS}}
|
| Allow civ to use ocean products (including [[amber]] and [[coral]]) in the goods it has available for trade. Without OCEAN_PRODUCTS, civilizations will not be able to trade ocean fish even if they are ''also'' available from other sources (e.g. [[sturgeon]]s and [[stingray]]s).

|-
| {{text anchor|INDOOR_FARMING}}
|
| Allow civ to use underground plant products in the goods it has available for trade. Lack of suitable vegetation in caverns will cause [[World generation#Rejections|worldgen rejection]]s.

|-
| {{text anchor|OUTDOOR_FARMING}}
|
| Allow civ to use outdoor plant products in the goods it has available for trade. Lack of suitable vegetation in the civ's starting area will cause [[World generation#Rejections|worldgen rejection]]s.

|-
| {{text anchor|INDOOR_GARDENS}}
|
| Allow civ to use underground plant growths (quarry bush leaves in unmodded games) in the goods it has available for trade.

|-
| {{text anchor|OUTDOOR_GARDENS}}
|
| Allow civ to use outdoor plant growths in the goods it has available for trade.

|-
| {{text anchor|INDOOR_ORCHARDS}}
|
| Allows civ to use indoor tree growths in the goods it has available for trade. Not used in vanilla entities, as vanilla underground trees do not grow fruit.

|-
| {{text anchor|OUTDOOR_ORCHARDS}}
|
| Allows civ to use outdoor tree growths in the goods it has available for trade.

|-
| {{text anchor|CLOTHING}}
|
| Civ members will attempt to wear clothing.

|-
| {{text anchor|SUBTERRANEAN_CLOTHING}}
|
| Will wear things made of spider silk and other subterranean materials.

|-
| {{text anchor|EQUIPMENT_IMPROVEMENTS}}
|
| Adds decorations to equipment based on the level of the generated unit. Also improves item quality.

|-
| {{text anchor|IMPROVED_BOWS}}
|
| Adds decorations to weapons generated for bowman and master bowman. An elf hack.

|-
| {{text anchor|METAL_PREF}}
|
| Allows metal materials to be used to make cages (inexpensive metals only) and crafts.

|-
| {{text anchor|STONE_PREF}}
|
| Allows the civilization to make use of nearby stone types. If the FURNACE_OPERATOR job is permitted, also allows ore-bearing stones to be smelted into metals.

|-
| {{text anchor|WOOD_WEAPONS}}
|
| The civilization can make traditionally metallic weapons such as swords and spears from wood. An elf hack.

|-
| {{text anchor|WOOD_ARMOR}}
|
| The civilization can make traditionally metallic armor such as mail shirts and helmets from wood. An elf hack.

|-
| {{text anchor|GEM_PREF}}
|
| Enables creatures of this entity to bring gems in trade.

|-
| {{text anchor|INDOOR_WOOD}}
|
| Allow civ to use subterranean wood types, such as tower-cap and fungiwood logs.

|-
| {{text anchor|OUTDOOR_WOOD}}
|
| Allow civ to use outdoor wood types, such as mangrove and oak.

|-
| {{text anchor|GEM_SHAPE}}
| [[Descriptor shape token|shape]]
| Precious gems cut by this civilization's jewelers can be of this shape.

|-
| {{text anchor|STONE_SHAPE}}
| [[Descriptor shape token|shape]]
| Ordinary non-gem stones cut by this civilization's jewelers can be of this shape.

|-
| {{text anchor|DIVINE_MAT_CLOTHING}}
|
| Allows civ to use materials with [DIVINE] for clothing. Used for generated divine entities.

|-
| {{text anchor|DIVINE_MAT_CRAFTS}}
|
| Allows civ to use materials with [DIVINE] for crafts.{{verify}} Used for generated divine entities.

|-
| {{text anchor|DIVINE_MAT_WEAPONS}}
|
| Allows civ to use metals with [DIVINE] for weapons. Used for generated divine entities.

|-
| {{text anchor|DIVINE_MAT_ARMOR}}
|
| Allows civ to use metals with [DIVINE] for armour. Used for generated divine entities.

|}

== Animal definitions ==

{{version|0.44.01}}

{| {{prettytable}}
|- bgcolor="#ddd"
! Token
! Arguments
! Description

|-
| {{text anchor|ANIMAL}}
|
| Start an animal definition.

|-
| {{text anchor|ANIMAL_TOKEN}}
| [[creature token]]
| Select specific creature.

|-
| {{text anchor|ANIMAL_CASTE_TOKEN}}
| [[Caste|creature caste token]]
| Select specific creature caste (requires ANIMAL_TOKEN). Sites with animal populations will still include all castes, but only the selected ones will be used for specific roles.

|-
| {{text anchor|ANIMAL_CLASS}}
| [[Creature token#CREATURE_CLASS|creature class]]
| Select creature castes with this creature class (multiple uses allowed).

|-
| {{text anchor|ANIMAL_FORBIDDEN_CLASS}}
| [[Creature token#CREATURE_CLASS|creature class]]
| Forbid creature castes with this creature class (multiple uses allowed).

|-
| {{text anchor|ANIMAL_ALWAYS_PRESENT}}
|
| Animal will be present even if it does not naturally occur in the entity's terrain.

|-
|
* {{text anchor|ANIMAL_NEVER_MOUNT}}, {{text anchor|ANIMAL_ALWAYS_MOUNT}}
* {{text anchor|ANIMAL_NEVER_WAGON_PULLER}}, {{text anchor|ANIMAL_ALWAYS_WAGON_PULLER}}
* {{text anchor|ANIMAL_NEVER_SIEGE}}, {{text anchor|ANIMAL_ALWAYS_SIEGE}}
* {{text anchor|ANIMAL_NEVER_PET}}, {{text anchor|ANIMAL_ALWAYS_PET}}
* {{text anchor|ANIMAL_NEVER_PACK_ANIMAL}}, {{text anchor|ANIMAL_ALWAYS_PACK_ANIMAL}}
|
| Override creature usage tokens. Respectively:
* [[Creature token#MOUNT|MOUNT]] and [[Creature token#MOUNT_EXOTIC|MOUNT_EXOTIC]]
* [[Creature token#WAGON_PULLER|WAGON_PULLER]]
* [[Creature token#TRAINABLE_WAR|TRAINABLE_WAR]] and not [[Creature token#CAN_LEARN|CAN_LEARN]]
* [[Creature token#PET|PET]] and [[Creature token#PET_EXOTIC|PET_EXOTIC]]
* [[Creature token#PACK_ANIMAL|PACK_ANIMAL]]
ALWAYS overrides NEVER if a caste is matched by more than one animal definition.

|}

== Tissue Styling Related Tokens ==
{| {{prettytable}}
|- bgcolor="#ddd"
! Token
! Arguments
! Description

|-
| {{text anchor|TISSUE_STYLE}}
| tissue style unit ID
| Select tissue layer which have the ID attached using TISSUE_STYLE_UNIT token in unit raws. This allows setting further cultural style parameters for selected tissue layer.

|-
| {{text anchor|TS_MAINTAIN_LENGTH}}
|
* minimum length?
* maximum length?
| Presumably sets culturally preferred tissue length for selected tissue. Needs testing.
Dwarves have their beards set to 100:NONE by default.

|-
| {{text anchor|TS_PREFERRED_SHAPING}}
| styling token
| Valid tokens are NEATLY_COMBED, BRAIDED, DOUBLE_BRAIDS, PONY_TAILS, CLEAN_SHAVEN and STANDARD_HAIR/BEARD/MOUSTACHE/SIDEBURNS_SHAPINGS.
Presumably sets culturally preferred tissue shapings for selected tissue. Needs testing.

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

Tool token

2016-02-05T13:39:22Z

AVK:

{{Quality|Superior|12:23, 18 May 2015 (UTC)}}
{{av}}

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

|-
| NAME
|
*singular
*plural
| Name of the tool. Required.

|-
| BONE_MAT{{version|0.42.01}}
|
| Permits the tool to be made from any bone.

|-
| CERAMIC_MAT{{version|0.42.01}}
|
| Permits the tool to be made from any ceramic material.

|-
|DESCRIPTION{{version|0.42.01}}
|
| Allows a string to describe the tool when (v)iewed. The text box can accommodate up to 325 characters until it cuts off, but the spacing of actual sentences puts the realistic limit closer to 300.

|-
| GLASS_MAT{{version|0.42.01}}
|
| Permits the tool to be made from any glass.

|-
| HARD_MAT
|
| Permits the tool to be made from anything with the [ITEMS_HARD] token, such as wood, stone or metal.

|-
| LEATHER_MAT{{version|0.42.01}}
|
| Permits the tool to be made from any leather.

|-
| METAL_MAT
|
| Permits the tool to be made from anything with the [IS_METAL] token.

|-
| METAL_WEAPON_MAT
|
| Permits the tool to be made from any metal with the [ITEMS_WEAPON] token.

|-
| SHEET_MAT{{version|0.42.01}}
|
| Permits the tool to be made from any "sheet" material, such as papyrus, paper, and parchment. Connected to the PAPER_SLURRY/PAPER_PLANT reaction classes? {{verify}}

|-
| SHELL_MAT{{version|0.42.01}}
|
| Permits the tool to be made from any shell.

|-
| SILK_MAT{{version|0.42.01}}
|
| Permits the tool to be made from any silk.

|-
| SOFT_MAT
|
| Permits the tool to be made from any material with the [ITEMS_SOFT] token, such as leather or textiles.

|-
| STONE_MAT{{version|0.42.01}}
|
| Permits the tool to be made from any stone. Presumably connected to the [IS_STONE] token.

|-
| THREAD_PLANT_MAT{{version|0.42.01}}
|
| Permits the tool to be made from any "plant fibre" material, such as pig tails.

|-
| WOOD_MAT
|
| Permits the tool to be made from any wood.

|-
| INCOMPLETE_ITEM{{version|0.42.01}}
|
| According to Toady, "Won't be used in world gen libraries (to differentiate scrolls from quires). Also put it on bindings, rollers, instr. pieces for completeness/future use". Used on scroll rollers, book bindings, and quires.

|-
| DEFAULT_IMPROVEMENT{{version|0.42.01}}
|
*improvement type and subtype (latter only really applicable to SPECIFIC)
*tool material flag like HARD_MAT or SILK_MAT
| Items that appear in the wild come standard with this kind of improvement. Used on scrolls: [DEFAULT_IMPROVEMENT:SPECIFIC:ROLLERS:HARD_MAT]
Currently bugged, the effect is also applied to everything made in-game. This causes scrolls to have two sets of rollers, for example.

|-
| UNIMPROVABLE
|
| Prevents the tool from being improved. Used on honeycombs, (scroll rollers, book bindings, and quires.){{version|0.42.01}}

|-
| VALUE
|
*num
| Defines the item value of the tool. Required.

|-
| TILE
|
*num
| Defines the tile used to represent the tool. Required.

|-
| INVERTED_TILE
|
| The background of the tile will be colored, instead of the foreground.

|-
| NO_DEFAULT_JOB{{version|0.42.01}}
|
| According to Toady, "only custom reactions are used to make this item". Found on scroll and quire.

|-
| TOOL_USE
|
*tool use, see below
| Defines the task performed using the tool.

|-
| FURNITURE
|
| Allows item to be stored in a furniture stockpile.

|-
| ADJECTIVE
|
*adjective
| Adjective preceding the material name (e.g. "large copper dagger")

|-
| SIZE / WEIGHT
|
*size
| Volume of tool in mL or cubic centimeters. Required.

|-
| CONTAINER_CAPACITY
|
*amount
| How much the item can contain. Defaults to 0.

|-
| SHOOT_FORCE
|
*value
| Required for weapons.

|-
| SHOOT_MAXVEL
|
*value
| Required for weapons.

|-
| SKILL
|
*Skill token
| The skill to determine effectiveness in melee with this tool. Required for weapons.

|-
| RANGED
|
*Skill token
*Ammo item token
| Makes this tool a ranged weapon that uses the specified ammo. The specified skill determines accuracy in ranged combat.

|-
| TWO_HANDED
|
*size
| Creatures under this size (in cm^3) must use the tool two-handed. Required for weapons.

|-
| MINIMUM_SIZE
|
*size
| Minimum body size (in cm^3) to use the tool at all (multigrasp required until TWO_HANDED value) Required for weapons.

|-
| MATERIAL_SIZE
|
*value
| Number of bar units needed for forging, as well as the amount gained from melting. Required for weapons.

|-
| ATTACK
|
*attacktype:BLUNT or EDGE
*contact_area:value
*penetration_size:value
*verb2nd:string
*verb3rd:string
*noun:string
*velocity_multiplier:value
| You can have many ATTACK tags and one will be randomly selected for each attack, with EDGE attacks 100 times more common than BLUNT attacks. Required for weapons.
|}

Valid tool uses (and the default tools used for these tasks) are as follows:
{| class="wikitable sortable"
|- bgcolor="#999999"
! ID
! Token
! Usage
|-
| 0 || LIQUID_COOKING || cauldron
|-
| 1 || LIQUID_SCOOP || ladle
|-
| 2 || GRIND_POWDER_RECEPTACLE || mortar
|-
| 3 || GRIND_POWDER_GRINDER || pestle
|-
| 4 || MEAT_CARVING || carving knife
|-
| 5 || MEAT_BONING || boning knife
|-
| 6 || MEAT_SLICING || slicing knife
|-
| 7 || MEAT_CLEAVING || meat cleaver
|-
| 8 || HOLD_MEAT_FOR_CARVING || carving fork
|-
| 9 || MEAL_CONTAINER || bowl
|-
| 10 || NEST_BOX || nest box
|-
| 11 || LIQUID_CONTAINER || jug
|-
| 12 || FOOD_STORAGE || large pot
|-
| 13 || HIVE || hive
|-
| 14 || SMALL_OBJECT_STORAGE || pouch
|-
| 15 || TRACK_CART || minecart
|-
| 16 || HEAVY_OBJECT_HAULING || wheelbarrow
|-
| 17 || STAND_AND_WORK_ABOVE || stepladder
|-
| 18? || ROLL_UP_SHEET{{version|0.42.01}} || scroll rollers{{version|0.42.01}}
|-
| 19? || PROTECT_FOLDED_SHEETS{{version|0.42.01}} || book binding{{version|0.42.01}}
|-
| 20? || CONTAIN_WRITING{{version|0.42.01}} || scroll & quire{{version|0.42.01}}
|-
| 21? || BOOKCASE{{version|0.42.01}} || bookcase{{version|0.42.01}}

|}

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

Item quality/Table

2015-06-04T19:26:42Z

AVK: Still no clue about deflection or rolls, but we do know what quality does to the edge these days.

{|
! style="padding-right: 35px;" | '''Designation''' || style="text-align: left;" | '''Description''' || style="padding-right: 20px; padding-left: 15px; text-align: center;" | '''Value Modifier''' || style="padding-right: 10px; text-align: center;" | '''Sharpness''' || style="text-align: center;" | ''' Weapon To-Hit / Armor Deflect Modifier'''
|-
|  Item Name || style="text-align: center;" | —     || 1x || 50% || 1x || style="text-align: center;" | || style="text-align: center;" |
|-
| -Item Name- || Well-crafted || 2x || 60% || ''unknown '' || style="text-align: center;" | || style="text-align: center;" |
|-
| +Item Name+ || Finely-crafted || 3x || 70% || ''unknown '' || style="text-align: center;" | || style="text-align: center;" |
|-
| *Item Name* || Superior quality || 4x || 80% || ''unknown '' ||style="text-align: center;" | || style="text-align: center;" |
|-
| ≡Item Name≡ || Exceptional || 5x || 90% || ''unknown '' || style="text-align: center;" | || style="text-align: center;" |
|-
| ☼Item Name☼ || Masterful || 12x || 100% || 2x || style="text-align: center;" | || style="text-align: center;" |
|-
| ''Unique name'' || Artifact || 120x || 100% || 3x || style="text-align: center;" |
|-
| «Item Name» || [[decoration|Decorated]] object || Varies || Varies || ''unknown '' || style="text-align: center;" | || style="text-align: center;" |
|}

Plant token

2015-05-24T14:42:37Z

AVK: /* Tree 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

|-
| 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.

|-
| 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 are available at depth 1. Defaults to 0:0 (surface only).

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

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

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

|-
| FREQUENCY
|
*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.

|-
| 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.

|}

==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, and must have both [STOCKPILE_PLANT_GROWTH] and [STRUCTURAL_PLANT_MAT] to be picked in fortress mode. This also lets them be collected from plant gathering and farming jobs, unless the growth is linked to the plant itself through a [[reaction]], as in [[quarry bush]]es.

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

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

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

|-
| 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.

|-
| 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

|-
| GROWTH_TRUNK_HEIGHT_PERC
|
*integer:integer
|

|-
| GROWTH_DENSITY
|
*integer
| Specifies growth density.

|-
| GROWTH_TIMING
|
*[[time]] ticks (0-403200)
| Specifies at which part of the year the growth appears. Default is all year round.

|-
| 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.

|-
| GROWTH_HAS_SEED
|
| The growth carries a seed, which is left when the growth is used or eaten.

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

|-
| 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.

|-
| TRUNK_NAME
|
*name
| What the trunk of the tree is named.

|-
| 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.

|-
| 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.

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

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

|-
| LIGHT_BRANCHES_NAME
|
*name
| What thin branches of the tree are named.

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

|-
| BRANCH_RADIUS / 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.

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

|-
| HEAVY_BRANCH_DENSITY / DIRECTED_BRANCH_DENSITY
|
*integer
| Similar to BRANCH_DENSITY for thick branches.

|-
| HEAVY_BRANCH_RADIUS / DIRECTED_BRANCH_RADIUS
|
*integer
| Similar as BRANCH_RADIUS for thick branches.

|-
| TRUNK_BRANCHING
|
*integer
| How much the trunk branches out. 0 makes the trunk straight.

|-
| ROOT_NAME / ROOTS_NAME
|
*name
| What the roots of the tree are named.

|-
| ROOT_DENSITY
|
*integer
| Density of the root growth.

|-
| ROOT_RADIUS
|
*integer
| How wide the roots reach out.

|-
| TWIGS_NAME
|
*name
| What the twigs of the tree are named.

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

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

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

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

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

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

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

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

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

|-
| TREE_HAS_MUSHROOM_CAP
|
| The tree has a rounded cap-hood like a giant mushroom. This severely stunts a tree's maximum height - see the [http://www.bay12games.com/dwarves/mantisbt/view.php?id=7313#c26413 bug report.]

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

|-
| 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.

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

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

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

|-
| DEAD_TREE_TILE
|
*tile
| The tile used for (un)dead trees and deciduous trees (generally in winter) 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. Unit hundreds of ticks, See [[Time]]. There are 1008 GROWDUR units in a season. Defaults to 300.

|-
| VALUE
|
*value
| Has no known effect. 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]]
| Names a [[alcohol|drink]] made from the plant, allowing it to be used in entity resources. Previously also permitted brewing the plant into [[alcohol]] made of this material. Instead, a MATERIAL_REACTION_PRODUCT of type DRINK_MAT should be used on the proper plant material.

|-
| MILL
|
* [[Material token|material]]
| Permits milling the plant at a [[quern]] or [[millstone]] into a powder made of this material and allows its use in entity resources. Said material should have [POWDER_MISC_PLANT] to permit proper stockpiling.

|-
| THREAD
|
* [[Material token|material]]
| Permits processing the plant at a [[farmer's workshop]] to yield threads made of this material and allows its use in entity resources. Said material should have [THREAD_PLANT] to permit proper stockpiling.

|-
| SEED
|
*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.

|-
| 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. This allows animals to graze on it, and prevents it and its growths from being picked by herbalists. (Grass growths can still be picked in adventure mode, however.)

|-
| GRASS_TILES
|
*tile
*tile
*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}}

Pineapple opal

2015-04-17T22:21:47Z

AVK:

{{quality|Fine|21:51, 7 December 2010 (UTC)}}{{gemlookup/0|wiki=Opal}}{{av}}

'''Pineapple opals''' are moderately valuable [[gem]]s that can be found just about anywhere.
==In Real Life==
Opal "pineapples" are highly unusual opal pseudomorphs. They are formed after a large glauberite crystal dissolves into nothing and leaves behind a crystal-shaped hole. When this "cast" is filled by slowly depositing calcite which then opalizes, the result is a roughly egg-shaped spike ball of precious opal. They're only found in Australia's White Cliffs, which has yielded specimens as large as an adult fist. They can be (and previously were) cut into standard cabochon shapes, but their uniqueness has since been recognized and prized.

{{gamedata}}
{{gems}}

Wood opal

2015-04-14T22:34:18Z

AVK:

{{quality|Fine|21:55, 7 December 2010 (UTC)}}{{gemlookup/0}}{{av}}

'''Wood opals''' are moderately valuable [[gem]]s that can be found just about anywhere.

==In Real Life==
Wood opals are a variety of petrified wood whose structure happened to transition into opal instead of the more usual chalcedony. The amount of actual opal on the fossil can be as little as a thin shiny coating, but the in-game versions probably represent the much more valuable and uncommon solid opal specimens.

{{gamedata}}
{{gems}}

Syndrome

2015-04-05T01:26:10Z

AVK: /* Special Effects */ COMBATHARDNESS was removed all the way back in v0.40.14

{{quality|unrated}}{{av}}

A '''syndrome''' is a disease or effect that a poor, hapless creature might get through encountering certain creatures, extracts, supernatural weather, 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 Blisters 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 Drowsiness Strong pain Fever Unconsciousness Complete paralysis1
|
|
|-
| Blob blisters
| cave blob fluid (contact or ingested)
| Touching a [[cave blob]]
| Mild pain 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 Fever Pain 
| Severe localized necrosis
|
|-
| Bumblebee sting
| bumblebee venom (injected)
| Being stung by a [[bumblebee]] worker
| Pain Strong swelling
|
|
|-
| Bushmaster bite
| bushmaster venom (injected)
| Being bitten by a [[bushmaster]], [[giant bushmaster]] or [[bushmaster man]]
| Strong pain Mild bleeding Dizziness Nausea Unconsciousness Complete paralysis1
|
|
|-
| Cave floater sickness
| cave floater gas (inhaled or ingested)
| Expelled from [[cave floater]]
| Mild nausea
| Fever Strong drowsiness (delayed) Strong dizziness (delayed)
| None
|-
| Cave spider bite
| cave spider venom (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 Swelling Nausea
|
|
|-
| Giant cave spider bite
| giant cave spider venom (injected)
| Being bitten by a [[giant cave spider]]
| Size-dependant paralysis.
| Death by asphyxiation, in small targets. Large targets are generally unhindered.
| None, not that it really matters.
|-
| Gila monster bite
| gila monster venom (injected)
| Being bitten by a [[gila monster]], [[giant gila monster]] or [[gila monster man]]
| Pain Mild swelling
|
|
|-
| Gnomeblight
| [[gnomeblight]] (contact, inhaled, injected, or ingested)
| Unknown. Affects gnomes only
| None
| Severe systemic necrosis2
| None
|-
| Giant desert scorpion sting
| giant desert scorpion venom (injected)
| Being stung by a [[giant desert scorpion]]
| Necrosis of the brain and nervous system
| '''Certain death'''
| None, not that is really matters.
|-
| Helmet snake bite
| helmet snake venom (injected)
| Being bitten by a [[helmet snake]]
| Minor bleeding
| Fever Nausea Dizziness Localized swelling Localized oozing Localized bruising Strong pain Intense localized necrosis Possible loss of limb
| None
|-
| Honey bee sting
| honey bee venom (injected)
| Being stung by a [[honey bee]] worker
| Pain Strong swelling
|
|
|-
| Iron man cough
| iron man gas (inhaled)
| Expelled by [[iron man]]
| Coughing blood
| None
| None
|-
| King cobra bite
| king cobra venom (injected)
| Being bitten by a [[king cobra]]
| Complete paralysis1 Pain, dizziness, drowsiness
| None
| None
|-
| Phantom spider bite
| phantom spider venom (injected)
| Being bitten by a [[phantom spider]]
| None
| Numbness and mild dizziness
| None
|-
| Platypus sting
| platypus venom (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 (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 (injected)
| Being bitten by a [[serpent man]]
| Complete paralysis1
| None
| None
|-
| [evil rain] sickness3
|rowspan=5| random
| Being caught outside in freakish weather in an evil biome
|rowspan=5| random
|rowspan=5| random
|rowspan=5| random
|-
| [evil cloud] sickness4
| Being caught in a creeping cloud in an evil biome
|-
| beast sickness5
| Encounters with [[forgotten beast]]s
|-
| titan sickness5
| Encounters with [[titan]]s
|-
| demon sickness5
| Encounters with [[demon]]s
|}
:1. For small creatures such as humans and dwarves, paralysis tends to result in suffocation.
:2. Necrosis of the brain will eventually result in death once the brain rots away completely.
:3. Evil rain typically only causes minor symptoms such as blisters, bruising, coughing blood, dizziness, fever, nausea, oozing, and pain.
:4. Evil clouds either cause major symptoms (as with beast/titan/demon sicknesses) or permanently transform creatures into [[Undead|zombie-like]] forms.
: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 fatal (severe necrosis from a contact poison attached to a breath weapon/creature made of blood).

==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 (i.e., 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_CLASS
This tag sets a class for the syndrome that can be used in [[Interaction token|interactions.]]

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. PEAK and END aren't required.

*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. Note that this effect is currently bugged, and will not "turn off" until the creature receives a wound to cause its body parts to update.
|-
| 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
| No
| Causes paralysis. 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 Effects===
Several special syndrome effects 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
! Accepts Target
! Arguments
! Description
|-
| CE_ADD_TAG
| No
| tags
| 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
| No
| tags
| Removes a tag from a creature. Supported arguments are the same as CE_ADD_TAG.
|-
| CE_DISPLAY_TILE
| No
| TILE:[[DF2012:Tilesets|tile number]]:[[DF2012:Color#Modding color|colour]]
| The creature displays the specified tile and colour instead of its normal one.
|-
| CE_DISPLAY_NAME
| No
| NAME:singular:plural:adjective
| Attaches a specified name to the creature's normal name.
|-
| CE_FLASH_TILE
| No
| TILE:tile number:colour:FREQUENCY:ticks default tile:ticks syndrome tile
| The creature flashes between its normal tile and the one specified here.
|-
| CE_PHYS_ATT_CHANGE
| No
| [[Attribute]]:percentage:fixed boost(?)
| Alters the physical [[attribute]]s of a creature.
|-
| CE_MENT_ATT_CHANGE
| No
| [[Attribute]]:percentage:fixed boost(?)
| Alters the mental [[attribute]]s of a creature.
|-
| CE_BODY_APPEARANCE_MODIFIER
| No
| APPEARANCE_MODIFIER:HEIGHT:percentage(?)
| Alters the size of the creature. (LENGTH and BROADNESS don't appear to work){{verify}}
|-
| CE_BP_APPEARANCE_MODIFIER
| Yes
| body part:APPEARANCE_MODIFIER:attribute:number]
| Alters the characteristics (height, width etc.) of a body part.
|-
| CE_MATERIAL_FORCE_MULTIPLIER
| No
| MAT_MULT:[[material token|material]]:A:B
| Makes creature affected by materials more or less by a factor of A/B. If A is 3 and B is 2, the creature will be 1.5x weaker to the defined material (can be NONE:NONE for all); if 2:3, the creature will be 1.5 times stronger.
|-
| CE_BODY_MAT_INTERACTION
| No
|
| Causes one of the creature's materials to trigger an interaction, generally when ingested. Several additional tokens may be specified after this:
* CE:INTERACTION:interaction_id
* CE:SYNDROME_TAG:syndrome_trigger_type (SYN_INGESTED, SYN_INJECTED, etc.)
|-
| CE_SPEED_CHANGE
| No
| speed modifier:number
| 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
| No
|
| 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
| No
| PROB:percentage:START:time:END:time
| Transforms into another creature. PROB and END arguments optional. The target creature is specified with:
* CE:CREATURE:CREATURE_ID:CASTE_ID (ex. CE:CREATURE:DWARF:FEMALE) 
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
| No
| PERC:percentage:PERC_ON:percentage
| 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 on a particular roll.
|-
| CE_SENSE_CREATURE_CLASS
| No
| CLASS:creature class:tile:color
| Allows creature to see other creatures with given class through walls. Vampires, for example, have CLASS:GENERAL_POISON:15:4:0:1.
|}

'''All''' creature effect tokens take START, END and PROB numbers, and can be followed by [CE:PERIODIC] and/or [CE:COUNTER_TRIGGER] to restrict when they actually take effect.
* PERIODIC:period_type:min_value:max_value
* {{text anchor|COUNTER_TRIGGER}}:counter_name:min_value:max_value:REQUIRED

Currently, the only valid period type is MOON_PHASE. Valid counter values are below:

{| {{prettytable}}
|- bgcolor="Bisque"
! Counter
! Description
|-
| ALCOHOLIC
| How long it's been (in [[time]] units) since the creature last had a drink of alcohol. Only present on creatures who need alcohol to get through the working day.
* 100800 (3 months) = and is starting to work slowly due to its scarcity
* 201600 (6 months) = and really wants a drink
* 302400 (9 months) = and has gone without a drink for far, far too long
* 403200 (1 year) = and can't even remember the last time he/she had some
|-
| MOUNTAIN
| How much the creature minds being outdoors. Low values are known to decrease the severity of certain unhappy [[thought]]s.
* 0 = likes working outdoors and grumbles only mildly at inclement weather.
* 1 = does not mind being outdoors, at least for a time.
* 2 = (no message)
|-
| TIME_SINCE_BREAK
| How long it's been (in [[time]] units) since the creature last went on [[break]]. Creatures generally go at least a year (100800 time units) between breaks unless the [[economy]] is active (which never happens).
|-
| ON_BREAK
| How long (in [[time]] units) the creature has been on break. Once it reaches 15000 (about 12.5 days), the creature should get back to work.
|-
| CAVE_ADAPT
| How cave-adapted the creature is. Increases by 1 for every [[time]] unit spent underground, to a maximum of 800000.
* 403200 (1 year) = going outside causes irritation
* 604800 (1.5 years) = going outside causes nausea
|-
| PARTIED_OUT
| How long before the creature will decide to attend another party. Starts at 3+ months and counts down to zero.
|-
| MILK_COUNTER
| How long before the creature can be milked again. Starts at the creature's MILK frequency and counts down to zero.
|-
| EGG_SPENT
| How long before the creature can lay more eggs. Starts at 3 months and counts down to zero.
|-
| GROUNDED_ANIMAL_ANGER
| How angry (and likely to attack) an animal is from being over-crowded. Increases when over-crowded and otherwise counts down to zero.
|-
| TIME_SINCE_SUCKED_BLOOD
| How long it's been (in [[time]] units) since the creature last sucked somebody's blood.
|-
| DRINKING_BLOOD
| How much longer the creature will be drinking somebody's blood. Starts at 2.4 days and counts down to zero.
|}

==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 are controlled by 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
| Shoots a trail of liquid mist at the target which can condense and trigger contact syndromes. Creature will attack as normal.
|-
| TRAILING_GAS_FLOW
| Shoots a trail of gas substance at the creature which can be inhaled. Creature will attack as normal.
|-
| TRAILING_ITEM_FLOW:[[item token]]
| Shoots a "cloud" of items at the target, leaving piles of this item on the floor. Note that this does ''not'' create the actual items or use falling item mechanics (meaning no flying daggers or Touhou-style barrages, unfortunately). Instead, this token acts as TRAILING_GAS_FLOW, except that the material will use its ''normal'' temperature - for example, a breath attack of steel anvils will envelop the target in a "burst of steel". 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. If the cooldown rate is short enough, 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 liquid glob of substance at the creature. Contact syndromes will take effect if the glob hits the target's exposed skin.
|-
| SPATTER_POWDER
| Creates a pile of powder at the specified location.
|-
| SPATTER_LIQUID
| Creates a pool of liquid at the specified location.
|-
| UNDIRECTED_GAS
| Creature occasionally releases a cloud of gas 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 liquid mist. 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 cloud of solid dust, 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.
|-
| UNDIRECTED_ITEM_CLOUD:[[item token]]
| Creature occasionally releases a "cloud" of items at the target, leaving piles of this item on the floor. The same comments apply as TRAILING_ITEM_FLOW. Creature will attack as normal.
|-
| WEB_SPRAY
| Emits a burst of [[web]]s that entangle target creatures.
|-
| DRAGONFIRE
| Emits a wide cone of [[dragon]] [[fire]] that burns target creatures at a scorching {{ct|50000}}. For this you want FLOW instead of a material.
|-
| FIREJET
| Emits a narrow cone of [[fire]] that burns target creatures at {{ct|11000}}. For this you want FLOW instead of a material.
|-
| FIREBALL
| Emits a fireball that burns the target creature. For this you want FLOW instead of a material.
|-
| WEATHER_CREEPING_GAS
| Creates a cloud of gas that appears at the edge of the map and slowly creeps across the map. Not usable by creatures.
|-
| WEATHER_CREEPING_VAPOR
| Creates a cloud of creeping vapor. Not usable by creatures.
|-
| WEATHER_CREEPING_DUST
| Creates a cloud of creeping dust. Not usable by creatures.
|-
| WEATHER_FALLING_MATERIAL
| Causes it to start raining a particular material. If the material is solid at the outdoor temperatures, it will snow the material instead. Regardless of the nature of the material, being caught in it will give dwarves the bad thought of being 'caught in freakish weather lately'. Not usable by creatures.
|}

Keep in mind that you can use multiple breath attacks, which appears to make the creature choose between them at random. Creatures cannot use the WEATHER effects, these being reserved for regional interactions.

One major difference between GAS, VAPOR, and DUST is that if the material cannot exist in the specified state at the current temperature, it will automatically be created at a temperature allowing it to exist. So if you create a vapor spray that uses rock or metal as a material, that spray will be created at the material's melting point, setting everything it touches on fire. You can also create a freezing spray by using a custom material that has extremely low melting and/or boiling points.

If you give a creature a material breath attack, be aware that it will be caught in the attack more frequently than its own targets. Make sure to make your creatures immune to their own breath weapons!

{{Category|Modding}}
{{Category|Creature attributes}}
[[ru:DF2012:Syndrome]]

Labor token

2014-08-11T13:40:48Z

AVK: Added the new labors of 40.07 and verified the rest were in their old places in the executable. Migration banner stripped.

{{quality|unrated}}{{av}}

A list of all labor tokens, mainly used in custom buildings.

{| {{prettytable}} class="sortable"
|- style='background-color:#ddd'
! #
! Token
! Labor
|-
|0||MINE||[[Mining]]
|-
|1||HAUL_STONE||[[Stone hauling]]
|-
|2||HAUL_WOOD||[[Wood hauling]]
|-
|3||HAUL_BODY||[[Burial]]
|-
|4||HAUL_FOOD||[[Food hauling]]
|-
|5||HAUL_REFUSE||[[Refuse hauling]]
|-
|6||HAUL_ITEM||[[Item hauling]]
|-
|7||HAUL_FURNITURE||[[Furniture hauling]]
|-
|8||HAUL_ANIMALS||[[Animal hauling]]
|-
|9||CLEAN||[[Cleaning]]
|-
|10||CUTWOOD||[[Wood cutting]]
|-
|11||CARPENTER||[[Carpentry]]
|-
|12||DETAIL||[[Stone detailing]]
|-
|13||MASON||[[Masonry]]
|-
|14||ARCHITECT||[[Architecture]]
|-
|15||ANIMALTRAIN||[[Animal training]]
|-
|16||ANIMALCARE||[[Animal care]]
|-
|17||DIAGNOSE||[[Diagnosis]]
|-
|18||SURGERY||[[Surgery]]
|-
|19||BONE_SETTING||[[Setting bones]]
|-
|20||SUTURING||[[Suturing]]
|-
|21||DRESSING_WOUNDS||[[Dressing wounds]]
|-
|22||FEED_WATER_CIVILIANS||[[Feed patients/prisoners]]
|-
|23||RECOVER_WOUNDED||[[Recovering wounded]]
|-
|24||BUTCHER||[[Butchery]]
|-
|25||TRAPPER||[[Tanning]]
|-
|26||DISSECT_VERMIN||[[Small animal dissection]]
|-
|27||LEATHER||[[Leatherworking]]
|-
|28||TANNER||[[Tanning]]
|-
|29||BREWER||[[Brewing]]
|-
|30||ALCHEMIST||[[Alchemy]]
|-
|31||SOAP_MAKER||[[Soap making]]
|-
|32||WEAVER||[[Weaving]]
|-
|33||CLOTHESMAKER||[[Clothesmaking]]
|-
|34||MILLER||[[Milling]]
|-
|35||PROCESS_PLANT||[[Plant processing]]
|-
|36||MAKE_CHEESE||[[Cheese making]]
|-
|37||MILK||[[Milking]]
|-
|38||COOK||[[Cooking]]
|-
|39||PLANT||[[Farming (fields)]]
|-
|40||HERBALIST||[[Plant gathering]]
|-
|41||FISH||[[Fishing]]
|-
|42||CLEAN_FISH||[[Fish cleaning]]
|-
|43||DISSECT_FISH||[[Fish dissection]]
|-
|44||HUNT||[[Hunting]]
|-
|45||SMELT||[[Furnace operating]]
|-
|46||FORGE_WEAPON||[[Weaponsmithing]]
|-
|47||FORGE_ARMOR||[[Armoring]]
|-
|48||FORGE_FURNITURE||[[Blacksmithing]]
|-
|49||METAL_CRAFT||[[Metalcrafting]]
|-
|50||CUT_GEM||[[Gem cutting]]
|-
|51||ENCRUST_GEM||[[Gem setting]]
|-
|52||WOOD_CRAFT||[[Woodcrafting]]
|-
|53||STONE_CRAFT||[[Stonecrafting]]
|-
|54||BONE_CARVE||[[Bone carving]]
|-
|55||GLASSMAKER||[[Glassmaking]]
|-
|56||EXTRACT_STRAND||[[Strand extraction]]
|-
|57||SIEGECRAFT||[[Siege engineering]]
|-
|58||SIEGEOPERATE||[[Siege operating]]
|-
|59||BOWYER||[[Crossbow-making]]
|-
|60||MECHANIC||[[Mechanics]]
|-
|61||POTASH_MAKING||[[Potash making]]
|-
|62||LYE_MAKING||[[Lye making]]
|-
|63||DYER||[[Dyeing]]
|-
|64||BURN_WOOD||[[Wood burning]]
|-
|65||OPERATE_PUMP||[[Pump operating]]
|-
|66||SHEARER||[[Shearing]]
|-
|67||SPINNER||[[Spinning]]
|-
|68||POTTERY||[[Pottery]]
|-
|69||GLAZING||[[Glazing]]
|-
|70||PRESSING||[[Pressing]]
|-
|71||BEEKEEPING||[[Beekeeping]]
|-
|72||WAX_WORKING||[[Wax working]]
|-
|73||HANDLE_VEHICLES||[[Push/haul vehicles]]
|-
|74||HAUL_TRADE||[[Trade|Depot teamstering]]
|-
|75||PULL_LEVER||[[Lever|Switch yanking]]
|-
|76||REMOVE_CONSTRUCTION||[[Construction|Teardown and building disassembly]]
|-
|77||HAUL_WATER||[[Activity_zone|Bucket brigading, apparently]]
|}
{{Category|Modding}}{{Category|Tokens}}

Reaction

2014-07-15T11:30:20Z

AVK: /* Item reaction products */ Oops again.

{{Quality|Superior|19:56, 28 August 2013 (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. There are several bugs with Adventure mode reactions, chief of which is the fact that you cannot select liquid reagents.{{verify}} 

==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 (SOAP_MAKER, SCREW_PRESS, and anything you've added).

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 (and subtype) 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, bars 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 [[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 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 [[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]
| Reagent material must have the specified reaction class - see below for more details.
|-
| [HAS_MATERIAL_REACTION_PRODUCT:X]
| Reagent material must have the specified material reaction product - see below for more details.
|-
| [HAS_ITEM_REACTION_PRODUCT:X]
| Reagent material must have the specified item reaction product - see below for more details.
|-
| [CONTAINS:X]
| Reagent is a container that holds the specified reagent (where ''X'' is the [[#name|name]] of the reagent).
|-
| [UNROTTEN]
| Reagent must not be rotten, mainly for organic materials.
|-
| style="vertical-align: top"| [CONTAINS_LYE]
| Reagent must be a BARREL or TOOL which contains at least one item of type LIQUID_MISC made of LYE. Use of this token is discouraged, as it does not work with buckets (instead, use [CONTAINS:lye] — note the colon — and a corresponding lye reagent [REAGENT:lye:150:LIQUID_MISC:NONE:LYE]).
|-
| [POTASHABLE]
| Alias for [CONTAINS_LYE].
|-
| [NOT_WEB]
| Reagent must be collected (to distinguish silk thread from webs). Only makes sense for items of type THREAD.
|-
| [WEB_ONLY]
| Reagent must be undisturbed (to distinguish silk thread from webs). Only makes sense for items of type THREAD.
|-
| [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]]. Not necessary if specifying [EMPTY].
|-
| [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 material]] - BAR, BLOCKS, BOULDER, or WOOD.
|-
| [FIRE_BUILD_SAFE]
| Reagent material must be solid and stable at temperatures approaching 11000. Only works with items of type BAR, BLOCKS, BOULDER, WOOD, and ANVIL - all others are considered unsafe.
|-
| [MAGMA_BUILD_SAFE]
| Reagent material must be solid and stable at temperatures approaching 12000. Only works with items of type BAR, BLOCKS, BOULDER, WOOD, and ANVIL - all others are considered unsafe.
|-
| [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 (CORPSE or CORPSEPIECE). Must be used even if your reagent item type is CORPSE or CORPSEPIECE, otherwise it will match any item.
|-
| [NO_EDGE_ALLOWED]
| Reagent must not have an edge - excludes sharp stones (produced using knapping) and most types of weapon/ammo.
|-
| [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]
| Reagent material must have [ITEMS_HARD].
|-
| [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]
| Reagent's item dimension must be at least this large. The reagent's item type must be BAR, POWDER_MISC, LIQUID_MISC, DRINK, THREAD, or CLOTH for this to work.
|-
| [HAS_TOOL_USE:X]
| Reagent must be a [[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 [[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. For the item types AMMO, REMAINS, MEAT, FISH, FISH_RAW, PLANT, LEAVES, DRINK, CHEESE, LIQUID_MISC, COIN, and EGG, the resulting items will be created as a single [[stack]], while all other item types will produce multiple individual items.

If a reaction can take stacks of input items, then it will attempt to perform the reaction enough times to consume as many full sets of reagents as it can - for example, if a reaction "1 piece of meat + 2 pieces of fish -> 3 pieces of cheese" is given a stack of 5 meat and 5 fish, it will produce 6 pieces of cheese and leave 3 meat and 1 fish behind. Using the token DOES_NOT_DETERMINE_PRODUCT_AMOUNT allows a reagent to be excluded from this calculation - for example, with the reaction "1 plant + 1 barrel -> 5 alcohol (into barrel)", using this on the barrel allows the reaction to be performed as "5 plant + 1 barrel -> 25 alcohol" instead of "5 plant + 5 barrel -> 25 alcohol".

====item token====
The [[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 [[craft]] items. This value cannot be used in any other context.

====material token====
A [[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. Has no effect on any other item types.
|-
| [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>.
|-
| PAGES
| Adds pages to a [[book]].
|}

All other item improvement tokens (ART_IMAGE, ITEMSPECIFIC, THREAD, CLOTH, SEWN_IMAGE, and ILLUSTRATION) are ignored.

====material token====
A [[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 [[magma kiln]], [[magma smelter]], or any custom building having [NEEDS_MAGMA]).

==== skill ====
The SKILL token determines what [[Skill token|skill]] the reaction requires and what skill it trains. Only one skill may be specified. For custom reactions, the amount of experience gained is linearly correlated with the amount of product created; a reaction with no product will yield no experience for the performing dwarf. Similarly, the amount of time a reaction takes is correlated with experience gained: if a reaction has zero experience gain due to having no skill associated, the reaction will take minimal time.

==== automatic ====
The AUTOMATIC token means that the reaction will be queued automatically if the reaction reagents are all present.

This token only works with jobs performed at a [[kiln]], [[smelter]], [[tanner's shop]], [[kitchen]], or custom workshop, and [[standing orders]] allow you to limit which ones trigger; custom reactions performed at a [[quern]], [[millstone]]{{verify}}, [[still]]{{verify}} or [[craftsdwarf's workshop]]{{verify}} cannot be made automatic.

==== 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.

==Reaction classes and products==

When you're doing things like tanning hides or brewing alcohol, having separate reactions for every single possible raw material is unwieldy and terrible. However, you can let the reaction itself ask the material for details and process them all with the same reaction. There are three types of tags to dictate this behavior.

===Reaction classes===

The simplest token is the reaction class. If it is tacked on a material, a reaction can limit reagents to only those materials that have the specified arbitrary [REACTION_CLASS:whatever] identifier.

We want a reaction that smelts iron and flux into pig iron. However, there's half-dozen different stones that count as flux. Instead of clogging up the smelter job menu with half-dozen nearly identical reactions that all take in either selenite or limestone or marble for the same result, we use a reaction class.

[REACTION:PIG_IRON_MAKING]
[NAME:make pig iron bars]
[BUILDING:SMELTER:NONE]
[REAGENT:A:150:BAR:NO_SUBTYPE:METAL:IRON]
[REAGENT:B:1:BOULDER:NO_SUBTYPE:NONE:NONE]'''[REACTION_CLASS:FLUX]'''
[REAGENT:C:150:BAR:NO_SUBTYPE:COAL:NO_MATGLOSS]
[PRODUCT:100:1:BAR:NO_SUBTYPE:METAL:PIG_IRON][PRODUCT_DIMENSION:150]
[FUEL]
[SKILL:SMELT]

Note how reagent B now asks "NONE:NONE" as its material now. It now means "boulders of any kind as long as they have the reaction class named FLUX". Stuff like borax, here:

[INORGANIC:BORAX]
[USE_MATERIAL_TEMPLATE:STONE_TEMPLATE]
[STATE_NAME_ADJ:ALL_SOLID:borax][DISPLAY_COLOR:7:7:1][TILE:'`']
'''[REACTION_CLASS:FLUX]'''
[ENVIRONMENT_SPEC:GYPSUM:CLUSTER_SMALL:100]
[ENVIRONMENT_SPEC:ROCK_SALT:CLUSTER:100]
[MATERIAL_VALUE:2]
[IS_STONE]
[MELTING_POINT:11334]
[BOILING_POINT:12835]
[SOLID_DENSITY:1730]

The label itself can be absolutely anything. It's only used to find a match between the material and the reaction.

===Material reaction products===

But what if it's not all the same what materials the members of the reaction class put out? If a tanner starts working on a bear pelt, a horse hide, some dragon scales and a section of human skin, surely they all can't produce generic boot leather! No, the reaction must get the chance to ask the "reaction class" what the reagent should turn out as. We will declare a material reaction product.

[REACTION:TAN_A_HIDE]
[NAME:tan a hide]
[BUILDING:TANNER:CUSTOM_T]
[REAGENT:flaps of skin:1:NONE:NONE:NONE:NONE][USE_BODY_COMPONENT][UNROTTEN]
'''[HAS_MATERIAL_REACTION_PRODUCT:BOOT_FABRIC]'''
[PRODUCT:100:1:SKIN_TANNED:NONE:'''GET_MATERIAL_FROM_REAGENT:flaps of skin:BOOT_FABRIC''']
[SKILL:TANNER]
[AUTOMATIC]

Where you'd usually have some fresh bodypart with the BOOT_FABRIC reaction class produce some generic SKIN_TANNED, this goes further. Instead of declaring a material, he spool of pattern-ready tailoring leather (SKIN_TANNED) now comes out as whatever the skin flaps' material reaction product (named BOOT_FABRIC) says in the material's definition (GET_MATERIAL_FROM_REAGENT). And what does it say?

[MATERIAL_TEMPLATE:SKIN_TEMPLATE]
[STATE_COLOR:ALL_SOLID:GRAY]
[STATE_NAME:ALL_SOLID:skin]
[STATE_ADJ:ALL_SOLID:skin]
...
[ABSORPTION:100]
'''[MATERIAL_REACTION_PRODUCT:BOOT_FABRIC:LOCAL_CREATURE_MAT:LEATHER]'''
[IMPLIES_ANIMAL_KILL]
[ROTS]

It says that the caller of the BOOT_FABRIC hook always comes out as the LEATHER of whatever creature the skin has been peeled off of (LOCAL_CREATURE_MAT). Make it BOOT_FABRIC:INORGANIC:GOLD instead and your tanner turns into Midas. Use your imagination.

===Item reaction products===

The version 0.40 added an even more powerful form of the above. Where material reaction products can only affect what type of stuff the predestined end product is made of, item reaction products can decide the entire end result ahead of time. Item AND material.

Let's assume for a moment that we're completely tired of leather earrings and hair crowns. We want a crafting reaction that takes cloth and only produces things that make sense.

[REACTION:TAILOR_THE_BEST_THING]
[NAME:weave something that makes sense]
[BUILDING:CRAFTSMAN]
[REAGENT:woven fabric:1:CLOTH:NONE:NONE:NONE]
'''[HAS_ITEM_REACTION_PRODUCT:BEST_OPTION]'''
[PRODUCT:100:1:'''GET_ITEM_DATA:woven fabric:BEST_OPTION''']
[SKILL:CLOTHIER]

Now we need to come up with the counterpart tags in the materials. Hmmm... cotton is thin and soft, so it makes pretty good undergarments. An undershirt, maybe?

[PLANT:COTTON] Gossypium hirsutum / sp.
[NAME:cotton plant][NAME_PLURAL:cotton plants][ADJ:cotton plant]
[USE_MATERIAL_TEMPLATE:STRUCTURAL:STRUCTURAL_PLANT_TEMPLATE]
[BASIC_MAT:LOCAL_PLANT_MAT:STRUCTURAL]
[DRY][BIOME:ANY_TROPICAL]
[VALUE:2]
...
[USE_MATERIAL_TEMPLATE:THREAD:THREAD_PLANT_TEMPLATE]
[MATERIAL_VALUE:2]
'''[ITEM_REACTION_PRODUCT:BEST_OPTION:ARMOR:ITEM_ARMOR_TUNIC:LOCAL_PLANT_MAT:THREAD]'''
...

Then jute fabric. Isn't that burlap? And what's about the only thing they make from burlap?

[PLANT:JUTE] Corchorus capsularis / Corchorus olitorius
[NAME:jute plant][NAME_PLURAL:jute plants][ADJ:jute plant]
[USE_MATERIAL_TEMPLATE:STRUCTURAL:STRUCTURAL_PLANT_TEMPLATE]
[BASIC_MAT:LOCAL_PLANT_MAT:STRUCTURAL]
[DRY][BIOME:ANY_TROPICAL]
[VALUE:2]
...
[USE_MATERIAL_TEMPLATE:THREAD:THREAD_PLANT_TEMPLATE]
[MATERIAL_VALUE:2]
'''[ITEM_REACTION_PRODUCT:BEST_OPTION:BOX:NONE:LOCAL_PLANT_MAT:THREAD]'''
...

Sacks, of course! Wait, how about silk?

[CREATURE:SPIDER_CAVE]
[DESCRIPTION:A tiny underground bug, sought after for its thread.]
[NAME:cave spider:cave spiders:cave spider]
...
[USE_MATERIAL_TEMPLATE:SILK:SILK_TEMPLATE]
'''[ITEM_REACTION_PRODUCT:BEST_OPTION:PANTS:ITEM_PANTS_THONG:LOCAL_CREATURE_MAT:SILK]'''
...

This goes on for as long as you let it. The ITEM_REACTION_PRODUCT declares the identifier and then the item and material with subtypes, just like a normal reaction's product line would.

==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
|
| Performing a reaction with large [[stack]]s of inputs can allow multiple sets of outputs to be produced. Setting this flag causes the reagent to be ignored in this process - for example, with the reaction "1 plant + 1 barrel -> 5 alcohol (into barrel)", using this on the barrel allows the reaction to be performed as "5 plant + 1 barrel -> 25 alcohol" instead of "5 plant + 5 barrel -> 25 alcohol".

|-
| EMPTY
|
| If the reagent is a container, it must be empty.

|-
| FIRE_BUILD_SAFE
|
| Reagent must be considered fire safe - i.e. 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_ITEM_REACTION_PRODUCT
| PRODUCT_ID (custom)
| Similar to MATERIAL_REACTION_PRODUCT, but requires the reagen'ts material to have a matching ITEM_REACTION_PRODUCT entry.

|-
| HAS_MATERIAL_REACTION_PRODUCT
| PRODUCT_ID (custom)
| Similar to REACTION_CLASS, but requires the reagent's material to have a matching [[Material definition token|MATERIAL_REACTION_PRODUCT]] entry. Intended for reactions which transform one class of material into another, such as skin->leather and fat->tallow.

|-
| HAS_TOOL_USE
| Tool-use token
| Reagent must be a [[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
|
* size
| Requires that the reagent have a dimension of at least this value. Only effective with BAR, POWDER_MISC, LIQUID_MISC, DRINK, THREAD, and CLOTH items.

|-
| 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 of success (%)
*Quantity
*Item token:subtype
*Material token:subtype
| Defines a thing that comes out of the reaction. GET_MATERIAL_FROM_REAGENT and GET_ITEM_DATA can be used to defer the choice of material and/or item to the appropriate tag in a given reagent's material - the former comes in place of the material token, the latter replaces both the item and material tokens. See above for detailed information on how the hooks work.

|-
| 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
| CLASS_ID (custom)
| Requires the reagent's material to have a matching [[Material definition token|REACTION_CLASS]] entry. Intended for reactions which accept a variety of materials but where the input material does not determine the output material, such as FLUX (for making pig iron and steel) and GYPSUM (for producing plaster powder).

|-
|REAGENT
|
* name/id
* quantity
* [[item token]]
* [[material token]]
| 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|Modding}}
{{Category|Tokens}}

Reaction

2014-07-15T11:28:59Z

AVK: /* Item reaction products */

{{Quality|Superior|19:56, 28 August 2013 (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. There are several bugs with Adventure mode reactions, chief of which is the fact that you cannot select liquid reagents.{{verify}} 

==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 (SOAP_MAKER, SCREW_PRESS, and anything you've added).

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 (and subtype) 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, bars 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 [[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 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 [[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]
| Reagent material must have the specified reaction class - see below for more details.
|-
| [HAS_MATERIAL_REACTION_PRODUCT:X]
| Reagent material must have the specified material reaction product - see below for more details.
|-
| [HAS_ITEM_REACTION_PRODUCT:X]
| Reagent material must have the specified item reaction product - see below for more details.
|-
| [CONTAINS:X]
| Reagent is a container that holds the specified reagent (where ''X'' is the [[#name|name]] of the reagent).
|-
| [UNROTTEN]
| Reagent must not be rotten, mainly for organic materials.
|-
| style="vertical-align: top"| [CONTAINS_LYE]
| Reagent must be a BARREL or TOOL which contains at least one item of type LIQUID_MISC made of LYE. Use of this token is discouraged, as it does not work with buckets (instead, use [CONTAINS:lye] — note the colon — and a corresponding lye reagent [REAGENT:lye:150:LIQUID_MISC:NONE:LYE]).
|-
| [POTASHABLE]
| Alias for [CONTAINS_LYE].
|-
| [NOT_WEB]
| Reagent must be collected (to distinguish silk thread from webs). Only makes sense for items of type THREAD.
|-
| [WEB_ONLY]
| Reagent must be undisturbed (to distinguish silk thread from webs). Only makes sense for items of type THREAD.
|-
| [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]]. Not necessary if specifying [EMPTY].
|-
| [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 material]] - BAR, BLOCKS, BOULDER, or WOOD.
|-
| [FIRE_BUILD_SAFE]
| Reagent material must be solid and stable at temperatures approaching 11000. Only works with items of type BAR, BLOCKS, BOULDER, WOOD, and ANVIL - all others are considered unsafe.
|-
| [MAGMA_BUILD_SAFE]
| Reagent material must be solid and stable at temperatures approaching 12000. Only works with items of type BAR, BLOCKS, BOULDER, WOOD, and ANVIL - all others are considered unsafe.
|-
| [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 (CORPSE or CORPSEPIECE). Must be used even if your reagent item type is CORPSE or CORPSEPIECE, otherwise it will match any item.
|-
| [NO_EDGE_ALLOWED]
| Reagent must not have an edge - excludes sharp stones (produced using knapping) and most types of weapon/ammo.
|-
| [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]
| Reagent material must have [ITEMS_HARD].
|-
| [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]
| Reagent's item dimension must be at least this large. The reagent's item type must be BAR, POWDER_MISC, LIQUID_MISC, DRINK, THREAD, or CLOTH for this to work.
|-
| [HAS_TOOL_USE:X]
| Reagent must be a [[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 [[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. For the item types AMMO, REMAINS, MEAT, FISH, FISH_RAW, PLANT, LEAVES, DRINK, CHEESE, LIQUID_MISC, COIN, and EGG, the resulting items will be created as a single [[stack]], while all other item types will produce multiple individual items.

If a reaction can take stacks of input items, then it will attempt to perform the reaction enough times to consume as many full sets of reagents as it can - for example, if a reaction "1 piece of meat + 2 pieces of fish -> 3 pieces of cheese" is given a stack of 5 meat and 5 fish, it will produce 6 pieces of cheese and leave 3 meat and 1 fish behind. Using the token DOES_NOT_DETERMINE_PRODUCT_AMOUNT allows a reagent to be excluded from this calculation - for example, with the reaction "1 plant + 1 barrel -> 5 alcohol (into barrel)", using this on the barrel allows the reaction to be performed as "5 plant + 1 barrel -> 25 alcohol" instead of "5 plant + 5 barrel -> 25 alcohol".

====item token====
The [[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 [[craft]] items. This value cannot be used in any other context.

====material token====
A [[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. Has no effect on any other item types.
|-
| [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>.
|-
| PAGES
| Adds pages to a [[book]].
|}

All other item improvement tokens (ART_IMAGE, ITEMSPECIFIC, THREAD, CLOTH, SEWN_IMAGE, and ILLUSTRATION) are ignored.

====material token====
A [[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 [[magma kiln]], [[magma smelter]], or any custom building having [NEEDS_MAGMA]).

==== skill ====
The SKILL token determines what [[Skill token|skill]] the reaction requires and what skill it trains. Only one skill may be specified. For custom reactions, the amount of experience gained is linearly correlated with the amount of product created; a reaction with no product will yield no experience for the performing dwarf. Similarly, the amount of time a reaction takes is correlated with experience gained: if a reaction has zero experience gain due to having no skill associated, the reaction will take minimal time.

==== automatic ====
The AUTOMATIC token means that the reaction will be queued automatically if the reaction reagents are all present.

This token only works with jobs performed at a [[kiln]], [[smelter]], [[tanner's shop]], [[kitchen]], or custom workshop, and [[standing orders]] allow you to limit which ones trigger; custom reactions performed at a [[quern]], [[millstone]]{{verify}}, [[still]]{{verify}} or [[craftsdwarf's workshop]]{{verify}} cannot be made automatic.

==== 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.

==Reaction classes and products==

When you're doing things like tanning hides or brewing alcohol, having separate reactions for every single possible raw material is unwieldy and terrible. However, you can let the reaction itself ask the material for details and process them all with the same reaction. There are three types of tags to dictate this behavior.

===Reaction classes===

The simplest token is the reaction class. If it is tacked on a material, a reaction can limit reagents to only those materials that have the specified arbitrary [REACTION_CLASS:whatever] identifier.

We want a reaction that smelts iron and flux into pig iron. However, there's half-dozen different stones that count as flux. Instead of clogging up the smelter job menu with half-dozen nearly identical reactions that all take in either selenite or limestone or marble for the same result, we use a reaction class.

[REACTION:PIG_IRON_MAKING]
[NAME:make pig iron bars]
[BUILDING:SMELTER:NONE]
[REAGENT:A:150:BAR:NO_SUBTYPE:METAL:IRON]
[REAGENT:B:1:BOULDER:NO_SUBTYPE:NONE:NONE]'''[REACTION_CLASS:FLUX]'''
[REAGENT:C:150:BAR:NO_SUBTYPE:COAL:NO_MATGLOSS]
[PRODUCT:100:1:BAR:NO_SUBTYPE:METAL:PIG_IRON][PRODUCT_DIMENSION:150]
[FUEL]
[SKILL:SMELT]

Note how reagent B now asks "NONE:NONE" as its material now. It now means "boulders of any kind as long as they have the reaction class named FLUX". Stuff like borax, here:

[INORGANIC:BORAX]
[USE_MATERIAL_TEMPLATE:STONE_TEMPLATE]
[STATE_NAME_ADJ:ALL_SOLID:borax][DISPLAY_COLOR:7:7:1][TILE:'`']
'''[REACTION_CLASS:FLUX]'''
[ENVIRONMENT_SPEC:GYPSUM:CLUSTER_SMALL:100]
[ENVIRONMENT_SPEC:ROCK_SALT:CLUSTER:100]
[MATERIAL_VALUE:2]
[IS_STONE]
[MELTING_POINT:11334]
[BOILING_POINT:12835]
[SOLID_DENSITY:1730]

The label itself can be absolutely anything. It's only used to find a match between the material and the reaction.

===Material reaction products===

But what if it's not all the same what materials the members of the reaction class put out? If a tanner starts working on a bear pelt, a horse hide, some dragon scales and a section of human skin, surely they all can't produce generic boot leather! No, the reaction must get the chance to ask the "reaction class" what the reagent should turn out as. We will declare a material reaction product.

[REACTION:TAN_A_HIDE]
[NAME:tan a hide]
[BUILDING:TANNER:CUSTOM_T]
[REAGENT:flaps of skin:1:NONE:NONE:NONE:NONE][USE_BODY_COMPONENT][UNROTTEN]
'''[HAS_MATERIAL_REACTION_PRODUCT:BOOT_FABRIC]'''
[PRODUCT:100:1:SKIN_TANNED:NONE:'''GET_MATERIAL_FROM_REAGENT:flaps of skin:BOOT_FABRIC''']
[SKILL:TANNER]
[AUTOMATIC]

Where you'd usually have some fresh bodypart with the BOOT_FABRIC reaction class produce some generic SKIN_TANNED, this goes further. Instead of declaring a material, he spool of pattern-ready tailoring leather (SKIN_TANNED) now comes out as whatever the skin flaps' material reaction product (named BOOT_FABRIC) says in the material's definition (GET_MATERIAL_FROM_REAGENT). And what does it say?

[MATERIAL_TEMPLATE:SKIN_TEMPLATE]
[STATE_COLOR:ALL_SOLID:GRAY]
[STATE_NAME:ALL_SOLID:skin]
[STATE_ADJ:ALL_SOLID:skin]
...
[ABSORPTION:100]
'''[MATERIAL_REACTION_PRODUCT:BOOT_FABRIC:LOCAL_CREATURE_MAT:LEATHER]'''
[IMPLIES_ANIMAL_KILL]
[ROTS]

It says that the caller of the BOOT_FABRIC hook always comes out as the LEATHER of whatever creature the skin has been peeled off of (LOCAL_CREATURE_MAT). Make it BOOT_FABRIC:INORGANIC:GOLD instead and your tanner turns into Midas. Use your imagination.

===Item reaction products===

The version 0.40 added an even more powerful form of the above. Where material reaction products can only affect what type of stuff the predestined end product is made of, item reaction products can decide the entire end result ahead of time. Item AND material.

Let's assume for a moment that we're completely tired of leather earrings and hair crowns. We want a crafting reaction that takes cloth and only produces things that make sense.

[REACTION:TAILOR_THE_BEST_THING]
[NAME:weave something that makes sense]
[BUILDING:CRAFTSMAN]
[REAGENT:woven fabric:1:CLOTH:NONE:NONE:NONE]
'''[HAS_ITEM_REACTION_PRODUCT:BEST_OPTION]'''
[PRODUCT:100:1:'''GET_ITEM_DATA:woven fabric:BEST_OPTION''']
[SKILL:CLOTHIER]

Now we need to come up with the counterpart tags in the materials. Hmmm... cotton is thin and soft, so it makes pretty good undergarments. An undershirt, maybe?

[PLANT:COTTON] Gossypium hirsutum / sp.
[NAME:cotton plant][NAME_PLURAL:cotton plants][ADJ:cotton plant]
[USE_MATERIAL_TEMPLATE:STRUCTURAL:STRUCTURAL_PLANT_TEMPLATE]
[BASIC_MAT:LOCAL_PLANT_MAT:STRUCTURAL]
[DRY][BIOME:ANY_TROPICAL]
[VALUE:2]
...
[THREAD:LOCAL_PLANT_MAT:THREAD]
'''[ITEM_REACTION_PRODUCT:BEST_OPTION:ARMOR:ITEM_ARMOR_TUNIC:LOCAL_PLANT_MAT:THREAD]'''
...

Then jute fabric. Isn't that burlap? And what's about the only thing they make from burlap?

[PLANT:JUTE] Corchorus capsularis / Corchorus olitorius
[NAME:jute plant][NAME_PLURAL:jute plants][ADJ:jute plant]
[USE_MATERIAL_TEMPLATE:STRUCTURAL:STRUCTURAL_PLANT_TEMPLATE]
[BASIC_MAT:LOCAL_PLANT_MAT:STRUCTURAL]
[DRY][BIOME:ANY_TROPICAL]
[VALUE:2]
...
[THREAD:LOCAL_PLANT_MAT:THREAD]
'''[ITEM_REACTION_PRODUCT:BEST_OPTION:BOX:NONE:LOCAL_PLANT_MAT:THREAD]'''
...

Sacks, of course! Wait, how about silk?

[CREATURE:SPIDER_CAVE]
[DESCRIPTION:A tiny underground bug, sought after for its thread.]
[NAME:cave spider:cave spiders:cave spider]
...
[USE_MATERIAL_TEMPLATE:SILK:SILK_TEMPLATE]
'''[ITEM_REACTION_PRODUCT:BEST_OPTION:PANTS:ITEM_PANTS_THONG:LOCAL_CREATURE_MAT:SILK]'''
...

This goes on for as long as you let it. The ITEM_REACTION_PRODUCT declares the identifier and then the item and material with subtypes, just like a normal reaction's product line would.

==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
|
| Performing a reaction with large [[stack]]s of inputs can allow multiple sets of outputs to be produced. Setting this flag causes the reagent to be ignored in this process - for example, with the reaction "1 plant + 1 barrel -> 5 alcohol (into barrel)", using this on the barrel allows the reaction to be performed as "5 plant + 1 barrel -> 25 alcohol" instead of "5 plant + 5 barrel -> 25 alcohol".

|-
| EMPTY
|
| If the reagent is a container, it must be empty.

|-
| FIRE_BUILD_SAFE
|
| Reagent must be considered fire safe - i.e. 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_ITEM_REACTION_PRODUCT
| PRODUCT_ID (custom)
| Similar to MATERIAL_REACTION_PRODUCT, but requires the reagen'ts material to have a matching ITEM_REACTION_PRODUCT entry.

|-
| HAS_MATERIAL_REACTION_PRODUCT
| PRODUCT_ID (custom)
| Similar to REACTION_CLASS, but requires the reagent's material to have a matching [[Material definition token|MATERIAL_REACTION_PRODUCT]] entry. Intended for reactions which transform one class of material into another, such as skin->leather and fat->tallow.

|-
| HAS_TOOL_USE
| Tool-use token
| Reagent must be a [[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
|
* size
| Requires that the reagent have a dimension of at least this value. Only effective with BAR, POWDER_MISC, LIQUID_MISC, DRINK, THREAD, and CLOTH items.

|-
| 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 of success (%)
*Quantity
*Item token:subtype
*Material token:subtype
| Defines a thing that comes out of the reaction. GET_MATERIAL_FROM_REAGENT and GET_ITEM_DATA can be used to defer the choice of material and/or item to the appropriate tag in a given reagent's material - the former comes in place of the material token, the latter replaces both the item and material tokens. See above for detailed information on how the hooks work.

|-
| 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
| CLASS_ID (custom)
| Requires the reagent's material to have a matching [[Material definition token|REACTION_CLASS]] entry. Intended for reactions which accept a variety of materials but where the input material does not determine the output material, such as FLUX (for making pig iron and steel) and GYPSUM (for producing plaster powder).

|-
|REAGENT
|
* name/id
* quantity
* [[item token]]
* [[material token]]
| 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|Modding}}
{{Category|Tokens}}

Reaction

2014-07-15T11:24:40Z

AVK: Redid the reaction class section with the new token and put it in the listings. The rest shouldn't have changed at all between versions. Migration template stripped.

{{Quality|Superior|19:56, 28 August 2013 (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. There are several bugs with Adventure mode reactions, chief of which is the fact that you cannot select liquid reagents.{{verify}} 

==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 (SOAP_MAKER, SCREW_PRESS, and anything you've added).

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 (and subtype) 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, bars 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 [[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 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 [[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]
| Reagent material must have the specified reaction class - see below for more details.
|-
| [HAS_MATERIAL_REACTION_PRODUCT:X]
| Reagent material must have the specified material reaction product - see below for more details.
|-
| [HAS_ITEM_REACTION_PRODUCT:X]
| Reagent material must have the specified item reaction product - see below for more details.
|-
| [CONTAINS:X]
| Reagent is a container that holds the specified reagent (where ''X'' is the [[#name|name]] of the reagent).
|-
| [UNROTTEN]
| Reagent must not be rotten, mainly for organic materials.
|-
| style="vertical-align: top"| [CONTAINS_LYE]
| Reagent must be a BARREL or TOOL which contains at least one item of type LIQUID_MISC made of LYE. Use of this token is discouraged, as it does not work with buckets (instead, use [CONTAINS:lye] — note the colon — and a corresponding lye reagent [REAGENT:lye:150:LIQUID_MISC:NONE:LYE]).
|-
| [POTASHABLE]
| Alias for [CONTAINS_LYE].
|-
| [NOT_WEB]
| Reagent must be collected (to distinguish silk thread from webs). Only makes sense for items of type THREAD.
|-
| [WEB_ONLY]
| Reagent must be undisturbed (to distinguish silk thread from webs). Only makes sense for items of type THREAD.
|-
| [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]]. Not necessary if specifying [EMPTY].
|-
| [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 material]] - BAR, BLOCKS, BOULDER, or WOOD.
|-
| [FIRE_BUILD_SAFE]
| Reagent material must be solid and stable at temperatures approaching 11000. Only works with items of type BAR, BLOCKS, BOULDER, WOOD, and ANVIL - all others are considered unsafe.
|-
| [MAGMA_BUILD_SAFE]
| Reagent material must be solid and stable at temperatures approaching 12000. Only works with items of type BAR, BLOCKS, BOULDER, WOOD, and ANVIL - all others are considered unsafe.
|-
| [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 (CORPSE or CORPSEPIECE). Must be used even if your reagent item type is CORPSE or CORPSEPIECE, otherwise it will match any item.
|-
| [NO_EDGE_ALLOWED]
| Reagent must not have an edge - excludes sharp stones (produced using knapping) and most types of weapon/ammo.
|-
| [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]
| Reagent material must have [ITEMS_HARD].
|-
| [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]
| Reagent's item dimension must be at least this large. The reagent's item type must be BAR, POWDER_MISC, LIQUID_MISC, DRINK, THREAD, or CLOTH for this to work.
|-
| [HAS_TOOL_USE:X]
| Reagent must be a [[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 [[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. For the item types AMMO, REMAINS, MEAT, FISH, FISH_RAW, PLANT, LEAVES, DRINK, CHEESE, LIQUID_MISC, COIN, and EGG, the resulting items will be created as a single [[stack]], while all other item types will produce multiple individual items.

If a reaction can take stacks of input items, then it will attempt to perform the reaction enough times to consume as many full sets of reagents as it can - for example, if a reaction "1 piece of meat + 2 pieces of fish -> 3 pieces of cheese" is given a stack of 5 meat and 5 fish, it will produce 6 pieces of cheese and leave 3 meat and 1 fish behind. Using the token DOES_NOT_DETERMINE_PRODUCT_AMOUNT allows a reagent to be excluded from this calculation - for example, with the reaction "1 plant + 1 barrel -> 5 alcohol (into barrel)", using this on the barrel allows the reaction to be performed as "5 plant + 1 barrel -> 25 alcohol" instead of "5 plant + 5 barrel -> 25 alcohol".

====item token====
The [[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 [[craft]] items. This value cannot be used in any other context.

====material token====
A [[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. Has no effect on any other item types.
|-
| [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>.
|-
| PAGES
| Adds pages to a [[book]].
|}

All other item improvement tokens (ART_IMAGE, ITEMSPECIFIC, THREAD, CLOTH, SEWN_IMAGE, and ILLUSTRATION) are ignored.

====material token====
A [[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 [[magma kiln]], [[magma smelter]], or any custom building having [NEEDS_MAGMA]).

==== skill ====
The SKILL token determines what [[Skill token|skill]] the reaction requires and what skill it trains. Only one skill may be specified. For custom reactions, the amount of experience gained is linearly correlated with the amount of product created; a reaction with no product will yield no experience for the performing dwarf. Similarly, the amount of time a reaction takes is correlated with experience gained: if a reaction has zero experience gain due to having no skill associated, the reaction will take minimal time.

==== automatic ====
The AUTOMATIC token means that the reaction will be queued automatically if the reaction reagents are all present.

This token only works with jobs performed at a [[kiln]], [[smelter]], [[tanner's shop]], [[kitchen]], or custom workshop, and [[standing orders]] allow you to limit which ones trigger; custom reactions performed at a [[quern]], [[millstone]]{{verify}}, [[still]]{{verify}} or [[craftsdwarf's workshop]]{{verify}} cannot be made automatic.

==== 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.

==Reaction classes and products==

When you're doing things like tanning hides or brewing alcohol, having separate reactions for every single possible raw material is unwieldy and terrible. However, you can let the reaction itself ask the material for details and process them all with the same reaction. There are three types of tags to dictate this behavior.

===Reaction classes===

The simplest token is the reaction class. If it is tacked on a material, a reaction can limit reagents to only those materials that have the specified arbitrary [REACTION_CLASS:whatever] identifier.

We want a reaction that smelts iron and flux into pig iron. However, there's half-dozen different stones that count as flux. Instead of clogging up the smelter job menu with half-dozen nearly identical reactions that all take in either selenite or limestone or marble for the same result, we use a reaction class.

[REACTION:PIG_IRON_MAKING]
[NAME:make pig iron bars]
[BUILDING:SMELTER:NONE]
[REAGENT:A:150:BAR:NO_SUBTYPE:METAL:IRON]
[REAGENT:B:1:BOULDER:NO_SUBTYPE:NONE:NONE]'''[REACTION_CLASS:FLUX]'''
[REAGENT:C:150:BAR:NO_SUBTYPE:COAL:NO_MATGLOSS]
[PRODUCT:100:1:BAR:NO_SUBTYPE:METAL:PIG_IRON][PRODUCT_DIMENSION:150]
[FUEL]
[SKILL:SMELT]

Note how reagent B now asks "NONE:NONE" as its material now. It now means "boulders of any kind as long as they have the reaction class named FLUX". Stuff like borax, here:

[INORGANIC:BORAX]
[USE_MATERIAL_TEMPLATE:STONE_TEMPLATE]
[STATE_NAME_ADJ:ALL_SOLID:borax][DISPLAY_COLOR:7:7:1][TILE:'`']
'''[REACTION_CLASS:FLUX]'''
[ENVIRONMENT_SPEC:GYPSUM:CLUSTER_SMALL:100]
[ENVIRONMENT_SPEC:ROCK_SALT:CLUSTER:100]
[MATERIAL_VALUE:2]
[IS_STONE]
[MELTING_POINT:11334]
[BOILING_POINT:12835]
[SOLID_DENSITY:1730]

The label itself can be absolutely anything. It's only used to find a match between the material and the reaction.

===Material reaction products===

But what if it's not all the same what materials the members of the reaction class put out? If a tanner starts working on a bear pelt, a horse hide, some dragon scales and a section of human skin, surely they all can't produce generic boot leather! No, the reaction must get the chance to ask the "reaction class" what the reagent should turn out as. We will declare a material reaction product.

[REACTION:TAN_A_HIDE]
[NAME:tan a hide]
[BUILDING:TANNER:CUSTOM_T]
[REAGENT:flaps of skin:1:NONE:NONE:NONE:NONE][USE_BODY_COMPONENT][UNROTTEN]
'''[HAS_MATERIAL_REACTION_PRODUCT:BOOT_FABRIC]'''
[PRODUCT:100:1:SKIN_TANNED:NONE:'''GET_MATERIAL_FROM_REAGENT:flaps of skin:BOOT_FABRIC''']
[SKILL:TANNER]
[AUTOMATIC]

Where you'd usually have some fresh bodypart with the BOOT_FABRIC reaction class produce some generic SKIN_TANNED, this goes further. Instead of declaring a material, he spool of pattern-ready tailoring leather (SKIN_TANNED) now comes out as whatever the skin flaps' material reaction product (named BOOT_FABRIC) says in the material's definition (GET_MATERIAL_FROM_REAGENT). And what does it say?

[MATERIAL_TEMPLATE:SKIN_TEMPLATE]
[STATE_COLOR:ALL_SOLID:GRAY]
[STATE_NAME:ALL_SOLID:skin]
[STATE_ADJ:ALL_SOLID:skin]
...
[ABSORPTION:100]
'''[MATERIAL_REACTION_PRODUCT:BOOT_FABRIC:LOCAL_CREATURE_MAT:LEATHER]'''
[IMPLIES_ANIMAL_KILL]
[ROTS]

It says that the caller of the BOOT_FABRIC hook always comes out as the LEATHER of whatever creature the skin has been peeled off of (LOCAL_CREATURE_MAT). Make it BOOT_FABRIC:INORGANIC:GOLD instead and your tanner turns into Midas. Use your imagination.

===Item reaction products===

The version 0.40 added an even more powerful form of the above. Where material reaction products can only affect what type of stuff the predestined end product is made of, item reaction products can decide the entire end result ahead of time. Item AND material.

Let's assume for a moment that we're completely tired of leather earrings and hair crowns. We want a crafting reaction that takes cloth and only produces things that make sense.

[REACTION:TAILOR_THE_BEST_THING]
[NAME:weave something that makes sense]
[BUILDING:CRAFTSMAN]
[REAGENT:woven fabric:1:CLOTH:NONE:NONE:NONE]
'''[HAS_ITEM_REACTION_PRODUCT:BEST_OPTION]'''
[PRODUCT:100:1:'''GET_ITEM_DATA:woven fabric:BEST_OPTION''']
[SKILL:CLOTHIER]

Now we need to come up with the counterpart tags in the materials. Hmmm... cotton is thin and soft, so it makes pretty good undergarments. An undershirt, maybe?

[PLANT:COTTON] Gossypium hirsutum / sp.
[NAME:cotton plant][NAME_PLURAL:cotton plants][ADJ:cotton plant]
[USE_MATERIAL_TEMPLATE:STRUCTURAL:STRUCTURAL_PLANT_TEMPLATE]
'''[ITEM_REACTION_PRODUCT:BEST_OPTION:ARMOR:ITEM_ARMOR_TUNIC:LOCAL_PLANT_MAT:THREAD]'''
[BASIC_MAT:LOCAL_PLANT_MAT:STRUCTURAL]
[DRY][BIOME:ANY_TROPICAL]
[VALUE:2]
...

Then jute fabric. Isn't that burlap? And what's about the only thing they make from burlap?

[PLANT:JUTE] Corchorus capsularis / Corchorus olitorius
[NAME:jute plant][NAME_PLURAL:jute plants][ADJ:jute plant]
[USE_MATERIAL_TEMPLATE:STRUCTURAL:STRUCTURAL_PLANT_TEMPLATE]
'''[ITEM_REACTION_PRODUCT:BEST_OPTION:BOX:NONE:LOCAL_PLANT_MAT:THREAD]'''
[BASIC_MAT:LOCAL_PLANT_MAT:STRUCTURAL]
[DRY][BIOME:ANY_TROPICAL]
[VALUE:2]
...

Sacks, of course! Wait, how about silk?

[CREATURE:SPIDER_CAVE]
[DESCRIPTION:A tiny underground bug, sought after for its thread.]
[NAME:cave spider:cave spiders:cave spider]
...
[USE_MATERIAL_TEMPLATE:SILK:SILK_TEMPLATE]
'''[ITEM_REACTION_PRODUCT:BEST_OPTION:PANTS:ITEM_PANTS_THONG:LOCAL_CREATURE_MAT:SILK]'''
...

This goes on for as long as you let it. The ITEM_REACTION_PRODUCT declares the identifier and then the item and material with subtypes, just like a normal reaction's product line would.

==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
|
| Performing a reaction with large [[stack]]s of inputs can allow multiple sets of outputs to be produced. Setting this flag causes the reagent to be ignored in this process - for example, with the reaction "1 plant + 1 barrel -> 5 alcohol (into barrel)", using this on the barrel allows the reaction to be performed as "5 plant + 1 barrel -> 25 alcohol" instead of "5 plant + 5 barrel -> 25 alcohol".

|-
| EMPTY
|
| If the reagent is a container, it must be empty.

|-
| FIRE_BUILD_SAFE
|
| Reagent must be considered fire safe - i.e. 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_ITEM_REACTION_PRODUCT
| PRODUCT_ID (custom)
| Similar to MATERIAL_REACTION_PRODUCT, but requires the reagen'ts material to have a matching ITEM_REACTION_PRODUCT entry.

|-
| HAS_MATERIAL_REACTION_PRODUCT
| PRODUCT_ID (custom)
| Similar to REACTION_CLASS, but requires the reagent's material to have a matching [[Material definition token|MATERIAL_REACTION_PRODUCT]] entry. Intended for reactions which transform one class of material into another, such as skin->leather and fat->tallow.

|-
| HAS_TOOL_USE
| Tool-use token
| Reagent must be a [[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
|
* size
| Requires that the reagent have a dimension of at least this value. Only effective with BAR, POWDER_MISC, LIQUID_MISC, DRINK, THREAD, and CLOTH items.

|-
| 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 of success (%)
*Quantity
*Item token:subtype
*Material token:subtype
| Defines a thing that comes out of the reaction. GET_MATERIAL_FROM_REAGENT and GET_ITEM_DATA can be used to defer the choice of material and/or item to the appropriate tag in a given reagent's material - the former comes in place of the material token, the latter replaces both the item and material tokens. See above for detailed information on how the hooks work.

|-
| 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
| CLASS_ID (custom)
| Requires the reagent's material to have a matching [[Material definition token|REACTION_CLASS]] entry. Intended for reactions which accept a variety of materials but where the input material does not determine the output material, such as FLUX (for making pig iron and steel) and GYPSUM (for producing plaster powder).

|-
|REAGENT
|
* name/id
* quantity
* [[item token]]
* [[material token]]
| 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|Modding}}
{{Category|Tokens}}

v0.34:Armor token

2014-03-17T03:04:14Z

AVK: /* Tokens */ Rewrote the whole lot. Wooden armor is also tied to METAL.

{{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

|-
| {{text anchor|NAME}}
| singular:plural
| Required
| What this item will be called ingame.

|-
| {{text anchor|MATERIAL_SIZE}}
| value
| Required
| 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.

|-
| {{text anchor|ARMORLEVEL}}
|
0 - clothing 
1 - leather 
2 - chain 
3 - plate
| All garments and shields
| The garment's general purpose. Defaults to 1 for shields, 0 for everything else. Class 0 items are claimed and used by civilians as ordinary clothing and are subject to [[wear]].

|-
| {{text anchor|METAL_ARMOR_LEVELS}}
|
| All garments
| Metal versions of this item count as one ARMORLEVEL higher and thus won't be worn by random peasants.

|-
| {{text anchor|CHAIN_METAL_TEXT}}
|
| All garments
| Metal versions of this item will have "chain" added between the material and item name.

|-
| {{text anchor|PREPLURAL}}
| <phrase> of
| ITEM_ARMOR 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.

|-
| {{text anchor|MATERIAL_PLACEHOLDER}}
| adjective
| ITEM_ARMOR 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.

|-
| {{text anchor|VALUE}}
|
|
| Unused. Defaults to -1.

|-
| {{text anchor|UPSTEP}}
| value, MAX
| ITEM_GLOVES ITEM_SHOES ITEM_SHIELD
| Length of gloves or footwear, counted in [LIMB] body parts towards the torso. A value of 1 lets gloves cover the lower arms, a value of 2 stretches a boot all the way over the upper leg and so on. Regardless of the value, none of these items can ever extend to cover the upper or lower body. Shields also have this token, but it only seems to affect weight.

|-
| {{text anchor|UBSTEP}}
| value, MAX
| ITEM_ARMOR
| Length of the sleeves, counted in [LIMB] body parts towards the hands. A value of 0 only protects both halves of the torso, 1 extends over the upper arms and so on. Regardless of the value, body armor can never extend to cover the hands or head.

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).

|-
| {{text anchor|LBSTEP}}
| value or MAX
| ITEM_ARMOR ITEM_PANTS
| Length of the legs/hem, counted in [LIMB] body parts towards the feet. A value of 0 only covers the lower body, 1 extends over the upper legs and so on. Regardless of the value, body armor or pants can never extend to cover the feet.

|-
| {{text anchor|BLOCKCHANCE}}
| value
| ITEM_SHIELD
| Affects the block chance of the shield. Defaults to 10.

|-
| {{text anchor|SOFT}}
|
| All garments
| Clothiers can make this item from all kinds of cloth. If paired with [LEATHER], the item has an equal chance of being either in randomly generated outfits. Further uses of this tag are unknown.

|-
| {{text anchor|HARD}}
|
| All garments
| Default state in the absence of a [SOFT] token. Actual effects unknown.

|-
| {{text anchor|METAL}}
|
| All garments
| Item can be made from metal. Overrides [SOFT] and [LEATHER] in randomly generated outfits, if the ARMORLEVEL permits. Civilizations with [[Entity_token#WOOD_ARMOR|[WOOD_ARMOR]]] will make this item out of wood instead.

|-
| {{text anchor|BARRED}}
|
| All garments
| Craftsmen can make this item from bones. Randomly generated outfits don't include bone armor.

|-
| {{text anchor|SCALED}}
|
| All garments
| Craftsmen can make this item from shells. Randomly generated outfits don't include shell armor.

|-
| {{text anchor|LEATHER}}
|
| All garments
| Leatherworkers can make this item from leather. If paired with [SOFT], this item has an equal chance of being either in randomly generated outfits.

|-
| {{text anchor|SHAPED}}
|
| All garments
| Only one shaped piece of clothing can be worn on a single body slot at a time.

|-
| {{text anchor|STRUCTURAL_ELASTICITY_CHAIN_ALL}}
|
| All garments
| Increases the *_STRAIN_AT_YIELD properties of the armor's material to 50000, if lower. This makes the garment flex and give way instead of shattering under force. Strong materials that resist cutting will blunt edged attacks into bone-crushing hits instead.

|-
| {{text anchor|STRUCTURAL_ELASTICITY_CHAIN_METAL}}
|
| All garments
| Increases the *_STRAIN_AT_YIELD properties of the armor's material to 50000, but only if the garment is made from metal.

|-
| {{text anchor|STRUCTURAL_ELASTICITY_WOVEN_THREAD}}
|
| All garments
| Reduces the armor material's SHEAR_YIELD to 20000, SHEAR_FRACTURE to 30000 and increases the *_STRAIN_AT_YIELD properties to 50000, but only if the garment is made from cloth. This makes the item very weak against edged attacks, even if the thread material is normally very strong.

|-
| {{text anchor|LAYER_SIZE}}
| value
| All garments
| The item's bulkiness when worn. Aside from the layer limitations, it's a big contributor to the thickness and weight (and therefore price) of the garment. See [[Armor]] for more on item sizes and layering. Defaults to 10.

|-
| {{text anchor|LAYER_PERMIT}}
| value
| All garments
| The maximum amount of crap that can fit underneath the garment. See [[Armor]] for more on item sizes and layering. Defaults to 10.

|-
| {{text anchor|LAYER}}
| UNDER OVER ARMOR COVER
| All garments
| Where the item goes in relation to other clothes. Socks cannot be worn on top of boots!
The LAYER_PERMIT of the highest layer is used on a given section of the body - you can fit a lot of shirts and other undergarments underneath a robe, but not if you wear a leather jerkin on top of it, and you can still wear a cloak over the whole ensemble. Defaults to UNDER.

|-
| {{text anchor|COVERAGE}}
| % value
| All garments
| How often the garment gets in the way of a contaminant or an attack. Armor with a 5% coverage value, for example, will be near useless because 95% of attacks will bypass it completely. Temperature effects and armor thickness are also influenced. Defaults to 100.

|}

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

v0.34 Talk:Finished goods

2014-03-03T21:30:27Z

AVK: /* Cloth, Silk and Yarn Crafts */

==Mugs==
Mugs are also heavier, so in my experience crafts are much more productive. How should this be reflected in the article? [[User:Dree12|Dree12]] 02:11, 16 April 2012 (UTC)

== Cut Glass/Gems ==

in v0.31 there was a discussion about glass- and gem-crafts, the footnote to the table still "refers" to it but the link does not work. Should the discussion be moved over to the new namespace, or a small section be written in the article itself?

== Crafts can be works of art? ==

What is "Some subtypes of crafts can be works of art (figurines, for example) on them when first built" supposed to mean?– [[template:unsigned|unsigned]] comment by [[User:71.190.3.225|71.190.3.225]]

:Presumably it was intended to indicate that a figurine of your civilization's king is no more valuable than a figurine of some random goblin invader (or cheese). I replaced "works of art" with "references to historical figures" in an attempt to clarify the thought.--[[User:Loci|Loci]] ([[User talk:Loci|talk]]) 19:11, 21 August 2013 (UTC)

== !!SCIENCE!! in multiples production ==

I've taken the time to perform some !!SCIENCE!! in regards to determining what crafts actually get the multiplication bonus.

I used DFHack 0.34.11 r3 and [http://dffd.wimbli.com/file.php?id=8162 this script] (to alter the skill level of a dwarf). My procedure was the following:

1. Created a new embark, with one of the dwarfs being a Proficient Bookkeeper (as to actually see the number of items, another being a Miner (as to have somewhere inside to work) and another a Proficient Stonecrafter.

2. Placed (using createitems) a table, a chair and a stone. The material used for all things was obsidian.

3. A Craftsdwarf's Workshop was constructed near the wagon using the stone and a small room was dug, where the bookkeeper's office would reside. After placement of the chair, the bookkeeper was assigned to it.

4. A stack of 100 stones was spawned at the center of the workshop (to minimize delays)(using create-items)

After step 4. the embark was saved. Henceforth, all trials could be made by giving a repeating order to the workshop and force-quitting DF after the trial was done. Two variables were tested, the number of different classes of stone items (Mug, Instrument, Crafts, Toys) produced by a Legendary +5 dwarf and whether the number of multiples was altered according to skill.

For the first test, the following trial results were obtained:

- Mugs: 300
- Instrument: 100
- flutes : 21
- trumpets : 15
- harps : 21
- drums : 14
- piccolos : 29
- Crafts : 209
- figurines : 23
- amulets : 34
- scepters : 29
- crowns : 24
- rings : 31
- earrings : 34
- bracelets : 34
- Toys : 100
- puzzleboxes : 18
- toy boats : 20
- toy hammers : 19
- toy axes : 22
- mini-forges : 21

As seen, only Crafts and Mugs are produced in multiples.

I then repeated this trial, only for mugs, for decreasing levels of skill (Legendary, Accomplished, Proficient and Dabbling). Regardless of the increase in levels done by the production of the mugs, they were produced in every trial at a 3:1 ratio. The amount of experience got was also the same (12000xp), which totals 40xp per mug (or 120xp per resource). This slightly contradicts what's stated on the [[Experience]] page.

I also tested the case for Crafts and a Dabbling dwarf. The results follow:

- Crafts : 194
- figurines : 32
- amulets : 23
- scepters : 25
- crowns : 20
- rings : 35
- earrings : 25
- bracelets : 34

Although there is some discrepancy, the results point that Crafts are produced in a 2:1 ratio. The experience given in this case was 8820xp, which does not fit the number of items produced. If going by resources, then producing 2 crafts (using 1 resource) gives around 90xp.

Also, the quality of the items produced was noted. If items are made in multiples, the quality is not. Each item gets it's own quality rating regardless of being produced in multiples, which explains the existence of 8 masterwork items out of 300.

These are my findings on the subject. I haven't tested gems or totems or any other material, but as this shows, '''the probability of multiples isn't increased by skill''', as stated in the main page.

--[[User:Doktoro Reichard|Doktoro Reichard]] ([[User talk:Doktoro Reichard|talk]]) 11:30, 30 December 2013 (UTC)

: Nice work and a good find on skill-independence of number of crafts produced per job, but other than that, it didn't seem like you unearthed much new information here. The irregular numbers of crafts produced are very easy to explain - a job randomly generates one to three crafts per job. This would have been trivially easy to observe by ordering a few stone crafts and following the shop inventory closely (via 't'). The random one-to-three spread explains why the average is two and why it's not a clean ratio. I edited the crafts entry accordingly.

: Nonetheless, a good idea to incorporate the findings into the page, which had been unclear on which items are produced in multiples and which only in singles (instruments, toys).

: And i don't want to belittle your work - the research on gemcutting and cloth crafts were very thorough efforts in areas that have been largely neglected so far.

--[[User:Larix|Larix]] ([[User talk:Larix|talk]]) 20:53, 23 January 2014 (UTC)

:: Well, think of it in this way: If I '''did''' unearth a lot of new information for something that exists for some time ago, then something would be amiss with everything. In other words, someone should have noticed something wrong. Gemcutting was actually explained in a paragraph at the Gems page, but I only remembered to check it after the testing. The main reason why I did all this was to investigate the possibility of multiples production (which is a real and useful property) that wasn't explained or exemplified at the time when I first researched this.

:: I'll probably complete the research anytime in the near future (for completeness) but my feeling is that there will not be that big differences between the remaining item classes.--[[User:Doktoro Reichard|Doktoro Reichard]] ([[User talk:Doktoro Reichard|talk]]) 00:57, 24 January 2014 (UTC)

==Glass and Gem Crafts==

I've done some more research to a topic that puzzled me: glass and gem crafts. The page points to the v0.31.25 talk page, which itself I felt it didn't provide a good enough explanation. Using a setup similar to the above (with the addition I also used ''fastdwarf 2 1'' to speed up the process). I've tested all varieties of glass, tested whether skill affects production and also tested gems (in this case, only [[Ruby]] and [[Prase]] were tested). 1000 items were used in each trial. The results are as follows:

Item | Gem | L.Gem | Crafts | Total
| | |f |a |s |c |r |e |b |
----------------+-----+-------+--+--+--+--+--+--+--+------
Green Glass | 658 | 197 |26|23|24|10|24|21|17| 1000
Clear Glass | 691 | 185 |15|18|23|20|14|17|17| 1000
Crystal Glass | 690 | 178 |18|17|22|26|27|13|9 | 1000
----------------+-----+-------+--+--+--+--+--+--+--+------
Gr. Glass (Dab.)| 651 | 212 |20|23|22|28|14|15|15| 1000
----------------+-----+-------+--+--+--+--+--+--+--+------
Ruby | 962 | 37 |0 |1 |0 |0 |0 |0 |0 | 1000
Prase | 954 | 44 |0 |1 |1 |0 |0 |0 |0 | 1000

Observing the data retrieved from the trials, the following can be concluded:

1. Raw Glass has a 65-70% chance to be cut to a Gem, 20-15% to be cut into a Large Gem and a 10-15% to be cut into a Craft.
2. Experience has no effect on the distribution.
3. Raw Gems has a 95% chance to be cut to a Gem and a 5% chance to be cut into a Large Gem. The results given by the Crafts production are too residual to be considered (i.e. the probability of a craft appearing is less than 1%.--[[User:Doktoro Reichard|Doktoro Reichard]] ([[User talk:Doktoro Reichard|talk]]) 14:56, 4 January 2014 (UTC)

It seems Quietust has done some code spelunking and found the correct ratios, although my research is slightly off, which could be explained by the difference in versions. Awkwardly, it is written at the [[Gems]] page.--[[User:Doktoro Reichard|Doktoro Reichard]] ([[User talk:Doktoro Reichard|talk]]) 15:31, 4 January 2014 (UTC)

I've done some more research and increased the sample size to 10000 items, the results follow:

Item | Gem | L.Gem | Crafts | Total
| | | f | a | s | c | r | e | b |
----------------+-----+-------+---+---+---+---+---+---+---+------
Green Glass | 6608| 2027 |188|199|198|188|205|184|203| 10000
Morion | 9489| 441 | 7| 10| 15| 12| 10| 4| 12| 10000

Treating the results we get roughly the same data that's stated at the Gems page. It strikes me as odd that this page didn't have any relationship whatsoever with the accurate information existing in the wiki... This being said, I'm updating the post with this information and also quoting it here:

{{User:Doktoro Reichard/Quote|text=Exactly 5% of all rough gems will be cut into a single craft or large gem (with 1 craft for every 8 large gems), and the same occurs with raw glass (but with different ratios - 33% of all jobs, producing 11 crafts for every 16 large gems).|sign=[[User:Quietust|Quietust]]|source=[[DF2012:Gems|Gems]] page}}--[[User:Doktoro Reichard|Doktoro Reichard]] ([[User talk:Doktoro Reichard|talk]]) 21:55, 4 January 2014 (UTC)

:Nice work! Thanks for investing the time to clarify the creation of gem crafts.--[[User:Loci|Loci]] ([[User talk:Loci|talk]]) 21:22, 6 January 2014 (UTC)

== Cloth, Silk and Yarn Crafts ==

Done more research, yet again, this time on the cloth/silk/yarn crafts. The sample size was 1000. Here are the results.

Items | Crafts | Total
| f | a | s | c | r | e | b |
----------------------+---+---+---+---+---+---+---+------
SPIDER_CAVE:SILK | 0 |661| 0 | 0 | 0 |700|657| 2018
GRASS_TAIL_PIG:THREAD | 0 |687| 0 | 0 | 0 |674|633| 1994
ALPACA:HAIR |308|289|291|287|272|279|278| 2004
TROLL:HAIR |294|290|322|280|283|275|301| 2045
FORGOTTEN_BEAST_1:SILK| 0 |665| 0 | 0 | 0 |663|619| 1947

It struck me as odd that only [[Yarn]] can be produced into the full range of craft products. Hence I devised 2 more tests. The TROLL:HAIR test was also done with the Clothier at 0 experience.

All things considered, here are the conclusions:

# All cloth-based crafts are produced in a more-or-less 2:1 ratio with the resources provided.
# [[Silk]] and [[Thread]] crafts can only be Amulets, Earrings and Bracelets. The percentage of any being crafted is 1/3.
# All possible crafts can be made with [[Yarn]]. The percentage of any being crafted is 1/7.
# Skill has no influence in the amount of multiples. Period. Craftsdwarves just gain experience too fast for any decrease in amount to be noticeable.

Without digging in the code I can't say for sure, but I would say that each individual item shares a similar mechanic to the [[Melt]]ing process (where item percentages are stored in the workshop). It would explain the discrepancies the crafs' production shows.--[[User:Doktoro Reichard|Doktoro Reichard]] ([[User talk:Doktoro Reichard|talk]]) 11:42, 7 January 2014 (UTC)

:Hair/wool yarn is the only material with the [ITEMS_HARD] tag. The others have [ITEMS_SOFT], which removes scepters, crowns, rings and figurines from the list of eligible crafts. A material without any valid tags like these defaults to producing large gems, of all things. --[[User:AVK|AVK]] ([[User talk:AVK|talk]]) 21:30, 3 March 2014 (UTC)

== Ceramic and Metal Crafts ==

Both Ceramic and Metal crafts have been found to follow on the rules previously determined by all other materials, so this is a follow-up. The results are as follows.

=== Ceramics ===

Items | Crafts | Total
| f | a | s | c | r | e | b |
------------+---+---+---+---+---+---+---+------
Earthenware |297|283|288|300|308|282|266| 2024
Stoneware |287|262|287|277|272|305|309| 1999
Porcelain |281|279|270|263|278|301|263| 1935

=== Metals ===

Items | Crafts | Total
| f | a | s | c | r | e | b |
-----------+---+---+---+---+---+---+---+------
Gold |318|285|297|259|285|295|277| 2016
Steel |264|280|293|297|270|308|285| 1997
Adamantine |274|271|288|276|301|308|300| 2018

Items | Instruments | Total
| f | t | h | d | p |
-----------+---+---+---+---+---+------
Gold |190|203|202|206|199| 1000
Steel |219|183|185|199|214| 1000
Adamantine |170|181|212|201|236| 1000

Items | Toys | Total
| p | b | h | a | f |
-----------+---+---+---+---+---+------
Gold |190|241|176|200|193| 1000
Steel |197|192|185|215|211| 1000
Adamantine |197|219|199|172|213| 1000

3000 Goblets were produced per each type of metal.

--[[User:Doktoro Reichard|Doktoro Reichard]] ([[User talk:Doktoro Reichard|talk]]) 16:48, 19 January 2014 (UTC)

v0.34:Entity token

2013-11-29T12:30:00Z

AVK:

{{quality|Exceptional|18:03, 28 April 2011 (UTC)}}{{av}}
These tokens define entities, or civilizations, in entity_*.txt files.

== Gameplay ==
{| {{prettytable}}
|- bgcolor="#ddd"
! Token
! Arguments
! Description

|-
| ADVENTURE_TIER
| order
| Allows adventure mode for entities with sites. Dwarves, Elves, and Humans take up tier 3, 2, and 1 respectively. Order doesn't need to be maintained; a custom creature can have a tier of 3000 and still work even if it's the only custom creature.
[ADVENTURE_TIER:4]

|-
| INDIV_CONTROLLABLE
|
| Allows the race to be played as an "outsider" in adventure mode. Not having this specified in one of the entities will cause the Adventure mode option to disappear. Note that ADVENTURE_TIER is not required if this token is included, and that this cannot be applied to civilizations that were not in an entity_*.txt file during world gen.

|-
| CIV_CONTROLLABLE
|
| Allows fortress mode. If multiple entities have the CIV_CONTROLLABLE token, than in embark mode the specific civs can be chosen by + or - on the civ list screen (by pressing tab), though it will not state what entity the civs belong to. To check which one, tab to the neighbors screen: the entity's race will be at the top. At least one civilization must have this token.
|-
| CREATURE
| creature
|The type of creature that will inhabit the civilization. Multiple entries will be chosen from at random for each civilization.
[CREATURE:DWARF]

|}

== Placement ==

{| {{prettytable}}
|- bgcolor="#ddd"
! Token
! Arguments
! Description

|-
| BIOME_SUPPORT
|
* [[Biome token|biome]]
* frequency
| Frequency goes from 0 to 10. Higher numbers make the entity more likely to settle there.
[BIOME_SUPPORT:ANY_GRASSLAND:4]

|-
| START_BIOME
| [[Biome token|biome]]
| Birth of the civilization can be performed on this biome.
[START_BIOME:MOUNTAIN]

|-
| DEFAULT_SITE_TYPE
| site type
| Valid site types are DARK_FORTRESS (π), CAVE (•), CAVE_DETAILED (Ω), TREE_CITY (î), and CITY (#). Also recognizes PLAYER_FORTRESS, FORTRESS, and MONUMENT, though these likely will not work. Defaults to CITY. CITY is the only one that exists in all 34.xx versions.
[DEFAULT_SITE_TYPE:CAVE_DETAILED]

|-
| LIKES_SITE
| site type
| Most residents will try to move to this site type, unless already at one.
[LIKES_SITE:CAVE_DETAILED]

|-
| TOLERATES_SITE
| site type
| Some residents will try to move to this site type, unless already at one.
[TOLERATES_SITE:CITY]

|-
| WORLD_CONSTRUCTION
| construction
| Controls which constructions the civ will build on the world map. Valid constructions are ROAD, TUNNEL, BRIDGE, and WALL.
[WORLD_CONSTRUCTION:BRIDGE]
[WORLD_CONSTRUCTION:ROAD]
[WORLD_CONSTRUCTION:TUNNEL]
[WORLD_CONSTRUCTION:WALL]

|}

== Population ==

{| {{prettytable}}
|- bgcolor="#ddd"
! Token
! Arguments
! Description

|-
| START_GROUP_NUMBER
| number
| Number of breeding couples to start with per entity. Helps give a boost to weaker civs by giving them more cannon fodder at the beginning of their histories, and better genetic diversity (if that's modeled for that particular creature). Note that single-gender (eg. [FEMALE], [MALE], [NO_GENDER]) creatures will not have breeding couples, so a civilization with only these creatures will not be very likely to survive. As of 40d, although many had problems getting such civilizations to survive, there are those who have demonstrably and repeatedly done so. Presumably if the civ-stating code can't place breeding couples, it doesn't start the civ. However, because the children never grow up, the civ is limited to its original individuals).
[START_GROUP_NUMBER:10]

|-
| MAX_POP_NUMBER
| number
| Max population '''per entity'''. Multiply this by max starting civ to get the total population of the species. Defaults to 500.
[MAX_POP_NUMBER:500]

|-
| MAX_SITE_POP_NUMBER
| number
| Max population per individual site. Generic site types will not hold any more than this number of entities. Must be at least 80 for towns to be generated. In general, lower pop numbers mean more sprawl, and higher numbers mean more needing to crawl when entering town stores, which are not affected by this cap. Defaults to 50.
[MAX_SITE_POP_NUMBER:200]

|-
| MAX_STARTING_CIV_NUMBER
| number
| Max number of entities to spawn at world generation. Worldgen picks civs in some sequential order from the raws. Once it reaches the end of the list, it will begin again at the top. Setting this number lower than 100, like say, 7, will cause worldgen to skip over this civ for placement if there are already 7 civs of this type. Note that if all civs are set to lower numbers, and the number of starting civs is set higher than the maximum possible amount of civs in total, it will gracefully stop placing civs and get down to the history aspect of worldgen. Defaults to 3.
[MAX_STARTING_CIV_NUMBER:3]

|}

== Flavor ==
{| {{prettytable}}
|- bgcolor="#ddd"
! Token
! Arguments
! Description

|-
| PERMITTED_BUILDING
| building name
| The named, custom building can be built by a civilization in Fortress Mode.
[PERMITTED_BUILDING:SOAP_MAKER]

|-
| PERMITTED_JOB
| [[Unit type token|profession]]
| Allows this job type to be selected. This applies to worldgen creatures, in the embark screen, and in play.
[PERMITTED_JOB:MINER]

|-
| PERMITTED_REACTION
| reaction name
| Allows this reaction to be used by a civilization. It is used primarily in Fortress Mode. When creating custom reactions, this token MUST be present or the player will not be able to use the reaction in Fortress Mode.
[PERMITTED_REACTION:TAN_A_HIDE]

|-
| CURRENCY_BY_YEAR
|
| Causes the civ's currency to be numbered with the year it was minted.

|-
| CURRENCY
|
* inorganic material
* value
| What kind of metals the civ uses for coin minting as well as the value of the coin.
[CURRENCY:SILVER:5]

|-
| ART_FACET_MODIFIER
|
* type
* number
| OWN_RACE, FANCIFUL, EVIL, GOOD
Number goes from 0 to 25600 where 256 is the default.
[ART_FACET_MODIFIER:OWN_RACE:512]

|-
| ART_IMAGE_ELEMENT_MODIFIER
|
* item
* number
| CREATURE, PLANT, TREE, SHAPE, ITEM 0-25600

Determines the chance of each image occurring in that entity's artwork, such as engravings and on artifacts, for default (non-historical) artwork.

[ART_IMAGE_ELEMENT_MODIFIER:TREE:512]

|-
| ITEM_IMPROVEMENT_MODIFIER
|
* item
* number
| ART_IMAGE, COVERED or GLAZED, RINGS_HANGING, BANDS, SPIKES, ITEMSPECIFIC, THREAD, CLOTH, SEWN_IMAGE 0-25600

Determines the chance of the entity using that particular artwork method, such as "encircled with bands" or "menaces with spikes".

[ITEM_IMPROVEMENT_MODIFIER:SPIKES:0]

This also seems to change the amount that the entity will pay for items that are improved in the ways in their tokens.

|-
| TRANSLATION
| language
| What language raw the entity uses.
* If an entity lacks this tag, translations appear to be drawn randomly from all translation files{{verify}}.
[TRANSLATION:DWARF]

|-
| SELECT_SYMBOL
|
* noun
* symbol
| ALL, REMAINING, CIV, SITE, VESSEL, RELIGION, MILITARY_UNIT, TEMPLE, WAR, BATTLE, SIEGE, ROAD, BRIDGE, TUNNEL, WALL
Causes the entity to more often use these symbols in the particular SYM set.
[SELECT_SYMBOL:ALL:PEACE]

|-
| SUBSELECT_SYMBOL
|
* noun
* symbol
| Unknown.

|-
| CULL_SYMBOL
|
* noun
* symbol
| Causes the entity to not use the words in these SYM sets.
[CULL_SYMBOL:ALL:UGLY]

|-
| FRIENDLY_COLOR
| see [[color]]
|
The color of this entity's civilization settlements in the world gen and embark screens. Defaults to 7:0:1.
[FRIENDLY_COLOR:1:0:1]

|}

== Religion ==
{| {{prettytable}}
|- bgcolor="#ddd"
! Token
! Arguments
! Description

|-
| RELIGION
| type
|
* REGIONAL_FORCE: The creatures will worship a single force associated with their spheres. Currently hardcoded to only be associated with rivers and nature.
* PANTHEON: The creatures will worship a group of gods, each aligned with their spheres and other appropriate ones as well.

[RELIGION:PANTHEON]

|-
| RELIGION_SPHERE
| sphere
| Can by any available [[Sphere]]. Multiple entries are possible. Choosing a religious sphere will automatically make its opposing sphere not possible for the species to have: adding WATER, for example, means the species will never get FIRE as a religious sphere.

[RELIGION_SPHERE:FORTRESSES]

|-
| SPHERE_ALIGNMENT
|
* type
* number
|
This token forces an entity to favor or disfavor particular religious spheres, causing them to acquire those spheres more often when generating a pantheon.

[SPHERE_ALIGNMENT:TREES:512]

|}

== Leadership ==
{| {{prettytable}}
|- bgcolor="#ddd"
! Token
! Arguments
! Description

|-
| POSITION
| string
| Defines a leader/noble position for a civilization. These replace previous tags such as [MAYOR] and [CAN_HAVE_SITE_LEADER] and so on. To define a position further, see [[Position token]].

|-
| LAND_HOLDER_TRIGGER
|
* land holder number
* population
* wealth exported
* created wealth
| Defines when a particular land-holding noble (baron, count, duke in vanilla) will arrive at a fortress.

|-
| VARIABLE_POSITIONS
| Position responsibility or ALL
| Allows a responsibility to be taken up by a dynamically generated position (such as Law-maker).

|}

== Behavior ==
{| {{prettytable}}
|- bgcolor="#ddd"
! Token
! Arguments
! Description

|-
| [[Ethics|ETHIC]]
|
*behavior
*reaction
| Sets the civ's view of certain behaviors, from capital punishment to completely acceptable. This also causes the civ to look upon opposing ethics with disfavor, if their reaction to it is opposing, and when at extremes (one ACCEPTABLE, another civ UNTHINKABLE for example) they will often go to war over it.
[ETHIC:EAT_SAPIENT_KILL:ACCEPTABLE]

|-
| WILL_ACCEPT_TRIBUTE
|
| Makes the civ's traders accept offered goods.

|-
| WANDERER, BEAST_HUNTER, SCOUT
|
| The civ will send out these sorts of adventurers in worldgen. This seems to increase Tracker skill.

|-
| ABUSE_BODIES
|
| The civilization will mutilate bodies when they are the victors in history-gen warfare, such as hanging bodies from trees, putting them on spikes, and so forth. Adventurers killed in Adventurer mode will sometimes be impaled on spikes wherever they died, with or without this token, and regardless of whether they actually antagonized the townspeople.

|-
| ACTIVE_SEASON
| season
| the season when the civ is most active: when they will trade, interact with you via diplomats, and/or invade you. Civs can have multiple season entries. Note: If multiple caravans arrive at the same time, you are able to select which civ to trade with at the depot menu. ACTIVE_SEASON tags may be changed for a currently active fort.
[ACTIVE_SEASON:AUTUMN]

|-
| AMBUSHER
|
| When invading sneaks around and shoots at straggling members of your society. They will spawn on the edge of the map and will only be visible when one of their party are spotted; this can be quite dangerous to undefended trade depots.

|-
| AT_PEACE_WITH_WILDLIFE
|
| Will not attack wildlife, and will not be attacked by them, even if you have them in your party. This can be somewhat disconcerting when attacked by bears in the forest and your elven ally sits back and does nothing.

|-
| BABYSNATCHER
|
| Sends thieves to steal babies. Also sends ambush parties to harass your civilization. Without this tag, enemy civs will only siege, and will siege as early as they would otherwise babysnatch. This can happen as early as the first year of the fort! In addition, babysnatcher civs will snatch children during worldgen, allowing them to become part of the civ if they do not escape.

Note: If the playable civ in Fortress Mode has this tag (ie. you add BABYSNATCHER to the Dwarf entity) then the roles will be reversed and elves and humans will siege and ambush and goblins will trade with you.

|-
| BUILDS_OUTDOOR_FORTIFICATIONS
|
| Makes the civilization build castles.

|-
| BUILDS_OUTDOOR_TOMBS
|
| Makes the civilization build tombs.

|-
| BANDITRY
| percentage
| Sets a percentage of the entity population to be used as bandits.

|-
| DIPLOMAT_BODYGUARDS
|
| Visiting diplomats are accompanied by a pair of soldiers. Does not work due to a bug.{{bug|5854}}

|-
| INVADERS_IGNORE_NEUTRALS
|
| Causes invaders to ignore visiting caravans and other neutral creatures.{{verify}}

|-
| ITEM_THIEF
|
| Sends thieves to steal items. This will also occur in history generation, and thieves will have the "thief" profession. Items stolen in history gen will be scattered around that creature's home.

|-
| LOCAL_BANDITRY
|
| Causes the entity to send out patrols that can ambush adventurers. Will cause cities to be hostile to adventurers whenever they enter, regardless of race or nationality.

|-
| MERCHANT_BODYGUARDS
|
| Caravan merchants are accompanied by soldiers.

|-
| MERCHANT_NOBILITY
|
| Effect unknown - in previous versions, this resulted in the civ having a Guild Representative / Merchant Baron / Merchant Prince, but now this is controlled solely by positions.

|-
| PROGRESS_TRIGGER_POPULATION
| level
| 0 to 5, civ will come to site once population at site has reached that level. If multiple progress triggers exist for a civ, it will come when any one of them is fulfilled instead of waiting for all of them to be reached. A value of 0 disables the trigger. 1 corresponds to 20 dwarves, 2 to 50 dwarves, 3 to 80, 4 to 110, and 5 to 140. Progress triggers may be changed, added, or deleted for a currently active fort. Note: hostile civs require that the population trigger be fulfilled as well as at least one other trigger before attacking.

|-
| PROGRESS_TRIGGER_PRODUCTION
| level
| 0 to 5, civ will come to site once created wealth has reached that level. If multiple progress triggers exist for a civ, it will come when any one of them is fulfilled instead of waiting for all of them to be reached. A value of 0 disables the trigger. 1 corresponds to 5000☼ created wealth, 2 to 25000☼, 3 to 100000☼, 4 to 200000☼, and 5 to 300000☼. Progress triggers may be changed, added, or deleted for a currently active fort.

|-
| PROGRESS_TRIGGER_TRADE
| level
| 0 to 5, civ will come to site once exported goods has reached that level. If multiple progress triggers exist for a civ, it will come when any one of them is fulfilled instead of waiting for all of them to be reached. A value of 0 disables the trigger. 1 corresponds to 500☼ exported wealth, 2 to 2500☼, 3 to 10000☼, 4 to 20000☼, and 5 to 30000☼. Progress triggers may be changed, added, or deleted for a currently active fort.

|-
| PROGRESS_TRIGGER_POP_SIEGE
| level
| 0 to 5, civ will begin to send sieges against the player civ when this level is reached if it is hostile.

If multiple progress triggers exist for a civ, it will come when any one of them is fulfilled instead of waiting for all of them to be reached. A value of 0 disables the trigger.

|-
| PROGRESS_TRIGGER_PROD_SIEGE
| level
| 0 to 5, civ will begin to send sieges against the player civ when this level is reached if it is hostile.

|-
| PROGRESS_TRIGGER_TRADE_SIEGE
| level
| 0 to 5, civ will begin to send sieges against the player civ when this level is reached if it is hostile.

|-
| SIEGER
|
| Will start campfires and wait around at the edge of your map for a month or two before rushing in to attack.

|-
| SKULKING
|
| This makes the severity of attacks depend on the extent of item/baby thievery rather than the passage of time. Makes trade impossible with the related civilization.

|-
| TREE_CAP_DIPLOMACY
|
| Visiting diplomats impose tree cutting quotas; without this, they will simply compliment your fortress and leave. Also causes the diplomat to make unannounced first contact at the very beginning of the first Spring after your fortress becomes a Barony.

|-
| LAYER_LINKED
|
| Defines if a civilization is a hidden subterranean entity, such as batman civilizations.

|-
| UNDEAD_CANDIDATE
|
| Unknown. Possibly makes this creature available as a "Corpse" (e.g. Human Corpse) for necromancers in adventure mode.

|}

== Items and Animals Used ==
{| {{prettytable}}
|- bgcolor="#ddd"
! Token
! Arguments
! Description

|-
| AMMO
| item token
|
[AMMO:ITEM_AMMO_BOLTS]

|-
| ARMOR
|
* item token
* rarity
|Rarity is optional. Permitted rarity values are RARE, UNCOMMON, FORCED (anything else is treated as COMMON).
[ARMOR:ITEM_ARMOR_PLATEMAIL:COMMON]

|-
| DIGGER
| item token
|
[DIGGER:ITEM_WEAPON_PICK]

|-
| GLOVES
|
* item token
* rarity
| Rarity is optional. Permitted rarity values are RARE, UNCOMMON, FORCED (anything else is treated as COMMON).
[GLOVES:ITEM_GLOVES_GLOVES:COMMON]

|-
| HELM
|
* item token
* rarity
| Rarity is optional. Permitted rarity values are RARE, UNCOMMON, FORCED (anything else is treated as COMMON).
[HELM:ITEM_HELM_HELM:COMMON]

|-
| INSTRUMENT
| item token
|
[INSTRUMENT:ITEM_INSTRUMENT_FLUTE]

|-
| PANTS
|
* item token
* rarity
| Rarity is optional. Permitted rarity values are RARE, UNCOMMON, FORCED (anything else is treated as COMMON).
[PANTS:ITEM_PANTS_PANTS:COMMON]

|-
| SHIELD
| item token
|
[SHIELD:ITEM_SHIELD_SHIELD]

|-
| SHOES
|
* item token
* rarity
| Rarity is optional. Permitted rarity values are RARE, UNCOMMON, FORCED (anything else is treated as COMMON).
[SHOES:ITEM_SHOES_SHOES:COMMON]

|-
| SIEGEAMMO
| item token
|
[SIEGEAMMO:ITEM_SIEGEAMMO_BALLISTA]

|-
| TOOL
| item token
|
[TOOL:ITEM_TOOL_NEST_BOX]

|-
| TOY
| item token
|
[TOY:ITEM_TOY_PUZZLEBOX]

|-
| TRAPCOMP
| item token
|
[TRAPCOMP:ITEM_TRAPCOMP_GIANTAXEBLADE]

|-
| WEAPON
| item token
|
[WEAPON:ITEM_WEAPON_AXE_BATTLE]

|-
| USE_ANIMAL_PRODUCTS
|
| Allows creature to use products made from animals, such as leather shirts.

|-
| USE_ANY_PET_RACE
|
| Assuming it passes other checks, any creature in their list of usables (from common domestic if they have that or from the surrounding 7x7 or so of squares and map features in those squares) which has PET or PET_EXOTIC will be available as a pet (next time, it'll let them use mounts/pullers/pack animals of any kind as well, but I'm not sure this matters in the stock raws). This notion of the initial usable creature list, which then gets pared down or otherwise considered, applies below as well. All common domestic and equipment creatures are also added to the initial list.

|-
| USE_CAVE_ANIMALS
|
| If they don't have it, creatures with exclusively subterranean biomes are skipped.

|-
| USE_EVIL_ANIMALS
|
| Don't have it -> EVIL creatures skipped.

|-
| USE_EVIL_PLANTS
|
| As EVIL creatures for all uses of plants.

|-
| USE_EVIL_WOOD
|
| As EVIL creatures for all uses of wood.

|-
| USE_GOOD_ANIMALS
|
| Don't have it -> GOOD creatures skipped.

|-
| USE_GOOD_PLANTS
|
| As GOOD creatures for all uses of plants.

|-
| USE_GOOD_WOOD
|
| As GOOD creatures for all uses of wood.

|-
| USE_MISC_PROCESSED_WOOD_PRODUCTS
|
| If wood is available locally, and the relevant professions are permitted, controls availability of lye, charcoal, potash and pearlash.

|-
| COMMON_DOMESTIC_MOUNT
|
| If a creature has MOUNT and the relevant COMMON_DOMESTIC_x tag (or COMMON_DOMESTIC for pets), it will be allowed if it passes the other checks.

|-
| COMMON_DOMESTIC_PACK
|
| If a creature has PACK_ANIMAL and the relevant COMMON_DOMESTIC_x tag (or COMMON_DOMESTIC for pets), it will be allowed if it passes the other checks. Also seems to be required currently for trading to occur.

|-
| COMMON_DOMESTIC_PET
|
| If a creature has PET and the relevant COMMON_DOMESTIC_x tag (or COMMON_DOMESTIC for pets), it will be allowed if it passes the other checks. Also seems to be required to have any animals at all, including those used in trading.

|-
| COMMON_DOMESTIC_PULL
|
| If a creature has WAGON_PULLER and the relevant COMMON_DOMESTIC_x tag (or COMMON_DOMESTIC for pets), it will be allowed if it passes the other checks.

|-
| RIVER_PRODUCTS
|
| Allow civ to use river products in the goods it has available for trade.

|-
| OCEAN_PRODUCTS
|
| Allow civ to use ocean products in the goods it has available for trade.

|-
| INDOOR_FARMING
|
| Allow civ to use underground plant products in the goods it has available for trade.

|-
| OUTDOOR_FARMING
|
| Allow civ to use outdoor plant products in the goods it has available for trade.

|-
| CLOTHING
|
| Civ members will attempt to wear clothing.

|-
| SUBTERRANEAN_CLOTHING
|
| Will wear things made of spider silk and other subterranean materials.

|-
| EQUIPMENT_IMPROVEMENTS
|
| Adds decorations to equipment based on the level of the generated unit. Also improves item quality.

|-
| IMPROVED_BOWS
|
| Adds decorations to weapons generated for bowman and master bowman. An elf hack.

|-
| METAL_PREF
|
| Needs testing.

|-
| STONE_PREF
|
| Enables creatures of this entity to bring stones in trade. Also seems to enable the use of metals smelted from ore, such as iron or copper.

|-
| WOOD_WEAPONS
|
| The civilization can make traditionally metallic weapons such as swords and spears from wood. An elf hack.

|-
| WOOD_ARMOR
|
| The civilization can make traditionally metallic armor such as mail shirts and helmets from wood. An elf hack.

|-
| GEM_PREF
|
| Enables creatures of this entity to bring gems in trade.

|-
| INDOOR_WOOD
|
| Allow civ to trade subterranean wood types, such as tower-cap and fungiwood logs.

|-
| OUTDOOR_WOOD
|
| Allow civ to use outdoor wood types, such as mangrove and oak.

|-
| GEM_SHAPE
| [[Descriptor shape token|shape]]
| Precious gems cut by this civilization's jewelers can be of this shape.

|-
| STONE_SHAPE
| [[Descriptor shape token|shape]]
| Ordinary non-gem stones cut by this civilization's jewelers can be of this shape.

|}

== Tissue Styling Related Tokens ==
{| {{prettytable}}
|- bgcolor="#ddd"
! Token
! Arguments
! Description

|-
| TISSUE_STYLE
| tissue?
| Presumably selects tissue to set cultural style parameters for. Needs testing.

|-
| TS_MAINTAIN_LENGTH
|
* minimum length?
* maximum length?
| Presumably sets culturally preferred tissue length for selected tissue. Needs testing.
Dwarves have their beards set to 100:NONE by default.

|-
| TS_PREFERRED_SHAPING
| styling token
| Valid tokens are NEATLY_COMBED, BRAIDED, DOUBLE_BRAIDS, PONY_TAILS, CLEAN_SHAVEN and STANDARD_HAIR/BEARD/MOUSTACHE/SIDEBURNS_SHAPINGS.
Presumably sets culturally preferred tissue shapings for selected tissue. Needs testing.

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

v0.34:Weapon rack

2013-09-29T12:43:07Z

AVK:

{{quality|Fine|16:55, 10 August 2010 (UTC)}}{{Buggy}}
{{furniture|name=Weapon Rack
|tile=√
|wood=y
|stone=y
|metal=y
|glass=y
|rooms=
* [[Barracks]]
}}
{{av}} 

'''Weapon rack''' is an item of [[furniture]] which can be used to create a [[barracks]] or to appease a [[noble]]'s demand or raise the [[value]] of a [[room]].

When used in a barracks designated for Individual Equipment storage, dwarves will prefer to store their weapons on the racks instead of stockpiles. Doing so in concert with [[armor stand]]s will allow you to create centralized armories for your military.

==Bugs==
Stockpiles take priority over all armory storage, ensuring that weapon racks will never be used for anything.
The current version of DFHack (r3) has scripts that repair armory behavior.

{{buildings}}

v0.34:Weapon rack

2013-09-29T12:42:55Z

AVK: Described armory bugs and the DFHack fix.

{{quality|Fine|16:55, 10 August 2010 (UTC)}}
{{furniture|name=Weapon Rack
|tile=√
|wood=y
|stone=y
|metal=y
|glass=y
|rooms=
* [[Barracks]]
}}
{{av}} 

'''Weapon rack''' is an item of [[furniture]] which can be used to create a [[barracks]] or to appease a [[noble]]'s demand or raise the [[value]] of a [[room]].

When used in a barracks designated for Individual Equipment storage, dwarves will prefer to store their weapons on the racks instead of stockpiles. Doing so in concert with [[armor stand]]s will allow you to create centralized armories for your military.

==Bugs==
Stockpiles take priority over all armory storage, ensuring that weapon racks will never be used for anything.
The current version of DFHack (r3) has scripts that repair armory behavior.

{{buildings}}

v0.34:Armor stand

2013-09-29T12:38:58Z

AVK: Described armory bugs and the DFHack fix.

{{quality|Fine|15:52, 30 September 2010 (UTC)}}{{av}}{{Buggy}}

{{furniture|name=Armor Stand
|tile=♫
|wood=y
|stone=y
|metal=y
|glass=y
|rooms=
* [[Barracks]]
}}

'''Armor Stands''' are a type of decorative [[furniture]]. Much like the [[weapon rack]], the armor stand can be used to lay down a [[barracks]], or it can be placed in a [[noble|noble's]] [[room]] to [[Requirement|appease]] them.

When used in a barracks designated for individual and squad equipment, dwarves will prefer to store their armor on stands instead of stockpiles. Doing so in concert with [[weapon rack]]s will allow you to create centralized armories for your military.

==Bugs==
Stockpile storage always takes priority over furniture, making armor stands all but useless for their practical purpose.
The current version of DFHack (r3) has scripts that repair armory behavior.

{{buildings}}

v0.34:Material definition token

2013-04-18T19:34:07Z

AVK: Yup, strangleholds check for compressive force. Also the obvious thing about bending.

{{quality|Exceptional|18:11, 28 April 2011 (UTC)}}{{av}}

The following tokens can be used in material definitions (whether for inorganics or those within plants and creatures) as well as in material templates.

==Material Properties==
{| {{prettytable}}
|- bgcolor="#C0C0C0"
! Token
! Arguments
! Description

|-
| PREFIX
| * string
| 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
| * string
| 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
|
* type
| Unknown. Valid values are BLOOD, SLIME, VOMIT, ICHOR, PUS, GOO, GRIME, or FILTH. SLIME value is used by evil cloud/rain materials.

|-
| POWDER_DYE
| [[color]] token
| Defines the material as a type of dye.

|-
| TILE
| [[Main: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 [[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: [[door]]s, [[floodgate]]s, [[hatch cover]]s, [[bin]]s, [[barrel]]s, and [[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 [[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]] token
| 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 [[glaze]]d. Defaults to 0.

|-
| IMPACT_YIELD
|
*value
| Specifies how hard of an impact the material can withstand before it will start deforming permanently. Used for blunt-force combat. Defaults to 10000.

|-
| IMPACT_FRACTURE
|
*value
| Specifies how hard of an impact the material can withstand before it will fail entirely. Used for blunt-force combat. Defaults to 10000.

|-
| IMPACT_STRAIN_AT_YIELD or IMPACT_ELASTICITY
|
*value
| Specifies how much the material will give when the yield point is reached.{{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 start deforming permanently. Determines a tissue's response to strangulation. Defaults to 10000.

|-
| COMPRESSIVE_FRACTURE
|
*value
| Specifies how hard the material can be compressed before it will fail entirely. Determines a tissue's response to strangulation. Defaults to 10000.

|-
| COMPRESSIVE_STRAIN_AT_YIELD or COMPRESSIVE_ELASTICITY
|
*value
| Specifies how much the material will give when it is compressed past its yield point.{{verify}} Determines a tissue's response to strangulation. Defaults to 0.

|-
| TENSILE_YIELD
|
*value
| Specifies how hard the material can be stretched before it will start deforming permanently. Determines a tissue's resistance to a latching and tearing bite. Defaults to 10000.

|-
| TENSILE_FRACTURE
|
*value
| Specifies how hard the material can be stretched before it will fail entirely. Determines a tissue's resistance to a latching and tearing bite. Defaults to 10000.

|-
| TENSILE_STRAIN_AT_YIELD or TENSILE_ELASTICITY
|
*value
| Specifies how much the material will give when it is stretched past its yield point. Determines a tissue's resistance to a latching and tearing bite. Defaults to 0.

|-
| TORSION_YIELD
|
*value
| Specifies how hard the material can be twisted before it will start deforming permanently. [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 fail entirely. [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 give when it is twisted past its yield point.{{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 start deforming permanently. Used for cutting calculations. Defaults to 10000.

|-
| SHEAR_FRACTURE
|
*value
| Specifies how hard the material can be sheared before it will fail entirely. Used for cutting calculations. Defaults to 10000.

|-
| SHEAR_STRAIN_AT_YIELD or SHEAR_ELASTICITY
|
*value
| Specifies how much the material will give when sheared past its yield point. Used for cutting calculations. Defaults to 0.

|-
| BENDING_YIELD
|
*value
| Specifies how hard the material can be bent before it will start deforming permanently. Determines a tissue's resistance to being mangled with a joint lock. Defaults to 10000.

|-
| BENDING_FRACTURE
|
*value
| Specifies how hard the material can be bent before it will fail entirely. Determines a tissue's resistance to being mangled with a joint lock. Defaults to 10000.

|-
| BENDING_STRAIN_AT_YIELD or BENDING_ELASTICITY
|
*value
| Specifies how much the material will give when bent past its yield point.{{verify}} Determines a tissue's resistance to being mangled with a joint lock. 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 [[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 will burn for a very long time (9 months and 16.8 days). 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. '''Not permitted in material template definitions.'''

|-
| IF_EXISTS_SET_COLDDAM_POINT
|
*temperature
| Changes a material's COLDDAM_POINT, but only if it was not set to NONE. '''Not permitted in material template definitions.'''

|-
| IF_EXISTS_SET_IGNITE_POINT
|
*temperature
| Changes a material's IGNITE_POINT, but only if it was not set to NONE. '''Not permitted in material template definitions.'''

|-
| IF_EXISTS_SET_MELTING_POINT
|
*temperature
| Changes a material's MELTING_POINT, but only if it was not set to NONE. '''Not permitted in material template definitions.'''

|-
| IF_EXISTS_SET_BOILING_POINT
|
*temperature
| Changes a material's BOILING_POINT, but only if it was not set to NONE. '''Not permitted in material template definitions.'''

|-
| IF_EXISTS_SET_MAT_FIXED_TEMP
|
*temperature
| Changes a material's MAT_FIXED_TEMP, but only if it was not set to NONE. '''Not permitted in material template definitions.'''

|-
| 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] [[plant token]]s. Defaults to BARREL.

|-
| BUTCHER_SPECIAL
|
*[[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 [[block]]s made from this material.

|-
| MATERIAL_REACTION_PRODUCT
|
*reaction reference
*[[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
|
* [[material token]]
| Allows the material to be used to make [[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. Entities opposed to killing animals (which currently does '''not''' include Elves) will refuse to accept these items in trade.

|-
| ALCOHOL_PLANT
|
| Classifies the material as plant-based alcohol, allowing its storage in food stockpiles under "Drink (Plant)".

|-
| ALCOHOL_CREATURE
|
| Classifies the material as animal-based alcohol, allowing its storage in food stockpiles under "Drink (Animal)".

|-
| ALCOHOL
|
| Classifies the material as generic alcohol. Implied by both ALCOHOL_PLANT and ALCOHOL_CREATURE. Exact behavior unknown, possibly vestigial.

|-
| CHEESE_PLANT
|
| Classifies the material as plant-based cheese, allowing its storage in food stockpiles under "Cheese (Plant)".

|-
| CHEESE_CREATURE
|
| Classifies the material as animal-based cheese, allowing its storage in food stockpiles under "Cheese (Animal)".

|-
| CHEESE
|
| Classifies the material as generic cheese. Implied by both CHEESE_PLANT and CHEESE_CREATURE. Exact behavior unknown, possibly vestigial.

|-
| POWDER_MISC_PLANT
|
| Classifies the material as plant powder, allowing its storage in in food stockpiles under "Milled Plant".

|-
| POWDER_MISC_CREATURE
|
| Classifies the material as creature powder, allowing its storage in food stockpiles under "Bone Meal".

|-
| POWDER_MISC
|
| Classifies the material as generic powder. Implied by both POWDER_MISC_PLANT and POWDER_MISC_CREATURE. Exact behavior unknown, possibly vestigial.

|-
| 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
|
| Classifies the material as milled paste, allowing its storage in food stockpiles under "Paste".

|-
| STOCKPILE_GLOB_PRESSED
|
| Classifies the material as pressed goods, allowing its storage in food stockpiles under "Pressed Material".

|-
| LIQUID_MISC_PLANT
|
| Classifies the material as a plant extract, allowing its storage in food stockpiles under "Extract (Plant)".

|-
| LIQUID_MISC_CREATURE
|
| Classifies the material as a creature extract, allowing its storage in food stockpiles under "Extract (Animal)".

|-
| LIQUID_MISC_OTHER
|
| Classifies the material as a miscellaneous liquid, allowing its storage in food stockpiles under "Misc. Liquid" along with lye.

|-
| LIQUID_MISC
|
| Classifies the material as a generic liquid. Implied by LIQUID_MISC_PLANT, LIQUID_MISC_CREATURE, and LIQUID_MISC_OTHER. Exact behavior unknown. Possibly vestigial.

|-
| STRUCTURAL_PLANT_MAT
|
| Classifies the material as plant, allowing its storage in food stockpiles under "Plants".

|-
| SEED_MAT
|
| Classifies the material as plant seed, allowing its storage in food stockpiles under "Seeds".

|-
| LEAF_MAT
|
| Classifies the material as plant leaf, allowing its storage in food stockpiles under "Leaves".

|-
| BONE
|
| Classifies the material as bone, allowing its use for bone carvers and restriction from stockpiles by material.

|-
| WOOD
|
| Classifies the material as wood, allowing its use for carpenters and storage in wood stockpiles. Entities opposed to killing plants (i.e. [[Elf|Elves]]) will refuse to accept these items in trade.

|-
| THREAD_PLANT
|
| Classifies the material as plant fiber, allowing its use for clothiers and storage in cloth stockpiles under "Thread (Plant)" and "Cloth (Plant)".

|-
| TOOTH
|
| Classifies the material as tooth, allowing its use for bone carvers and restriction from stockpiles by material.

|-
| HORN
|
| Classifies the material as horn, allowing its use for bone carvers and restriction from stockpiles by material.

|-
| PEARL
|
| Classifies the material as pearl, allowing its use for bone carvers and restriction from stockpiles by material.

|-
| SHELL
|
| Classifies the material as shell, allowing its use for bone carvers and restriction from stockpiles by material.

|-
| LEATHER
|
| Classifies the material as leather, allowing its use for leatherworkers and storage in leather stockpiles.

|-
| SILK
|
| Classifies the material as silk, allowing its use for clothiers and storage in cloth stockpiles under "Thread (Silk)" and "Cloth (Silk)".

|-
| SOAP
|
| Classifies the material as soap, allowing it to be used as a bath detergent and stored in bar/block stockpiles under "Bars: Other Materials".{{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 [[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. Possibly vestigial.

|-
| ITEMS_BARRED
|
| Equivalent to ITEMS_HARD. Given to [[bone]].

|-
| ITEMS_SCALED
|
| Equivalent to ITEMS_HARD. Given to [[shell]].

|-
| ITEMS_LEATHER
|
| Equivalent to ITEMS_SOFT. Given to [[leather]].

|-
| ITEMS_SOFT
|
| Random [[finished goods|crafts]] made from this material can not be made into rings, crowns, scepters or figurines. Given to [[plant fiber]], [[silk]] and [[wool]].

|-
| ITEMS_HARD
|
| Random [[finished goods|crafts]] made from this material include all seven items. Given to [[stone]], [[wood]], [[bone]], [[shell]], [[chitin]], [[nail|claws]], [[tooth|teeth]], [[horn|horns]], [[horn|hooves]] and [[wax|beeswax]]. [[Hair]], [[pearl|pearls]] and eggshells also have the tag.

|-
| IS_STONE
|
| Used to define that said material is stone. Allows its 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 [[glaze]]d.

|-
| YARN
|
| Classifies the material as yarn, allowing its use for clothiers and its storage 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 [[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
|
| [[Anvil]]s can be made out of this material.

|-
| ITEMS_AMMO
|
| [[Weapon#Ammunition|Ammunition]] can be made out of this material.

|-
| ITEMS_DIGGER
|
| [[Weapon#Dwarf-manufactured weapons|Picks]] can be made out of this material.

|-
| ITEMS_ARMOR
|
| [[Armor]] can be made out of this material.

|-
| ITEMS_DELICATE
|
| Used internally by amber and coral. Functionally equivalent to ITEMS_HARD.

|-
| 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 CE_SWELLING CE_OOZING CE_BRUISING CE_BLISTERS CE_NUMBNESS CE_PARALYSIS CE_FEVER CE_BLEEDING CE_COUGH_BLOOD CE_VOMIT_BLOOD CE_NAUSEA CE_UNCONSCIOUSNESS CE_NECROSIS CE_IMPAIR_FUNCTION CE_DROWSINESS 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 [[Syndrome#Creature effect tokens|Syndromes page]]

|}

==See Also==
* [[Inorganic material definition token]]
* [[Syndrome]]

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

v0.34:Tracker

2013-04-15T08:26:43Z

AVK:

{{Quality|Fine|21:55, 30 December 2010 (UTC)}}
{{Skill
| color = 3:0
| skill = Tracker
| profession = Unknown
| job name = None
| tasks = None
| attributes =
* Unknown
}}
{{av}}

Tracker is a [[skill]] that, like [[Military tactics|military tactics]], is seemingly only used during [[world generation]]. It is not uncommon for historical [[migrant|immigrants]] to arrive with some level in the skill.

Historical figures that have done scouting, beast hunting or wandering in the past always seem to have some level of this skill.

See also [[Military tactics]].

{{skills}}

v0.34:Military tactics

2013-04-15T08:24:50Z

AVK:

{{quality|Fine|22:46, 23 October 2010 (UTC)}}
{{Skill
| color = 3:0
| skill = Military Tactics
| profession = Unknown
| job name = None
| tasks = None
| attributes =
* Unknown
}}
{{av}}

'''Military Tactics''' is a [[military]] [[skill]] first introduced in 0.31.14. Presumably, this skill relates to choices made during combat, and is valuable for survival. However, players have collected too little information about this skill to know for sure. When assigning dwarves to squads, Military Tactician never appears as a "relevant skill."

It seems the only way to gain experience in this skill is to lead an army in a major historical conflict. Assaulting a site or organizing a defense both do the trick.

See also [[Tracker]].

{{skills}}

v0.34:Tracker

2013-04-15T08:17:06Z

AVK:

v0.34:Entity token

2013-03-30T23:57:47Z

AVK:

{{quality|Exceptional|18:03, 28 April 2011 (UTC)}}{{av}}
These tokens define entities, or civilizations, in entity_*.txt files.

== Gameplay ==
{| {{prettytable}}
|- bgcolor="#ddd"
! Token
! Arguments
! Description

|-
| ADVENTURE_TIER
| order
| Allows adventure mode for entities with sites. Dwarves, Elves, and Humans take up tier 3, 2, and 1 respectively. Order doesn't need to be maintained; a custom creature can have a tier of 3000 and still work even if it's the only custom creature.
[ADVENTURE_TIER:4]

|-
| INDIV_CONTROLLABLE
|
| Allows the race to be played as an "outsider" in adventure mode. Not having this specified in one of the entities will cause the Adventure mode option to disappear. Note that ADVENTURE_TIER is not required if this token is included.

|-
| CIV_CONTROLLABLE
|
| Allows fortress mode. If multiple entities have the CIV_CONTROLLABLE token, than in embark mode the specific civs can be chosen by + or - on the civ list screen (by pressing tab), though it will not state what entity the civs belong to. To check which one, tab to the neighbors screen: the entity's race will be at the top. At least one civilization must have this token.
|-
| CREATURE
| creature
|The type of creature that will inhabit the civilization. Multiple entries will be chosen from at random for each civilization.
[CREATURE:DWARF]

|}

== Placement ==

{| {{prettytable}}
|- bgcolor="#ddd"
! Token
! Arguments
! Description

|-
| BIOME_SUPPORT
|
* [[Biome token|biome]]
* frequency
| Frequency goes from 0 to 10. Higher numbers make the entity more likely to settle there.
[BIOME_SUPPORT:ANY_GRASSLAND:4]

|-
| START_BIOME
| [[Biome token|biome]]
| Birth of the civilization can be performed on this biome.
[START_BIOME:MOUNTAIN]

|-
| DEFAULT_SITE_TYPE
| site type
| Valid site types are DARK_FORTRESS (π), CAVE (•), CAVE_DETAILED (Ω), TREE_CITY (î), and CITY (#). Also recognizes PLAYER_FORTRESS, FORTRESS, and MONUMENT, though these likely will not work. Defaults to CITY. CITY is the only one that exists in all 34.xx versions.
[DEFAULT_SITE_TYPE:CAVE_DETAILED]

|-
| LIKES_SITE
| site type
| Most residents will try to move to this site type, unless already at one.
[LIKES_SITE:CAVE_DETAILED]

|-
| TOLERATES_SITE
| site type
| Some residents will try to move to this site type, unless already at one.
[TOLERATES_SITE:CITY]

|-
| WORLD_CONSTRUCTION
| construction
| Controls which constructions the civ will build on the world map. Valid constructions are ROAD, TUNNEL, BRIDGE, and WALL.
[WORLD_CONSTRUCTION:BRIDGE]
[WORLD_CONSTRUCTION:ROAD]
[WORLD_CONSTRUCTION:TUNNEL]
[WORLD_CONSTRUCTION:WALL]

|}

== Population ==

{| {{prettytable}}
|- bgcolor="#ddd"
! Token
! Arguments
! Description

|-
| START_GROUP_NUMBER
| number
| Number of breeding couples to start with per entity. Helps give a boost to weaker civs by giving them more cannon fodder at the beginning of their histories, and better genetic diversity (if that's modeled for that particular creature). Note that single-gender (eg. [FEMALE], [MALE], [NO_GENDER]) creatures will not have breeding couples, so a civilization with only these creatures will not be very likely to survive. As of 40d, although many had problems getting such civilizations to survive, there are those who have demonstrably and repeatedly done so. Presumably if the civ-stating code can't place breeding couples, it doesn't start the civ. However, because the children never grow up, the civ is limited to its original individuals).
[START_GROUP_NUMBER:10]

|-
| MAX_POP_NUMBER
| number
| Max population '''per entity'''. Multiply this by max starting civ to get the total population of the species. Defaults to 500.
[MAX_POP_NUMBER:500]

|-
| MAX_SITE_POP_NUMBER
| number
| Max population per individual site. Generic site types will not hold any more than this number of entities. Must be at least 80 for towns to be generated. In general, lower pop numbers mean more sprawl, and higher numbers mean more needing to crawl when entering town stores, which are not affected by this cap. Defaults to 50.
[MAX_SITE_POP_NUMBER:200]

|-
| MAX_STARTING_CIV_NUMBER
| number
| Max number of entities to spawn at world generation. Worldgen picks civs in some sequential order from the raws. Once it reaches the end of the list, it will begin again at the top. Setting this number lower than 100, like say, 7, will cause worldgen to skip over this civ for placement if there are already 7 civs of this type. Note that if all civs are set to lower numbers, and the number of starting civs is set higher than the maximum possible amount of civs in total, it will gracefully stop placing civs and get down to the history aspect of worldgen. Defaults to 3.
[MAX_STARTING_CIV_NUMBER:3]

|}

== Flavor ==
{| {{prettytable}}
|- bgcolor="#ddd"
! Token
! Arguments
! Description

|-
| PERMITTED_BUILDING
| building name
| The named, custom building can be built by a civilization in Fortress Mode.
[PERMITTED_BUILDING:SOAP_MAKER]

|-
| PERMITTED_JOB
| [[Unit type token|profession]]
| Allows this job type to be selected. This applies to worldgen creatures, in the embark screen, and in play.
[PERMITTED_JOB:MINER]

|-
| PERMITTED_REACTION
| reaction name
| Allows this reaction to be used by a civilization. It is used primarily in Fortress Mode. When creating custom reactions, this token MUST be present or the player will not be able to use the reaction in Fortress Mode.
[PERMITTED_REACTION:TAN_A_HIDE]

|-
| CURRENCY_BY_YEAR
|
| Causes the civ's currency to be numbered with the year it was minted.

|-
| CURRENCY
|
* inorganic material
* value
| What kind of metals the civ uses for coin minting as well as the value of the coin.
[CURRENCY:SILVER:5]

|-
| ART_FACET_MODIFIER
|
* type
* number
| OWN_RACE, FANCIFUL, EVIL, GOOD
Number goes from 0 to 25600 where 256 is the default.
[ART_FACET_MODIFIER:OWN_RACE:512]

|-
| ART_IMAGE_ELEMENT_MODIFIER
|
* item
* number
| CREATURE, PLANT, TREE, SHAPE, ITEM 0-25600

Determines the chance of each image occurring in that entity's artwork, such as engravings and on artifacts, for default (non-historical) artwork.

[ART_IMAGE_ELEMENT_MODIFIER:TREE:512]

|-
| ITEM_IMPROVEMENT_MODIFIER
|
* item
* number
| ART_IMAGE, COVERED or GLAZED, RINGS_HANGING, BANDS, SPIKES, ITEMSPECIFIC, THREAD, CLOTH, SEWN_IMAGE 0-25600

Determines the chance of the entity using that particular artwork method, such as "encircled with bands" or "menaces with spikes".

[ITEM_IMPROVEMENT_MODIFIER:SPIKES:0]

This also seems to change the amount that the entity will pay for items that are improved in the ways in their tokens.

|-
| TRANSLATION
| language
| What language raw the entity uses.
* If an entity lacks this tag, translations appear to be drawn randomly from all translation files{{verify}}.
[TRANSLATION:DWARF]

|-
| CULL_SYMBOL
|
* noun
* symbol
| ALL, CIV, SITE
Causes the entity to not use the words in these SYM sets.
[CULL_SYMBOL:ALL:UGLY]

|-
| SELECT_SYMBOL
|
* noun
* symbol
| Causes the entity to more often use these symbols in the particular SYM set.
[SELECT_SYMBOL:ALL:PEACE]

|-
| SUBSELECT_SYMBOL
|
* noun
* symbol
| Unknown.

|-
| FRIENDLY_COLOR
| see [[color]]
|
The color of this entity's civilization settlements in the world gen and embark screens. Defaults to 7:0:1.
[FRIENDLY_COLOR:1:0:1]

|}

== Religion ==
{| {{prettytable}}
|- bgcolor="#ddd"
! Token
! Arguments
! Description

|-
| RELIGION
| type
|
* REGIONAL_FORCE: The creatures will worship a single force associated with their spheres. Currently hardcoded to only be associated with rivers and nature.
* PANTHEON: The creatures will worship a group of gods, each aligned with their spheres and other appropriate ones as well.

[RELIGION:PANTHEON]

|-
| RELIGION_SPHERE
| sphere
| Can by any available [[Sphere]]. Multiple entries are possible. Choosing a religious sphere will automatically make its opposing sphere not possible for the species to have: adding WATER, for example, means the species will never get FIRE as a religious sphere.

[RELIGION_SPHERE:FORTRESSES]

|-
| SPHERE_ALIGNMENT
|
* type
* number
|
This token forces an entity to favor or disfavor particular religious spheres, causing them to acquire those spheres more often when generating a pantheon.

[SPHERE_ALIGNMENT:TREES:512]

|}

== Leadership ==
{| {{prettytable}}
|- bgcolor="#ddd"
! Token
! Arguments
! Description

|-
| POSITION
| string
| Defines a leader/noble position for a civilization. These replace previous tags such as [MAYOR] and [CAN_HAVE_SITE_LEADER] and so on. To define a position further, see [[Position token]].

|-
| LAND_HOLDER_TRIGGER
|
* land holder number
* population
* wealth exported
* created wealth
| Defines when a particular land-holding noble (baron, count, duke in vanilla) will arrive at a fortress.

|-
| VARIABLE_POSITIONS
| Position responsibility or ALL
| Allows a responsibility to be taken up by a dynamically generated position (such as Law-maker).

|}

== Behavior ==
{| {{prettytable}}
|- bgcolor="#ddd"
! Token
! Arguments
! Description

|-
| [[Ethics|ETHIC]]
|
*behavior
*reaction
| Sets the civ's view of certain behaviors, from capital punishment to completely acceptable. This also causes the civ to look upon opposing ethics with disfavor, if their reaction to it is opposing, and when at extremes (one ACCEPTABLE, another civ UNTHINKABLE for example) they will often go to war over it.
[ETHIC:EAT_SAPIENT_KILL:ACCEPTABLE]

|-
| WILL_ACCEPT_TRIBUTE
|
| Makes the civ's traders accept offered goods.

|-
| WANDERER, BEAST_HUNTER, SCOUT
|
| The civ will send out these sorts of adventurers in worldgen. This seems to increase Tracker skill.

|-
| ABUSE_BODIES
|
| The civilization will mutilate bodies when they are the victors in history-gen warfare, such as hanging bodies from trees, putting them on spikes, and so forth. Adventurers killed in Adventurer mode will sometimes be impaled on spikes wherever they died, with or without this token, and regardless of whether they actually antagonized the townspeople.

|-
| ACTIVE_SEASON
| season
| the season when the civ is most active: when they will trade, interact with you via diplomats, and/or invade you. Civs can have multiple season entries. Note: If multiple caravans arrive at the same time, you are able to select which civ to trade with at the depot menu. ACTIVE_SEASON tags may be changed for a currently active fort.
[ACTIVE_SEASON:AUTUMN]

|-
| AMBUSHER
|
| When invading sneaks around and shoots at straggling members of your society. They will spawn on the edge of the map and will only be visible when one of their party are spotted; this can be quite dangerous to undefended trade depots.

|-
| AT_PEACE_WITH_WILDLIFE
|
| Will not attack wildlife, and will not be attacked by them, even if you have them in your party. This can be somewhat disconcerting when attacked by bears in the forest and your elven ally sits back and does nothing.

|-
| BABYSNATCHER
|
| Sends thieves to steal babies. Also sends ambush parties to harass your civilization. Without this tag, enemy civs will only siege, and will siege as early as they would otherwise babysnatch. This can happen as early as the first year of the fort! In addition, babysnatcher civs will snatch children during worldgen, allowing them to become part of the civ if they do not escape.

Note: If the playable civ in Fortress Mode has this tag (ie. you add BABYSNATCHER to the Dwarf entity) then the roles will be reversed and elves and humans will siege and ambush and goblins will trade with you.

|-
| BUILDS_OUTDOOR_FORTIFICATIONS
|
| Makes the civilization build castles.

|-
| BUILDS_OUTDOOR_TOMBS
|
| Makes the civilization build tombs.

|-
| BANDITRY
| percentage
| Sets a percentage of the entity population to be used as bandits.

|-
| DIPLOMAT_BODYGUARDS
|
| Visiting diplomats are accompanied by a pair of soldiers. Does not work due to a bug.{{bug|5854}}

|-
| INVADERS_IGNORE_NEUTRALS
|
| Causes invaders to ignore visiting caravans and other neutral creatures.{{verify}}

|-
| ITEM_THIEF
|
| Sends thieves to steal items. This will also occur in history generation, and thieves will have the "thief" profession. Items stolen in history gen will be scattered around that creature's home.

|-
| LOCAL_BANDITRY
|
| Causes the entity to send out patrols that can ambush adventurers.

|-
| MERCHANT_BODYGUARDS
|
| Caravan merchants are accompanied by soldiers.

|-
| MERCHANT_NOBILITY
|
| Effect unknown - in previous versions, this resulted in the civ having a Guild Representative / Merchant Baron / Merchant Prince, but now this is controlled solely by positions.

|-
| PROGRESS_TRIGGER_POPULATION
| level
| 0 to 5, civ will come to site once population at site has reached that level. If multiple progress triggers exist for a civ, it will come when any one of them is fulfilled instead of waiting for all of them to be reached. A value of 0 disables the trigger. 1 corresponds to 20 dwarves, 2 to 50 dwarves, 3 to 80, 4 to 110, and 5 to 140. Progress triggers may be changed, added, or deleted for a currently active fort. Note: hostile civs require that the population trigger be fulfilled as well as at least one other trigger before attacking.

|-
| PROGRESS_TRIGGER_PRODUCTION
| level
| 0 to 5, civ will come to site once created wealth has reached that level. If multiple progress triggers exist for a civ, it will come when any one of them is fulfilled instead of waiting for all of them to be reached. A value of 0 disables the trigger. 1 corresponds to 5000☼ created wealth, 2 to 25000☼, 3 to 100000☼, 4 to 200000☼, and 5 to 300000☼. Progress triggers may be changed, added, or deleted for a currently active fort.

|-
| PROGRESS_TRIGGER_TRADE
| level
| 0 to 5, civ will come to site once exported goods has reached that level. If multiple progress triggers exist for a civ, it will come when any one of them is fulfilled instead of waiting for all of them to be reached. A value of 0 disables the trigger. 1 corresponds to 500☼ exported wealth, 2 to 2500☼, 3 to 10000☼, 4 to 20000☼, and 5 to 30000☼. Progress triggers may be changed, added, or deleted for a currently active fort.

|-
| PROGRESS_TRIGGER_POP_SIEGE
| level
| 0 to 5, civ will begin to send sieges against the player civ when this level is reached if it is hostile.

If multiple progress triggers exist for a civ, it will come when any one of them is fulfilled instead of waiting for all of them to be reached. A value of 0 disables the trigger.

|-
| PROGRESS_TRIGGER_PROD_SIEGE
| level
| 0 to 5, civ will begin to send sieges against the player civ when this level is reached if it is hostile.

|-
| PROGRESS_TRIGGER_TRADE_SIEGE
| level
| 0 to 5, civ will begin to send sieges against the player civ when this level is reached if it is hostile.

|-
| SIEGER
|
| Will start campfires and wait around at the edge of your map for a month or two before rushing in to attack.

|-
| SKULKING
|
| This makes the severity of attacks depend on the extent of item/baby thievery rather than the passage of time.

|-
| TREE_CAP_DIPLOMACY
|
| Visiting diplomats impose tree cutting quotas; without this, they will simply compliment your fortress and leave. Also causes the diplomat to make unannounced first contact at the very beginning of the first Spring after your fortress becomes a Barony.

|-
| LAYER_LINKED
|
| Defines if a civilization is a hidden subterranean entity, such as batman civilizations.

|-
| UNDEAD_CANDIDATE
|
| Unknown.

|}

== Items and Animals Used ==
{| {{prettytable}}
|- bgcolor="#ddd"
! Token
! Arguments
! Description

|-
| AMMO
| item token
|
[AMMO:ITEM_AMMO_BOLTS]

|-
| ARMOR
|
* item token
* rarity
|Rarity is optional. Permitted rarity values are RARE, UNCOMMON, FORCED (anything else is treated as COMMON).
[ARMOR:ITEM_ARMOR_PLATEMAIL:COMMON]

|-
| DIGGER
| item token
|
[DIGGER:ITEM_WEAPON_PICK]

|-
| GLOVES
|
* item token
* rarity
| Rarity is optional. Permitted rarity values are RARE, UNCOMMON, FORCED (anything else is treated as COMMON).
[GLOVES:ITEM_GLOVES_GLOVES:COMMON]

|-
| HELM
|
* item token
* rarity
| Rarity is optional. Permitted rarity values are RARE, UNCOMMON, FORCED (anything else is treated as COMMON).
[HELM:ITEM_HELM_HELM:COMMON]

|-
| INSTRUMENT
| item token
|
[INSTRUMENT:ITEM_INSTRUMENT_FLUTE]

|-
| PANTS
|
* item token
* rarity
| Rarity is optional. Permitted rarity values are RARE, UNCOMMON, FORCED (anything else is treated as COMMON).
[PANTS:ITEM_PANTS_PANTS:COMMON]

|-
| SHIELD
| item token
|
[SHIELD:ITEM_SHIELD_SHIELD]

|-
| SHOES
|
* item token
* rarity
| Rarity is optional. Permitted rarity values are RARE, UNCOMMON, FORCED (anything else is treated as COMMON).
[SHOES:ITEM_SHOES_SHOES:COMMON]

|-
| SIEGEAMMO
| item token
|
[SIEGEAMMO:ITEM_SIEGEAMMO_BALLISTA]

|-
| TOOL
| item token
|
[TOOL:ITEM_TOOL_NEST_BOX]

|-
| TOY
| item token
|
[TOY:ITEM_TOY_PUZZLEBOX]

|-
| TRAPCOMP
| item token
|
[TRAPCOMP:ITEM_TRAPCOMP_GIANTAXEBLADE]

|-
| WEAPON
| item token
|
[WEAPON:ITEM_WEAPON_AXE_BATTLE]

|-
| USE_ANIMAL_PRODUCTS
|
| Allows creature to use products made from animals, such as leather shirts.

|-
| USE_ANY_PET_RACE
|
| Assuming it passes other checks, any creature in their list of usables (from common domestic if they have that or from the surrounding 7x7 or so of squares and map features in those squares) which has PET or PET_EXOTIC will be available as a pet (next time, it'll let them use mounts/pullers/pack animals of any kind as well, but I'm not sure this matters in the stock raws). This notion of the initial usable creature list, which then gets pared down or otherwise considered, applies below as well. All common domestic and equipment creatures are also added to the initial list.

|-
| USE_CAVE_ANIMALS
|
| If they don't have it, creatures with exclusively subterranean biomes are skipped.

|-
| USE_EVIL_ANIMALS
|
| Don't have it -> EVIL creatures skipped.

|-
| USE_EVIL_PLANTS
|
| As EVIL creatures for all uses of plants.

|-
| USE_EVIL_WOOD
|
| As EVIL creatures for all uses of wood.

|-
| USE_GOOD_ANIMALS
|
| Don't have it -> GOOD creatures skipped.

|-
| USE_GOOD_PLANTS
|
| As GOOD creatures for all uses of plants.

|-
| USE_GOOD_WOOD
|
| As GOOD creatures for all uses of wood.

|-
| USE_MISC_PROCESSED_WOOD_PRODUCTS
|
| If wood is available locally, and the relevant professions are permitted, controls availability of lye, charcoal, potash and pearlash.

|-
| COMMON_DOMESTIC_MOUNT
|
| If a creature has MOUNT and the relevant COMMON_DOMESTIC_x tag (or COMMON_DOMESTIC for pets), it will be allowed if it passes the other checks.

|-
| COMMON_DOMESTIC_PACK
|
| If a creature has PACK_ANIMAL and the relevant COMMON_DOMESTIC_x tag (or COMMON_DOMESTIC for pets), it will be allowed if it passes the other checks. Also seems to be required currently for trading to occur.

|-
| COMMON_DOMESTIC_PET
|
| If a creature has PET and the relevant COMMON_DOMESTIC_x tag (or COMMON_DOMESTIC for pets), it will be allowed if it passes the other checks. Also seems to be required to have any animals at all, including those used in trading.

|-
| COMMON_DOMESTIC_PULL
|
| If a creature has WAGON_PULLER and the relevant COMMON_DOMESTIC_x tag (or COMMON_DOMESTIC for pets), it will be allowed if it passes the other checks.

|-
| RIVER_PRODUCTS
|
| Allow civ to use river products in the goods it has available for trade.

|-
| OCEAN_PRODUCTS
|
| Allow civ to use ocean products in the goods it has available for trade.

|-
| INDOOR_FARMING
|
| Allow civ to use underground plant products in the goods it has available for trade.

|-
| OUTDOOR_FARMING
|
| Allow civ to use outdoor plant products in the goods it has available for trade.

|-
| CLOTHING
|
| Civ members will attempt to wear clothing.

|-
| SUBTERRANEAN_CLOTHING
|
| Will wear things made of spider silk and other subterranean materials.

|-
| EQUIPMENT_IMPROVEMENTS
|
| Adds decorations to equipment based on the level of the generated unit. Also improves item quality.

|-
| IMPROVED_BOWS
|
| Adds decorations to weapons generated for bowman and master bowman. An elf hack.

|-
| METAL_PREF
|
| Needs testing.

|-
| STONE_PREF
|
| Enables creatures of this entity to bring stones in trade. Also seems to enable the use of metals smelted from ore, such as iron or copper.

|-
| WOOD_WEAPONS
|
| Causes members to be able to use wooden weapons.

|-
| WOOD_ARMOR
|
| Causes members to be able to use wooden armor.

|-
| GEM_PREF
|
| Enables creatures of this entity to bring gems in trade.

|-
| INDOOR_WOOD
|
| Allow civ to trade subterranean wood types, such as tower-cap and fungiwood logs.

|-
| OUTDOOR_WOOD
|
| Allow civ to use outdoor wood types, such as mangrove and oak.

|}

== Tissue Styling Related Tokens ==
{| {{prettytable}}
|- bgcolor="#ddd"
! Token
! Arguments
! Description

|-
| TISSUE_STYLE
|
*tissue???
| Presumably selects tissue to set cultural style parameters for. Needs testing.

|-
| TS_MAINTAIN_LENGTH
|
*length?
*???
| Presumably sets culturally preferred tissue length for selected tissue. Needs testing.

|-
| TS_PREFERRED_SHAPING
| ???
| Presumably sets culturally preferred tissue shapings for selected tissue. Needs testing.

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

v0.34:Ethic

2013-03-23T22:48:03Z

AVK:

{{quality|Exceptional|18:03, 28 April 2011 (UTC)}}{{av}}
== List of acceptable ethics tags==

Ethics tags are used in the [[Entity token|entity raw files]] to determine how different civilizations feel about various issues. Relationships between civilizations are based on their ethic responses in relation to each other; similar ethics result in friendship, while conflicting ethics result in animosity. Strongly conflicting ethics often trigger [[war]]s during worldgen.

In practice, this generally causes Elves to declare war on everybody else over killing plants and making trophies, and everybody else to declare war on the Elves over the devouring of sapient beings.

== Ethics types ==
{| {{prettytable}}
|- bgcolor="#dddddd"
!Token
!Extra Information
|-
|ASSAULT
| The result of a tantruming citizen attacking another in fortress mode. Other effects unknown.
|-
|EAT_SAPIENT_KILL
| This determines if the race will sometimes devour dead enemy combatants.
|-
|EAT_SAPIENT_OTHER
| This also determines whatever or not a race is willing to butcher other sapients.
|-
|KILL_ANIMAL
| A response between MISGUIDED and UNTHINKABLE (see below) causes the entity to refuse animal products in trade - namely, [[material token|materials]] with [IMPLIES_ANIMAL_KILL].
|-
|KILL_ENEMY
|
|-
|KILL_ENTITY_MEMBER
|
|-
|KILL_NEUTRAL
|
|-
|KILL_PLANT
| This determines a race's position towards wood as well - a response between MISGUIDED and UNTHINKABLE (see below) causes the entity to refuse wooden objects in trade, and it also prohibits them from bringing caravan [[wagon]]s.
|-
|LYING
|
|-
|MAKE_TROPHY_ANIMAL
|
|-
|MAKE_TROPHY_SAME_RACE
|
|-
|MAKE_TROPHY_SAPIENT
|
|-
|OATH_BREAKING
| The result of a citizen violating noble mandates in fortress mode. Other effects unknown.
|-
|SLAVERY
|
|-
|THEFT
| This determines whether the race will try to steal goods.
|-
|TORTURE_ANIMALS
|
|-
|TORTURE_AS_EXAMPLE
|
|-
|TORTURE_FOR_FUN
|
|-
|TORTURE_FOR_INFORMATION
|
|-
|TREASON
|
|-
|TRESPASSING
|
|-
|VANDALISM
| The result of a tantruming citizen breaking furniture in fortress mode. Other effects unknown.
|}

==Ethics values==
As used internally (see below), roughly in order of acceptability:

{| {{prettytable}}
|- bgcolor="#dddddd"
! Num !! Token
|-
| 0 || NOT_APPLICABLE
|-
| 1 || ACCEPTABLE
|-
| 2 || PERSONAL_MATTER
|-
| 3 || JUSTIFIED_IF_NO_REPERCUSSIONS
|-
| 4 || JUSTIFIED_IF_GOOD_REASON
|-
| 5 || JUSTIFIED_IF_EXTREME_REASON
|-
| 6 || JUSTIFIED_IF_SELF_DEFENSE
|-
| 7 || ONLY_IF_SANCTIONED
|-
| 8 || MISGUIDED
|-
| 9 || SHUN
|-
| 10 || APPALLING
|-
| 11 || PUNISH_REPRIMAND
|-
| 12 || PUNISH_SERIOUS
|-
| 13 || PUNISH_EXILE
|-
| 14 || PUNISH_CAPITAL
|-
| 15 || UNTHINKABLE
|-
| 16 || REQUIRED
|}

==Ethics value numbers in relation to each other==
The following table describes how entities respond to differences in ethics, using the evaluator's ethic response as the row number and the target's ethic response as the column number.
{| ((prettytable}}
|- style="text-align:right"
! -
! 0 !! 1 !! 2 !! 3 !! 4 !! 5 !! 6 !! 7 !! 8 !! 9 !! 10 !! 11 !! 12 !! 13 !! 14 !! 15 !! 16
|- style="text-align:right"
! 0
| 0 || 0 || 0 || 0 || 0 || 0 || 0 || 0 || 0 || 0 || 0 || 0 || 0 || 0 || 0 || 0 || 0
|- style="text-align:right"
! 1
| 0 || 1 || 1 || 1 || 0 || 0 || 0 || 0 || -1 || -2 || -2 || -2 || -3 || -5 || -5 || -2 || 1
|- style="text-align:right"
! 2
| 0 || 1 || 1 || 1 || 0 || 0 || 0 || 0 || -1 || -2 || -2 || -2 || -3 || -5 || -5 || -2 || 1
|- style="text-align:right"
! 3
| 0 || 1 || 1 || 1 || 0 || 0 || 0 || 0 || -1 || -2 || -2 || -2 || -3 || -5 || -5 || -2 || 1
|- style="text-align:right"
! 4
| 0 || 0 || 0 || 0 || 2 || 1 || 0 || 0 || 0 || -1 || -1 || -1 || -1 || -1 || -1 || -1 || 0
|- style="text-align:right"
! 5
| 0 || -1 || -1 || 0 || 1 || 2 || 0 || 0 || 0 || -1 || -1 || -1 || -1 || -1 || -1 || -1 || -1
|- style="text-align:right"
! 6
| 0 || -2 || -2 || -1 || 0 || 1 || 2 || 0 || 0 || 0 || -1 || -1 || -1 || -1 || -1 || -1 || -2
|- style="text-align:right"
! 7
| 0 || -2 || -2 || -1 || 0 || 1 || 0 || 2 || 0 || 0 || -1 || -1 || -1 || -1 || -1 || -1 || -2
|- style="text-align:right"
! 8
| 0 || -1 || -1 || 0 || 0 || 0 || 0 || 0 || 2 || 1 || 1 || 1 || 0 || 0 || -1 || 1 || -1
|- style="text-align:right"
! 9
| 0 || -1 || -1 || 0 || 0 || 0 || 0 || 0 || 1 || 2 || 1 || 1 || 0 || 0 || -1 || 1 || -1
|- style="text-align:right"
! 10
| 0 || -5 || -5 || -3 || -2 || -1 || -1 || -2 || 1 || 1 || 2 || 1 || 1 || 1 || 0 || 1 || -5
|- style="text-align:right"
! 11
| 0 || -5 || -5 || -3 || -2 || -1 || -1 || -2 || 1 || 1 || 1 || 2 || 1 || 1 || 0 || 1 || -5
|- style="text-align:right"
! 12
| 0 ||-10 ||-10 || -7 || -3 || -2 || -2 || -3 || 0 || 1 || 1 || 0 || 2 || 1 || 1 || 1 ||-10
|- style="text-align:right"
! 13
| 0 ||-10 ||-10 || -7 || -3 || -2 || -2 || -3 || 0 || 1 || 1 || 0 || 1 || 2 || 1 || 1 ||-10
|- style="text-align:right"
! 14
| 0 ||-15 ||-15 ||-10 || -5 || -3 || -3 || -5 || 0 || 0 || 1 || 0 || 1 || 1 || 2 || 1 ||-15
|- style="text-align:right"
! 15
| 0 ||-15 ||-15 ||-10 || -5 || -3 || -3 || -5 || 0 || 1 || 1 || 0 || 1 || 1 || 1 || 2 ||-15
|- style="text-align:right"
! 16
| 0 || 1 || 1 || 1 || 0 || 0 || 0 || 0 || -1 || -2 || -2 || -2 || -3 || -5 || -5 || -2 || 1
|}

The above values were collected from a disassembly and are identical to the values given by Toady himself in [http://www.bay12forums.com/smf/index.php?topic=22151.msg239689 this forum thread].

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

v0.34:Position token

2013-03-23T21:04:33Z

AVK: Oops, didn't know what I was talking about.

{{quality|Exceptional|18:14, 28 April 2011 (UTC)}}{{av}}
These tokens define positions in entity_*.txt files. See [[Entity token]].
==Position Tokens==
These tokens belong in an entity definition. These tokens apply to a position (such as monarch) and should follow the [POSITION:POSITION_NAME] token.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Description

|-
| ACCOUNT_EXEMPT
|
| The position holder is not subjected to the economy. Less than relevant right now.

|-
| ALLOWED_CLASS
| CREATURE_CLASS Token
| Only creatures with the specified class token can be appointed to this position.

|-
| ALLOWED_CREATURE
| CREATURE:CASTE
| Restricts the position to only the defined caste. Only works with a caste of the entity's current race (If the entity had multiple CREATURE: tokens)

|-
| APPOINTED_BY
| position
| This position can only be chosen to the task from the nobles screen, and is available only if there is an *argument* present. For example, the GENERAL is [APPOINTED_BY:MONARCH]. Contrast [ELECTED]. Being appointed by a MONARCH seems to handle a lot of worldgen stuff and interferes with fort mode titles.

|-
| BRAG_ON_KILL
|
| A creature that kills this position will be sure to talk about it a lot.

|-
| CHAT_WORTHY
|
| In adventure mode, when referencing locations an NPC may mention this position holder living there or having done some deed there.

|-
| COLOR
| color
| Creatures of this position will have this color, instead of their profession color. e.g. [COLOR:5:0:1]

|-
| COMMANDER
| position:ALL
| This position will act as a commander of the specified position{{verify}}. E.g. GENERAL is [COMMANDER:LIEUTENANT:ALL]. Unknown if values other than ALL work.

|-
| CONQUERED_SITE
|
| This position is the puppet ruler left behind on a conquered site.

|-
| DEMAND_MAX
| number (0-100)
| How many demands at one time the position can make of the population.

|-
| DETERMINES_COIN_DESIGN
|
| Minted coins will have images that reflect the personality of this position holder.

|-
| DO_NOT_CULL
|
| The position won't be culled from Legends as "unimportant" during world generation.

|-
| DUTY_BOUND
|
| Members of this position will never agree to 'join' your character during adventure mode.

|-
| ELECTED
|
| The population will periodically select the most skill-eligible creature to fill this position. Contrast [APPOINTED_BY].

|-
| EXECUTION_SKILL
| weapon skill
| A mandatory subtag of [RESPONSIBILITY:EXECUTIONS]. Determines the weapon chosen by the executioner for his work.

|-
| EXPORTED_IN_LEGENDS
|
| The various members who have filled this role will be listed in the civilisation's history.

|-
| FLASHES
|
| The creature holding this position will visibly flash, like legendary citizens. Represents a properly noble station by default.

|-
| GENDER
| male/female
| The position can only be held by specified gender.

|-
| KILL_QUEST
|
| The position can assign quests to adventurers.

|-
| LAND_HOLDER
| importance tier (1-3)
| The position is a title bestowed by the King. The outpost liaison may offer to appoint a citizen to this position once the wealth requirements given in the LAND_HOLDER_TRIGGER in the entity definition has been met.

|-
| LAND_NAME
| string
| The name the area takes on when under the control of a LAND_HOLDER. E.g. for the DUKE, [LAND_NAME:a duchy]

|-
| MANDATE_MAX
| number (0-100)
| The maximum number of mandates the position can make at once.

|-
| MENIAL_WORK_EXEMPTION
|
| The position cannot be assigned labours, and will generally just lounge around like nobles do. Currently does not actually work. {{bug|3721}}

|-
| MENIAL_WORK_EXEMPTION_SPOUSE
|
| The spouse of the position holder doesn't have to work, either. Also doesn't work either. {{bug|3721}}

|-
| MILITARY_SCREEN_ONLY
|
| This position can not be appointed from the nobles screen. Intended for militia captains and other squad leaders to reduce clutter.

|-
| NAME
| singular:plural
| The name of the position.

|-
| NAME_MALE
| singular:plural
| If the creature holding the position is male, this is the position's name. E.g. for MONARCH, [NAME_MALE:king:kings]

|-
| NAME_FEMALE
| singular:plural
| If the creature holding the position is female, this is the position's name. E.g. for MONARCH, [NAME_FEMALE:queen:queens]

|-
| NUMBER
|
* number/AS_NEEDED
| How many of the position there should be. If the [SITE] token exists, this is per site, otherwise this is per civilisation.

|-
| PRECEDENCE
| number (0-30000)
| How important the position is in society; a lower number is more important. For MONARCH it's 1, for MILITIA_CAPTAIN it's 200.

|-
| PUNISHMENT_EXEMPTION
|
| The position holder will not be held accountable for his or her crimes. Does not appear to work. {{bug|4589}}

|-
| QUEST_GIVER
|
| The position holder can give quests in Adventurer mode. Functionality in 0.31.13 and later is uncertain.

|-
| REJECTED_CLASS
| CREATURE_CLASS Token
| Creatures of the specified class cannot be appointed to this position.

|-
| REJECTED_CREATURE
| CREATURE:CASTE
| Restricts position holders by CREATURE type.

|-
| REPLACED_BY
| position
| This position is absorbed by another down the line. For example, expedition leader is [REPLACED_BY:MAYOR].

|-
| REQUIRED_BEDROOM
| number (0-1000000)
| The position holder requires a bedroom with at least this value.

|-
| REQUIRED_BOXES
| number (0-100)
| The position holder requires at least this many boxes.

|-
| REQUIRED_CABINETS
| number (0-100)
| The position holder requires at least this many cabinets.

|-
| REQUIRED_DINING
| number (0-1000000)
| The position holder requires a dining room with at least this value.

|-
| REQUIRED_OFFICE
| number (0-1000000)
| The position holder requires an office with at least this value.

|-
| REQUIRED_RACKS
| number (0-100)
| The position holder requires at least this many weapon racks.

|-
| REQUIRED_STANDS
| number (0-100)
| The position holder requires at least this many armour stands.

|-
| REQUIRED_TOMB
| number (0-1000000)
| The position holder requires a tomb with at least this value.

|-
| REQUIRES_POPULATION
| number
| The position requires the population to be at least this number before it becomes available or before the position holder will move in.

|-
| RESPONSIBILITY
| responsibility
| The position holder does a thing. See the table below for suitable arguments.

|-
| RULES_FROM_LOCATION
|
| The position holder is the main ruler of his site and tends to stay there. {{verify}}

|-
| SITE
|
| The civilisation will attempt to have this position separate for each site.

|-
| SLEEP_PRETENSION
|
| The position holder will get upset if someone with a higher PRECEDENCE holds quarters with a greater value than their own.

|-
| SPOUSE
| singular:plural
| The name of the position holder's spouse.

|-
| SPOUSE_FEMALE
| singular:plural
| If the spouse of the creature holding the position is female, this is the spouse's position name.

|-
| SPOUSE_MALE
| singular:plural
| If the spouse of the creature holding the position is male, this is the spouse's position name.

|-
| SQUAD
| number:singular:plural
| The position holder is authorized to form a military squad, led by themselves. The number denotes the maximum headcount. The noun used to describe the subordinates (e.g. royal guard) may be a relic from the 40d era.{{verify}}

|-
| SUCCESSION
|
* BY_HEIR / BY_POSITION:position
| How a new position holder is chosen.

|}

== Responsibilities ==
{| {{prettytable}}
|- bgcolor="#dddddd"
! Argument
! Description
! Notes

|-
| ACCOUNTING
| Found on bookkeeper. Position will use Record Keeper skill to keep track of stocks.

|-
| ATTACK_ENEMIES
| Found on elven ranger captain and human warrior. Effect unknown.{{verify}}

|-
| BUILD_MORALE
| Found on champion. Position will lead military training exercises.{{verify}}

|-
| COLLECT_TAXES
| Found on tax collector. Position goes around and collects the tax money from the populace, under armed escort.
| Removed in version 0.31 along with the dwarven [[economy]]. Has no current effect.

|-
| EQUIPMENT_MANIFESTS
| Found on arsenal dwarf. Position will keep track of assigned weapons and equipment.
| Removed in version 31.10. Has no effect.

|-
| ESCORT_TAX_COLLECTOR
| Found on hammerer. Position serves as one of the tax collector's bodyguards during his rounds.
| Removed in version 0.31 along with the tax collector. Has no current effect.

|-
| ESTABLISH_COLONY_TRADE_AGREEMENTS
| Found on outpost liaison. Position will live in the civilization capital and travels to make trade agreements with its colonies.

|-
| EXECUTIONS
| Found on hammerer. Position executes death penalties with a weapon of the appropriate skill.
|

|-
| HEALTH_MANAGEMENT
| Found on chief medical dwarf. Position will use Diagnostician skill enable the {{key|z}}-menu health screen.
|

|-
| LAW_ENFORCEMENT
| Found on sheriff/captain of the guard. Position and its subordinates are in charge of punishing criminals.

|-
| LAW_MAKING
| Found on monarch/landholders. Effect unknown.{{verify}}

|-
| MAKE_INTRODUCTIONS
| Found on diplomat. Effect unknown.{{verify}}

|-
| MAKE_PEACE_AGREEMENTS
| Found on diplomat. Position negotiates peace treaties in order to end wars.

|-
| MAKE_TOPIC_AGREEMENTS
| Found on diplomat. Position negotiates special agreements such as tree cutting quotas.

|-
| MANAGE_PRODUCTION
| Found on manager. Position enables the use of workshop profiles and uses the Organizer skill to process work orders entered in the job manager after the fortress population reaches 20.

|-
| MEET_WORKERS
| Found on expedition leader/mayor. Position holds meetings with unhappy citizens and tries to pacify them with happy thoughts.

|-
| MILITARY_GOALS
| Found on monarch/landholder/leaders. Effect unknown.{{verify}}

|-
| MILITARY_STRATEGY
| Found on general/militia commander. During worldgen, position will go on expeditions to tame exotic creatures.{{verify}}

|-
| PATROL_TERRITORY
| Found on elven ranger captain and human warrior. Effect unknown.{{verify}}

|-
| RECEIVE_DIPLOMATS
| Found on monarch/landholder/leaders. Position will hold meetings with incoming diplomats and liaisons.

|-
| RELIGION
| Found on elven druid. Position informs you about worship cults{{verify}}

|-
| SORT_AMMUNITION
| Found on arsenal dwarf. Position approves changes to ammunition settings in the military screen.
| Removed in version 31.10. Has no current effect.

|-
| TAME_EXOTICS
| Found on dungeon master. Position enables taming exotic creatures and does forge work.
| Defunct since version 0.31, removed with the animal training overhaul in 34.06. Has no current effect.

|-
| TRADE
| Found on broker. Position will use Appraisal skill to display value estimates and trade at the depot when set to broker only. When applied to other civilizations, the position will arrive with the caravan to make trade agreements.

|-
| UPGRADE_SQUAD_EQUIPMENT
| Found on arsenal dwarf. Position approves changes to assigned squad equipment in the military screen.
| Removed in version 31.10. Has no current effect.

|}

== Related Tokens ==
The following two ENTITY tokens are not actually position tokens, but bear mentioning on this page because they can modify the way that a civilization's positions behave:

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Description

|-
| LAND_HOLDER_TRIGGER
|
* landholder tier
* population
* wealth exported
* created wealth
| Defines the requirements for the noble ruler promotions. The tier numbers determine which position is used.

|-
| VARIABLE_POSITIONS
| Position responsibility or ALL
| Allows a responsibility to be taken up by a dynamically generated position (such as Law-maker).

|}

== Why Won't My Positions Appear? ==
The way DF determines what positions will actually ''appear'' in your fortress is somewhat counterintuitive and fairly limiting. This guide should help you understand what you can do to actually get your positions working properly.

There are five tokens governing which positions appear in your fortress - LAND_HOLDER, REQUIRES_POPULATION, APPOINTED_BY, ELECTED, and REPLACED_BY. The first two determine when your fortress is eligible for a new position, the next two determine how a new position for which your fortress is eligible can be added, and the fifth allows you to clear up obsolete positions. Unfortunately, they also interact in some strange ways that makes creating interesting position structures difficult.

When you start a new fortress, DF compiles a list of your initial positions. To do this, it looks at the requirements for each position - any position whose only requirement is less than seven dwarves (either because they have no requirement tokens, or because their only requirement tokens are [REQUIRES_POPULATION: =< 7] or [LAND_HOLDER:some trigger whose only requirement is some number of dwarves equal to or less than 7]). Most importantly, ''any'' position whose only requirement is a LAND_HOLDER requirement, regardless of what the trigger for that requirement is, will be added if another eligible starting position is REPLACED_BY it. '''A non-LAND_HOLDER position that is REPLACED_BY a LAND_HOLDER position will never appear.''' With this list compiled, the game culls all positions that are REPLACED_BY another eligible position, and then culls all positions that have the APPOINTED_BY token. '''You may not embark with any appointed positions.''' Any remaining positions are then filled by a dwarf chosen at random.

'''Positions do not automatically appear when you reach their requirements.''' For example, if you remove the ELECTED token from the Mayor, then the Mayor will never appear, even once you reach his required number of dwarves. '''For a position that does not appear at embark to appear in your fortress, it must be APPOINTED_BY another position or ELECTED.'''

Naturally, this is more complicated than it looks. '''APPOINTED_BY positions must be appointed by another position already in your fortress, or a civ-level position. Only LAND_HOLDER positions may be appointed by civ-level positions.''' LAND_HOLDER positions that are APPOINTED_BY civ-level positions are inherently tied to civ-level tokens with the ESTABLISH_COLONY_TRADE_AGREEMENTS responsibility. If a fortress meets the LAND_HOLDER_TRIGGER for a new LAND_HOLDER tier when a caravan leaves, then the next time the outpost liaison or equivalent arrives, he will offer to make you an official colony, which will allow you to select all positions for that LAND_HOLDER level. '''Each time he appears, the outpost liaison will only promote your fortress one tier up the LAND_HOLDER track.''' The biggest problem with this system is that you may set your LAND_HOLDER_TRIGGERS such that you are eligible for the first tier of LAND_HOLDER positions at embark. '''If you are eligible for the first tier of LAND_HOLDER positions at embark, then all first-tier positions will appear twice - once at embark, and again when the outpost liaison comes to appoint you to the first tier.'''

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

v0.34:Position token

2013-03-23T04:51:00Z

AVK:

{{quality|Exceptional|18:14, 28 April 2011 (UTC)}}{{av}}
These tokens define positions in entity_*.txt files. See [[Entity token]].
==Position Tokens==
These tokens belong in an entity definition. These tokens apply to a position (such as monarch) and should follow the [POSITION:POSITION_NAME] token.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Description

|-
| ACCOUNT_EXEMPT
|
| The position holder is not subjected to the economy. Less than relevant right now.

|-
| ALLOWED_CLASS
| CREATURE_CLASS Token
| Only creatures with the specified class token can be appointed to this position.

|-
| ALLOWED_CREATURE
| CREATURE:CASTE
| Restricts the position to only the defined caste. Only works with a caste of the entity's current race (If the entity had multiple CREATURE: tokens)

|-
| APPOINTED_BY
| position
| This position can only be chosen to the task from the nobles screen, and is available only if there is an *argument* present. For example, the GENERAL is [APPOINTED_BY:MONARCH]. Contrast [ELECTED]. Being appointed by a MONARCH seems to handle a lot of worldgen stuff and interferes with fort mode titles.

|-
| BRAG_ON_KILL
|
| A creature that kills this position will be sure to talk about it a lot.

|-
| CHAT_WORTHY
|
| In adventure mode, when referencing locations an NPC may mention this position holder living there or having done some deed there.

|-
| COLOR
| color
| Creatures of this position will have this color, instead of their profession color. e.g. [COLOR:5:0:1]

|-
| COMMANDER
| position:ALL
| This position will act as a commander of the specified position{{verify}}. E.g. GENERAL is [COMMANDER:LIEUTENANT:ALL]. Unknown if values other than ALL work.

|-
| CONQUERED_SITE
|
| This position is the puppet ruler left behind on a conquered site.

|-
| DEMAND_MAX
| number (0-100)
| How many demands at one time the position can make of the population.

|-
| DETERMINES_COIN_DESIGN
|
| Minted coins will have images that reflect the personality of this position holder.

|-
| DO_NOT_CULL
|
| The position won't be culled from Legends as "unimportant" during world generation.

|-
| DUTY_BOUND
|
| Members of this position will never agree to 'join' your character during adventure mode.

|-
| ELECTED
|
| The population will periodically select the most skill-eligible creature to fill this position. Contrast [APPOINTED_BY].

|-
| EXECUTION_SKILL
| weapon skill
| A mandatory subtag of [RESPONSIBILITY:EXECUTIONS]. Determines the weapon chosen by the executioner for his work.

|-
| EXPORTED_IN_LEGENDS
|
| The various members who have filled this role will be listed in the civilisation's history.

|-
| FLASHES
|
| The creature holding this position will visibly flash, like legendary citizens. Represents a properly noble station by default.

|-
| GENDER
| male/female
| The position can only be held by specified gender.

|-
| KILL_QUEST
|
| The position can assign quests to adventurers.

|-
| LAND_HOLDER
| importance tier (1-3)
| The position is a title bestowed by the King. The outpost liaison may offer to appoint a citizen to this position once the wealth requirements given in the LAND_HOLDER_TRIGGER in the entity definition has been met.

|-
| LAND_NAME
| string
| The name the area takes on when under the control of a LAND_HOLDER. E.g. for the DUKE, [LAND_NAME:a duchy]

|-
| MANDATE_MAX
| number (0-100)
| The maximum number of mandates the position can make at once.

|-
| MENIAL_WORK_EXEMPTION
|
| The position cannot be assigned labours, and will generally just lounge around like nobles do. Currently does not actually work. {{bug|3721}}

|-
| MENIAL_WORK_EXEMPTION_SPOUSE
|
| The spouse of the position holder doesn't have to work, either. Also doesn't work either. {{bug|3721}}

|-
| MILITARY_SCREEN_ONLY
|
| This position can not be appointed from the nobles screen. Intended for militia captains and other squad leaders to reduce clutter.

|-
| NAME
| singular:plural
| The name of the position.

|-
| NAME_MALE
| singular:plural
| If the creature holding the position is male, this is the position's name. E.g. for MONARCH, [NAME_MALE:king:kings]

|-
| NAME_FEMALE
| singular:plural
| If the creature holding the position is female, this is the position's name. E.g. for MONARCH, [NAME_FEMALE:queen:queens]

|-
| NUMBER
|
* number/AS_NEEDED
| How many of the position there should be. If the [SITE] token exists, this is per site, otherwise this is per civilisation.

|-
| PRECEDENCE
| number (0-30000)
| How important the position is in society; a lower number is more important. For MONARCH it's 1, for MILITIA_CAPTAIN it's 200.

|-
| PUNISHMENT_EXEMPTION
|
| The position holder will not be held accountable for his or her crimes. Does not appear to work. {{bug|4589}}

|-
| QUEST_GIVER
|
| The position holder can give quests in Adventurer mode. Functionality in 0.31.13 and later is uncertain.

|-
| REJECTED_CLASS
| CREATURE_CLASS Token
| Creatures of the specified class cannot be appointed to this position.

|-
| REJECTED_CREATURE
| CREATURE:CASTE
| Restricts position holders by CREATURE type.

|-
| REPLACED_BY
| position
| This position is absorbed by another down the line. For example, expedition leader is [REPLACED_BY:MAYOR].

|-
| REQUIRED_BEDROOM
| number (0-1000000)
| The position holder requires a bedroom with at least this value.

|-
| REQUIRED_BOXES
| number (0-100)
| The position holder requires at least this many boxes.

|-
| REQUIRED_CABINETS
| number (0-100)
| The position holder requires at least this many cabinets.

|-
| REQUIRED_DINING
| number (0-1000000)
| The position holder requires a dining room with at least this value.

|-
| REQUIRED_OFFICE
| number (0-1000000)
| The position holder requires an office with at least this value.

|-
| REQUIRED_RACKS
| number (0-100)
| The position holder requires at least this many weapon racks.

|-
| REQUIRED_STANDS
| number (0-100)
| The position holder requires at least this many armour stands.

|-
| REQUIRED_TOMB
| number (0-1000000)
| The position holder requires a tomb with at least this value.

|-
| REQUIRES_POPULATION
| number
| The position requires the population to be at least this number before it becomes available or before the position holder will move in.

|-
| RESPONSIBILITY
| responsibility
| The position holder does a thing. See the table below for suitable arguments.

|-
| RULES_FROM_LOCATION
|
| The position holder is the main ruler of his site and tends to stay there. {{verify}}

|-
| SITE
|
| The civilisation will attempt to have this position separate for each site.

|-
| SLEEP_PRETENSION
|
| The position holder will get upset if someone with a higher PRECEDENCE holds quarters with a greater value than their own.

|-
| SPOUSE
| singular:plural
| The name of the position holder's spouse.

|-
| SPOUSE_FEMALE
| singular:plural
| If the spouse of the creature holding the position is female, this is the spouse's position name.

|-
| SPOUSE_MALE
| singular:plural
| If the spouse of the creature holding the position is male, this is the spouse's position name.

|-
| SQUAD
| number:singular:plural
| The position holder is authorized to form a military squad, led by themselves. The number denotes the maximum headcount. The noun used to describe the subordinates (e.g. royal guard) may be a relic from the 40d era.{{verify}}

|-
| SUCCESSION
|
* BY_HEIR / BY_POSITION:position
| How a new position holder is chosen.

|}

== Responsibilities ==
{| {{prettytable}}
|- bgcolor="#dddddd"
! Argument
! Description
! Notes

|-
| ACCOUNTING
| Found on bookkeeper. Position will use Record Keeper skill to keep track of stocks.

|-
| ATTACK_ENEMIES
| Found on elven ranger captain and human warrior. Effect unknown.{{verify}}

|-
| BUILD_MORALE
| Found on champion. Position will lead military training exercises.{{verify}}

|-
| COLLECT_TAXES
| Found on tax collector. Position goes around and collects the tax money from the populace, under armed escort.
| Removed in version 0.31 along with the dwarven [[economy]]. Has no current effect.

|-
| EQUIPMENT_MANIFESTS
| Found on arsenal dwarf. Position will keep track of assigned weapons and equipment.
| Removed in version 31.10. Has no effect.

|-
| ESCORT_TAX_COLLECTOR
| Found on hammerer. Position serves as one of the tax collector's bodyguards during his rounds.
| Removed in version 0.31 along with the tax collector. Has no current effect.

|-
| ESTABLISH_COLONY_TRADE_AGREEMENTS
| Found on outpost liaison. Position will live in the civilization capital and travels to make trade agreements with its colonies.

|-
| EXECUTIONS
| Found on hammerer. Position executes death penalties with a weapon of the appropriate skill.
|

|-
| HEALTH_MANAGEMENT
| Found on chief medical dwarf. Position will use Diagnostician skill enable the {{key|z}}-menu health screen.
|

|-
| LAW_ENFORCEMENT
| Found on sheriff/captain of the guard. Position and its subordinates are in charge of punishing criminals.

|-
| LAW_MAKING
| Found on monarch/landholders. Effect unknown.{{verify}}

|-
| MAKE_INTRODUCTIONS
| Found on diplomat. Effect unknown.{{verify}}

|-
| MAKE_PEACE_AGREEMENTS
| Found on diplomat. Position negotiates peace treaties in order to end wars.

|-
| MAKE_TOPIC_AGREEMENTS
| Found on diplomat. Position negotiates special agreements such as tree cutting quotas.

|-
| MANAGE_PRODUCTION
| Found on manager. Position enables the use of workshop profiles and uses the Organizer skill to process work orders entered in the job manager after the fortress population reaches 20.

|-
| MEET_WORKERS
| Found on expedition leader/mayor. Position holds meetings with unhappy citizens and tries to pacify them with happy thoughts.

|-
| MILITARY_GOALS
| Found on monarch/landholder/leaders. Effect unknown.{{verify}}

|-
| MILITARY_STRATEGY
| Found on general/militia commander. During worldgen, position will go on expeditions to tame exotic creatures.{{verify}}

|-
| PATROL_TERRITORY
| Found on elven ranger captain and human warrior. Position and its subordinates will scout the area around their settlement in worldgen.{{verify}}

|-
| RECEIVE_DIPLOMATS
| Found on monarch/landholder/leaders. Position will hold meetings with incoming diplomats and liaisons.

|-
| RELIGION
| Found on elven druid. Position informs you about worship cults{{verify}}

|-
| SORT_AMMUNITION
| Found on arsenal dwarf. Position approves changes to ammunition settings in the military screen.
| Removed in version 31.10. Has no current effect.

|-
| TAME_EXOTICS
| Found on dungeon master. Position enables taming exotic creatures and does forge work.
| Defunct since version 0.31, removed with the animal training overhaul in 34.06. Has no current effect.

|-
| TRADE
| Found on broker. Position will use Appraisal skill to display value estimates and trade at the depot when set to broker only. When applied to other civilizations, the position will arrive with the caravan to make trade agreements.

|-
| UPGRADE_SQUAD_EQUIPMENT
| Found on arsenal dwarf. Position approves changes to assigned squad equipment in the military screen.
| Removed in version 31.10. Has no current effect.

|}

== Related Tokens ==
The following two ENTITY tokens are not actually position tokens, but bear mentioning on this page because they can modify the way that a civilization's positions behave:

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Description

|-
| LAND_HOLDER_TRIGGER
|
* landholder tier
* population
* wealth exported
* created wealth
| Defines the requirements for the noble ruler promotions. The tier numbers determine which position is used.

|-
| VARIABLE_POSITIONS
| Position responsibility or ALL
| Allows a responsibility to be taken up by a dynamically generated position (such as Law-maker).

|}

== Why Won't My Positions Appear? ==
The way DF determines what positions will actually ''appear'' in your fortress is somewhat counterintuitive and fairly limiting. This guide should help you understand what you can do to actually get your positions working properly.

There are five tokens governing which positions appear in your fortress - LAND_HOLDER, REQUIRES_POPULATION, APPOINTED_BY, ELECTED, and REPLACED_BY. The first two determine when your fortress is eligible for a new position, the next two determine how a new position for which your fortress is eligible can be added, and the fifth allows you to clear up obsolete positions. Unfortunately, they also interact in some strange ways that makes creating interesting position structures difficult.

When you start a new fortress, DF compiles a list of your initial positions. To do this, it looks at the requirements for each position - any position whose only requirement is less than seven dwarves (either because they have no requirement tokens, or because their only requirement tokens are [REQUIRES_POPULATION: =< 7] or [LAND_HOLDER:some trigger whose only requirement is some number of dwarves equal to or less than 7]). Most importantly, ''any'' position whose only requirement is a LAND_HOLDER requirement, regardless of what the trigger for that requirement is, will be added if another eligible starting position is REPLACED_BY it. '''A non-LAND_HOLDER position that is REPLACED_BY a LAND_HOLDER position will never appear.''' With this list compiled, the game culls all positions that are REPLACED_BY another eligible position, and then culls all positions that have the APPOINTED_BY token. '''You may not embark with any appointed positions.''' Any remaining positions are then filled by a dwarf chosen at random.

'''Positions do not automatically appear when you reach their requirements.''' For example, if you remove the ELECTED token from the Mayor, then the Mayor will never appear, even once you reach his required number of dwarves. '''For a position that does not appear at embark to appear in your fortress, it must be APPOINTED_BY another position or ELECTED.'''

Naturally, this is more complicated than it looks. '''APPOINTED_BY positions must be appointed by another position already in your fortress, or a civ-level position. Only LAND_HOLDER positions may be appointed by civ-level positions.''' LAND_HOLDER positions that are APPOINTED_BY civ-level positions are inherently tied to civ-level tokens with the ESTABLISH_COLONY_TRADE_AGREEMENTS responsibility. If a fortress meets the LAND_HOLDER_TRIGGER for a new LAND_HOLDER tier when a caravan leaves, then the next time the outpost liaison or equivalent arrives, he will offer to make you an official colony, which will allow you to select all positions for that LAND_HOLDER level. '''Each time he appears, the outpost liaison will only promote your fortress one tier up the LAND_HOLDER track.''' The biggest problem with this system is that you may set your LAND_HOLDER_TRIGGERS such that you are eligible for the first tier of LAND_HOLDER positions at embark. '''If you are eligible for the first tier of LAND_HOLDER positions at embark, then all first-tier positions will appear twice - once at embark, and again when the outpost liaison comes to appoint you to the first tier.'''

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

v0.34:Position token

2013-03-23T04:47:35Z

AVK:

{{quality|Exceptional|18:14, 28 April 2011 (UTC)}}{{av}}
These tokens define positions in entity_*.txt files. See [[Entity token]].
==Position Tokens==
These tokens belong in an entity definition. These tokens apply to a position (such as monarch) and should follow the [POSITION:POSITION_NAME] token.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Description

|-
| ACCOUNT_EXEMPT
|
| The position holder is not subjected to the economy. Less than relevant right now.

|-
| ALLOWED_CLASS
| CREATURE_CLASS Token
| Only creatures with the specified class token can be appointed to this position.

|-
| ALLOWED_CREATURE
| CREATURE:CASTE
| Restricts the position to only the defined caste. Only works with a caste of the entity's current race (If the entity had multiple CREATURE: tokens)

|-
| APPOINTED_BY
| position
| This position can only be chosen to the task from the nobles screen, and is available only if there is an *argument* present. For example, the GENERAL is [APPOINTED_BY:MONARCH]. Contrast [ELECTED]. Being appointed by a MONARCH seems to handle a lot of worldgen stuff and interferes with fort mode titles.

|-
| BRAG_ON_KILL
|
| A creature that kills this position will be sure to talk about it a lot.

|-
| CHAT_WORTHY
|
| In adventure mode, when referencing locations an NPC may mention this position holder living there or having done some deed there.

|-
| COLOR
| color
| Creatures of this position will have this color, instead of their profession color. e.g. [COLOR:5:0:1]

|-
| COMMANDER
| position:ALL
| This position will act as a commander of the specified position{{verify}}. E.g. GENERAL is [COMMANDER:LIEUTENANT:ALL]. Unknown if values other than ALL work.

|-
| CONQUERED_SITE
|
| This position is the puppet ruler left behind on a conquered site.

|-
| DEMAND_MAX
| number (0-100)
| How many demands at one time the position can make of the population.

|-
| DETERMINES_COIN_DESIGN
|
| Minted coins will have images that reflect the personality of this position holder.

|-
| DO_NOT_CULL
|
| The position won't be culled from Legends as "unimportant" during world generation.

|-
| DUTY_BOUND
|
| Members of this position will never agree to 'join' your character during adventure mode.

|-
| ELECTED
|
| The population will periodically select the most skill-eligible creature to fill this position. Contrast [APPOINTED_BY].

|-
| EXECUTION_SKILL
| weapon skill
| A mandatory subtag of [RESPONSIBILITY:EXECUTIONS]. Determines the weapon chosen by the executioner for his work.

|-
| EXPORTED_IN_LEGENDS
|
| The various members who have filled this role will be listed in the civilisation's history.

|-
| FLASHES
|
| The creature holding this position will visibly flash, like legendary citizens. Represents a properly noble station by default.

|-
| GENDER
| male/female
| The position can only be held by specified gender.

|-
| KILL_QUEST
|
| The position can assign quests to adventurers.

|-
| LAND_HOLDER
| importance tier (1-3)
| The position is a title bestowed by the King. The outpost liaison may offer to appoint a citizen to this position once the wealth requirements given in the LAND_HOLDER_TRIGGER in the entity definition has been met.

|-
| LAND_NAME
| string
| The name the area takes on when under the control of a LAND_HOLDER. E.g. for the DUKE, [LAND_NAME:a duchy]

|-
| MANDATE_MAX
| number (0-100)
| The maximum number of mandates the position can make at once.

|-
| MENIAL_WORK_EXEMPTION
|
| The position cannot be assigned labours, and will generally just lounge around like nobles do. Currently does not actually work. {{bug|3721}}

|-
| MENIAL_WORK_EXEMPTION_SPOUSE
|
| The spouse of the position holder doesn't have to work, either. Also doesn't work either. {{bug|3721}}

|-
| MILITARY_SCREEN_ONLY
|
| This position can not be appointed from the nobles screen. Intended for militia captains and other squad leaders to reduce clutter.

|-
| NAME
| singular:plural
| The name of the position.

|-
| NAME_MALE
| singular:plural
| If the creature holding the position is male, this is the position's name. E.g. for MONARCH, [NAME_MALE:king:kings]

|-
| NAME_FEMALE
| singular:plural
| If the creature holding the position is female, this is the position's name. E.g. for MONARCH, [NAME_FEMALE:queen:queens]

|-
| NUMBER
|
* number/AS_NEEDED
| How many of the position there should be. If the [SITE] token exists, this is per site, otherwise this is per civilisation.

|-
| PRECEDENCE
| number (0-30000)
| How important the position is in society; a lower number is more important. For MONARCH it's 1, for MILITIA_CAPTAIN it's 200.

|-
| PUNISHMENT_EXEMPTION
|
| The position holder will not be held accountable for his or her crimes. Does not appear to work. {{bug|4589}}

|-
| QUEST_GIVER
|
| The position holder can give quests in Adventurer mode. Functionality in 0.31.13 and later is uncertain.

|-
| REJECTED_CLASS
| CREATURE_CLASS Token
| Creatures of the specified class cannot be appointed to this position.

|-
| REJECTED_CREATURE
| CREATURE:CASTE
| Restricts position holders by CREATURE type.

|-
| REPLACED_BY
| position
| This position is absorbed by another down the line. For example, expedition leader is [REPLACED_BY:MAYOR].

|-
| REQUIRED_BEDROOM
| number (0-1000000)
| The position holder requires a bedroom with at least this value.

|-
| REQUIRED_BOXES
| number (0-100)
| The position holder requires at least this many boxes.

|-
| REQUIRED_CABINETS
| number (0-100)
| The position holder requires at least this many cabinets.

|-
| REQUIRED_DINING
| number (0-1000000)
| The position holder requires a dining room with at least this value.

|-
| REQUIRED_OFFICE
| number (0-1000000)
| The position holder requires an office with at least this value.

|-
| REQUIRED_RACKS
| number (0-100)
| The position holder requires at least this many weapon racks.

|-
| REQUIRED_STANDS
| number (0-100)
| The position holder requires at least this many armour stands.

|-
| REQUIRED_TOMB
| number (0-1000000)
| The position holder requires a tomb with at least this value.

|-
| REQUIRES_POPULATION
| number
| The position requires the population to be at least this number before it becomes available or before the position holder will move in.

|-
| RESPONSIBILITY
| responsibility
| The position holder does a thing. See the table below for suitable arguments.

|-
| RULES_FROM_LOCATION
|
| The position holder is the big poobah. {{verify}}

|-
| SITE
|
| The civilisation will attempt to have this position separate for each site.

|-
| SLEEP_PRETENSION
|
| The position holder will get upset if someone with a higher PRECEDENCE holds quarters with a greater value than their own.

|-
| SPOUSE
| singular:plural
| The name of the position holder's spouse.

|-
| SPOUSE_FEMALE
| singular:plural
| If the spouse of the creature holding the position is female, this is the spouse's position name.

|-
| SPOUSE_MALE
| singular:plural
| If the spouse of the creature holding the position is male, this is the spouse's position name.

|-
| SQUAD
| number:singular:plural
| The position holder is authorized to form a military squad, led by themselves. The number denotes the maximum headcount. The noun used to describe the subordinates (e.g. royal guard) may be a relic from the 40d era.{{verify}}

|-
| SUCCESSION
|
* BY_HEIR / BY_POSITION:position
| How a new position holder is chosen.

|}

== Responsibilities ==
{| {{prettytable}}
|- bgcolor="#dddddd"
! Argument
! Description
! Notes

|-
| ACCOUNTING
| Found on bookkeeper. Position will use Record Keeper skill to keep track of stocks.

|-
| ATTACK_ENEMIES
| Found on elven ranger captain and human warrior. Effect unknown.{{verify}}

|-
| BUILD_MORALE
| Found on champion. Position will lead military training exercises.{{verify}}

|-
| COLLECT_TAXES
| Found on tax collector. Position goes around and collects the tax money from the populace, under armed escort.
| Removed in version 0.31 along with the dwarven [[economy]]. Has no current effect.

|-
| EQUIPMENT_MANIFESTS
| Found on arsenal dwarf. Position will keep track of assigned weapons and equipment.
| Removed in version 31.10. Has no effect.

|-
| ESCORT_TAX_COLLECTOR
| Found on hammerer. Position serves as one of the tax collector's bodyguards during his rounds.
| Removed in version 0.31 along with the tax collector. Has no current effect.

|-
| ESTABLISH_COLONY_TRADE_AGREEMENTS
| Found on outpost liaison. Position will live in the civilization capital and travels to make trade agreements with its colonies.

|-
| EXECUTIONS
| Found on hammerer. Position executes death penalties with a weapon of the appropriate skill.
|

|-
| HEALTH_MANAGEMENT
| Found on chief medical dwarf. Position will use Diagnostician skill enable the {{key|z}}-menu health screen.
|

|-
| LAW_ENFORCEMENT
| Found on sheriff/captain of the guard. Position and its subordinates are in charge of punishing criminals.

|-
| LAW_MAKING
| Found on monarch/landholders. Effect unknown.{{verify}}

|-
| MAKE_INTRODUCTIONS
| Found on diplomat. Effect unknown.{{verify}}

|-
| MAKE_PEACE_AGREEMENTS
| Found on diplomat. Position negotiates peace treaties in order to end wars.

|-
| MAKE_TOPIC_AGREEMENTS
| Found on diplomat. Position negotiates special agreements such as tree cutting quotas.

|-
| MANAGE_PRODUCTION
| Found on manager. Position enables the use of workshop profiles and uses the Organizer skill to process work orders entered in the job manager after the fortress population reaches 20.

|-
| MEET_WORKERS
| Found on expedition leader/mayor. Position holds meetings with unhappy citizens and tries to pacify them with happy thoughts.

|-
| MILITARY_GOALS
| Found on monarch/landholder/leaders. Effect unknown.{{verify}}

|-
| MILITARY_STRATEGY
| Found on general/militia commander. During worldgen, position will go on expeditions to tame exotic creatures.{{verify}}

|-
| PATROL_TERRITORY
| Found on elven ranger captain and human warrior. Position and its subordinates will scout the area around their settlement in worldgen.{{verify}}

|-
| RECEIVE_DIPLOMATS
| Found on monarch/landholder/leaders. Position will hold meetings with incoming diplomats and liaisons.

|-
| RELIGION
| Found on elven druid. Position informs you about worship cults{{verify}}

|-
| SORT_AMMUNITION
| Found on arsenal dwarf. Position approves changes to ammunition settings in the military screen.
| Removed in version 31.10. Has no current effect.

|-
| TAME_EXOTICS
| Found on dungeon master. Position enables taming exotic creatures and does forge work.
| Defunct since version 0.31, removed with the animal training overhaul in 34.06. Has no current effect.

|-
| TRADE
| Found on broker. Position will use Appraisal skill to display value estimates and trade at the depot when set to broker only. When applied to other civilizations, the position will arrive with the caravan to make trade agreements.

|-
| UPGRADE_SQUAD_EQUIPMENT
| Found on arsenal dwarf. Position approves changes to assigned squad equipment in the military screen.
| Removed in version 31.10. Has no current effect.

|}

== Related Tokens ==
The following two ENTITY tokens are not actually position tokens, but bear mentioning on this page because they can modify the way that a civilization's positions behave:

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Description

|-
| LAND_HOLDER_TRIGGER
|
* landholder tier
* population
* wealth exported
* created wealth
| Defines the requirements for the noble ruler promotions. The tier numbers determine which position is used.

|-
| VARIABLE_POSITIONS
| Position responsibility or ALL
| Allows a responsibility to be taken up by a dynamically generated position (such as Law-maker).

|}

== Why Won't My Positions Appear? ==
The way DF determines what positions will actually ''appear'' in your fortress is somewhat counterintuitive and fairly limiting. This guide should help you understand what you can do to actually get your positions working properly.

There are five tokens governing which positions appear in your fortress - LAND_HOLDER, REQUIRES_POPULATION, APPOINTED_BY, ELECTED, and REPLACED_BY. The first two determine when your fortress is eligible for a new position, the next two determine how a new position for which your fortress is eligible can be added, and the fifth allows you to clear up obsolete positions. Unfortunately, they also interact in some strange ways that makes creating interesting position structures difficult.

When you start a new fortress, DF compiles a list of your initial positions. To do this, it looks at the requirements for each position - any position whose only requirement is less than seven dwarves (either because they have no requirement tokens, or because their only requirement tokens are [REQUIRES_POPULATION: =< 7] or [LAND_HOLDER:some trigger whose only requirement is some number of dwarves equal to or less than 7]). Most importantly, ''any'' position whose only requirement is a LAND_HOLDER requirement, regardless of what the trigger for that requirement is, will be added if another eligible starting position is REPLACED_BY it. '''A non-LAND_HOLDER position that is REPLACED_BY a LAND_HOLDER position will never appear.''' With this list compiled, the game culls all positions that are REPLACED_BY another eligible position, and then culls all positions that have the APPOINTED_BY token. '''You may not embark with any appointed positions.''' Any remaining positions are then filled by a dwarf chosen at random.

'''Positions do not automatically appear when you reach their requirements.''' For example, if you remove the ELECTED token from the Mayor, then the Mayor will never appear, even once you reach his required number of dwarves. '''For a position that does not appear at embark to appear in your fortress, it must be APPOINTED_BY another position or ELECTED.'''

Naturally, this is more complicated than it looks. '''APPOINTED_BY positions must be appointed by another position already in your fortress, or a civ-level position. Only LAND_HOLDER positions may be appointed by civ-level positions.''' LAND_HOLDER positions that are APPOINTED_BY civ-level positions are inherently tied to civ-level tokens with the ESTABLISH_COLONY_TRADE_AGREEMENTS responsibility. If a fortress meets the LAND_HOLDER_TRIGGER for a new LAND_HOLDER tier when a caravan leaves, then the next time the outpost liaison or equivalent arrives, he will offer to make you an official colony, which will allow you to select all positions for that LAND_HOLDER level. '''Each time he appears, the outpost liaison will only promote your fortress one tier up the LAND_HOLDER track.''' The biggest problem with this system is that you may set your LAND_HOLDER_TRIGGERS such that you are eligible for the first tier of LAND_HOLDER positions at embark. '''If you are eligible for the first tier of LAND_HOLDER positions at embark, then all first-tier positions will appear twice - once at embark, and again when the outpost liaison comes to appoint you to the first tier.'''

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

v0.34:Position token

2013-03-22T20:07:21Z

AVK:

{{quality|Exceptional|18:14, 28 April 2011 (UTC)}}{{av}}
These tokens define positions in entity_*.txt files. See [[Entity token]].
==Position Tokens==
These tokens belong in an entity definition. These tokens apply to a position (such as monarch) and should follow the [POSITION:POSITION_NAME] token.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Description

|-
| ACCOUNT_EXEMPT
|
| The position holder is not subjected to the Dwarven Economy.

|-
| ALLOWED_CLASS
| CREATURE_CLASS Token
| Only creatures with the specified class token can be appointed to this position.

|-
| ALLOWED_CREATURE
| CREATURE:CASTE
| Restricts the position to only the defined caste. Only works with a caste of the entity's current race (If the entity had multiple CREATURE: tokens)

|-
| APPOINTED_BY
| position
| The position used as an argument selects creatures to fill the role in question. For example, the GENERAL is [APPOINTED_BY:MONARCH].

|-
| BRAG_ON_KILL
|
| A creature that kills this position will be sure to talk about it a lot.

|-
| CHAT_WORTHY
|
| In adventure mode, when referencing locations an NPC may mention this position holder living there or having done some deed there.

|-
| COLOR
| color
| Creatures of this position will have this color, instead of their profession color. e.g. [COLOR:5:0:1]

|-
| COMMANDER
| position:ALL
| This position will act as a commander of the specified position{{verify}}. E.g. GENERAL is [COMMANDER:LIEUTENANT:ALL]. Unknown if values other than ALL work.

|-
| CONQUERED_SITE
|
| This position will be available to creatures when the site has been taken over by another civilisation.

|-
| DEMAND_MAX
| number (0-100)
| How many demands at one time the position can make of the population.

|-
| DETERMINES_COIN_DESIGN
|
| Coins minted will have images that reflect the personality of this position holder.

|-
| DO_NOT_CULL
|
| The position won't be culled during world generation.

|-
| DUTY_BOUND
|
| Members of this position will never agree to 'join' your character during adventure mode.

|-
| ELECTED
|
| The population will periodically select the creature to fill this position.

|-
| EXECUTION_SKILL
| weapon skill
| required for the [RESPONSIBILITY:EXECUTIONS] on which weapon class to use for it

|-
| EXPORTED_IN_LEGENDS
|
| The various members who have filled this role will be listed in the civilisation's history.

|-
| FLASHES
|
| The creature holding this position will flash on the display.

|-
| GENDER
|
*MALE/FEMALE
| The position can only be held by specified gender.

|-
| KILL_QUEST
|
| The position can assign quests to adventurers.

|-
| LAND_HOLDER
| number
| The position will arrive when the LAND_HOLDER_TRIGGER in the entity definition has been met.

|-
| LAND_NAME
| string
| The name the area takes on when under the control of a LAND_HOLDER. E.g. for the DUKE, [LAND_NAME:a duchy]

|-
| MANDATE_MAX
| number (0-100)
| The maximum number of mandates the position can make at once.

|-
| MENIAL_WORK_EXEMPTION
|
| The position cannot be assigned labours, and will generally just lounge around like nobles do. Currently does not actually work. {{bug|3721}}

|-
| MENIAL_WORK_EXEMPTION_SPOUSE
|
| The spouse of the position holder doesn't have to work, either. Also doesn't work either. {{bug|3721}}

|-
| MILITARY_SCREEN_ONLY
|
| The position only shows up in the Military screen.{{verify}}

|-
| NAME
| singular:plural
| The name of the position.

|-
| NAME_MALE
| singular:plural
| If the creature holding the position is male, this is the position's name. E.g. for MONARCH, [NAME_MALE:king:kings]

|-
| NAME_FEMALE
| singular:plural
| If the creature holding the position is female, this is the position's name. E.g. for MONARCH, [NAME_FEMALE:queen:queens]

|-
| NUMBER
|
* number/AS_NEEDED
| How many of the position there should be. If the [SITE] token exists, this is per site, otherwise this is per civilisation.

|-
| PRECEDENCE
| number (0-30000)
| How important the position is in society; a lower number is more important. For MONARCH it's 1, for MILITIA_CAPTAIN it's 200.

|-
| PUNISHMENT_EXEMPTION
|
| The position holder will not be held accountable for his or her crimes. Does not appear to work. {{bug|4589}}

|-
| QUEST_GIVER
|
| The position holder can give quests in Adventurer mode. Functionality in 0.31.13 and later is uncertain.

|-
| REJECTED_CLASS
| CREATURE_CLASS Token
| Creatures of the specified class cannot be appointed to this position.

|-
| REJECTED_CREATURE
| CREATURE:CASTE
| Restricts position holders by CREATURE type.

|-
| REPLACED_BY
| position
| For when one position is a lesser form of another. For example, expedition leader is [REPLACED_BY:MAYOR].

|-
| REQUIRED_BEDROOM
| number (0-1000000)
| The position holder requires a bedroom with at least this value.

|-
| REQUIRED_BOXES
| number (0-100)
| The position holder requires at least this many boxes.

|-
| REQUIRED_CABINETS
| number (0-100)
| The position holder requires at least this many cabinets.

|-
| REQUIRED_DINING
| number (0-1000000)
| The position holder requires a dining room with at least this value.

|-
| REQUIRED_OFFICE
| number (0-1000000)
| The position holder requires an office with at least this value.

|-
| REQUIRED_RACKS
| number (0-100)
| The position holder requires at least this many weapon racks.

|-
| REQUIRED_STANDS
| number (0-100)
| The position holder requires at least this many armour stands.

|-
| REQUIRED_TOMB
| number (0-1000000)
| The position holder requires a tomb with at least this value.

|-
| REQUIRES_POPULATION
| number
| The position requires the population to be at least this number before it becomes available or before the position holder will move in.

|-
| RESPONSIBILITY
| responsibility
| See the table below for the available responsibility tokens. E.g. [RESPONSIBILITY:TAME_EXOTICS]

|-
| RULES_FROM_LOCATION
|
| Has a specific site for the noble to live in to rule from--say, a keep. {{verify}}

|-
| SITE
|
| The civilisation will attempt to have this position separate for each site.

|-
| SLEEP_PRETENSION
|
| The position holder will get upset if someone with a higher precedence holds quarters with a greater value than their own.

|-
| SPOUSE
| singular:plural
| The name of the position holder's spouse.

|-
| SPOUSE_FEMALE
| singular:plural
| If the spouse of the creature holding the position is female, this is the spouse's position name.

|-
| SPOUSE_MALE
| singular:plural
| If the spouse of the creature holding the position is male, this is the spouse's position name.

|-
| SQUAD
| number:singular:plural
| The position holder will be accompanied by this many whatevers; e.g. for HAMMERER, [SQUAD:10:royal guard:royal guards]

|-
| SUCCESSION
|
* BY_HEIR / BY_POSITION:position
| How a new position holder is chosen.

|}

== Responsibilities ==
{| {{prettytable}}
|- bgcolor="#dddddd"
! Argument
! Description
! Notes

|-
| ACCOUNTING
| Found on bookkeeper. Position will use Record Keeper skill to keep track of stocks.

|-
| ATTACK_ENEMIES
| Found on elven ranger captain and human warrior. Effect unknown.{{verify}}

|-
| BUILD_MORALE
| Found on champion. Position will lead military training exercises.{{verify}}

|-
| COLLECT_TAXES
| Found on tax collector. Position goes around and collects the tax money from the populace, under armed escort.
| Removed in version 0.31 along with the dwarven [[economy]]. Has no current effect.

|-
| EQUIPMENT_MANIFESTS
| Found on arsenal dwarf. Position will keep track of assigned weapons and equipment.
| Removed in version 31.10. Has no effect.

|-
| ESCORT_TAX_COLLECTOR
| Found on hammerer. Position serves as one of the tax collector's bodyguards during his rounds.
| Removed in version 0.31 along with the tax collector. Has no current effect.

|-
| ESTABLISH_COLONY_TRADE_AGREEMENTS
| Found on outpost liaison. Position will live in the civilization capital and travels to make trade agreements with its colonies.

|-
| EXECUTIONS
| Found on hammerer. Position executes death penalties with a weapon of the appropriate skill.
|

|-
| HEALTH_MANAGEMENT
| Found on chief medical dwarf. Position will use Diagnostician skill enable the {{key|z}}-menu health screen.
|

|-
| LAW_ENFORCEMENT
| Found on sheriff/captain of the guard. Position and its subordinates are in charge of punishing criminals.

|-
| LAW_MAKING
| Found on monarch/landholders. Effect unknown.{{verify}}

|-
| MAKE_INTRODUCTIONS
| Found on diplomat. Effect unknown.{{verify}}

|-
| MAKE_PEACE_AGREEMENTS
| Found on diplomat. Position negotiates peace treaties in order to end wars.

|-
| MAKE_TOPIC_AGREEMENTS
| Found on diplomat. Position negotiates special agreements such as tree cutting quotas.

|-
| MANAGE_PRODUCTION
| Found on manager. Position enables the use of workshop profiles and uses the Organizer skill to process work orders entered in the job manager after the fortress population reaches 20.

|-
| MEET_WORKERS
| Found on expedition leader/mayor. Position holds meetings with unhappy citizens and tries to pacify them with happy thoughts.

|-
| MILITARY_GOALS
| Found on monarch/landholder/leaders. Effect unknown.{{verify}}

|-
| MILITARY_STRATEGY
| Found on general/militia commander. During worldgen, position will go on expeditions to tame exotic creatures.{{verify}}

|-
| PATROL_TERRITORY
| Found on elven ranger captain and human warrior. Position and its subordinates will scout the area around their settlement in worldgen.{{verify}}

|-
| RECEIVE_DIPLOMATS
| Found on monarch/landholder/leaders. Position will hold meetings with incoming diplomats and liaisons.

|-
| RELIGION
| Found on elven druid. Position informs you about worship cults{{verify}}

|-
| SORT_AMMUNITION
| Found on arsenal dwarf. Position approves changes to ammunition settings in the military screen.
| Removed in version 31.10. Has no current effect.

|-
| TAME_EXOTICS
| Found on dungeon master. Position enables taming exotic creatures and does forge work.
| Defunct since version 0.31, removed with the animal training overhaul in 34.06. Has no current effect.

|-
| TRADE
| Found on broker. Position will use Appraisal skill to display value estimates and trade at the depot when set to broker only. When applied to other civilizations, the position will arrive with the caravan to make trade agreements.

|-
| UPGRADE_SQUAD_EQUIPMENT
| Found on arsenal dwarf. Position approves changes to assigned squad equipment in the military screen.
| Removed in version 31.10. Has no current effect.

|}

== Related Tokens ==
The following two ENTITY tokens are not actually position tokens, but bear mentioning on this page because they can modify the way that a civilization's positions behave:

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Description

|-
| LAND_HOLDER_TRIGGER
|
* land holder number
* population
* wealth exported
* created wealth
| Defines when a particular land-holding noble (baron, count, duke in vanilla) will arrive at a fortress.

|-
| VARIABLE_POSITIONS
| Position responsibility or ALL
| Allows a responsibility to be taken up by a dynamically generated position (such as Law-maker).

|}

== Why Won't My Positions Appear? ==
The way DF determines what positions will actually ''appear'' in your fortress is somewhat counterintuitive and fairly limiting. This guide should help you understand what you can do to actually get your positions working properly.

There are five tokens governing which positions appear in your fortress - LAND_HOLDER, REQUIRES_POPULATION, APPOINTED_BY, ELECTED, and REPLACED_BY. The first two determine when your fortress is eligible for a new position, the next two determine how a new position for which your fortress is eligible can be added, and the fifth allows you to clear up obsolete positions. Unfortunately, they also interact in some strange ways that makes creating interesting position structures difficult.

When you start a new fortress, DF compiles a list of your initial positions. To do this, it looks at the requirements for each position - any position whose only requirement is less than seven dwarves (either because they have no requirement tokens, or because their only requirement tokens are [REQUIRES_POPULATION: =< 7] or [LAND_HOLDER:some trigger whose only requirement is some number of dwarves equal to or less than 7]). Most importantly, ''any'' position whose only requirement is a LAND_HOLDER requirement, regardless of what the trigger for that requirement is, will be added if another eligible starting position is REPLACED_BY it. '''A non-LAND_HOLDER position that is REPLACED_BY a LAND_HOLDER position will never appear.''' With this list compiled, the game culls all positions that are REPLACED_BY another eligible position, and then culls all positions that have the APPOINTED_BY token. '''You may not embark with any appointed positions.''' Any remaining positions are then filled by a dwarf chosen at random.

'''Positions do not automatically appear when you reach their requirements.''' For example, if you remove the ELECTED token from the Mayor, then the Mayor will never appear, even once you reach his required number of dwarves. '''For a position that does not appear at embark to appear in your fortress, it must be APPOINTED_BY another position or ELECTED.'''

Naturally, this is more complicated than it looks. '''APPOINTED_BY positions must be appointed by another position already in your fortress, or a civ-level position. Only LAND_HOLDER positions may be appointed by civ-level positions.''' LAND_HOLDER positions that are APPOINTED_BY civ-level positions are inherently tied to civ-level tokens with the ESTABLISH_COLONY_TRADE_AGREEMENTS responsibility. If a fortress meets the LAND_HOLDER_TRIGGER for a new LAND_HOLDER tier when a caravan leaves, then the next time the outpost liaison or equivalent arrives, he will offer to make you an official colony, which will allow you to select all positions for that LAND_HOLDER level. '''Each time he appears, the outpost liaison will only promote your fortress one tier up the LAND_HOLDER track.''' The biggest problem with this system is that you may set your LAND_HOLDER_TRIGGERS such that you are eligible for the first tier of LAND_HOLDER positions at embark. '''If you are eligible for the first tier of LAND_HOLDER positions at embark, then all first-tier positions will appear twice - once at embark, and again when the outpost liaison comes to appoint you to the first tier.'''

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

v0.34:Position token

2013-03-20T21:00:02Z

AVK:

{{quality|Exceptional|18:14, 28 April 2011 (UTC)}}{{av}}
These tokens define positions in entity_*.txt files. See [[Entity token]].
==Position Tokens==
These tokens belong in an entity definition. These tokens apply to a position (such as monarch) and should follow the [POSITION:POSITION_NAME] token.

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Description

|-
| ACCOUNT_EXEMPT
|
| The position holder is not subjected to the Dwarven Economy.

|-
| ALLOWED_CLASS
| CREATURE_CLASS Token
| Only creatures with the specified class token can be appointed to this position.

|-
| ALLOWED_CREATURE
| CREATURE:CASTE
| Restricts the position to only the defined caste. Only works with a caste of the entity's current race (If the entity had multiple CREATURE: tokens)

|-
| APPOINTED_BY
| position
| The position used as an argument selects creatures to fill the role in question. For example, the GENERAL is [APPOINTED_BY:MONARCH].

|-
| BRAG_ON_KILL
|
| A creature that kills this position will be sure to talk about it a lot.

|-
| CHAT_WORTHY
|
| In adventure mode, when referencing locations an NPC may mention this position holder living there or having done some deed there.

|-
| COLOR
| color
| Creatures of this position will have this color, instead of their profession color. e.g. [COLOR:5:0:1]

|-
| COMMANDER
| position:ALL
| This position will act as a commander of the specified position{{verify}}. E.g. GENERAL is [COMMANDER:LIEUTENANT:ALL]. Unknown if values other than ALL work.

|-
| CONQUERED_SITE
|
| This position will be available to creatures when the site has been taken over by another civilisation.

|-
| DEMAND_MAX
| number (0-100)
| How many demands at one time the position can make of the population.

|-
| DETERMINES_COIN_DESIGN
|
| Coins minted will have images that reflect the personality of this position holder.

|-
| DO_NOT_CULL
|
| The position won't be culled during world generation.

|-
| DUTY_BOUND
|
| Members of this position will never agree to 'join' your character during adventure mode.

|-
| ELECTED
|
| The population will periodically select the creature to fill this position.

|-
| EXECUTION_SKILL
| weapon skill
| required for the [RESPONSIBILITY:EXECUTIONS] on which weapon class to use for it

|-
| EXPORTED_IN_LEGENDS
|
| The various members who have filled this role will be listed in the civilisation's history.

|-
| FLASHES
|
| The creature holding this position will flash on the display.

|-
| GENDER
|
*MALE/FEMALE
| The position can only be held by specified gender.

|-
| KILL_QUEST
|
| The position can assign quests to adventurers.

|-
| LAND_HOLDER
| number
| The position will arrive when the LAND_HOLDER_TRIGGER in the entity definition has been met.

|-
| LAND_NAME
| string
| The name the area takes on when under the control of a LAND_HOLDER. E.g. for the DUKE, [LAND_NAME:a duchy]

|-
| MANDATE_MAX
| number (0-100)
| The maximum number of mandates the position can make at once.

|-
| MENIAL_WORK_EXEMPTION
|
| The position cannot be assigned labours, and will generally just lounge around like nobles do. Currently does not actually work. {{bug|3721}}

|-
| MENIAL_WORK_EXEMPTION_SPOUSE
|
| The spouse of the position holder doesn't have to work, either. Also doesn't work either. {{bug|3721}}

|-
| MILITARY_SCREEN_ONLY
|
| The position only shows up in the Military screen.{{verify}}

|-
| NAME
| singular:plural
| The name of the position.

|-
| NAME_MALE
| singular:plural
| If the creature holding the position is male, this is the position's name. E.g. for MONARCH, [NAME_MALE:king:kings]

|-
| NAME_FEMALE
| singular:plural
| If the creature holding the position is female, this is the position's name. E.g. for MONARCH, [NAME_FEMALE:queen:queens]

|-
| NUMBER
|
* number/AS_NEEDED
| How many of the position there should be. If the [SITE] token exists, this is per site, otherwise this is per civilisation.

|-
| PRECEDENCE
| number (0-30000)
| How important the position is in society; a lower number is more important. For MONARCH it's 1, for MILITIA_CAPTAIN it's 200.

|-
| PUNISHMENT_EXEMPTION
|
| The position holder will not be held accountable for his or her crimes. Does not appear to work. {{bug|4589}}

|-
| QUEST_GIVER
|
| The position holder can give quests in Adventurer mode. Functionality in 0.31.13 and later is uncertain.

|-
| REJECTED_CLASS
| CREATURE_CLASS Token
| Creatures of the specified class cannot be appointed to this position.

|-
| REJECTED_CREATURE
| CREATURE:CASTE
| Restricts position holders by CREATURE type.

|-
| REPLACED_BY
| position
| For when one position is a lesser form of another. For example, expedition leader is [REPLACED_BY:MAYOR].

|-
| REQUIRED_BEDROOM
| number (0-1000000)
| The position holder requires a bedroom with at least this value.

|-
| REQUIRED_BOXES
| number (0-100)
| The position holder requires at least this many boxes.

|-
| REQUIRED_CABINETS
| number (0-100)
| The position holder requires at least this many cabinets.

|-
| REQUIRED_DINING
| number (0-1000000)
| The position holder requires a dining room with at least this value.

|-
| REQUIRED_OFFICE
| number (0-1000000)
| The position holder requires an office with at least this value.

|-
| REQUIRED_RACKS
| number (0-100)
| The position holder requires at least this many weapon racks.

|-
| REQUIRED_STANDS
| number (0-100)
| The position holder requires at least this many armour stands.

|-
| REQUIRED_TOMB
| number (0-1000000)
| The position holder requires a tomb with at least this value.

|-
| REQUIRES_POPULATION
| number
| The position requires the population to be at least this number before it becomes available or before the position holder will move in.

|-
| RESPONSIBILITY
| responsibility
| See the table below for the available responsibility tokens. E.g. [RESPONSIBILITY:TAME_EXOTICS]

|-
| RULES_FROM_LOCATION
|
| Has a specific site for the noble to live in to rule from--say, a keep. {{verify}}

|-
| SITE
|
| The civilisation will attempt to have this position separate for each site.

|-
| SLEEP_PRETENSION
|
| The position holder will get upset if someone with a higher precedence holds quarters with a greater value than their own.

|-
| SPOUSE
| singular:plural
| The name of the position holder's spouse.

|-
| SPOUSE_FEMALE
| singular:plural
| If the spouse of the creature holding the position is female, this is the spouse's position name.

|-
| SPOUSE_MALE
| singular:plural
| If the spouse of the creature holding the position is male, this is the spouse's position name.

|-
| SQUAD
| number:singular:plural
| The position holder will be accompanied by this many whatevers; e.g. for HAMMERER, [SQUAD:10:royal guard:royal guards]

|-
| SUCCESSION
|
* BY_HEIR / BY_POSITION:position
| How a new position holder is chosen.

|}

== Responsibilities ==
{| {{prettytable}}
|- bgcolor="#dddddd"
! Argument
! Description
! Notes

|-
| ACCOUNTING
| Found on bookkeeper. Position will keep track of stocks.

|-
| ATTACK_ENEMIES
| Found on elven ranger captain and human warrior. Effect unknown.{{verify}}

|-
| BUILD_MORALE
| Found on champion. Position will lead military training exercises.{{verify}}

|-
| COLLECT_TAXES
| Found on tax collector. Position goes around and collects the tax money from the populace, under armed escort.
| Removed in version 0.31 along with the dwarven [[economy]]. Has no current effect.

|-
| EQUIPMENT_MANIFESTS
| Found on arsenal dwarf. Position will keep track of assigned weapons and equipment.
| Removed in version 31.10. Has no effect.

|-
| ESCORT_TAX_COLLECTOR
| Found on hammerer. Position serves as one of the tax collector's bodyguards during his rounds.
| Removed in version 0.31 along with the tax collector. Has no current effect.

|-
| ESTABLISH_COLONY_TRADE_AGREEMENTS
| Found on outpost liaison. Position will make trade agreements with the civilisation's colonies.

|-
| EXECUTIONS
| Found on hammerer. Position executes death penalties with a weapon of the appropriate skill.

|-
| HEALTH_MANAGEMENT
| Found on chief medical dwarf. Position will enable the {{key|z}}-menu health screen.

|-
| LAW_ENFORCEMENT
| Found on sheriff/captain of the guard. Position is in charge of imprisoning criminals.

|-
| LAW_MAKING
| Found on monarch/landholders. Effect unknown.{{verify}}

|-
| MAKE_INTRODUCTIONS
| Found on diplomat. Effect unknown.{{verify}}

|-
| MAKE_PEACE_AGREEMENTS
| Found on diplomat. Position negotiates peace treaties in order to end wars.

|-
| MAKE_TOPIC_AGREEMENTS
| Found on diplomat. Position negotiates special agreements such as tree cutting quotas.

|-
| MANAGE_PRODUCTION
| Found on manager. Position enables the use of workshop profiles and processes work orders entered in the job manager after the fortress population reaches 20.

|-
| MEET_WORKERS
| Found on expedition leader/mayor. Position holds meetings with unhappy citizens and tries to pacify them with happy thoughts.

|-
| MILITARY_GOALS
| Found on monarch/landholder/leaders. Effect unknown.{{verify}}

|-
| MILITARY_STRATEGY
| Found on general/militia commander. During worldgen, position will go on expeditions to tame exotic creatures.

|-
| PATROL_TERRITORY
| Found on elven ranger captain and human warrior. Effect unknown.{{verify}}

|-
| RECEIVE_DIPLOMATS
| Found on monarch/landholder/leaders. Position will hold meetings with incoming diplomats and liaisons.

|-
| RELIGION
| Found on elven druid. Possibly it's the one who can tell you information about worship cults{{verify}}

|-
| SORT_AMMUNITION
| Found on arsenal dwarf. Position approves changes to ammunition settings in the military screen.
| Removed in version 31.10. Has no current effect.

|-
| TAME_EXOTICS
| Found on dungeon master. Position enables taming exotic creatures and does forge work.
| Defunct since version 0.31, removed with the animal training overhaul in 34.06. Has no current effect.

|-
| TRADE
| Found on broker. Position will use Appraisal skill to display value estimates and trade at the depot when set to broker only. When applied to other civilizations, the position will arrive with the caravan to make trade agreements.

|-
| UPGRADE_SQUAD_EQUIPMENT
| Found on arsenal dwarf. Position approves changes to assigned squad equipment in the military screen.
| Removed in version 31.10. Has no current effect.

|}

== Related Tokens ==
The following two ENTITY tokens are not actually position tokens, but bear mentioning on this page because they can modify the way that a civilization's positions behave:

{| {{prettytable}}
|- bgcolor="#dddddd"
! Token
! Arguments
! Description

|-
| LAND_HOLDER_TRIGGER
|
* land holder number
* population
* wealth exported
* created wealth
| Defines when a particular land-holding noble (baron, count, duke in vanilla) will arrive at a fortress.

|-
| VARIABLE_POSITIONS
| Position responsibility or ALL
| Allows a responsibility to be taken up by a dynamically generated position (such as Law-maker).

|}

== Why Won't My Positions Appear? ==
The way DF determines what positions will actually ''appear'' in your fortress is somewhat counterintuitive and fairly limiting. This guide should help you understand what you can do to actually get your positions working properly.

There are five tokens governing which positions appear in your fortress - LAND_HOLDER, REQUIRES_POPULATION, APPOINTED_BY, ELECTED, and REPLACED_BY. The first two determine when your fortress is eligible for a new position, the next two determine how a new position for which your fortress is eligible can be added, and the fifth allows you to clear up obsolete positions. Unfortunately, they also interact in some strange ways that makes creating interesting position structures difficult.

When you start a new fortress, DF compiles a list of your initial positions. To do this, it looks at the requirements for each position - any position whose only requirement is less than seven dwarves (either because they have no requirement tokens, or because their only requirement tokens are [REQUIRES_POPULATION: =< 7] or [LAND_HOLDER:some trigger whose only requirement is some number of dwarves equal to or less than 7]). Most importantly, ''any'' position whose only requirement is a LAND_HOLDER requirement, regardless of what the trigger for that requirement is, will be added if another eligible starting position is REPLACED_BY it. '''A non-LAND_HOLDER position that is REPLACED_BY a LAND_HOLDER position will never appear.''' With this list compiled, the game culls all positions that are REPLACED_BY another eligible position, and then culls all positions that have the APPOINTED_BY token. '''You may not embark with any appointed positions.''' Any remaining positions are then filled by a dwarf chosen at random.

'''Positions do not automatically appear when you reach their requirements.''' For example, if you remove the ELECTED token from the Mayor, then the Mayor will never appear, even once you reach his required number of dwarves. '''For a position that does not appear at embark to appear in your fortress, it must be APPOINTED_BY another position or ELECTED.'''

Naturally, this is more complicated than it looks. '''APPOINTED_BY positions must be appointed by another position already in your fortress, or a civ-level position. Only LAND_HOLDER positions may be appointed by civ-level positions.''' LAND_HOLDER positions that are APPOINTED_BY civ-level positions are inherently tied to civ-level tokens with the ESTABLISH_COLONY_TRADE_AGREEMENTS responsibility. If a fortress meets the LAND_HOLDER_TRIGGER for a new LAND_HOLDER tier when a caravan leaves, then the next time the outpost liaison or equivalent arrives, he will offer to make you an official colony, which will allow you to select all positions for that LAND_HOLDER level. '''Each time he appears, the outpost liaison will only promote your fortress one tier up the LAND_HOLDER track.''' The biggest problem with this system is that you may set your LAND_HOLDER_TRIGGERS such that you are eligible for the first tier of LAND_HOLDER positions at embark. '''If you are eligible for the first tier of LAND_HOLDER positions at embark, then all first-tier positions will appear twice - once at embark, and again when the outpost liaison comes to appoint you to the first tier.'''

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

v0.34:Body token

2012-12-12T20:43:56Z

AVK:

{{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
|
| Defines part as 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. NOTE: This tag cannot be applied to body parts with the [INTERNAL] token.

|-
| 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. If the limb it's in is grabbed in a wrestling hold, it can be broken with bending force. This disables the parent limb.

|-
| 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
|
| Defines part as mouth.

|-
| NUMBER
|
*value
| 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). In practice, though, they cannot be individually damaged - if you knock out one tooth, the entire group will be knocked out at once (and will be scattered across the area).

|-
| 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. Used with [[shell]]s.

|}

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

v0.34:Creature token

2012-12-12T02:23:38Z

AVK:

{{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:''' 
[ATTACK:GORE:BODYPART:BY_CATEGORY:HORN] 
''GORE'' : name of the attack 
''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:''' 
[BODY:BODY_WITH_HEAD_FLAG:HEART:GUTS:BRAIN:MOUTH] 
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:''' 
[BODY_APPEARANCE_MODIFIER:HEIGHT:90:95:98:100:102:105:110] 
''HEIGHT'' : marks the height to be changed 
''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:''' 
[BODY_DETAIL_PLAN:VERTEBRATE_TISSUE_LAYERS:SKIN:FAT:MUSCLE:BONE:CARTILAGE] 
This creates the detailed body of a [[fox]], the skin, fat, muscle, bones and cartilage out of the vertebrate tissues. 
A [[Purring maggot|maggot]] would only need: 
''[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:''' 
[BODY_SIZE:0:0:10000] 
[BODY_SIZE:1:168:50000] 
[BODY_SIZE:12:0:220000] 
This describes the size of a [[minotaur]]. His birth size would be 10,000 cm3 (~10 kg). At 1 year and 168 days old he would be 50,000 cm3 (~50 kg). And as an adult (at 12 years old) he would be 220,000 cm3 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
| integer
| Multiplies body size by a factor of (integer)%. 50 halves size, 200 doubles.

|-
| 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
| 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
|
| The creature is immune to FIREBALL and FIREJET attacks.

|-
| FIREIMMUNE_SUPER
| Caste
|
| The creature is immune to DRAGONFIRE attacks. 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.".[[http://www.bay12forums.com/smf/index.php?topic=60554.msg1719248#msg1719248 source post]] 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
| The contact area of the attack, measured in % of the body part's volume.

|-
| ATTACK_PENETRATION_PERC
| Caste
|
*% value
| The penetration value of the attack, measured in % of the body part's volume. Requires ATTACK_FLAG_EDGE.

|-
| ATTACK_PRIORITY
| Caste
|
*MAIN or SECOND
| Usage frequency. MAIN attacks are 100 times more frequently chosen than SECOND. Opportunity attacks ignore this preference.

|-
| ATTACK_VELOCITY_MODIFIER
| Caste
| number
| The velocity multiplier of the attack, multiplied by 1000.

|-
| ATTACK_FLAG_CANLATCH
| Caste
|
| Attacks that damage tissue have the chance to latch on in a wrestling hold. The grabbing bodypart can then use the "shake around" wrestling move, causing severe, armor-bypassing tensile damage according to the attacker's body volume.

|-
| 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 is edged, with all the effects on physical resistance and contact area that it entails.

|-
| 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: 
[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:Creature token

2012-12-12T02:18:25Z

AVK:

{{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:''' 
[ATTACK:GORE:BODYPART:BY_CATEGORY:HORN] 
''GORE'' : name of the attack 
''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:''' 
[BODY:BODY_WITH_HEAD_FLAG:HEART:GUTS:BRAIN:MOUTH] 
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:''' 
[BODY_APPEARANCE_MODIFIER:HEIGHT:90:95:98:100:102:105:110] 
''HEIGHT'' : marks the height to be changed 
''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:''' 
[BODY_DETAIL_PLAN:VERTEBRATE_TISSUE_LAYERS:SKIN:FAT:MUSCLE:BONE:CARTILAGE] 
This creates the detailed body of a [[fox]], the skin, fat, muscle, bones and cartilage out of the vertebrate tissues. 
A [[Purring maggot|maggot]] would only need: 
''[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:''' 
[BODY_SIZE:0:0:10000] 
[BODY_SIZE:1:168:50000] 
[BODY_SIZE:12:0:220000] 
This describes the size of a [[minotaur]]. His birth size would be 10,000 cm3 (~10 kg). At 1 year and 168 days old he would be 50,000 cm3 (~50 kg). And as an adult (at 12 years old) he would be 220,000 cm3 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
| integer
| Multiplies body size by a factor of (integer)%. 50 halves size, 200 doubles.

|-
| 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
| 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
|
| The creature is immune to FIREBALL and FIREJET attacks.

|-
| FIREIMMUNE_SUPER
| Caste
|
| The creature is immune to DRAGONFIRE attacks. 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.".[[http://www.bay12forums.com/smf/index.php?topic=60554.msg1719248#msg1719248 source post]] 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
| The contact area of the attack, measured in % of the body part's volume.

|-
| ATTACK_PENETRATION_PERC
| Caste
|
*% value
| The penetration value of the attack, measured in % of the body part's volume. Requires ATTACK_FLAG_EDGE.

|-
| ATTACK_PRIORITY
| Caste
|
*MAIN or SECOND
| Usage frequency. MAIN attacks are 100 times more frequently chosen than SECOND. Opportunity attacks ignore this preference.

|-
| ATTACK_VELOCITY_MODIFIER
| Caste
| number
| The velocity multiplier of the attack, multiplied by 1000.

|-
| ATTACK_FLAG_CANLATCH
| Caste
|
| Attacks that damage tissue have the chance to latch on in a wrestling hold. The grabbing bodypart can then use the "shake around" wrestling move, causing severe tensile damage according to the attacker's body volume.

|-
| 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 is edged, with all the effects on physical resistance and contact area that it entails.

|-
| 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: 
[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:Tissue definition token

2012-12-12T01:58:48Z

AVK:

{{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
|
* [[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. Edged attacks have the chance to break an artery, increasing blood loss.

|-
| SCARS
| N/A
| Simply whether or not the tissue will be scarred once healed.

|-
| STRUCTURAL
| N/A
| Holds the body part together. A cut or a fracture disables the body part it's in.

|-
| CONNECTIVE_TISSUE_ANCHOR
| N/A
| Any ligaments or tendons are part of this tissue. Vulnerable to edged attacks, damage disables the limb.

|-
| SETTABLE
| N/A
| The tissue will not heal/heals slower until it is set by a bone doctor.

|-
| SPLINTABLE
| N/A
| The broken tissue can be fixed with a cast or a splint to restore function while it heals.

|-
| FUNCTIONAL
| N/A
| The tissue performs some sort of special function (e.g. sight, hearing, breathing, etc.) An organ with such a function will stop working if a sufficient amount of damage is sustained by its FUNCTIONAL tissues. If an organ has no FUNCTIONAL tissues, it will stop working only if it is severed or destroyed entirely by heat or cold.

|-
| NERVOUS
| N/A
| Unknown - not used.

|-
| THOUGHT
| N/A
| If a creature has no functioning parts with the THOUGHT token, it will be unable to move or breathe. NO_THOUGHT_CENTER_FOR_MOVEMENT bypasses this limitation.

|-
| MUSCULAR
| N/A
| Seems to affect where sensory or motor nerves are located, and whether damage to this tissue will render a limb useless.

|-
| 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
| Holds body parts together. A body part will not be severed unless all of its component tissues with the CONNECTS tag are severed.

|-
| MAJOR_ARTERIES
| N/A
| Causes tissue to sometimes severely bleed when damaged. This is independent of its VASCULAR value.

|-
| 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 [[Entity_token|entity]] entry)

|-
| TISSUE_SHAPE
|
*value
| Value can be one of the following:
;LAYER
:Regular layer tissue.
;STRANDS
:Seems to be harder to sever.
;FEATHERS
:Edge attacks will pass right through the tissue.
;SCALES
:?
;CUSTOM
:?

|-
| SUBORDINATE_TO_TISSUE
|
*value
| Tissue is implicitly attached to another tissue and will fall off that tissue layer is destroyed. Used for hair and feathers, which are subordinate to skin.

|-
| 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==
These are used in creature raws to override the above for whatever reason.
{| {{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
| Sets a new relative thickness for selected tissue layers.

|-
|TL_CONNECTS
|
| Gives the CONNECTS attribute to selected layers.

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

|-
|TL_HEALING_RATE
|
* value
| Sets a new HEALING_RATE of the selected tissue layers.

|-
|TL_VASCULAR
|
| Sets a new a VASCULAR value (which modulates bleeding) for selected tissue layers.

|-
|TL_PAIN_RECEPTORS
|
| Sets a 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.34:Health screen

2012-12-12T01:58:46Z

AVK:

{{quality|Exceptional|23:31, 17 April 2011 (UTC)}}

In the status menu (accessed using the {{k|z}}-status key), one of the sub-menus is '''Health'''. This sub-menu becomes available when a dwarf is appointed to the [[Chief medical dwarf]] position. It does not display information unless the CMD is at least a novice [[diagnostician]]. 
The z-health menu is used to monitor the health of friendly dwarves. A subject dwarf's status effects and injuries are cataloged in the health menu by [[Healthcare|hospital staff]] upon diagnosis. Some basic needs are automatically shown in the menu whenever a dwarf becomes hungry, thirsty, or tired. Doctors will begin treating injured or otherwise unhealthy dwarves only after diagnosis and when proper equipment is available. 
Note: The screen is entirely mouse enabled. 

Listed below are all of the conditions displayed in the z-health screen:
===First Key Column===
This is the column that lists requests and requirements of the subject.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=D|color=2:0:1|desc='''Diagnosis request''' - [[Diagnostician]] needed to diagnose the subject}}
{{HealthStatus table row|symbol=≈|color=3:0:1|desc='''Cleaning request''' - Dwarf with a water bucket and cleaning labor enabled needed to bathe off contaminants, preferably using [[soap]] }}
{{HealthStatus table row|symbol=S|color=4:0:1|desc='''Surgery required''' - [[Surgeon]] needed to excise necrotic tissue or repair organ damage}}
{{HealthStatus table row|symbol=R|color=5:0:1|desc='''Inoperable Rot''' - [[Surgeon]] needed to amputate a necrotic limb}}
{{HealthStatus table row|symbol=Ø|color=7:0:1|desc='''Suture request''' - [[Suturer]] needed to repair cuts, wounds and nerve damage (!!) using thread}}
{{HealthStatus table row|symbol=B|color=6:0:1|desc='''Setting request''' - [[Bone doctor]] needed to set the subject's fractured bones}}
{{HealthStatus table row|symbol=<s>°</s>|color=7:0:1|desc='''Dressing request''' - [[Wound dresser]] needed to top off the medical procedure using cloth bandages}}
{{HealthStatus table row|symbol=T|color=6:0:1|desc='''Traction request''' - [[Traction bench]] needed to immobilize subject with overlapping fractures}}
{{HealthStatus table row|symbol=I|color=6:0:1|desc='''Immobilization request''' - [[Gypsum plaster|Cast]] (wound dresser) or [[splint]] (bone doctor) needed to stabilize a repaired fracture}}
{{HealthStatus table row|symbol=C|color=6:0:1|desc='''Crutch required''' - [[Crutch]] needed for the subject to walk}}
|}

===Second Key Column===
This column shows different degrees of bleeding, blood loss, numbness, and paralysis.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=B!+|color=4:0:1|desc='''Heavy bleeding''' - Subject is quickly losing blood through many wounds or torn arteries. This is an emergency.}}
{{HealthStatus table row|symbol=B!~|color=4:0:0|desc='''Bleeding''' - Subject is losing blood through a wound. Typically harmless due to dwarves' fast natural healing rate.}}
{{HealthStatus table row|symbol=Bl+|color=5:0:1|desc='''Severe Blood Loss''' - Subject is Pale. Caused by massive blood loss, typically from a severed limb. This is an emergency.}}
{{HealthStatus table row|symbol=Bl~|color=5:0:1|desc='''Blood Loss''' - Subject is Faint. Caused by moderate blood loss from wounds or necrosis.}}
{{HealthStatus table row|symbol=Pz+|color=3:0:1|desc='''Paralyzed''' - Subject is completely paralyzed. Common effect of upper spinal injury. Death by suffocation is imminent}}
{{HealthStatus table row|symbol=Pz~|color=3:0:1|desc='''Partially paralyzed''' - One or more limbs unusable due to severed nerves}}
{{HealthStatus table row|symbol=Slg|color=3:0:1|desc='''Sluggish''' - Characteristic of weak or lessening paralysis}}
{{HealthStatus table row|symbol=Nm+|color=3:0:1|desc='''Completely numb''' - Symptom of syndromes or sensory nerve damage. Eliminates pain sensation in affected areas and severely hampers motor ability. Protracted syndrome effects may cause permanent damage.}}
{{HealthStatus table row|symbol=Nm~|color=3:0:1|desc='''Partially numb''' - Symptom of syndromes or sensory nerve damage. Further reduces pain in affected areas and hampers fine motor ability.}}
{{HealthStatus table row|symbol=Nm-|color=3:0:1|desc='''Slightly numb''' - Symptom of syndromes or sensory nerve damage. Reduces pain in affected areas.}}
|}

===Third Key Column===
This column shows different degrees of pain, exhaustion and fever and also shows dizziness and whether the subject is stunned.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=F!|color=4:0:1|desc='''Serious fever''' - Reduces focus stat, may stun. Typical warning sign of more dangerous syndromes.}}
{{HealthStatus table row|symbol=F+|color=4:0:1|desc='''Moderate fever''' - Reduces focus stat. Typical warning sign of more dangerous syndromes.}}
{{HealthStatus table row|symbol=F~|color=4:0:1|desc='''Slight fever''' - Reduces focus stat. Relatively harmless.}}
{{HealthStatus table row|symbol=Dz|color=3:0:1|desc='''Dizzy''' - Common symptom of snakebite. Chance for subject to stumble in a random direction instead of performing an action, depending on severity.}}
{{HealthStatus table row|symbol=Pn!|color=6:0:1|desc='''Extreme pain''' - Bone fracture or a staggering number of surface wounds. Subject can't take any more and falls unconscious, giving into pain. Thresholds depend on subject's willpower stat.}}
{{HealthStatus table row|symbol=Pn+|color=6:0:1|desc='''Moderate pain''' - Serious, recent damage to muscle and/or fat. Interferes with actions?}}
{{HealthStatus table row|symbol=Pn~|color=6:0:1|desc='''Slight pain''' - Subject has suffered minor cuts or bruises.}}
{{HealthStatus table row|symbol=St|color=3:0:1|desc='''Stunned''' - The wind has been knocked out of the subject by an unexpected fall, impact, cave-in or takedown. Temporary and harmless in itself.}}
{{HealthStatus table row|symbol=Exh|color=6:0:1|desc='''Exhausted''' - Caused by taking too many combat actions in a turn?{{verify}}}}
{{HealthStatus table row|symbol=Ovx|color=6:0:1|desc='''Over-exerted''' - Caused by taking too many combat actions in a turn?{{verify}}}}
{{HealthStatus table row|symbol=Tir|color=6:0:1|desc='''Tired''' - Caused by taking too many combat actions in a turn?{{verify}}}}
|}

===Fourth Key Column===
This column shows breathing problems and various needs (including extreme like starvation and dehydration).
{{HealthStatus table head}}
{{HealthStatus table row|symbol=Dr|color=1:0:1|desc='''Drowning''' - Cannot breathe due to being stuck underwater. This is an emergency.}}
{{HealthStatus table row|symbol=Wd|color=7:0:0|desc='''Winded''' - Typical of punctured lungs. Comparison against breathing trouble needed.}}
{{HealthStatus table row|symbol=Br|color=4:0:1|desc='''Cannot breathe''' - Usually indicates severe lung injury or asphyxiation. Death is imminent unless one lung was injured a long time ago and will finish healing to the point of being able to breathe before subject dies.}}
{{HealthStatus table row|symbol=Br|color=7:0:0|desc='''Trouble breathing''' - Usually indicates lung injury or extreme exertion}}
{{HealthStatus table row|symbol=T!|color=4:0:1|desc='''Dehydrated''' - If the subject doesn't receive booze (or [[water]], if hospitalized) they will die. This is an emergency.}}
{{HealthStatus table row|symbol=T~|color=1:0:1|desc='''Thirsty'''}}
{{HealthStatus table row|symbol=H!|color=4:0:1|desc='''Starving''' - If the subject doesn't receive food they will die. This is an emergency.}}
{{HealthStatus table row|symbol=H~|color=6:0:0|desc='''Hungry'''}}
{{HealthStatus table row|symbol=Dw|color=4:0:1|desc='''Very drowsy''' - If the subject doesn't get sleep soon they will go [[insane]]. This is an emergency.}}
{{HealthStatus table row|symbol=Dw|color=1:0:1|desc='''Drowsy''' - Subject is tired enough to go to bed, but hasn't done so yet. Also caused by syndromes.}}
{{HealthStatus table row|symbol=Na|color=2:0:1|desc='''Nauseous''' - Symptom of cave adaptation or injury to the guts. The subject may stop and [[vomit]] instead of making an action. Excessive vomiting can cause dehydration.}}
|}

===Fifth Key Column===
This column shows vision and grasping impairment, problems with nerves, and being unable to stand or fly.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=V|color=4:0:1|desc='''Vision lost''' - Subject will have a very hard time completing normal tasks}}
{{HealthStatus table row|symbol=V|color=6:0:1|desc='''Vision impaired''' - Subject will have a hard time completing normal tasks}}
{{HealthStatus table row|symbol=V|color=7:0:0|desc='''Vision ~impaired''' - Subject will have a slightly hard time completing normal tasks. Caused naturally by old age (110+ with dwarves).}}
{{HealthStatus table row|symbol=P|color=2:0:1|desc='''Popped out''' - Subject's intestines have popped out. Death is imminent.}}
{{HealthStatus table row|symbol=Sx|color=6:0:1|desc='''Cannot stand''' - Subject can only crawl due to dismemberment or lower body paralysis. Subject needs a [[crutch]] to stand or walk.}}
{{HealthStatus table row|symbol=S~|color=6:0:1|desc='''Stand impaired''' - Subject has trouble standing due to numbness or injury to the legs. Subject might need a crutch? {{verify}}}}
{{HealthStatus table row|symbol=Gx|color=6:0:1|desc='''Cannot grasp''' - Subject cannot manipulate objects due to dismemberment or paralysis.}}
{{HealthStatus table row|symbol=G~|color=6:0:1|desc='''Grasp impaired''' - Subject has trouble with fine motor control, but can still grasp things. Typically caused by injury or numbness.}}
{{HealthStatus table row|symbol=Fx|color=6:0:1|desc='''Cannot fly''' - Subject can no longer fly due to paralysis or injury. Applied only to former flyers.}}
{{HealthStatus table row|symbol=F~|color=6:0:1|desc='''Flight impaired''' - Subject has trouble flying due to injury. Applied only to flyers.}}
{{HealthStatus table row|symbol=Mn|color=3:0:1|desc='''Motor nerve''' - A motor nerve has been damaged, which can affect the subject's ability to move, stand, or fly}}
{{HealthStatus table row|symbol=Sn|color=3:0:1|desc='''Sensory nerve''' - A sensory nerve has been damaged, which can affect the subject's ability to feel sensations, to see, and to breathe{{verify}}}}
|}

===Sixth Key Column===
This column shows torn arteries, tendons and ligaments along with fractures and bruising.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=A!|color=4:0:1|desc='''Major artery torn''' - Heart injury or torn throat. This is invariably fatal.}}
{{HealthStatus table row|symbol=A+|color=4:0:1|desc='''Artery torn''' - Subject will probably suffer bleeding of some type. This can be an emergency.}}
{{HealthStatus table row|symbol=Of|color=4:0:1|desc='''Overlapping fracture''' - A widely displaced limb fracture in real life, only seems to represent extreme damage ingame. Cannot be set without a traction bench.}}
{{HealthStatus table row|symbol=Cf|color=4:0:1|desc='''Compound fracture''' - A fracture that has also broken a tissue directly subordinate to the bone, such as fingernails or spinal nerves. Tissues torn by bone fragments jammed through them also count.}}
{{HealthStatus table row|symbol=Tn|color=4:0:1|desc='''Torn tendon''' - Sinew damage. Limb is disabled. Cannot be set, heals on its own.}}
{{HealthStatus table row|symbol=Tn|color=6:0:1|desc='''Tendon strain''' - Sinew damage. Rarely this slight.}}
{{HealthStatus table row|symbol=Tn|color=6:0:0|desc='''Tendon bruise''' - Sinew damage. Rarely this slight.}}
{{HealthStatus table row|symbol=Lg|color=4:0:1|desc='''Torn ligament''' - Sinew damage. Limb is disabled. Cannot be set, heals on its own.}}
{{HealthStatus table row|symbol=Lg|color=6:0:1|desc='''Ligament strain''' - Sinew damage. Rarely this slight.}}
{{HealthStatus table row|symbol=Lg|color=6:0:0|desc='''Ligament bruise''' - Sinew damage. Rarely this slight.}}
{{HealthStatus table row|symbol=Ns|color=6:0:1|desc='''Need setting''' - A [[bone doctor]] is needed to treat injuries}}
|}

===Seventh Key Column===
This column shows broken tissue, different degrees of pain, damage and swelling, and whether the subject has an infection.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=X!|color=4:0:1|desc='''Broken tissue'''}}
{{HealthStatus table row|symbol=D!|color=4:0:1|desc='''Heavy damage''' - Typical amount of bruising sustained in combat. Also caused by syndromes.}}
{{HealthStatus table row|symbol=D+|color=6:0:1|desc='''Moderate damage''' - Varying degrees of bruising. Typically caused by syndromes.}}
{{HealthStatus table row|symbol=D~|color=6:0:0|desc='''Light damage''' - Varying degrees of bruising. Typically caused by syndromes.}}
{{HealthStatus table row|symbol=X~|color=6:0:1|desc='''Partially broken tissue''' - The subject's skin or muscle is cut or torn open. Not necessarily an emergency.}}
{{HealthStatus table row|symbol=Pb!|color=6:0:1|desc='''Extreme pain''' - Not caused by injuries. Syndrome symptom?}}
{{HealthStatus table row|symbol=Pb+|color=6:0:1|desc='''Moderate pain''' - Not caused by injuries. Syndrome symptom?}}
{{HealthStatus table row|symbol=Pb~|color=6:0:1|desc='''Minor pain''' - Not caused by injuries. Syndrome symptom?}}
{{HealthStatus table row|symbol=Sw!|color=6:0:1|desc='''Extreme swelling''' - Typically caused by syndromes. Further impedes use of affected limbs and matures into necrosis. Swelling of the throat can cause suffocation.}}
{{HealthStatus table row|symbol=Sw+|color=6:0:1|desc='''Medium swelling''' - Typically caused by syndromes. Impedes use of affected limbs.}}
{{HealthStatus table row|symbol=Sw~|color=6:0:1|desc='''Minor swelling''' - Typically caused by syndromes. Slightly impedes use of affected limbs.}}
{{HealthStatus table row|symbol=In|color=5:0:1|desc='''Infection''' - Appears in open wounds either exposed to contaminated water or left untreated for too long. Cannot be treated. Subject's health attributes may affect survival rate?{{verify}}}}
|}

{{Category|Healthcare}}
{{Category|Interface}}

v0.34:Crutch

2012-12-12T01:47:07Z

AVK:

{{quality|Fine|03:06, 18 April 2011 (UTC)}}{{av}}

Crutches are used by [[dwarf|dwarves]] to move around when injuries have limited their mobility. However, dwarves who have lost the use of their legs due to spinal nerve injuries will not acquire and use crutches; only broken/amputated legs/feet will trigger hospital staff to assign crutches as part of treatment.

Crutches are made out of one [[wood]] log at the [[carpenter's workshop]] or one [[metal]] bar at a [[forge]]. Crutches are stored in a Finished Goods stockpile, and will be placed in bins when there is space available.

Dwarves hold crutches like any other object and may use them in self-defense.

== Adventurer mode ==

In adventurer mode crutches can be used to walk when one or both legs are disabled. The associated skill is [[crutch-walker|crutch-walking]], and this can be trained to increase movement speed while using a crutch. It is possible to train crutch-walking without having an injury, however any adventurer carrying a crutch in their hand will have the movement penalty of using a crutch applied. It is possible to sneak while using a crutch. The crutch-walker status remains in effect while swimming. It is possible to aim attacks using crutches if you are holding one.

Once a crutch has been equipped, it will continue to be used until it is dropped from one's hands - [[thrower|throwing]] the crutch will not properly clear the "[[crutch-walker|crutch-walking]]" status, nor will placing the crutch into a container (or subsequently dropping or throwing the crutch from said container); in order to stop crutch-walking, the crutch must be re-equipped and then dropped. It may then be picked up and stored in a backpack with no status applied.

It is not currently possible to craft crutches in adventurer mode. Due to the current store-type imbalance in adventure mode they may be difficult to find for sale in shops. Crutches are most easily found during exploration of fortresses, camps or other places that have loot lying around.

{{Category|Healthcare}}

v0.34:Material definition token

2012-06-29T18:40:13Z

AVK:

{{quality|Exceptional|18:11, 28 April 2011 (UTC)}}{{av}}

The following tokens can be used in material definitions (whether for inorganics or those within plants and creatures) as well as in material templates.

==Material Properties==
{| {{prettytable}}
|- bgcolor="#C0C0C0"
! Token
! Arguments
! Description

|-
| PREFIX
| * string
| 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
| * string
| 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
|
* type
| Unknown. Valid values are BLOOD, SLIME, VOMIT, ICHOR, PUS, GOO, GRIME, or FILTH.

|-
| POWDER_DYE
| [[color]] token
| Defines the material as a type of dye.

|-
| TILE
| [[Main: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 [[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: [[door]]s, [[floodgate]]s, [[hatch cover]]s, [[bin]]s, [[barrel]]s, and [[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 [[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]] token
| 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 [[glaze]]d. Defaults to 0.

|-
| IMPACT_YIELD
|
*value
| Specifies how hard of an impact the material can withstand before it will start deforming permanently. Used for blunt-force combat. Defaults to 10000.

|-
| IMPACT_FRACTURE
|
*value
| Specifies how hard of an impact the material can withstand before it will fail entirely. Used for blunt-force combat. Defaults to 10000.

|-
| IMPACT_STRAIN_AT_YIELD or IMPACT_ELASTICITY
|
*value
| Specifies how much the material will give when the yield point is reached.{{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 start deforming permanently. [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 fail entirely. [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 give when it is compressed past its yield point.{{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 start deforming permanently. Determines a tissue's resistance to a latching and tearing bite. Defaults to 10000.

|-
| TENSILE_FRACTURE
|
*value
| Specifies how hard the material can be stretched before it will fail entirely. Determines a tissue's resistance to a latching and tearing bite. Defaults to 10000.

|-
| TENSILE_STRAIN_AT_YIELD or TENSILE_ELASTICITY
|
*value
| Specifies how much the material will give when it is stretched past its yield point. Determines a tissue's resistance to a latching and tearing bite. Defaults to 0.

|-
| TORSION_YIELD
|
*value
| Specifies how hard the material can be twisted before it will start deforming permanently. [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 fail entirely. [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 give when it is twisted past its yield point.{{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 start deforming permanently. Used for cutting calculations. Defaults to 10000.

|-
| SHEAR_FRACTURE
|
*value
| Specifies how hard the material can be sheared before it will fail entirely. Used for cutting calculations. Defaults to 10000.

|-
| SHEAR_STRAIN_AT_YIELD or SHEAR_ELASTICITY
|
*value
| Specifies how much the material will give when sheared past its yield point. Used for cutting calculations. Defaults to 0.

|-
| BENDING_YIELD
|
*value
| Specifies how hard the material can be bent before it will start deforming permanently. [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 fail entirely. [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 give when bent past its yield point.{{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 [[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 will burn for a very long time (9 months and 16.8 days). 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. '''Not permitted in material template definitions.'''

|-
| IF_EXISTS_SET_COLDDAM_POINT
|
*temperature
| Changes a material's COLDDAM_POINT, but only if it was not set to NONE. '''Not permitted in material template definitions.'''

|-
| IF_EXISTS_SET_IGNITE_POINT
|
*temperature
| Changes a material's IGNITE_POINT, but only if it was not set to NONE. '''Not permitted in material template definitions.'''

|-
| IF_EXISTS_SET_MELTING_POINT
|
*temperature
| Changes a material's MELTING_POINT, but only if it was not set to NONE. '''Not permitted in material template definitions.'''

|-
| IF_EXISTS_SET_BOILING_POINT
|
*temperature
| Changes a material's BOILING_POINT, but only if it was not set to NONE. '''Not permitted in material template definitions.'''

|-
| IF_EXISTS_SET_MAT_FIXED_TEMP
|
*temperature
| Changes a material's MAT_FIXED_TEMP, but only if it was not set to NONE. '''Not permitted in material template definitions.'''

|-
| 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] [[plant token]]s. Defaults to BARREL.

|-
| BUTCHER_SPECIAL
|
*[[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 [[block]]s made from this material.

|-
| MATERIAL_REACTION_PRODUCT
|
*reaction reference
*[[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
|
* [[material token]]
| Allows the material to be used to make [[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. Entities opposed to killing animals (which currently does '''not''' include Elves) will refuse to accept these items in trade.

|-
| ALCOHOL_PLANT
|
| Classifies the material as plant-based alcohol, allowing its storage in food stockpiles under "Drink (Plant)".

|-
| ALCOHOL_CREATURE
|
| Classifies the material as animal-based alcohol, allowing its storage in food stockpiles under "Drink (Animal)".

|-
| ALCOHOL
|
| Classifies the material as generic alcohol. Implied by both ALCOHOL_PLANT and ALCOHOL_CREATURE. Exact behavior unknown, possibly vestigial.

|-
| CHEESE_PLANT
|
| Classifies the material as plant-based cheese, allowing its storage in food stockpiles under "Cheese (Plant)".

|-
| CHEESE_CREATURE
|
| Classifies the material as animal-based cheese, allowing its storage in food stockpiles under "Cheese (Animal)".

|-
| CHEESE
|
| Classifies the material as generic cheese. Implied by both CHEESE_PLANT and CHEESE_CREATURE. Exact behavior unknown, possibly vestigial.

|-
| POWDER_MISC_PLANT
|
| Classifies the material as plant powder, allowing its storage in in food stockpiles under "Milled Plant".

|-
| POWDER_MISC_CREATURE
|
| Classifies the material as creature powder, allowing its storage in food stockpiles under "Bone Meal".

|-
| POWDER_MISC
|
| Classifies the material as generic powder. Implied by both POWDER_MISC_PLANT and POWDER_MISC_CREATURE. Exact behavior unknown, possibly vestigial.

|-
| 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
|
| Classifies the material as milled paste, allowing its storage in food stockpiles under "Paste".

|-
| STOCKPILE_GLOB_PRESSED
|
| Classifies the material as pressed goods, allowing its storage in food stockpiles under "Pressed Material".

|-
| LIQUID_MISC_PLANT
|
| Classifies the material as a plant extract, allowing its storage in food stockpiles under "Extract (Plant)".

|-
| LIQUID_MISC_CREATURE
|
| Classifies the material as a creature extract, allowing its storage in food stockpiles under "Extract (Animal)".

|-
| LIQUID_MISC_OTHER
|
| Classifies the material as a miscellaneous liquid, allowing its storage in food stockpiles under "Misc. Liquid" along with lye.

|-
| LIQUID_MISC
|
| Classifies the material as a generic liquid. Implied by LIQUID_MISC_PLANT, LIQUID_MISC_CREATURE, and LIQUID_MISC_OTHER. Exact behavior unknown. Possibly vestigial.

|-
| STRUCTURAL_PLANT_MAT
|
| Classifies the material as plant, allowing its storage in food stockpiles under "Plants".

|-
| SEED_MAT
|
| Classifies the material as plant seed, allowing its storage in food stockpiles under "Seeds".

|-
| LEAF_MAT
|
| Classifies the material as plant leaf, allowing its storage in food stockpiles under "Leaves".

|-
| BONE
|
| Classifies the material as bone, allowing its use for bone carvers and restriction from stockpiles by material.

|-
| WOOD
|
| Classifies the material as wood, allowing its use for carpenters and storage in wood stockpiles. Entities opposed to killing plants (i.e. [[Elf|Elves]]) will refuse to accept these items in trade.

|-
| THREAD_PLANT
|
| Classifies the material as plant fiber, allowing its use for clothiers and storage in cloth stockpiles under "Thread (Plant)" and "Cloth (Plant)".

|-
| TOOTH
|
| Classifies the material as tooth, allowing its use for bone carvers and restriction from stockpiles by material.

|-
| HORN
|
| Classifies the material as horn, allowing its use for bone carvers and restriction from stockpiles by material.

|-
| PEARL
|
| Classifies the material as pearl, allowing its use for bone carvers and restriction from stockpiles by material.

|-
| SHELL
|
| Classifies the material as shell, allowing its use for bone carvers and restriction from stockpiles by material.

|-
| LEATHER
|
| Classifies the material as leather, allowing its use for leatherworkers and storage in leather stockpiles.

|-
| SILK
|
| Classifies the material as silk, allowing its use for clothiers and storage in cloth stockpiles under "Thread (Silk)" and "Cloth (Silk)".

|-
| SOAP
|
| Classifies the material as soap, allowing it to be used as a bath detergent and stored in bar/block stockpiles under "Bars: Other Materials".{{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 [[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. Possibly vestigial.

|-
| ITEMS_BARRED
|
| Equivalent to ITEMS_HARD. Given to [[bone]].

|-
| ITEMS_SCALED
|
| Equivalent to ITEMS_HARD. Given to [[shell]].

|-
| ITEMS_LEATHER
|
| Equivalent to ITEMS_SOFT. Given to [[leather]].

|-
| ITEMS_SOFT
|
| Random [[finished goods|crafts]] made from this material can not be made into rings, crowns, scepters or figurines. Given to [[plant fiber]], [[silk]] and [[wool]].

|-
| ITEMS_HARD
|
| Random [[finished goods|crafts]] made from this material include all seven items. Given to [[stone]], [[wood]], [[bone]], [[shell]], [[chitin]], [[nail|claws]], [[tooth|teeth]], [[horn|horns]], [[horn|hooves]] and [[wax|beeswax]]. [[Hair]], [[pearl|pearls]] and eggshells also have the tag.

|-
| IS_STONE
|
| Used to define that said material is stone. Allows its 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 [[glaze]]d.

|-
| YARN
|
| Classifies the material as yarn, allowing its use for clothiers and its storage 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 [[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
|
| [[Anvil]]s can be made out of this material.

|-
| ITEMS_AMMO
|
| [[Weapon#Ammunition|Ammunition]] can be made out of this material.

|-
| ITEMS_DIGGER
|
| [[Weapon#Dwarf-manufactured weapons|Picks]] can be made out of this material.

|-
| ITEMS_ARMOR
|
| [[Armor]] can be made out of this material.

|-
| ITEMS_DELICATE
|
| Used internally by amber and coral. Functionally equivalent to ITEMS_HARD.

|-
| 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 CE_SWELLING CE_OOZING CE_BRUISING CE_BLISTERS CE_NUMBNESS CE_PARALYSIS CE_FEVER CE_BLEEDING CE_COUGH_BLOOD CE_VOMIT_BLOOD CE_NAUSEA CE_UNCONSCIOUSNESS CE_NECROSIS CE_IMPAIR_FUNCTION CE_DROWSINESS 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 [[Syndrome#Creature effect tokens|Syndromes page]]

|}

==See Also==
* [[Inorganic material definition token]]
* [[Syndrome]]

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

v0.34:Material definition token

2012-06-29T15:59:05Z

AVK: Added personal research into ITEMS_ tags and tensile strength, rewrote a few descriptions for similarity.

{{quality|Exceptional|18:11, 28 April 2011 (UTC)}}{{av}}

The following tokens can be used in material definitions (whether for inorganics or those within plants and creatures) as well as in material templates.

==Material Properties==
{| {{prettytable}}
|- bgcolor="#C0C0C0"
! Token
! Arguments
! Description

|-
| PREFIX
| * string
| 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
| * string
| 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
|
* type
| Unknown. Valid values are BLOOD, SLIME, VOMIT, ICHOR, PUS, GOO, GRIME, or FILTH.

|-
| POWDER_DYE
| [[color]] token
| Defines the material as a type of dye.

|-
| TILE
| [[Main: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 [[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: [[door]]s, [[floodgate]]s, [[hatch cover]]s, [[bin]]s, [[barrel]]s, and [[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 [[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]] token
| 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 [[glaze]]d. Defaults to 0.

|-
| IMPACT_YIELD
|
*value
| Specifies how hard of an impact the material can withstand before it will start deforming permanently. Used for blunt-force combat. Defaults to 10000.

|-
| IMPACT_FRACTURE
|
*value
| Specifies how hard of an impact the material can withstand before it will fail entirely. Used for blunt-force combat. Defaults to 10000.

|-
| IMPACT_STRAIN_AT_YIELD or IMPACT_ELASTICITY
|
*value
| Specifies how much the material will give when the yield point is reached.{{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 start deforming permanently. [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 fail entirely. [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 give when it is compressed past its yield point.{{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 start deforming permanently. Determines a tissue's resistance to a latching and tearing bite. Defaults to 10000.

|-
| TENSILE_FRACTURE
|
*value
| Specifies how hard the material can be stretched before it will fail entirely. Determines a tissue's resistance to a latching and tearing bite. Defaults to 10000.

|-
| TENSILE_STRAIN_AT_YIELD or TENSILE_ELASTICITY
|
*value
| Specifies how much the material will give when it is stretched past its yield point. Determines a tissue's resistance to a latching and tearing bite. Defaults to 0.

|-
| TORSION_YIELD
|
*value
| Specifies how hard the material can be twisted before it will start deforming permanently. [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 fail entirely. [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 give when it is twisted past its yield point.{{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 start deforming permanently. Used for cutting calculations. Defaults to 10000.

|-
| SHEAR_FRACTURE
|
*value
| Specifies how hard the material can be sheared before it will fail entirely. Used for cutting calculations. Defaults to 10000.

|-
| SHEAR_STRAIN_AT_YIELD or SHEAR_ELASTICITY
|
*value
| Specifies how much the material will give when sheared past its yield point. Used for cutting calculations. Defaults to 0.

|-
| BENDING_YIELD
|
*value
| Specifies how hard the material can be bent before it will start deforming permanently. [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 fail entirely. [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 give when bent past its yield point.{{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 [[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 will burn for a very long time (9 months and 16.8 days). 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. '''Not permitted in material template definitions.'''

|-
| IF_EXISTS_SET_COLDDAM_POINT
|
*temperature
| Changes a material's COLDDAM_POINT, but only if it was not set to NONE. '''Not permitted in material template definitions.'''

|-
| IF_EXISTS_SET_IGNITE_POINT
|
*temperature
| Changes a material's IGNITE_POINT, but only if it was not set to NONE. '''Not permitted in material template definitions.'''

|-
| IF_EXISTS_SET_MELTING_POINT
|
*temperature
| Changes a material's MELTING_POINT, but only if it was not set to NONE. '''Not permitted in material template definitions.'''

|-
| IF_EXISTS_SET_BOILING_POINT
|
*temperature
| Changes a material's BOILING_POINT, but only if it was not set to NONE. '''Not permitted in material template definitions.'''

|-
| IF_EXISTS_SET_MAT_FIXED_TEMP
|
*temperature
| Changes a material's MAT_FIXED_TEMP, but only if it was not set to NONE. '''Not permitted in material template definitions.'''

|-
| 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] [[plant token]]s. Defaults to BARREL.

|-
| BUTCHER_SPECIAL
|
*[[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 [[block]]s made from this material.

|-
| MATERIAL_REACTION_PRODUCT
|
*reaction reference
*[[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
|
* [[material token]]
| Allows the material to be used to make [[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. Entities opposed to killing animals (which currently does '''not''' include Elves) will refuse to accept these items in trade.

|-
| ALCOHOL_PLANT
|
| 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)".

|-
| ALCOHOL
|
| Classifies the material as generic alcohol. Implied by both ALCOHOL_PLANT and ALCOHOL_CREATURE. Exact behavior unknown.

|-
| CHEESE_PLANT
|
| Classifies the material as plant cheese, allowing it to be stored in food stockpiles under "Cheese (Plant)".

|-
| CHEESE_CREATURE
|
| Classifies the material as creature cheese, allowing it to be stored in food stockpiles under "Cheese (Animal)".

|-
| CHEESE
|
| Classifies the material as generic cheese. Implied by both CHEESE_PLANT and CHEESE_CREATURE. Exact behavior unknown.

|-
| POWDER_MISC_PLANT
|
| 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".

|-
| POWDER_MISC
|
| Classifies the material as generic powder. Implied by both POWDER_MISC_PLANT and POWDER_MISC_CREATURE. Exact behavior unknown.

|-
| 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
|
| 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.

|-
| LIQUID_MISC
|
| Classifies the material as a generic liquid. Implied by LIQUID_MISC_PLANT, LIQUID_MISC_CREATURE, and LIQUID_MISC_OTHER. Exact behavior unknown.

|-
| 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".

|-
| LEAF_MAT
|
| Classifies the material as plant leaf, allowing it to be stored in food stockpiles under "Leaves".

|-
| BONE
|
| Classifies the material as bone, allowing it to be used by bone carvers and restricted from stockpiles by material.

|-
| WOOD
|
| Classifies the material as wood, allowing it to be used by carpenters and stored in wood stockpiles. Entities opposed to killing plants (i.e. [[Elf|Elves]]) will refuse to accept these items in trade.

|-
| THREAD_PLANT
|
| Classifies the material as plant fiber, allowing it to be used by clothiers and stored in cloth stockpiles under "Thread (Plant)" and "Cloth (Plant)".

|-
| TOOTH
|
| Classifies the material as tooth, allowing it to be used by bone carvers and restricted from stockpiles by material.

|-
| HORN
|
| Classifies the material as horn, allowing it to be used by bone carvers and restricted from stockpiles by material.

|-
| PEARL
|
| Classifies the material as pearl, allowing it to be used by bone carvers and restricted from stockpiles by material.

|-
| SHELL
|
| Classifies the material as shell, allowing it to be used by bone carvers and restricted from stockpiles by material.

|-
| LEATHER
|
| Classifies the material as leather, allowing it to be used by leatherworkers and stored in leather stockpiles.

|-
| SILK
|
| Classifies the material as silk, allowing it to be used by clothiers and stored in cloth stockpiles under "Thread (Silk)" and "Cloth (Silk)".

|-
| SOAP
|
| Classifies the material as soap, allowing it to be used as a bath detergent and stored in bar/block stockpiles under "Bars: Other Materials".{{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 [[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. Possibly vestigial.

|-
| ITEMS_BARRED
|
| Equivalent to ITEMS_HARD. Given to [[bone]].

|-
| ITEMS_SCALED
|
| Equivalent to ITEMS_HARD. Given to [[shell]].

|-
| ITEMS_LEATHER
|
| Equivalent to ITEMS_SOFT. Given to [[leather]].

|-
| ITEMS_SOFT
|
| Random [[finished_goods|crafts]] made from this material can not be made into rings, crowns, scepters or figurines. Given to [[plant fiber]], [[silk]] and [[wool]].

|-
| ITEMS_HARD
|
| Random [[finished_goods|crafts]] made from this material include all seven items. Given to [[stone]], [[wood]], [[bone]], [[shell]], [[chitin]], [[nail|claws]], [[tooth|teeth]], [[horn|horns]], [[hooves|hoof]] and [[wax|beeswax]]. [[Hair]], [[pearls|pearl]] and eggshells also have the tag.

|-
| 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 [[glaze]]d.

|-
| YARN
|
| Classifies the material as yarn, allowing it to be used by clothiers and craftsmen and 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 [[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
|
| [[Anvil]]s can be made out of this material.

|-
| ITEMS_AMMO
|
| [[Weapon#Ammunition|Ammunition]] can be made out of this material.

|-
| ITEMS_DIGGER
|
| [[Weapon#Dwarf-manufactured weapons|Picks]] can be made out of this material.

|-
| ITEMS_ARMOR
|
| [[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 CE_SWELLING CE_OOZING CE_BRUISING CE_BLISTERS CE_NUMBNESS CE_PARALYSIS CE_FEVER CE_BLEEDING CE_COUGH_BLOOD CE_VOMIT_BLOOD CE_NAUSEA CE_UNCONSCIOUSNESS CE_NECROSIS CE_IMPAIR_FUNCTION CE_DROWSINESS 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 [[Syndrome#Creature effect tokens|Syndromes page]]

|}

==See Also==
* [[Inorganic material definition token]]
* [[Syndrome]]

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

v0.34:Body detail plan token

2012-06-09T19:52:04Z

AVK: IN_FRONT position token produces an error. It's FRONT.

{{quality|Exceptional|17:58, 28 April 2011 (UTC)}}{{av}}

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

|-
| ADD_MATERIAL
|
* identifier
* material template
| Adds a new material to the creature based on the specified template and assigned to the specified identifier.

|-
| ADD_TISSUE
|
* identifier
* tissue template
| Adds a new tissue to the creature based on the specified template and assigned to the specified identifier.

|-
| BODY_DETAIL_PLAN
|
| Begins defining a body detail plan for use in creature raws

|-
| BP_LAYERS
|
*BY_CATEGORY or BY_TYPE or BY_TOKEN
*body part
*tissue name or tissue ARG# for innermost tissue
*tissue thickness
*tissue name or tissue ARG# for second innermost tissue
*tissue thickness
*tissue name or tissue ARG# for third innermost tissue
*tissue thickness
etc...
| Defines a series of tissue layers. Alternatively to specifying a tissue, variable arguments can be entered (numbered arbitrarily to a max of 5) to be filled with tissues when the plan is called in the creature entry. The SELECT_TISSUE creature token with TL_RELATIVE_THICKNESS can change tissue thickness, but tissue ''layering'' is hard to do without a new detail plan.

|-
| BP_LAYERS_OVER
|
| Works like BP_LAYERS, but defines layers over existing layers?

|-
| BP_LAYERS_UNDER
|
| Works like BP_LAYERS, but defines layers under existing layers?

|-
| BP_POSITION
|
*BY_CATEGORY or BY_TYPE or BY_TOKEN
*body part
*position token
| Defines a position for the specified body part (the nose is assigned the position FRONT, as it's on the front of the face). This has some effects on combat, attacks and the like. Valid position tokens are FRONT, BACK, SIDES, TOP and BOTTOM.

|-
| BP_RELATION
|
*BY_CATEGORY or BY_TYPE or BY_TOKEN
*body part to be affected
*relation token
*BY_CATEGORY or BY_TYPE or BY_TOKEN
*parent body part
*coverage
| Defines a positional relationship between one body part and another (the right eyelid is AROUND the right eye with coverage 50, as it only partially covers the eye). This has some effects on combat, attacks and the like. Valid relation tokens are AROUND, SURROUNDED_BY, ABOVE, BELOW, FRONT, BEHIND, CLEANS, and CLEANED_BY. The lattermost two tokens are used when specifying parts that clean each other (such as eyelids to eyes).

|-
| BP_RELSIZE
|
*BY_CATEGORY (or, presumably, BY_TYPE or BY_TOKEN)
*body part
*relsize
| Defines a relsize for the selected body part for the current body detail plan

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

v0.34:Health screen

2012-06-07T23:34:36Z

AVK:

{{quality|Exceptional|23:31, 17 April 2011 (UTC)}}

In the status menu (accessed using the {{k|z}}-status key), one of the sub-menus is '''Health'''. This sub-menu becomes available when a dwarf is appointed to the [[Chief medical dwarf]] position. It does not display information unless the CMD is at least a novice [[diagnostician]]. 
The z-health menu is used to monitor the health of friendly dwarves. A subject dwarf's status effects and injuries are cataloged in the health menu by [[Healthcare|hospital staff]] upon diagnosis. Some basic needs are automatically shown in the menu whenever a dwarf becomes hungry, thirsty, or tired. Doctors will begin treating injured or otherwise unhealthy dwarves only after diagnosis and when proper equipment is available. 
Note: The screen is entirely mouse enabled. 

Listed below are all of the conditions displayed in the z-health screen:
===First Key Column===
This is the column that lists requests and requirements of the subject.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=D|color=2:0:1|desc='''Diagnosis request''' - [[Diagnostician]] needed to diagnose the subject}}
{{HealthStatus table row|symbol=≈|color=3:0:1|desc='''Cleaning request''' - Dwarf with a water bucket and cleaning labor enabled needed to bathe off contaminants, preferably using [[soap]] }}
{{HealthStatus table row|symbol=S|color=4:0:1|desc='''Surgery required''' - [[Surgeon]] needed to excise necrotic tissue or repair organ damage}}
{{HealthStatus table row|symbol=R|color=5:0:1|desc='''Inoperable Rot''' - [[Surgeon]] needed to amputate a necrotic limb}}
{{HealthStatus table row|symbol=Ø|color=7:0:1|desc='''Suture request''' - [[Suturer]] needed to repair cuts, wounds and nerve damage (!!) using thread}}
{{HealthStatus table row|symbol=B|color=6:0:1|desc='''Setting request''' - [[Bone doctor]] needed to set the subject's fractured bones}}
{{HealthStatus table row|symbol=<s>°</s>|color=7:0:1|desc='''Dressing request''' - [[Wound dresser]] needed to top off the medical procedure using cloth bandages}}
{{HealthStatus table row|symbol=T|color=6:0:1|desc='''Traction request''' - [[Traction bench]] needed to immobilize subject with overlapping fractures}}
{{HealthStatus table row|symbol=I|color=6:0:1|desc='''Immobilization request''' - [[Gypsum plaster|Cast]] (wound dresser) or [[splint]] (bone doctor) needed to stabilize a repaired fracture}}
{{HealthStatus table row|symbol=C|color=6:0:1|desc='''Crutch required''' - [[Crutch]] needed for the subject to walk}}
|}

===Second Key Column===
This column shows different degrees of bleeding, blood loss, numbness, and paralysis.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=B!+|color=4:0:1|desc='''Heavy bleeding''' - Subject is quickly losing blood through many wounds or torn arteries. This is an emergency.}}
{{HealthStatus table row|symbol=B!~|color=4:0:0|desc='''Bleeding''' - Subject is losing blood through a wound. Typically harmless due to dwarves' fast natural healing rate.}}
{{HealthStatus table row|symbol=Bl+|color=5:0:1|desc='''Severe Blood Loss''' - Subject is Pale. Caused by massive blood loss, typically from a severed limb. This is an emergency.}}
{{HealthStatus table row|symbol=Bl~|color=5:0:1|desc='''Blood Loss''' - Subject is Faint. Caused by moderate blood loss from wounds or necrosis.}}
{{HealthStatus table row|symbol=Pz+|color=3:0:1|desc='''Paralyzed''' - Subject is completely paralyzed. Common effect of upper spinal injury. Death by suffocation is imminent}}
{{HealthStatus table row|symbol=Pz~|color=3:0:1|desc='''Partially paralyzed''' - One or more limbs unusable due to severed nerves}}
{{HealthStatus table row|symbol=Slg|color=3:0:1|desc='''Sluggish''' - Characteristic of weak or lessening paralysis}}
{{HealthStatus table row|symbol=Nm+|color=3:0:1|desc='''Completely numb''' - Symptom of syndromes or sensory nerve damage. Eliminates pain sensation in affected areas and severely hampers motor ability. Protracted syndrome effects may cause permanent damage.}}
{{HealthStatus table row|symbol=Nm~|color=3:0:1|desc='''Partially numb''' - Symptom of syndromes or sensory nerve damage. Further reduces pain in affected areas and hampers fine motor ability.}}
{{HealthStatus table row|symbol=Nm-|color=3:0:1|desc='''Slightly numb''' - Symptom of syndromes or sensory nerve damage. Reduces pain in affected areas.}}
|}

===Third Key Column===
This column shows different degrees of pain, exhaustion and fever and also shows dizziness and whether the subject is stunned.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=F!|color=4:0:1|desc='''Serious fever''' - Reduces focus stat, may stun. Typical warning sign of more dangerous syndromes.}}
{{HealthStatus table row|symbol=F+|color=4:0:1|desc='''Moderate fever''' - Reduces focus stat. Typical warning sign of more dangerous syndromes.}}
{{HealthStatus table row|symbol=F~|color=4:0:1|desc='''Slight fever''' - Reduces focus stat. Relatively harmless.}}
{{HealthStatus table row|symbol=Dz|color=3:0:1|desc='''Dizzy''' - Common symptom of snakebite. Chance for subject to stumble in a random direction instead of performing an action, depending on severity.}}
{{HealthStatus table row|symbol=Pn!|color=6:0:1|desc='''Extreme pain''' - Bone fracture or a staggering number of surface wounds. Subject can't take any more and falls unconscious, giving into pain. Thresholds depend on subject's willpower stat.}}
{{HealthStatus table row|symbol=Pn+|color=6:0:1|desc='''Moderate pain''' - Serious, recent damage to muscle and/or fat. Interferes with actions?}}
{{HealthStatus table row|symbol=Pn~|color=6:0:1|desc='''Slight pain''' - Subject has suffered minor cuts or bruises.}}
{{HealthStatus table row|symbol=St|color=3:0:1|desc='''Stunned''' - The wind has been knocked out of the subject by an unexpected fall, impact, cave-in or takedown. Temporary and harmless in itself.}}
{{HealthStatus table row|symbol=Exh|color=6:0:1|desc='''Exhausted''' - Caused by taking too many combat actions in a turn?{{verify}}}}
{{HealthStatus table row|symbol=Ovx|color=6:0:1|desc='''Over-exerted''' - Caused by taking too many combat actions in a turn?{{verify}}}}
{{HealthStatus table row|symbol=Tir|color=6:0:1|desc='''Tired''' - Caused by taking too many combat actions in a turn?{{verify}}}}
|}

===Fourth Key Column===
This column shows breathing problems and various needs (including extreme like starvation and dehydration).
{{HealthStatus table head}}
{{HealthStatus table row|symbol=Dr|color=1:0:1|desc='''Drowning''' - Cannot breathe due to being stuck underwater. This is an emergency.}}
{{HealthStatus table row|symbol=Wd|color=7:0:0|desc='''Winded''' - Typical of punctured lungs. Comparison against breathing trouble needed.}}
{{HealthStatus table row|symbol=Br|color=4:0:1|desc='''Cannot breathe''' - Usually indicates severe lung injury or asphyxiation. Death is imminent unless one lung was injured a long time ago and will finish healing to the point of being able to breathe before subject dies.}}
{{HealthStatus table row|symbol=Br|color=7:0:0|desc='''Trouble breathing''' - Usually indicates lung injury or extreme exertion}}
{{HealthStatus table row|symbol=T!|color=4:0:1|desc='''Dehydrated''' - If the subject doesn't receive booze (or [[water]], if hospitalized) they will die. This is an emergency.}}
{{HealthStatus table row|symbol=T~|color=1:0:1|desc='''Thirsty'''}}
{{HealthStatus table row|symbol=H!|color=4:0:1|desc='''Starving''' - If the subject doesn't receive food they will die. This is an emergency.}}
{{HealthStatus table row|symbol=H~|color=6:0:0|desc='''Hungry'''}}
{{HealthStatus table row|symbol=Dw|color=4:0:1|desc='''Very drowsy''' - If the subject doesn't get sleep soon they will go [[insane]]. This is an emergency.}}
{{HealthStatus table row|symbol=Dw|color=1:0:1|desc='''Drowsy''' - Subject is tired enough to go to bed, but hasn't done so yet. Also caused by syndromes.}}
{{HealthStatus table row|symbol=Na|color=2:0:1|desc='''Nauseous''' - Symptom of cave adaptation or injury to the guts. The subject may stop and [[vomit]] instead of making an action. Excessive vomiting can cause dehydration.}}
|}

===Fifth Key Column===
This column shows vision and grasping impairment, problems with nerves, and being unable to stand or fly.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=V|color=4:0:1|desc='''Vision lost''' - Subject will have a very hard time completing normal tasks}}
{{HealthStatus table row|symbol=V|color=6:0:1|desc='''Vision impaired''' - Subject will have a hard time completing normal tasks}}
{{HealthStatus table row|symbol=V|color=7:0:0|desc='''Vision ~impaired''' - Subject will have a slightly hard time completing normal tasks. Caused naturally by old age (110+ with dwarves).}}
{{HealthStatus table row|symbol=P|color=2:0:1|desc='''Popped out''' - Subject's intestines have popped out. Death is imminent.}}
{{HealthStatus table row|symbol=Sx|color=6:0:1|desc='''Cannot stand''' - Subject can only crawl due to dismemberment or lower body paralysis. Subject needs a [[crutch]] to stand or walk.}}
{{HealthStatus table row|symbol=S~|color=6:0:1|desc='''Stand impaired''' - Subject has trouble standing due to numbness or injury to the legs. Subject might need a crutch? {{verify}}}}
{{HealthStatus table row|symbol=Gx|color=6:0:1|desc='''Cannot grasp''' - Subject cannot manipulate objects due to dismemberment or paralysis.}}
{{HealthStatus table row|symbol=G~|color=6:0:1|desc='''Grasp impaired''' - Subject has trouble with fine motor control, but can still grasp things. Typically caused by injury or numbness.}}
{{HealthStatus table row|symbol=Fx|color=6:0:1|desc='''Cannot fly''' - Subject can no longer fly due to paralysis or injury. Applied only to former flyers.}}
{{HealthStatus table row|symbol=F~|color=6:0:1|desc='''Flight impaired''' - Subject has trouble flying due to injury. Applied only to flyers.}}
{{HealthStatus table row|symbol=Mn|color=3:0:1|desc='''Motor nerve''' - A motor nerve has been damaged, which can affect the subject's ability to move, stand, or fly}}
{{HealthStatus table row|symbol=Sn|color=3:0:1|desc='''Sensory nerve''' - A sensory nerve has been damaged, which can affect the subject's ability to feel sensations, to see, and to breathe{{verify}}}}
|}

===Sixth Key Column===
This column shows torn arteries, tendons and ligaments along with fractures and bruising.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=A!|color=4:0:1|desc='''Major artery torn''' - Heart injury or torn throat. This is invariably fatal.}}
{{HealthStatus table row|symbol=A+|color=4:0:1|desc='''Artery torn''' - Subject will probably suffer bleeding of some type. This can be an emergency.}}
{{HealthStatus table row|symbol=Of|color=4:0:1|desc='''Overlapping fracture''' - A widely displaced limb fracture in real life, only seems to represent extreme damage ingame. Cannot be set without a traction bench.}}
{{HealthStatus table row|symbol=Cf|color=4:0:1|desc='''Compound fracture''' - A fracture that has also broken a tissue directly subordinate to the bone, such as fingernails or spinal nerves. Tissues torn by bone fragments jammed through them also count.}}
{{HealthStatus table row|symbol=Tn|color=4:0:1|desc='''Torn tendon''' - Muscle is severed from the bone. Causes severe pain and disables limb?{{verify}}}}
{{HealthStatus table row|symbol=Tn|color=6:0:1|desc='''Tendon strain''' - Muscle damage. Causes pain and limits movement?{{verify}}}}
{{HealthStatus table row|symbol=Tn|color=6:0:0|desc='''Tendon bruise''' - Slight muscle damage.}}
{{HealthStatus table row|symbol=Lg|color=4:0:1|desc='''Torn ligament''' - Broken joint. Causes severe pain and disables limb?{{verify}}}}
{{HealthStatus table row|symbol=Lg|color=6:0:1|desc='''Ligament strain''' - Joint damage. Causes pain and limits movement? {{verify}}}}
{{HealthStatus table row|symbol=Lg|color=6:0:0|desc='''Ligament bruise''' - Slight joint damage.}}
{{HealthStatus table row|symbol=Ns|color=6:0:1|desc='''Need setting''' - A [[bone doctor]] is needed to treat injuries}}
|}

===Seventh Key Column===
This column shows broken tissue, different degrees of pain, damage and swelling, and whether the subject has an infection.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=X!|color=4:0:1|desc='''Broken tissue'''}}
{{HealthStatus table row|symbol=D!|color=4:0:1|desc='''Heavy damage''' - Typical amount of bruising sustained in combat. Also caused by syndromes.}}
{{HealthStatus table row|symbol=D+|color=6:0:1|desc='''Moderate damage''' - Varying degrees of bruising. Typically caused by syndromes.}}
{{HealthStatus table row|symbol=D~|color=6:0:0|desc='''Light damage''' - Varying degrees of bruising. Typically caused by syndromes.}}
{{HealthStatus table row|symbol=X~|color=6:0:1|desc='''Partially broken tissue''' - The subject's skin or muscle is cut or torn open. Not necessarily an emergency.}}
{{HealthStatus table row|symbol=Pb!|color=6:0:1|desc='''Extreme pain''' - Not caused by injuries. Syndrome symptom?}}
{{HealthStatus table row|symbol=Pb+|color=6:0:1|desc='''Moderate pain''' - Not caused by injuries. Syndrome symptom?}}
{{HealthStatus table row|symbol=Pb~|color=6:0:1|desc='''Minor pain''' - Not caused by injuries. Syndrome symptom?}}
{{HealthStatus table row|symbol=Sw!|color=6:0:1|desc='''Extreme swelling''' - Typically caused by syndromes. Further impedes use of affected limbs and matures into necrosis. Swelling of the throat can cause suffocation.}}
{{HealthStatus table row|symbol=Sw+|color=6:0:1|desc='''Medium swelling''' - Typically caused by syndromes. Impedes use of affected limbs.}}
{{HealthStatus table row|symbol=Sw~|color=6:0:1|desc='''Minor swelling''' - Typically caused by syndromes. Slightly impedes use of affected limbs.}}
{{HealthStatus table row|symbol=In|color=5:0:1|desc='''Infection''' - Appears in open wounds either exposed to contaminated water or left untreated for too long. Cannot be treated. Subject's health attributes may affect survival rate?{{verify}}}}
|}

{{Category|Healthcare}}
{{Category|Interface}}

v0.34:Health screen

2012-06-07T23:33:53Z

AVK:

{{quality|Exceptional|23:31, 17 April 2011 (UTC)}}

In the status menu (accessed using the {{k|z}}-status key), one of the sub-menus is '''Health'''. This sub-menu becomes available when a dwarf is appointed to the [[Chief medical dwarf]] position. It does not display information unless the CMD is at least a novice [[diagnostician]]. 
The z-health menu is used to monitor the health of friendly dwarves. A subject dwarf's status effects and injuries are cataloged in the health menu by [[Healthcare|hospital staff]] upon diagnosis. Some basic needs are automatically shown in the menu whenever a dwarf becomes hungry, thirsty, or tired. Doctors will begin treating injured or otherwise unhealthy dwarves only after diagnosis and when proper equipment is available. 
Note: The screen is entirely mouse enabled. 

Listed below are all of the conditions displayed in the z-health screen:
===First Key Column===
This is the column that lists requests and requirements of the subject.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=D|color=2:0:1|desc='''Diagnosis request''' - [[Diagnostician]] needed to diagnose the subject}}
{{HealthStatus table row|symbol=≈|color=3:0:1|desc='''Cleaning request''' - Dwarf with a water bucket and cleaning labor enabled needed to bathe off contaminants, preferably using [[soap]] }}
{{HealthStatus table row|symbol=S|color=4:0:1|desc='''Surgery required''' - [[Surgeon]] needed to excise necrotic tissue or repair organ damage}}
{{HealthStatus table row|symbol=R|color=5:0:1|desc='''Inoperable Rot''' - [[Surgeon]] needed to amputate a necrotic limb}}
{{HealthStatus table row|symbol=Ø|color=7:0:1|desc='''Suture request''' - [[Suturer]] needed to repair cuts, wounds and nerve damage (!!) using thread}}
{{HealthStatus table row|symbol=B|color=6:0:1|desc='''Setting request''' - [[Bone doctor]] needed to set the subject's fractured bones}}
{{HealthStatus table row|symbol=<s>°</s>|color=7:0:1|desc='''Dressing request''' - [[Wound dresser]] needed to top off the medical procedure using cloth bandages}}
{{HealthStatus table row|symbol=T|color=6:0:1|desc='''Traction request''' - [[Traction bench]] needed to immobilize subject with overlapping fractures}}
{{HealthStatus table row|symbol=I|color=6:0:1|desc='''Immobilization request''' - [[Gypsum plaster|Cast]] (wound dresser) or [[splint]] (bone doctor) needed to stabilize a repaired fracture}}
{{HealthStatus table row|symbol=C|color=6:0:1|desc='''Crutch required''' - [[Crutch]] needed for the subject to walk}}
|}

===Second Key Column===
This column shows different degrees of bleeding, blood loss, numbness, and paralysis.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=B!+|color=4:0:1|desc='''Heavy bleeding''' - Subject is quickly losing blood through many wounds or torn arteries. This is an emergency.}}
{{HealthStatus table row|symbol=B!~|color=4:0:0|desc='''Bleeding''' - Subject is losing blood through a wound. Typically harmless due to dwarves' fast natural healing rate.}}
{{HealthStatus table row|symbol=Bl+|color=5:0:1|desc='''Severe Blood Loss''' - Subject is Pale. Caused by massive blood loss, typically from a severed limb. This is an emergency.}}
{{HealthStatus table row|symbol=Bl~|color=5:0:1|desc='''Blood Loss''' - Subject is Faint. Caused by moderate blood loss from wounds or necrosis.}}
{{HealthStatus table row|symbol=Pz+|color=3:0:1|desc='''Paralyzed''' - Subject is completely paralyzed. Common effect of upper spinal injury. Death by suffocation is imminent}}
{{HealthStatus table row|symbol=Pz~|color=3:0:1|desc='''Partially paralyzed''' - One or more limbs unusable due to severed nerves}}
{{HealthStatus table row|symbol=Slg|color=3:0:1|desc='''Sluggish''' - Characteristic of weak or lessening paralysis}}
{{HealthStatus table row|symbol=Nm+|color=3:0:1|desc='''Completely numb''' - Symptom of syndromes or sensory nerve damage. Eliminates pain sensation in affected areas and severely hampers motor ability. Protracted syndrome effects may cause permanent damage.}}
{{HealthStatus table row|symbol=Nm~|color=3:0:1|desc='''Partially numb''' - Symptom of syndromes or sensory nerve damage. Further reduces pain in affected areas and hampers fine motor ability.}}
{{HealthStatus table row|symbol=Nm-|color=3:0:1|desc='''Slightly numb''' - Symptom of syndromes or sensory nerve damage. Reduces pain in affected areas.}}
|}

===Third Key Column===
This column shows different degrees of pain, exhaustion and fever and also shows dizziness and whether the subject is stunned.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=F!|color=4:0:1|desc='''Serious fever''' - Reduces focus stat, may stun. Typical warning sign of more dangerous syndromes.}}
{{HealthStatus table row|symbol=F+|color=4:0:1|desc='''Moderate fever''' - Reduces focus stat. Typical warning sign of more dangerous syndromes.}}
{{HealthStatus table row|symbol=F~|color=4:0:1|desc='''Slight fever''' - Reduces focus stat. Relatively harmless.}}
{{HealthStatus table row|symbol=Dz|color=3:0:1|desc='''Dizzy''' - Common symptom of snakebite. Chance for subject to stumble in a random direction instead of performing an action, depending on severity.}}
{{HealthStatus table row|symbol=Pn!|color=6:0:1|desc='''Extreme pain''' - Bone fracture or a staggering number of surface wounds. Subject can't take any more and falls unconscious, giving into pain. Thresholds depend on subject's willpower stat.}}
{{HealthStatus table row|symbol=Pn+|color=6:0:1|desc='''Moderate pain''' - Serious, recent damage to muscle and/or fat. Interferes with actions?}}
{{HealthStatus table row|symbol=Pn~|color=6:0:1|desc='''Slight pain''' - Subject has suffered minor cuts or bruises.}}
{{HealthStatus table row|symbol=St|color=3:0:1|desc='''Stunned''' - The wind has been knocked out of the subject by an unexpected fall, impact, cave-in or takedown. Temporary and harmless in itself.}}
{{HealthStatus table row|symbol=Exh|color=6:0:1|desc='''Exhausted''' - Caused by taking too many combat actions in a turn?{{verify}}}}
{{HealthStatus table row|symbol=Ovx|color=6:0:1|desc='''Over-exerted''' - Caused by taking too many combat actions in a turn?{{verify}}}}
{{HealthStatus table row|symbol=Tir|color=6:0:1|desc='''Tired''' - Caused by taking too many combat actions in a turn?{{verify}}}}
|}

===Fourth Key Column===
This column shows breathing problems and various needs (including extreme like starvation and dehydration).
{{HealthStatus table head}}
{{HealthStatus table row|symbol=Dr|color=1:0:1|desc='''Drowning''' - Cannot breathe due to being stuck underwater. This is an emergency.}}
{{HealthStatus table row|symbol=Wd|color=7:0:0|desc='''Winded''' - Typical of punctured lungs. Comparison against breathing trouble needed.}}
{{HealthStatus table row|symbol=Br|color=4:0:1|desc='''Cannot breathe''' - Usually indicates severe lung injury or asphyxiation. Death is imminent unless one lung was injured a long time ago and will finish healing to the point of being able to breathe before subject dies.}}
{{HealthStatus table row|symbol=Br|color=7:0:0|desc='''Trouble breathing''' - Usually indicates lung injury or extreme exertion}}
{{HealthStatus table row|symbol=T!|color=4:0:1|desc='''Dehydrated''' - If the subject doesn't receive booze (or [[water]], if hospitalized) they will die. This is an emergency.}}
{{HealthStatus table row|symbol=T~|color=1:0:1|desc='''Thirsty'''}}
{{HealthStatus table row|symbol=H!|color=4:0:1|desc='''Starving''' - If the subject doesn't receive food they will die. This is an emergency.}}
{{HealthStatus table row|symbol=H~|color=6:0:0|desc='''Hungry'''}}
{{HealthStatus table row|symbol=Dw|color=4:0:1|desc='''Very drowsy''' - If the subject doesn't get sleep soon they will go [[insane]]. This is an emergency.}}
{{HealthStatus table row|symbol=Dw|color=1:0:1|desc='''Drowsy''' - Subject is tired enough to go to bed, but hasn't done so yet. Also caused by syndromes.}}
{{HealthStatus table row|symbol=Na|color=2:0:1|desc='''Nauseous''' - Symptom of cave adaptation or injury to the guts. The subject may stop and [[vomit]] instead of making an action. Excessive vomiting can cause dehydration.}}
|}

===Fifth Key Column===
This column shows vision and grasping impairment, problems with nerves, and being unable to stand or fly.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=V|color=4:0:1|desc='''Vision lost''' - Subject will have a very hard time completing normal tasks}}
{{HealthStatus table row|symbol=V|color=6:0:1|desc='''Vision impaired''' - Subject will have a hard time completing normal tasks}}
{{HealthStatus table row|symbol=V|color=7:0:0|desc='''Vision ~impaired''' - Subject will have a slightly hard time completing normal tasks. Caused naturally by old age (110+ with dwarves).}}
{{HealthStatus table row|symbol=P|color=2:0:1|desc='''Popped out''' - Subject's intestines have popped out. Death is imminent.}}
{{HealthStatus table row|symbol=Sx|color=6:0:1|desc='''Cannot stand''' - Subject can only crawl due to dismemberment or lower body paralysis. Subject needs a [[crutch]] to stand or walk.}}
{{HealthStatus table row|symbol=S~|color=6:0:1|desc='''Stand impaired''' - Subject has trouble standing due to numbness or injury to the legs. Subject might need a crutch? {{verify}}}}
{{HealthStatus table row|symbol=Gx|color=6:0:1|desc='''Cannot grasp''' - Subject cannot manipulate objects due to dismemberment or paralysis.}}
{{HealthStatus table row|symbol=G~|color=6:0:1|desc='''Grasp impaired''' - Subject has trouble with fine motor control, but can still grasp things. Typically caused by injury or numbness.}}
{{HealthStatus table row|symbol=Fx|color=6:0:1|desc='''Cannot fly''' - Subject can no longer fly due to paralysis or injury. Applied only to former flyers.}}
{{HealthStatus table row|symbol=F~|color=6:0:1|desc='''Flight impaired''' - Subject has trouble flying due to injury. Applied only to flyers.}}
{{HealthStatus table row|symbol=Mn|color=3:0:1|desc='''Motor nerve''' - A motor nerve has been damaged, which can affect the subject's ability to move, stand, or fly}}
{{HealthStatus table row|symbol=Sn|color=3:0:1|desc='''Sensory nerve''' - A sensory nerve has been damaged, which can affect the subject's ability to feel sensations, to see, and to breathe{{verify}}}}
|}

===Sixth Key Column===
This column shows torn arteries, tendons and ligaments along with fractures and bruising.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=A!|color=4:0:1|desc='''Major artery torn''' - Heart injury or torn throat. This is invariably fatal.}}
{{HealthStatus table row|symbol=A+|color=4:0:1|desc='''Artery torn''' - Subject will probably suffer bleeding of some type. This can be an emergency.}}
{{HealthStatus table row|symbol=Of|color=4:0:1|desc='''Overlapping fracture''' - A widely displaced limb fracture in real life, seems only to represent extreme damage ingame. Cannot be set without a traction bench.}}
{{HealthStatus table row|symbol=Cf|color=4:0:1|desc='''Compound fracture''' - A fracture that has also broken a tissue directly subordinate to the bone, such as fingernails or spinal nerves. Tissues torn by bone fragments jammed through them also count.}}
{{HealthStatus table row|symbol=Tn|color=4:0:1|desc='''Torn tendon''' - Muscle is severed from the bone. Causes severe pain and disables limb?{{verify}}}}
{{HealthStatus table row|symbol=Tn|color=6:0:1|desc='''Tendon strain''' - Muscle damage. Causes pain and limits movement?{{verify}}}}
{{HealthStatus table row|symbol=Tn|color=6:0:0|desc='''Tendon bruise''' - Slight muscle damage.}}
{{HealthStatus table row|symbol=Lg|color=4:0:1|desc='''Torn ligament''' - Broken joint. Causes severe pain and disables limb?{{verify}}}}
{{HealthStatus table row|symbol=Lg|color=6:0:1|desc='''Ligament strain''' - Joint damage. Causes pain and limits movement? {{verify}}}}
{{HealthStatus table row|symbol=Lg|color=6:0:0|desc='''Ligament bruise''' - Slight joint damage.}}
{{HealthStatus table row|symbol=Ns|color=6:0:1|desc='''Need setting''' - A [[bone doctor]] is needed to treat injuries}}
|}

===Seventh Key Column===
This column shows broken tissue, different degrees of pain, damage and swelling, and whether the subject has an infection.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=X!|color=4:0:1|desc='''Broken tissue'''}}
{{HealthStatus table row|symbol=D!|color=4:0:1|desc='''Heavy damage''' - Typical amount of bruising sustained in combat. Also caused by syndromes.}}
{{HealthStatus table row|symbol=D+|color=6:0:1|desc='''Moderate damage''' - Varying degrees of bruising. Typically caused by syndromes.}}
{{HealthStatus table row|symbol=D~|color=6:0:0|desc='''Light damage''' - Varying degrees of bruising. Typically caused by syndromes.}}
{{HealthStatus table row|symbol=X~|color=6:0:1|desc='''Partially broken tissue''' - The subject's skin or muscle is cut or torn open. Not necessarily an emergency.}}
{{HealthStatus table row|symbol=Pb!|color=6:0:1|desc='''Extreme pain''' - Not caused by injuries. Syndrome symptom?}}
{{HealthStatus table row|symbol=Pb+|color=6:0:1|desc='''Moderate pain''' - Not caused by injuries. Syndrome symptom?}}
{{HealthStatus table row|symbol=Pb~|color=6:0:1|desc='''Minor pain''' - Not caused by injuries. Syndrome symptom?}}
{{HealthStatus table row|symbol=Sw!|color=6:0:1|desc='''Extreme swelling''' - Typically caused by syndromes. Further impedes use of affected limbs and matures into necrosis. Swelling of the throat can cause suffocation.}}
{{HealthStatus table row|symbol=Sw+|color=6:0:1|desc='''Medium swelling''' - Typically caused by syndromes. Impedes use of affected limbs.}}
{{HealthStatus table row|symbol=Sw~|color=6:0:1|desc='''Minor swelling''' - Typically caused by syndromes. Slightly impedes use of affected limbs.}}
{{HealthStatus table row|symbol=In|color=5:0:1|desc='''Infection''' - Appears in open wounds either exposed to contaminated water or left untreated for too long. Cannot be treated. Subject's health attributes may affect survival rate?{{verify}}}}
|}

{{Category|Healthcare}}
{{Category|Interface}}

v0.34:Health screen

2012-06-07T23:32:28Z

AVK: Overlapping breaks don't match up with real life either? Well I'll be.

{{quality|Exceptional|23:31, 17 April 2011 (UTC)}}

In the status menu (accessed using the {{k|z}}-status key), one of the sub-menus is '''Health'''. This sub-menu becomes available when a dwarf is appointed to the [[Chief medical dwarf]] position. It does not display information unless the CMD is at least a novice [[diagnostician]]. 
The z-health menu is used to monitor the health of friendly dwarves. A subject dwarf's status effects and injuries are cataloged in the health menu by [[Healthcare|hospital staff]] upon diagnosis. Some basic needs are automatically shown in the menu whenever a dwarf becomes hungry, thirsty, or tired. Doctors will begin treating injured or otherwise unhealthy dwarves only after diagnosis and when proper equipment is available. 
Note: The screen is entirely mouse enabled. 

Listed below are all of the conditions displayed in the z-health screen:
===First Key Column===
This is the column that lists requests and requirements of the subject.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=D|color=2:0:1|desc='''Diagnosis request''' - [[Diagnostician]] needed to diagnose the subject}}
{{HealthStatus table row|symbol=≈|color=3:0:1|desc='''Cleaning request''' - Dwarf with a water bucket and cleaning labor enabled needed to bathe off contaminants, preferably using [[soap]] }}
{{HealthStatus table row|symbol=S|color=4:0:1|desc='''Surgery required''' - [[Surgeon]] needed to excise necrotic tissue or repair organ damage}}
{{HealthStatus table row|symbol=R|color=5:0:1|desc='''Inoperable Rot''' - [[Surgeon]] needed to amputate a necrotic limb}}
{{HealthStatus table row|symbol=Ø|color=7:0:1|desc='''Suture request''' - [[Suturer]] needed to repair cuts, wounds and nerve damage (!!) using thread}}
{{HealthStatus table row|symbol=B|color=6:0:1|desc='''Setting request''' - [[Bone doctor]] needed to set the subject's fractured bones}}
{{HealthStatus table row|symbol=<s>°</s>|color=7:0:1|desc='''Dressing request''' - [[Wound dresser]] needed to top off the medical procedure using cloth bandages}}
{{HealthStatus table row|symbol=T|color=6:0:1|desc='''Traction request''' - [[Traction bench]] needed to immobilize subject with overlapping fractures}}
{{HealthStatus table row|symbol=I|color=6:0:1|desc='''Immobilization request''' - [[Gypsum plaster|Cast]] (wound dresser) or [[splint]] (bone doctor) needed to stabilize a repaired fracture}}
{{HealthStatus table row|symbol=C|color=6:0:1|desc='''Crutch required''' - [[Crutch]] needed for the subject to walk}}
|}

===Second Key Column===
This column shows different degrees of bleeding, blood loss, numbness, and paralysis.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=B!+|color=4:0:1|desc='''Heavy bleeding''' - Subject is quickly losing blood through many wounds or torn arteries. This is an emergency.}}
{{HealthStatus table row|symbol=B!~|color=4:0:0|desc='''Bleeding''' - Subject is losing blood through a wound. Typically harmless due to dwarves' fast natural healing rate.}}
{{HealthStatus table row|symbol=Bl+|color=5:0:1|desc='''Severe Blood Loss''' - Subject is Pale. Caused by massive blood loss, typically from a severed limb. This is an emergency.}}
{{HealthStatus table row|symbol=Bl~|color=5:0:1|desc='''Blood Loss''' - Subject is Faint. Caused by moderate blood loss from wounds or necrosis.}}
{{HealthStatus table row|symbol=Pz+|color=3:0:1|desc='''Paralyzed''' - Subject is completely paralyzed. Common effect of upper spinal injury. Death by suffocation is imminent}}
{{HealthStatus table row|symbol=Pz~|color=3:0:1|desc='''Partially paralyzed''' - One or more limbs unusable due to severed nerves}}
{{HealthStatus table row|symbol=Slg|color=3:0:1|desc='''Sluggish''' - Characteristic of weak or lessening paralysis}}
{{HealthStatus table row|symbol=Nm+|color=3:0:1|desc='''Completely numb''' - Symptom of syndromes or sensory nerve damage. Eliminates pain sensation in affected areas and severely hampers motor ability. Protracted syndrome effects may cause permanent damage.}}
{{HealthStatus table row|symbol=Nm~|color=3:0:1|desc='''Partially numb''' - Symptom of syndromes or sensory nerve damage. Further reduces pain in affected areas and hampers fine motor ability.}}
{{HealthStatus table row|symbol=Nm-|color=3:0:1|desc='''Slightly numb''' - Symptom of syndromes or sensory nerve damage. Reduces pain in affected areas.}}
|}

===Third Key Column===
This column shows different degrees of pain, exhaustion and fever and also shows dizziness and whether the subject is stunned.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=F!|color=4:0:1|desc='''Serious fever''' - Reduces focus stat, may stun. Typical warning sign of more dangerous syndromes.}}
{{HealthStatus table row|symbol=F+|color=4:0:1|desc='''Moderate fever''' - Reduces focus stat. Typical warning sign of more dangerous syndromes.}}
{{HealthStatus table row|symbol=F~|color=4:0:1|desc='''Slight fever''' - Reduces focus stat. Relatively harmless.}}
{{HealthStatus table row|symbol=Dz|color=3:0:1|desc='''Dizzy''' - Common symptom of snakebite. Chance for subject to stumble in a random direction instead of performing an action, depending on severity.}}
{{HealthStatus table row|symbol=Pn!|color=6:0:1|desc='''Extreme pain''' - Bone fracture or a staggering number of surface wounds. Subject can't take any more and falls unconscious, giving into pain. Thresholds depend on subject's willpower stat.}}
{{HealthStatus table row|symbol=Pn+|color=6:0:1|desc='''Moderate pain''' - Serious, recent damage to muscle and/or fat. Interferes with actions?}}
{{HealthStatus table row|symbol=Pn~|color=6:0:1|desc='''Slight pain''' - Subject has suffered minor cuts or bruises.}}
{{HealthStatus table row|symbol=St|color=3:0:1|desc='''Stunned''' - The wind has been knocked out of the subject by an unexpected fall, impact, cave-in or takedown. Temporary and harmless in itself.}}
{{HealthStatus table row|symbol=Exh|color=6:0:1|desc='''Exhausted''' - Caused by taking too many combat actions in a turn?{{verify}}}}
{{HealthStatus table row|symbol=Ovx|color=6:0:1|desc='''Over-exerted''' - Caused by taking too many combat actions in a turn?{{verify}}}}
{{HealthStatus table row|symbol=Tir|color=6:0:1|desc='''Tired''' - Caused by taking too many combat actions in a turn?{{verify}}}}
|}

===Fourth Key Column===
This column shows breathing problems and various needs (including extreme like starvation and dehydration).
{{HealthStatus table head}}
{{HealthStatus table row|symbol=Dr|color=1:0:1|desc='''Drowning''' - Cannot breathe due to being stuck underwater. This is an emergency.}}
{{HealthStatus table row|symbol=Wd|color=7:0:0|desc='''Winded''' - Typical of punctured lungs. Comparison against breathing trouble needed.}}
{{HealthStatus table row|symbol=Br|color=4:0:1|desc='''Cannot breathe''' - Usually indicates severe lung injury or asphyxiation. Death is imminent unless one lung was injured a long time ago and will finish healing to the point of being able to breathe before subject dies.}}
{{HealthStatus table row|symbol=Br|color=7:0:0|desc='''Trouble breathing''' - Usually indicates lung injury or extreme exertion}}
{{HealthStatus table row|symbol=T!|color=4:0:1|desc='''Dehydrated''' - If the subject doesn't receive booze (or [[water]], if hospitalized) they will die. This is an emergency.}}
{{HealthStatus table row|symbol=T~|color=1:0:1|desc='''Thirsty'''}}
{{HealthStatus table row|symbol=H!|color=4:0:1|desc='''Starving''' - If the subject doesn't receive food they will die. This is an emergency.}}
{{HealthStatus table row|symbol=H~|color=6:0:0|desc='''Hungry'''}}
{{HealthStatus table row|symbol=Dw|color=4:0:1|desc='''Very drowsy''' - If the subject doesn't get sleep soon they will go [[insane]]. This is an emergency.}}
{{HealthStatus table row|symbol=Dw|color=1:0:1|desc='''Drowsy''' - Subject is tired enough to go to bed, but hasn't done so yet. Also caused by syndromes.}}
{{HealthStatus table row|symbol=Na|color=2:0:1|desc='''Nauseous''' - Symptom of cave adaptation or injury to the guts. The subject may stop and [[vomit]] instead of making an action. Excessive vomiting can cause dehydration.}}
|}

===Fifth Key Column===
This column shows vision and grasping impairment, problems with nerves, and being unable to stand or fly.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=V|color=4:0:1|desc='''Vision lost''' - Subject will have a very hard time completing normal tasks}}
{{HealthStatus table row|symbol=V|color=6:0:1|desc='''Vision impaired''' - Subject will have a hard time completing normal tasks}}
{{HealthStatus table row|symbol=V|color=7:0:0|desc='''Vision ~impaired''' - Subject will have a slightly hard time completing normal tasks. Caused naturally by old age (110+ with dwarves).}}
{{HealthStatus table row|symbol=P|color=2:0:1|desc='''Popped out''' - Subject's intestines have popped out. Death is imminent.}}
{{HealthStatus table row|symbol=Sx|color=6:0:1|desc='''Cannot stand''' - Subject can only crawl due to dismemberment or lower body paralysis. Subject needs a [[crutch]] to stand or walk.}}
{{HealthStatus table row|symbol=S~|color=6:0:1|desc='''Stand impaired''' - Subject has trouble standing due to numbness or injury to the legs. Subject might need a crutch? {{verify}}}}
{{HealthStatus table row|symbol=Gx|color=6:0:1|desc='''Cannot grasp''' - Subject cannot manipulate objects due to dismemberment or paralysis.}}
{{HealthStatus table row|symbol=G~|color=6:0:1|desc='''Grasp impaired''' - Subject has trouble with fine motor control, but can still grasp things. Typically caused by injury or numbness.}}
{{HealthStatus table row|symbol=Fx|color=6:0:1|desc='''Cannot fly''' - Subject can no longer fly due to paralysis or injury. Applied only to former flyers.}}
{{HealthStatus table row|symbol=F~|color=6:0:1|desc='''Flight impaired''' - Subject has trouble flying due to injury. Applied only to flyers.}}
{{HealthStatus table row|symbol=Mn|color=3:0:1|desc='''Motor nerve''' - A motor nerve has been damaged, which can affect the subject's ability to move, stand, or fly}}
{{HealthStatus table row|symbol=Sn|color=3:0:1|desc='''Sensory nerve''' - A sensory nerve has been damaged, which can affect the subject's ability to feel sensations, to see, and to breathe{{verify}}}}
|}

===Sixth Key Column===
This column shows torn arteries, tendons and ligaments along with fractures and bruising.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=A!|color=4:0:1|desc='''Major artery torn''' - Heart injury or torn throat. This is invariably fatal.}}
{{HealthStatus table row|symbol=A+|color=4:0:1|desc='''Artery torn''' - Subject will probably suffer bleeding of some type. This can be an emergency.}}
{{HealthStatus table row|symbol=Of|color=4:0:1|desc='''Overlapping fracture''' - A widely displaced limb fracture in real life, seems only to represent extreme damage ingame. Cannot be set without a traction bench.}}
{{HealthStatus table row|symbol=Cf|color=4:0:1|desc='''Compound fracture''' - A fracture that has also broken a tissue directly subordinate to the bone, such as fingernails or spinal nerves.}}
{{HealthStatus table row|symbol=Tn|color=4:0:1|desc='''Torn tendon''' - Muscle is severed from the bone. Causes severe pain and disables limb?{{verify}}}}
{{HealthStatus table row|symbol=Tn|color=6:0:1|desc='''Tendon strain''' - Muscle damage. Causes pain and limits movement?{{verify}}}}
{{HealthStatus table row|symbol=Tn|color=6:0:0|desc='''Tendon bruise''' - Slight muscle damage.}}
{{HealthStatus table row|symbol=Lg|color=4:0:1|desc='''Torn ligament''' - Broken joint. Causes severe pain and disables limb?{{verify}}}}
{{HealthStatus table row|symbol=Lg|color=6:0:1|desc='''Ligament strain''' - Joint damage. Causes pain and limits movement? {{verify}}}}
{{HealthStatus table row|symbol=Lg|color=6:0:0|desc='''Ligament bruise''' - Slight joint damage.}}
{{HealthStatus table row|symbol=Ns|color=6:0:1|desc='''Need setting''' - A [[bone doctor]] is needed to treat injuries}}
|}

===Seventh Key Column===
This column shows broken tissue, different degrees of pain, damage and swelling, and whether the subject has an infection.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=X!|color=4:0:1|desc='''Broken tissue'''}}
{{HealthStatus table row|symbol=D!|color=4:0:1|desc='''Heavy damage''' - Typical amount of bruising sustained in combat. Also caused by syndromes.}}
{{HealthStatus table row|symbol=D+|color=6:0:1|desc='''Moderate damage''' - Varying degrees of bruising. Typically caused by syndromes.}}
{{HealthStatus table row|symbol=D~|color=6:0:0|desc='''Light damage''' - Varying degrees of bruising. Typically caused by syndromes.}}
{{HealthStatus table row|symbol=X~|color=6:0:1|desc='''Partially broken tissue''' - The subject's skin or muscle is cut or torn open. Not necessarily an emergency.}}
{{HealthStatus table row|symbol=Pb!|color=6:0:1|desc='''Extreme pain''' - Not caused by injuries. Syndrome symptom?}}
{{HealthStatus table row|symbol=Pb+|color=6:0:1|desc='''Moderate pain''' - Not caused by injuries. Syndrome symptom?}}
{{HealthStatus table row|symbol=Pb~|color=6:0:1|desc='''Minor pain''' - Not caused by injuries. Syndrome symptom?}}
{{HealthStatus table row|symbol=Sw!|color=6:0:1|desc='''Extreme swelling''' - Typically caused by syndromes. Further impedes use of affected limbs and matures into necrosis. Swelling of the throat can cause suffocation.}}
{{HealthStatus table row|symbol=Sw+|color=6:0:1|desc='''Medium swelling''' - Typically caused by syndromes. Impedes use of affected limbs.}}
{{HealthStatus table row|symbol=Sw~|color=6:0:1|desc='''Minor swelling''' - Typically caused by syndromes. Slightly impedes use of affected limbs.}}
{{HealthStatus table row|symbol=In|color=5:0:1|desc='''Infection''' - Appears in open wounds either exposed to contaminated water or left untreated for too long. Cannot be treated. Subject's health attributes may affect survival rate?{{verify}}}}
|}

{{Category|Healthcare}}
{{Category|Interface}}

v0.34:Health screen

2012-05-19T07:25:28Z

AVK: Compound fractures work different from real life, it seems. Also changed a few things.

{{quality|Exceptional|23:31, 17 April 2011 (UTC)}}

In the status menu (accessed using the {{k|z}}-status key), one of the sub-menus is '''Health'''. This sub-menu becomes available when a dwarf is appointed to the [[Chief medical dwarf]] position. It does not display information unless the CMD is at least a novice [[diagnostician]]. 
The z-health menu is used to monitor the health of friendly dwarves. A subject dwarf's status effects and injuries are cataloged in the health menu by [[Healthcare|hospital staff]] upon diagnosis. Some basic needs are automatically shown in the menu whenever a dwarf becomes hungry, thirsty, or tired. Doctors will begin treating injured or otherwise unhealthy dwarves only after diagnosis and when proper equipment is available. 
Note: The screen is entirely mouse enabled. 

Listed below are all of the conditions displayed in the z-health screen:
===First Key Column===
This is the column that lists requests and requirements of the subject.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=D|color=2:0:1|desc='''Diagnosis request''' - [[Diagnostician]] needed to diagnose the subject}}
{{HealthStatus table row|symbol=≈|color=3:0:1|desc='''Cleaning request''' - Dwarf with a water bucket and cleaning labor enabled needed to bathe off contaminants, preferably using [[soap]] }}
{{HealthStatus table row|symbol=S|color=4:0:1|desc='''Surgery required''' - [[Surgeon]] needed to excise necrotic tissue or repair organ damage}}
{{HealthStatus table row|symbol=R|color=5:0:1|desc='''Inoperable Rot''' - [[Surgeon]] needed to amputate a necrotic limb}}
{{HealthStatus table row|symbol=Ø|color=7:0:1|desc='''Suture request''' - [[Suturer]] needed to repair cuts, wounds and nerve damage (!!) using thread}}
{{HealthStatus table row|symbol=B|color=6:0:1|desc='''Setting request''' - [[Bone doctor]] needed to set the subject's fractured bones}}
{{HealthStatus table row|symbol=<s>°</s>|color=7:0:1|desc='''Dressing request''' - [[Wound dresser]] needed to top off the medical procedure using cloth bandages}}
{{HealthStatus table row|symbol=T|color=6:0:1|desc='''Traction request''' - [[Traction bench]] needed to immobilize subject with overlapping fractures}}
{{HealthStatus table row|symbol=I|color=6:0:1|desc='''Immobilization request''' - [[Gypsum plaster|Cast]] (wound dresser) or [[splint]] (bone doctor) needed to stabilize a repaired fracture}}
{{HealthStatus table row|symbol=C|color=6:0:1|desc='''Crutch required''' - [[Crutch]] needed for the subject to walk}}
|}

===Second Key Column===
This column shows different degrees of bleeding, blood loss, numbness, and paralysis.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=B!+|color=4:0:1|desc='''Heavy bleeding''' - Subject is quickly losing blood through many wounds or torn arteries. This is an emergency.}}
{{HealthStatus table row|symbol=B!~|color=4:0:0|desc='''Bleeding''' - Subject is losing blood through a wound. Typically harmless due to dwarves' fast natural healing rate.}}
{{HealthStatus table row|symbol=Bl+|color=5:0:1|desc='''Severe Blood Loss''' - Subject is Pale. Caused by massive blood loss, typically from a severed limb. This is an emergency.}}
{{HealthStatus table row|symbol=Bl~|color=5:0:1|desc='''Blood Loss''' - Subject is Faint. Caused by moderate blood loss from wounds or necrosis.}}
{{HealthStatus table row|symbol=Pz+|color=3:0:1|desc='''Paralyzed''' - Subject is completely paralyzed. Common effect of upper spinal injury. Death by suffocation is imminent}}
{{HealthStatus table row|symbol=Pz~|color=3:0:1|desc='''Partially paralyzed''' - One or more limbs unusable due to severed nerves}}
{{HealthStatus table row|symbol=Slg|color=3:0:1|desc='''Sluggish''' - Characteristic of weak or lessening paralysis}}
{{HealthStatus table row|symbol=Nm+|color=3:0:1|desc='''Completely numb''' - Symptom of syndromes or sensory nerve damage. Eliminates pain sensation in affected areas and severely hampers motor ability. Protracted syndrome effects may cause permanent damage.}}
{{HealthStatus table row|symbol=Nm~|color=3:0:1|desc='''Partially numb''' - Symptom of syndromes or sensory nerve damage. Further reduces pain in affected areas and hampers fine motor ability.}}
{{HealthStatus table row|symbol=Nm-|color=3:0:1|desc='''Slightly numb''' - Symptom of syndromes or sensory nerve damage. Reduces pain in affected areas.}}
|}

===Third Key Column===
This column shows different degrees of pain, exhaustion and fever and also shows dizziness and whether the subject is stunned.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=F!|color=4:0:1|desc='''Serious fever''' - Reduces focus stat, may stun. Typical warning sign of more dangerous syndromes.}}
{{HealthStatus table row|symbol=F+|color=4:0:1|desc='''Moderate fever''' - Reduces focus stat. Typical warning sign of more dangerous syndromes.}}
{{HealthStatus table row|symbol=F~|color=4:0:1|desc='''Slight fever''' - Reduces focus stat. Relatively harmless.}}
{{HealthStatus table row|symbol=Dz|color=3:0:1|desc='''Dizzy''' - Common symptom of snakebite. Chance for subject to stumble in a random direction instead of performing an action, depending on severity.}}
{{HealthStatus table row|symbol=Pn!|color=6:0:1|desc='''Extreme pain''' - Bone fracture or a staggering number of surface wounds. Subject can't take any more and falls unconscious, giving into pain. Thresholds depend on subject's willpower stat.}}
{{HealthStatus table row|symbol=Pn+|color=6:0:1|desc='''Moderate pain''' - Serious, recent damage to muscle and/or fat. Interferes with actions?}}
{{HealthStatus table row|symbol=Pn~|color=6:0:1|desc='''Slight pain''' - Subject has suffered minor cuts or bruises.}}
{{HealthStatus table row|symbol=St|color=3:0:1|desc='''Stunned''' - The wind has been knocked out of the subject by an unexpected fall, impact, cave-in or takedown. Temporary and harmless in itself.}}
{{HealthStatus table row|symbol=Exh|color=6:0:1|desc='''Exhausted''' - Caused by taking too many combat actions in a turn?{{verify}}}}
{{HealthStatus table row|symbol=Ovx|color=6:0:1|desc='''Over-exerted''' - Caused by taking too many combat actions in a turn?{{verify}}}}
{{HealthStatus table row|symbol=Tir|color=6:0:1|desc='''Tired''' - Caused by taking too many combat actions in a turn?{{verify}}}}
|}

===Fourth Key Column===
This column shows breathing problems and various needs (including extreme like starvation and dehydration).
{{HealthStatus table head}}
{{HealthStatus table row|symbol=Dr|color=1:0:1|desc='''Drowning''' - Cannot breathe due to being stuck underwater. This is an emergency.}}
{{HealthStatus table row|symbol=Wd|color=7:0:0|desc='''Winded''' - Typical of punctured lungs. Comparison against breathing trouble needed.}}
{{HealthStatus table row|symbol=Br|color=4:0:1|desc='''Cannot breathe''' - Usually indicates severe lung injury or asphyxiation. Death is imminent unless one lung was injured a long time ago and will finish healing to the point of being able to breathe before subject dies.}}
{{HealthStatus table row|symbol=Br|color=7:0:0|desc='''Trouble breathing''' - Usually indicates lung injury or extreme exertion}}
{{HealthStatus table row|symbol=T!|color=4:0:1|desc='''Dehydrated''' - If the subject doesn't receive booze (or [[water]], if hospitalized) they will die. This is an emergency.}}
{{HealthStatus table row|symbol=T~|color=1:0:1|desc='''Thirsty'''}}
{{HealthStatus table row|symbol=H!|color=4:0:1|desc='''Starving''' - If the subject doesn't receive food they will die. This is an emergency.}}
{{HealthStatus table row|symbol=H~|color=6:0:0|desc='''Hungry'''}}
{{HealthStatus table row|symbol=Dw|color=4:0:1|desc='''Very drowsy''' - If the subject doesn't get sleep soon they will go [[insane]]. This is an emergency.}}
{{HealthStatus table row|symbol=Dw|color=1:0:1|desc='''Drowsy''' - Subject is tired enough to go to bed, but hasn't done so yet. Also caused by syndromes.}}
{{HealthStatus table row|symbol=Na|color=2:0:1|desc='''Nauseous''' - Symptom of cave adaptation or injury to the guts. The subject may stop and [[vomit]] instead of making an action. Excessive vomiting can cause dehydration.}}
|}

===Fifth Key Column===
This column shows vision and grasping impairment, problems with nerves, and being unable to stand or fly.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=V|color=4:0:1|desc='''Vision lost''' - Subject will have a very hard time completing normal tasks}}
{{HealthStatus table row|symbol=V|color=6:0:1|desc='''Vision impaired''' - Subject will have a hard time completing normal tasks}}
{{HealthStatus table row|symbol=V|color=7:0:0|desc='''Vision ~impaired''' - Subject will have a slightly hard time completing normal tasks. Caused naturally by old age (110+ with dwarves).}}
{{HealthStatus table row|symbol=P|color=2:0:1|desc='''Popped out''' - Subject's intestines have popped out. Death is imminent.}}
{{HealthStatus table row|symbol=Sx|color=6:0:1|desc='''Cannot stand''' - Subject can only crawl due to dismemberment or lower body paralysis. Subject needs a [[crutch]] to stand or walk.}}
{{HealthStatus table row|symbol=S~|color=6:0:1|desc='''Stand impaired''' - Subject has trouble standing due to numbness or injury to the legs. Subject might need a crutch? {{verify}}}}
{{HealthStatus table row|symbol=Gx|color=6:0:1|desc='''Cannot grasp''' - Subject cannot manipulate objects due to dismemberment or paralysis.}}
{{HealthStatus table row|symbol=G~|color=6:0:1|desc='''Grasp impaired''' - Subject has trouble with fine motor control, but can still grasp things. Typically caused by injury or numbness.}}
{{HealthStatus table row|symbol=Fx|color=6:0:1|desc='''Cannot fly''' - Subject can no longer fly due to paralysis or injury. Applied only to former flyers.}}
{{HealthStatus table row|symbol=F~|color=6:0:1|desc='''Flight impaired''' - Subject has trouble flying due to injury. Applied only to flyers.}}
{{HealthStatus table row|symbol=Mn|color=3:0:1|desc='''Motor nerve''' - A motor nerve has been damaged, which can affect the subject's ability to move, stand, or fly}}
{{HealthStatus table row|symbol=Sn|color=3:0:1|desc='''Sensory nerve''' - A sensory nerve has been damaged, which can affect the subject's ability to feel sensations, to see, and to breathe{{verify}}}}
|}

===Sixth Key Column===
This column shows torn arteries, tendons and ligaments along with fractures and bruising.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=A!|color=4:0:1|desc='''Major artery torn''' - Heart injury or torn throat. This is invariably fatal.}}
{{HealthStatus table row|symbol=A+|color=4:0:1|desc='''Artery torn''' - Subject will probably suffer bleeding of some type. This can be an emergency.}}
{{HealthStatus table row|symbol=Of|color=4:0:1|desc='''Overlapping fracture''' - Typically a limb fracture with severely displaced fragments. A traction bench may be required to reconnect the bones.}}
{{HealthStatus table row|symbol=Cf|color=4:0:1|desc='''Compound fracture''' - A fracture that has also broken a tissue directly subordinate to the bone, such as fingernails or spinal nerves.}}
{{HealthStatus table row|symbol=Tn|color=4:0:1|desc='''Torn tendon''' - Muscle is severed from the bone. Causes severe pain and disables limb?{{verify}}}}
{{HealthStatus table row|symbol=Tn|color=6:0:1|desc='''Tendon strain''' - Muscle damage. Causes pain and limits movement?{{verify}}}}
{{HealthStatus table row|symbol=Tn|color=6:0:0|desc='''Tendon bruise''' - Slight muscle damage.}}
{{HealthStatus table row|symbol=Lg|color=4:0:1|desc='''Torn ligament''' - Broken joint. Causes severe pain and disables limb?{{verify}}}}
{{HealthStatus table row|symbol=Lg|color=6:0:1|desc='''Ligament strain''' - Joint damage. Causes pain and limits movement? {{verify}}}}
{{HealthStatus table row|symbol=Lg|color=6:0:0|desc='''Ligament bruise''' - Slight joint damage.}}
{{HealthStatus table row|symbol=Ns|color=6:0:1|desc='''Need setting''' - A [[bone doctor]] is needed to treat injuries}}
|}

===Seventh Key Column===
This column shows broken tissue, different degrees of pain, damage and swelling, and whether the subject has an infection.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=X!|color=4:0:1|desc='''Broken tissue'''}}
{{HealthStatus table row|symbol=D!|color=4:0:1|desc='''Heavy damage''' - Typical amount of bruising sustained in combat. Also caused by syndromes.}}
{{HealthStatus table row|symbol=D+|color=6:0:1|desc='''Moderate damage''' - Varying degrees of bruising. Typically caused by syndromes.}}
{{HealthStatus table row|symbol=D~|color=6:0:0|desc='''Light damage''' - Varying degrees of bruising. Typically caused by syndromes.}}
{{HealthStatus table row|symbol=X~|color=6:0:1|desc='''Partially broken tissue''' - The subject's skin or muscle is cut or torn open. Not necessarily an emergency.}}
{{HealthStatus table row|symbol=Pb!|color=6:0:1|desc='''Extreme pain''' - Not caused by injuries. Syndrome symptom?}}
{{HealthStatus table row|symbol=Pb+|color=6:0:1|desc='''Moderate pain''' - Not caused by injuries. Syndrome symptom?}}
{{HealthStatus table row|symbol=Pb~|color=6:0:1|desc='''Minor pain''' - Not caused by injuries. Syndrome symptom?}}
{{HealthStatus table row|symbol=Sw!|color=6:0:1|desc='''Extreme swelling''' - Typically caused by syndromes. Further impedes use of affected limbs and matures into necrosis. Swelling of the throat can cause suffocation.}}
{{HealthStatus table row|symbol=Sw+|color=6:0:1|desc='''Medium swelling''' - Typically caused by syndromes. Impedes use of affected limbs.}}
{{HealthStatus table row|symbol=Sw~|color=6:0:1|desc='''Minor swelling''' - Typically caused by syndromes. Slightly impedes use of affected limbs.}}
{{HealthStatus table row|symbol=In|color=5:0:1|desc='''Infection''' - Appears in open wounds either exposed to contaminated water or left untreated for too long. Cannot be treated. Subject's health attributes may affect survival rate?{{verify}}}}
|}

{{Category|Healthcare}}
{{Category|Interface}}

v0.34:Tanner's shop

2012-05-16T00:04:20Z

AVK: Fixed in 34.xsomething.

{{Quality|Exceptional|19:15, 25 June 2010 (UTC)}}{{Workshop|name=Tanner's shop|key=n|job=Tanning
|construction=
* [[Building material]] (non-[[economic]])
|construction_job=
* [[Tanner|Tanning]]
|use=
* [[Skin|Hide]]
|production=
* [[Leather]]
}}{{av}}

A '''tanner's shop''' is used to make [[leather]] from a [[Butcher's shop|butchered]] animal skin. A tanner's shop is operated by any dwarf with the 'tanning' [[labor]] enabled.

==Menu==
'''Tanner's Shop'''

*{{k|t}} Tan a hide.

==Notes==
*The 'tan a hide' job is automatically triggered after the game notices that there is a skin to be tanned within a certain distance of the tanner's shop. The player can turn off this behaviour by going into the {{K|o}}rders menu, choosing {{K|W}}orkshop Orders, and then turning Auto {{K|t}}an off.
*If you have turned Auto Tan off, your [[manager]] ({{K|u}}nits, {{K|m}}anager) can manually queue "Tan a Hide" jobs. This is also useful if for some reason Auto Tan ignores a skin.

{{Workshops}}

v0.34:Wood

2012-05-14T15:50:15Z

AVK:

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

'''Wood''' is produced by [[designation|{{Key|d}}esignating]] [[tree|{{Key|t}}rees]] to be chopped down. Any [[dwarf]] with the [[wood cutting]] [[labor]] enabled and access to a [[battle axe]] will cut down the trees, which will turn one tree into one '''log''', the raw form of wood.

Only [[nether-cap]] wood is [[magma-safe]].

"'''Timber'''" is the name of the ninth month of the dwarven [[calendar]], covering late Fall.

==Growing==

[[Tree]]s start their lives as saplings. Saplings cannot be cut down until they mature into full-grown trees, which can take several years. Saplings will randomly appear in appropriate [[soil]] (above and below ground) and [[mud]]dy underground rock (underground areas will only start to sprout saplings once you have hit the [[caverns]]) to provide a slow (but steady) supply of wood. Fully-grown trees will impede units' movement, so be sure to clear them out of active corridors.

==Sources==

Besides cutting down trees, wood (and some wooden goods, such as [[barrel]]s) is often available from the [[elf|elven]], [[dwarf|dwarven]] and [[human]] [[caravan]]s. Wood can also be purchased before embarking. Wood is quite inexpensive, costing only 3☼ per log, and you may wish to bring a large number of logs when embarking in order to jump-start your [[wood industry]]. The [[wagon (embark)|wagon]] you start the game with can also be dismantled for three logs.

==Considerations==

===Reasons you need wood===
*To build [[bed]]s
**Without beds your dwarves will get unhappy thoughts from sleeping on the ground
*To build [[water wheel]]s and [[windmill]]s, as well as [[axle]]s
**Without wood, you cannot generate ''or'' transfer [[power]].
*To build [[siege engine]]s and ballista bolts
**These can be very effective defenses when traps fail.
*If you want [[obsidian]] [[short sword]]s, they require one obsidian stone and one wood each (these swords likely consist of a wooden hilt with an obsidian blade or, as a more exotic alternative, a thin wooden "paddle" with sharp flakes of obsidian forming sharp edges, like the Aztec [http://en.wikipedia.org/wiki/Macuahuitl macuahuitl]).
**If you have access to obsidian, these can be a great source of quick weaponry early in the game, before any steel works are up to speed. Even on a tree-lite map, each weapon takes less wood to produce than a steel weapon (unless you are using [[magma]] to fuel your [[smelter]]s and [[forge]]s and have access to [[bituminous coal]] and [[lignite]]).
*To be burnt for [[ash]], which is used in [[Glass_industry|glass making]], [[Soap|soap making]], [[Glazing|glazing]], and for fertilizing crops.

===Reasons you want wood===
*It is simpler to make items from wood.
**For instance, it only takes one log to produce a [[bin]], [[barrel]], [[bucket]], or [[cage]]; but if you forge them instead then they'll take three metal [[bar]]s (though in versions 0.31.01-0.31.25, a bug causes metal items to only require 1 bar).
*All metalworks ([[smelter]]s, [[forge]]s), [[glass]]works and [[ceramic]] [[kiln]]s are either coal-[[fuel]]ed or magma-fueled. If you are planning on having any sort of serious metal or glass production, then you're going to need either a lot of wood, or [[magma]] (and [[charcoal]] or [[bituminous coal|coal]] for [[steel]]).
*Wooden training [[weapon]]s are useful for military training started shortly after embark should you feel the need.
*[[Crossbow]]s can be made from wood (or [[bone]]) and may be preferred if you have a skilled [[bowyer]] but not a skilled [[weaponsmith]].

===Reasons you don't need much wood===
*Everything other than beds, axles, windmills, water wheels, ''obsidian'' shortswords, siege engine parts, and ballista bolts can be made without the use of wood.
** In particular, [[barrel]]s can be replaced by stone [[pot]]s without having to use either fuel or magma.
*Once you have [[magma]] then you don't need wood for fuel. If you have coal, you don't need (as much) wood to produce [[charcoal]] for [[steel]]. If you have both, you don't need wood to produce metal or steel products.
**([[Bituminous coal]] ''without'' magma triples the effective output of wood, [[lignite]] doubles it.)

==Weight==
The weight of a 'unit' of each type of wood is half their density; the densities for each individual type of wood is listed under the appropriate [[tree]]. Wood has a default [SOLID_DENSITY] of 500, making it about three times lighter than most stone and fifteen times lighter than iron. Feather tree wood is the lightest, with a density of 100, and blood thorn wood is the heaviest, with a density of 1250. Candlenut (140), and glumprong (1200) are also notable. However, since average wood is relatively light to begin with, with the possible exception of wood [[hauling]], this makes (almost?) no practical difference in the daily routine of a fortress or your dwarves.

{| style="margin:1em 1em 1em 0;background:#F9F9F9;border:1px #AAA solid;border-collapse:collapse;" class="wikitable sortable"
|- style="background:#F2F2F2;text-align:center;"
!style="border:1px #AAA solid;padding:0.2em;"| Wood Type
!style="border:1px #AAA solid;padding:0.2em;"| Density
!style="border:1px #AAA solid;padding:0.2em;"| Color
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Ash (tree)]]
|style="border:1px #AAA solid;padding:0.2em;"| 600
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Pale Brown|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Saguaro]]
|style="border:1px #AAA solid;padding:0.2em;"| 430
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Ecru|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Oak]]
|style="border:1px #AAA solid;padding:0.2em;"| 700
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Auburn|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Maple]]
|style="border:1px #AAA solid;padding:0.2em;"| 540
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Rust|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Chestnut]]
|style="border:1px #AAA solid;padding:0.2em;"| 430
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Dark Chestnut|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Candlenut]]
|style="border:1px #AAA solid;padding:0.2em;"| 140
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Ochre|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Palm]]
|style="border:1px #AAA solid;padding:0.2em;"| 680
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Dark Taupe|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Rubber tree|Rubber]]
|style="border:1px #AAA solid;padding:0.2em;"| 490
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Flax|6:1}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Alder]]
|style="border:1px #AAA solid;padding:0.2em;"| 410
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Tan|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Birch]]
|style="border:1px #AAA solid;padding:0.2em;"| 650
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Burnt Umber|4:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Black-cap|Black-Cap]]
|style="border:1px #AAA solid;padding:0.2em;"| 650
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Black|0:1}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Acacia]]
|style="border:1px #AAA solid;padding:0.2em;"| 600
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Peach|7:1}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Cacao tree|Cacao]]
|style="border:1px #AAA solid;padding:0.2em;"| 430
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Chocolate|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Cedar]]
|style="border:1px #AAA solid;padding:0.2em;"| 570
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Olive|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Feather tree|Feather Tree]]
|style="border:1px #AAA solid;padding:0.2em;"| 100
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Cream|7:1}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Fungiwood]]
|style="border:1px #AAA solid;padding:0.2em;"| 600
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Lemon|6:1}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Glumprong]]
|style="border:1px #AAA solid;padding:0.2em;"| 1200
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Purple|5:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Goblin-cap]]
|style="border:1px #AAA solid;padding:0.2em;"| 600
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Red|4:1}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Highwood]]
|style="border:1px #AAA solid;padding:0.2em;"| 500
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Brown|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Kapok]]
|style="border:1px #AAA solid;padding:0.2em;"| 260
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Tan|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Larch]]
|style="border:1px #AAA solid;padding:0.2em;"| 590
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Light Brown|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Mahogany]]
|style="border:1px #AAA solid;padding:0.2em;"| 600
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Mahogany|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Mango_tree|Mango]]
|style="border:1px #AAA solid;padding:0.2em;"| 520
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Burnt Sienna|4:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Mangrove]]
|style="border:1px #AAA solid;padding:0.2em;"| 830
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Dark Taupe|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Nether-cap]]
|style="border:1px #AAA solid;padding:0.2em;"| 550
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Dark Indigo|1:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Pine]]
|style="border:1px #AAA solid;padding:0.2em;"| 510
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Beige|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Spore tree|Spore]]
|style="border:1px #AAA solid;padding:0.2em;"| 600
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Teal|3:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Tower-cap]]
|style="border:1px #AAA solid;padding:0.2em;"| 600
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|White|7:1}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Tunnel tube|Tunnel Tube]]
|style="border:1px #AAA solid;padding:0.2em;"| 500
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Violet|5:1}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Willow]]
|style="border:1px #AAA solid;padding:0.2em;"| 390
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Tan|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Blood thorn]]
|style="border:1px #AAA solid;padding:0.2em;"| 1250
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Crimson|4:0}}
|}

== Biomes ==
*[[Temperate]] forest
*[[Tropical]] forest
*[[Taiga]]
*[[Flatland]]
*[[Swamp]]
*[[Desert]]

'''See also:'''
:* [[Wood industry]].

{{Wood FAQ}}

{{Category|Materials}}

v0.34:Wood

2012-05-14T15:38:05Z

AVK:

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

'''Wood''' is produced by [[designation|{{Key|d}}esignating]] [[tree|{{Key|t}}rees]] to be chopped down. Any [[dwarf]] with the [[wood cutting]] [[labor]] enabled and access to a [[battle axe]] will cut down the trees, which will turn one tree into one '''log''', the raw form of wood.

Only [[nether-cap]] wood is [[magma-safe]].

"'''Timber'''" is the name of the ninth month of the dwarven [[calendar]], covering late Fall.

==Growing==

[[Tree]]s start their lives as saplings. Saplings cannot be cut down until they mature into full-grown trees, which can take several years. Saplings will randomly appear in appropriate [[soil]] (above and below ground) and [[mud]]dy underground rock (underground areas will only start to sprout saplings once you have hit the [[caverns]]) to provide a slow (but steady) supply of wood. Fully-grown trees will impede units' movement, so be sure to clear them out of active corridors.

==Sources==

Besides cutting down trees, wood (and some wooden goods, such as [[barrel]]s) is often available from the [[elf|elven]], [[dwarf|dwarven]] and [[human]] [[caravan]]s. Wood can also be purchased before embarking. Wood is quite inexpensive, costing only 3☼ per log, and you may wish to bring a large number of logs when embarking in order to jump-start your [[wood industry]]. The [[wagon (embark)|wagon]] you start the game with can also be dismantled for three logs.

==Considerations==

===Reasons you need wood===
*To build [[bed]]s
**Without beds your dwarves will get unhappy thoughts from sleeping on the ground
*To build [[water wheel]]s and [[windmill]]s, as well as [[axle]]s
**Without wood, you cannot generate ''or'' transfer [[power]].
*To build [[siege engine]]s and ballista bolts
**These can be very effective defenses when traps fail.
*If you want [[obsidian]] [[short sword]]s, they require one obsidian stone and one wood each (these swords likely consist of a wooden hilt with an obsidian blade or, as a more exotic alternative, a thin wooden "paddle" with sharp flakes of obsidian forming sharp edges, like the Aztec [http://en.wikipedia.org/wiki/Macuahuitl macuahuitl]).
**If you have access to obsidian, these can be a great source of quick weaponry early in the game, before any steel works are up to speed. Even on a tree-lite map, each weapon takes less wood to produce than a steel weapon (unless you are using [[magma]] to fuel your [[smelter]]s and [[forge]]s and have access to [[bituminous coal]] and [[lignite]]).
*To be burnt for [[ash]], which is used in [[Glass_industry|glass making]], [[Soap|soap making]], [[Glazing|glazing]], and for fertilizing crops.

===Reasons you want wood===
*It is simpler to make items from wood.
**For instance, it only takes one log to produce a [[bin]], [[barrel]], [[bucket]], or [[cage]]; but if you forge them instead then they'll take three metal [[bar]]s (though in versions 0.31.01-0.31.25, a bug causes metal items to only require 1 bar).
*All metalworks ([[smelter]]s, [[forge]]s), [[glass]]works and [[ceramic]] [[kiln]]s are either coal-[[fuel]]ed or magma-fueled. If you are planning on having any sort of serious metal or glass production, then you're going to need either a lot of wood, or [[magma]] (and [[charcoal]] or [[bituminous coal|coal]] for [[steel]]).
*Wooden training [[weapon]]s are useful for military training started shortly after embark should you feel the need.
*[[Crossbow]]s can be made from wood (or [[bone]]) and may be preferred if you have a skilled [[bowyer]] but not a skilled [[weaponsmith]].

===Reasons you don't need much wood===
*Everything other than beds, axles, windmills, water wheels, ''obsidian'' shortswords, siege engine parts, and ballista bolts can be made without the use of wood.
** In particular, [[barrel]]s can be replaced by stone [[pot]]s without having to use either fuel or magma.
*Once you have [[magma]] then you don't need wood for fuel. If you have coal, you don't need (as much) wood to produce [[charcoal]] for [[steel]]. If you have both, you don't need wood to produce metal or steel products.
**([[Bituminous coal]] ''without'' magma triples the effective output of wood, [[lignite]] doubles it.)

==Weight==
The weight of a 'unit' of each type of wood is half their density; the densities for each individual type of wood is listed under the appropriate [[tree]]. Wood has a default [SOLID_DENSITY] of 500, making it about three times lighter than most stone and fifteen times lighter than iron. Feather tree wood is the lightest, with a density of 100, and blood thorn wood is the heaviest, with a density of 1250. Candlenut (140), and glumprong (1200) are also notable. However, since average wood is relatively light to begin with, with the possible exception of wood [[hauling]], this makes (almost?) no practical difference in the daily routine of a fortress or your dwarves.

{| style="margin:1em 1em 1em 0;background:#F9F9F9;border:1px #AAA solid;border-collapse:collapse;" class="wikitable sortable"
|- style="background:#F2F2F2;text-align:center;"
!style="border:1px #AAA solid;padding:0.2em;"| Wood Type
!style="border:1px #AAA solid;padding:0.2em;"| Density
!style="border:1px #AAA solid;padding:0.2em;"| Color
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Ash (tree)]]
|style="border:1px #AAA solid;padding:0.2em;"| 600
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Pale Brown|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Saguaro]]
|style="border:1px #AAA solid;padding:0.2em;"| 430
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Ecru|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Oak]]
|style="border:1px #AAA solid;padding:0.2em;"| 700
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Auburn|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Maple]]
|style="border:1px #AAA solid;padding:0.2em;"| 540
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Rust|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Chestnut]]
|style="border:1px #AAA solid;padding:0.2em;"| 430
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Dark Chestnut|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Candlenut]]
|style="border:1px #AAA solid;padding:0.2em;"| 140
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Ochre|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Palm]]
|style="border:1px #AAA solid;padding:0.2em;"| 680
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Dark Taupe|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Rubber tree|Rubber]]
|style="border:1px #AAA solid;padding:0.2em;"| 490
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Flax|6:1}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Alder]]
|style="border:1px #AAA solid;padding:0.2em;"| 410
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Tan|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Birch]]
|style="border:1px #AAA solid;padding:0.2em;"| 650
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Burnt Umber|4:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Black-cap|Black-Cap]]
|style="border:1px #AAA solid;padding:0.2em;"| 650
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Black|0:1}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Acacia]]
|style="border:1px #AAA solid;padding:0.2em;"| 600
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Peach|7:1}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Cacao tree|Cacao]]
|style="border:1px #AAA solid;padding:0.2em;"| 430
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Chocolate|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Cedar]]
|style="border:1px #AAA solid;padding:0.2em;"| 570
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Olive|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Feather tree|Feather Tree]]
|style="border:1px #AAA solid;padding:0.2em;"| 100
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Cream|7:1}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Fungiwood]]
|style="border:1px #AAA solid;padding:0.2em;"| 600
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Lemon|6:1}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Glumprong]]
|style="border:1px #AAA solid;padding:0.2em;"| 1200
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Purple|5:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Goblin-cap]]
|style="border:1px #AAA solid;padding:0.2em;"| 600
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Red|4:1}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Highwood]]
|style="border:1px #AAA solid;padding:0.2em;"| 500
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Brown|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Kapok]]
|style="border:1px #AAA solid;padding:0.2em;"| 260
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Tan|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Larch]]
|style="border:1px #AAA solid;padding:0.2em;"| 590
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Light Brown|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Mahogany]]
|style="border:1px #AAA solid;padding:0.2em;"| 600
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Brown|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Mango_tree|Mango]]
|style="border:1px #AAA solid;padding:0.2em;"| 520
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Burnt Sienna|4:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Mangrove]]
|style="border:1px #AAA solid;padding:0.2em;"| 830
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Dark Taupe|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Nether-cap]]
|style="border:1px #AAA solid;padding:0.2em;"| 550
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Dark Indigo|1:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Pine]]
|style="border:1px #AAA solid;padding:0.2em;"| 510
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Beige|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Spore tree|Spore]]
|style="border:1px #AAA solid;padding:0.2em;"| 600
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Teal|3:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Tower-cap]]
|style="border:1px #AAA solid;padding:0.2em;"| 600
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|White|7:1}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Tunnel tube|Tunnel Tube]]
|style="border:1px #AAA solid;padding:0.2em;"| 500
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Violet|5:1}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Willow]]
|style="border:1px #AAA solid;padding:0.2em;"| 390
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Tan|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Blood thorn]]
|style="border:1px #AAA solid;padding:0.2em;"| 1250
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Crimson|4:0}}
|}

== Biomes ==
*[[Temperate]] forest
*[[Tropical]] forest
*[[Taiga]]
*[[Flatland]]
*[[Swamp]]
*[[Desert]]

'''See also:'''
:* [[Wood industry]].

{{Wood FAQ}}

{{Category|Materials}}

v0.34:Wood

2012-05-14T15:35:40Z

AVK: Updated new wood colors and material densities from the v0.34.08 update.

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

'''Wood''' is produced by [[designation|{{Key|d}}esignating]] [[tree|{{Key|t}}rees]] to be chopped down. Any [[dwarf]] with the [[wood cutting]] [[labor]] enabled and access to a [[battle axe]] will cut down the trees, which will turn one tree into one '''log''', the raw form of wood.

Only [[nether-cap]] wood is [[magma-safe]].

"'''Timber'''" is the name of the ninth month of the dwarven [[calendar]], covering late Fall.

==Growing==

[[Tree]]s start their lives as saplings. Saplings cannot be cut down until they mature into full-grown trees, which can take several years. Saplings will randomly appear in appropriate [[soil]] (above and below ground) and [[mud]]dy underground rock (underground areas will only start to sprout saplings once you have hit the [[caverns]]) to provide a slow (but steady) supply of wood. Fully-grown trees will impede units' movement, so be sure to clear them out of active corridors.

==Sources==

Besides cutting down trees, wood (and some wooden goods, such as [[barrel]]s) is often available from the [[elf|elven]], [[dwarf|dwarven]] and [[human]] [[caravan]]s. Wood can also be purchased before embarking. Wood is quite inexpensive, costing only 3☼ per log, and you may wish to bring a large number of logs when embarking in order to jump-start your [[wood industry]]. The [[wagon (embark)|wagon]] you start the game with can also be dismantled for three logs.

==Considerations==

===Reasons you need wood===
*To build [[bed]]s
**Without beds your dwarves will get unhappy thoughts from sleeping on the ground
*To build [[water wheel]]s and [[windmill]]s, as well as [[axle]]s
**Without wood, you cannot generate ''or'' transfer [[power]].
*To build [[siege engine]]s and ballista bolts
**These can be very effective defenses when traps fail.
*If you want [[obsidian]] [[short sword]]s, they require one obsidian stone and one wood each (these swords likely consist of a wooden hilt with an obsidian blade or, as a more exotic alternative, a thin wooden "paddle" with sharp flakes of obsidian forming sharp edges, like the Aztec [http://en.wikipedia.org/wiki/Macuahuitl macuahuitl]).
**If you have access to obsidian, these can be a great source of quick weaponry early in the game, before any steel works are up to speed. Even on a tree-lite map, each weapon takes less wood to produce than a steel weapon (unless you are using [[magma]] to fuel your [[smelter]]s and [[forge]]s and have access to [[bituminous coal]] and [[lignite]]).
*To be burnt for [[ash]], which is used in [[Glass_industry|glass making]], [[Soap|soap making]], [[Glazing|glazing]], and for fertilizing crops.

===Reasons you want wood===
*It is simpler to make items from wood.
**For instance, it only takes one log to produce a [[bin]], [[barrel]], [[bucket]], or [[cage]]; but if you forge them instead then they'll take three metal [[bar]]s (though in versions 0.31.01-0.31.25, a bug causes metal items to only require 1 bar).
*All metalworks ([[smelter]]s, [[forge]]s), [[glass]]works and [[ceramic]] [[kiln]]s are either coal-[[fuel]]ed or magma-fueled. If you are planning on having any sort of serious metal or glass production, then you're going to need either a lot of wood, or [[magma]] (and [[charcoal]] or [[bituminous coal|coal]] for [[steel]]).
*Wooden training [[weapon]]s are useful for military training started shortly after embark should you feel the need.
*[[Crossbow]]s can be made from wood (or [[bone]]) and may be preferred if you have a skilled [[bowyer]] but not a skilled [[weaponsmith]].

===Reasons you don't need much wood===
*Everything other than beds, axles, windmills, water wheels, ''obsidian'' shortswords, siege engine parts, and ballista bolts can be made without the use of wood.
** In particular, [[barrel]]s can be replaced by stone [[pot]]s without having to use either fuel or magma.
*Once you have [[magma]] then you don't need wood for fuel. If you have coal, you don't need (as much) wood to produce [[charcoal]] for [[steel]]. If you have both, you don't need wood to produce metal or steel products.
**([[Bituminous coal]] ''without'' magma triples the effective output of wood, [[lignite]] doubles it.)

==Weight==
The weight of a 'unit' of each type of wood is half their density; the densities for each individual type of wood is listed under the appropriate [[tree]]. Wood has a default [SOLID_DENSITY] of 500, making it about three times lighter than most stone and fifteen times lighter than iron. Feather tree wood is the lightest, with a density of 100, and blood thorn wood is the heaviest, with a density of 1250. Candlenut (140), and glumprong (1200) are also notable. However, since average wood is relatively light to begin with, with the possible exception of wood [[hauling]], this makes (almost?) no practical difference in the daily routine of a fortress or your dwarves.

{| style="margin:1em 1em 1em 0;background:#F9F9F9;border:1px #AAA solid;border-collapse:collapse;" class="wikitable sortable"
|- style="background:#F2F2F2;text-align:center;"
!style="border:1px #AAA solid;padding:0.2em;"| Wood Type
!style="border:1px #AAA solid;padding:0.2em;"| Density
!style="border:1px #AAA solid;padding:0.2em;"| Color
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Ash (tree)]]
|style="border:1px #AAA solid;padding:0.2em;"| 600
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Pale Brown|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Saguaro]]
|style="border:1px #AAA solid;padding:0.2em;"| 430
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Ecru|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Oak]]
|style="border:1px #AAA solid;padding:0.2em;"| 700
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Auburn|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Maple]]
|style="border:1px #AAA solid;padding:0.2em;"| 540
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Rust|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Chestnut]]
|style="border:1px #AAA solid;padding:0.2em;"| 430
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Dark Chestnut|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Candlenut]]
|style="border:1px #AAA solid;padding:0.2em;"| 140
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Ochre|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Palm]]
|style="border:1px #AAA solid;padding:0.2em;"| 680
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Dark Taupe|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Rubber tree|Rubber]]
|style="border:1px #AAA solid;padding:0.2em;"| 490
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Flax|6:1}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Alder]]
|style="border:1px #AAA solid;padding:0.2em;"| 410
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Tan|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Birch]]
|style="border:1px #AAA solid;padding:0.2em;"| 650
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Burnt Umber|4:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Black-cap|Black-Cap]]
|style="border:1px #AAA solid;padding:0.2em;"| 650
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Black|0:1}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Acacia]]
|style="border:1px #AAA solid;padding:0.2em;"| 600
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Peach|7:1}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Cacao tree|Cacao]]
|style="border:1px #AAA solid;padding:0.2em;"| 430
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Chocolate|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Cedar]]
|style="border:1px #AAA solid;padding:0.2em;"| 570
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Olive|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Feather tree|Feather Tree]]
|style="border:1px #AAA solid;padding:0.2em;"| 100
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Cream|7:1}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Fungiwood]]
|style="border:1px #AAA solid;padding:0.2em;"| 600
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Lemon|6:1}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Glumprong]]
|style="border:1px #AAA solid;padding:0.2em;"| 1200
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Purple|5:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Goblin-cap]]
|style="border:1px #AAA solid;padding:0.2em;"| 600
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Red|4:1}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Highwood]]
|style="border:1px #AAA solid;padding:0.2em;"| 500
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Brown|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Kapok]]
|style="border:1px #AAA solid;padding:0.2em;"| 260
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Tan|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Larch]]
|style="border:1px #AAA solid;padding:0.2em;"| 590
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Light Brown|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Mahogany]]
|style="border:1px #AAA solid;padding:0.2em;"| 600
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Brown|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Mango]]
|style="border:1px #AAA solid;padding:0.2em;"| 520
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Burnt Sienna|4:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Mangrove]]
|style="border:1px #AAA solid;padding:0.2em;"| 830
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Dark Taupe|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Nether-cap]]
|style="border:1px #AAA solid;padding:0.2em;"| 550
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Dark Indigo|1:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Pine]]
|style="border:1px #AAA solid;padding:0.2em;"| 510
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Beige|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Spore tree|Spore]]
|style="border:1px #AAA solid;padding:0.2em;"| 600
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Teal|3:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Tower-cap]]
|style="border:1px #AAA solid;padding:0.2em;"| 600
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|White|7:1}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Tunnel tube|Tunnel Tube]]
|style="border:1px #AAA solid;padding:0.2em;"| 500
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Violet|5:1}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Willow]]
|style="border:1px #AAA solid;padding:0.2em;"| 390
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Tan|6:0}}
|-
|style="border:1px #AAA solid;padding:0.2em;"| [[Blood thorn]]
|style="border:1px #AAA solid;padding:0.2em;"| 1250
|style="border:1px #AAA solid;padding:0.2em;"| {{Tile|Crimson|4:0}}
|}

== Biomes ==
*[[Temperate]] forest
*[[Tropical]] forest
*[[Taiga]]
*[[Flatland]]
*[[Swamp]]
*[[Desert]]

'''See also:'''
:* [[Wood industry]].

{{Wood FAQ}}

{{Category|Materials}}

v0.34:Rubicelle

2012-04-25T23:24:04Z

AVK:

{{gemlookup/0}}{{av}}{{Quality|Fine}}

A typical moderately precious metamorphic gem. Also known as a yellow spinel.

{{gamedata}}
{{gems}}

v0.34:Diagnostician

2012-04-24T13:17:24Z

AVK:

{{quality|Fine|18:01, 28 April 2011 (UTC)}}{{Skill
| color = 5:0
| skill = Diagnostician
| specialty = Diagnoser
| profession = [[Doctor]]
| job name = [[Diagnosis]]
| tasks =
* Diagnose wounded dwarves
| attributes =
* Analytical Ability
* Memory
* Intuition
}}
{{av}}

The '''diagnostician''' skill is used in the [[Healthcare]] Industry, with the corresponding [[labor]] '''diagnosis'''. It is used in deciding how a dwarf is hurt and how to fix him. It is the only relevant skill of the [[chief medical dwarf]] position, and the [[health screen]] will not display information without it.

'''See also:'''

*[[Healthcare]]

{{skills}}

{{Category|Healthcare}}

v0.34:Diagnostician

2012-04-24T13:17:03Z

AVK:

{{quality|Fine|18:01, 28 April 2011 (UTC)}}{{Skill
| color = 5:0
| skill = Diagnostician
| specialty = Diagnoser
| profession = [[Doctor]]
| job name = [[Diagnosis]]
| tasks =
* Diagnose wounded dwarves
| attributes =
* Analytical Ability
* Memory
* Intuition
}}
{{av}}

The '''diagnostician''' skill is used in the [[Healthcare]] Industry, with the corresponding [[labor]] '''diagnosis'''. It is used in deciding how a dwarf is hurt and how to fix him. It is the only relevant skill of the [[chief medical dwarf]] position, and the [[health screen]] will not display information without at least a novice level in the skill.

'''See also:'''

*[[Healthcare]]

{{skills}}

{{Category|Healthcare}}

v0.34:Health screen

2012-04-24T13:14:39Z

AVK:

{{quality|Exceptional|23:31, 17 April 2011 (UTC)}}

In the status menu (accessed using the {{k|z}}-status key), one of the sub-menus is '''Health'''. This sub-menu becomes available when a dwarf is appointed to the [[Chief medical dwarf]] position. It does not display information unless the CMD is at least a novice [[diagnostician]]. 
The z-health menu is used to monitor the health of friendly dwarves. A subject dwarf's status effects and injuries are cataloged in the health menu by [[Healthcare|hospital staff]] upon diagnosis. Some basic needs are automatically shown in the menu whenever a dwarf becomes hungry, thirsty, or tired. Doctors will begin treating injured or otherwise unhealthy dwarves only after diagnosis and when proper equipment is available. 
Note: The screen is entirely mouse enabled. 

Listed below are all of the conditions displayed in the z-health screen:
===First Key Column===
This is the column that lists requests and requirements of the subject.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=D|color=2:0:1|desc='''Diagnosis request''' - [[Diagnostician]] needed to diagnose the subject}}
{{HealthStatus table row|symbol=≈|color=3:0:1|desc='''Cleaning request''' - Dwarf with a water bucket and cleaning labor enabled needed to bathe off contaminants, preferably using [[soap]] }}
{{HealthStatus table row|symbol=S|color=4:0:1|desc='''Surgery required''' - [[Surgeon]] needed to excise necrotic tissue or repair organ damage}}
{{HealthStatus table row|symbol=R|color=5:0:1|desc='''Inoperable Rot''' - [[Surgeon]] needed to amputate a necrotic limb}}
{{HealthStatus table row|symbol=Ø|color=7:0:1|desc='''Suture request''' - [[Suturer]] needed to repair cuts, wounds and nerve damage (!!) using thread}}
{{HealthStatus table row|symbol=B|color=6:0:1|desc='''Setting request''' - [[Bone doctor]] needed to set the subject's fractured bones}}
{{HealthStatus table row|symbol=<s>°</s>|color=7:0:1|desc='''Dressing request''' - [[Wound dresser]] needed to top off the medical procedure using cloth bandages}}
{{HealthStatus table row|symbol=T|color=6:0:1|desc='''Traction request''' - [[Traction bench]] needed to immobilize subject with overlapping fractures}}
{{HealthStatus table row|symbol=I|color=6:0:1|desc='''Immobilization request''' - [[Gypsum plaster|Cast]] (wound dresser) or [[splint]] (bone doctor) needed to stabilize a repaired fracture}}
{{HealthStatus table row|symbol=C|color=6:0:1|desc='''Crutch required''' - [[Crutch]] needed for the subject to walk}}
|}

===Second Key Column===
This column shows different degrees of bleeding, blood loss, numbness, and paralysis.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=B!+|color=4:0:1|desc='''Heavy bleeding''' - Subject is quickly losing blood through many wounds or torn arteries. This is an emergency.}}
{{HealthStatus table row|symbol=B!~|color=4:0:0|desc='''Bleeding''' - Subject is losing blood through a wound. Typically harmless due to dwarves' fast natural healing rate.}}
{{HealthStatus table row|symbol=Bl+|color=5:0:1|desc='''Severe Blood Loss''' - Subject is Pale. Caused by massive blood loss, typically from a severed limb. This is an emergency.}}
{{HealthStatus table row|symbol=Bl~|color=5:0:1|desc='''Blood Loss''' - Subject is Faint. Caused by moderate blood loss from wounds or necrosis.}}
{{HealthStatus table row|symbol=Pz+|color=3:0:1|desc='''Paralyzed''' - Subject is completely paralyzed. Common effect of upper spinal injury. Death by suffocation is imminent}}
{{HealthStatus table row|symbol=Pz~|color=3:0:1|desc='''Partially paralyzed''' - One or more limbs unusable due to severed nerves}}
{{HealthStatus table row|symbol=Slg|color=3:0:1|desc='''Sluggish''' - Characteristic of weak or lessening paralysis}}
{{HealthStatus table row|symbol=Nm+|color=3:0:1|desc='''Completely numb''' - Symptom of syndromes or sensory nerve damage. Eliminates pain sensation in affected areas and severely hampers motor ability. Protracted syndrome effects may cause permanent damage.}}
{{HealthStatus table row|symbol=Nm~|color=3:0:1|desc='''Partially numb''' - Symptom of syndromes or sensory nerve damage. Further reduces pain in affected areas and hampers fine motor ability.}}
{{HealthStatus table row|symbol=Nm-|color=3:0:1|desc='''Slightly numb''' - Symptom of syndromes or sensory nerve damage. Reduces pain in affected areas.}}
|}

===Third Key Column===
This column shows different degrees of pain, exhaustion and fever and also shows dizziness and whether the subject is stunned.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=F!|color=4:0:1|desc='''Serious fever''' - Reduces focus stat, may stun. Typical warning sign of more dangerous syndromes.}}
{{HealthStatus table row|symbol=F+|color=4:0:1|desc='''Moderate fever''' - Reduces focus stat. Typical warning sign of more dangerous syndromes.}}
{{HealthStatus table row|symbol=F~|color=4:0:1|desc='''Slight fever''' - Reduces focus stat. Relatively harmless.}}
{{HealthStatus table row|symbol=Dz|color=3:0:1|desc='''Dizzy''' - Common symptom of snakebite. Causes subject to stumble in a random direction whenever performing an action, depending on severity.}}
{{HealthStatus table row|symbol=Pn!|color=6:0:1|desc='''Extreme pain''' - Subject can't take any more and falls unconscious, giving into pain. Typical of broken bones. Thresholds depend on subject's willpower stat.}}
{{HealthStatus table row|symbol=Pn+|color=6:0:1|desc='''Moderate pain''' - Moderate amount of pain receptors have been triggered by wounds. Interferes with actions?}}
{{HealthStatus table row|symbol=Pn~|color=6:0:1|desc='''Slight pain''' - Subject has suffered minor cuts or bruises.}}
{{HealthStatus table row|symbol=St|color=3:0:1|desc='''Stunned''' - The wind has been knocked out of the subject by an unexpected fall, impact, cave-in or takedown. Temporary and harmless in itself.}}
{{HealthStatus table row|symbol=Exh|color=6:0:1|desc='''Exhausted''' - Caused by taking too many combat actions in a turn?{{verify}}}}
{{HealthStatus table row|symbol=Ovx|color=6:0:1|desc='''Over-exerted''' - Caused by taking too many combat actions in a turn?{{verify}}}}
{{HealthStatus table row|symbol=Tir|color=6:0:1|desc='''Tired''' - Caused by taking too many combat actions in a turn?{{verify}}}}
|}

===Fourth Key Column===
This column shows breathing problems and various needs (including extreme like starvation and dehydration).
{{HealthStatus table head}}
{{HealthStatus table row|symbol=Dr|color=1:0:1|desc='''Drowning''' - Cannot breathe due to being stuck underwater. This is an emergency.}}
{{HealthStatus table row|symbol=Wd|color=7:0:0|desc='''Winded'''}}
{{HealthStatus table row|symbol=Br|color=4:0:1|desc='''Cannot breathe''' - Usually indicates severe lung injury or asphyxiation. Death is imminent unless one lung was injured a long time ago and will finish healing to the point of being able to breathe before subject dies.}}
{{HealthStatus table row|symbol=Br|color=7:0:0|desc='''Trouble breathing''' - Usually indicates lung injury or extreme exertion}}
{{HealthStatus table row|symbol=T!|color=4:0:1|desc='''Dehydrated''' - If the subject doesn't receive booze (or [[water]], if hospitalized) they will die. This is an emergency.}}
{{HealthStatus table row|symbol=T~|color=1:0:1|desc='''Thirsty'''}}
{{HealthStatus table row|symbol=H!|color=4:0:1|desc='''Starving''' - If the subject doesn't receive food they will die. This is an emergency.}}
{{HealthStatus table row|symbol=H~|color=6:0:0|desc='''Hungry'''}}
{{HealthStatus table row|symbol=Dw|color=4:0:1|desc='''Very drowsy''' - If the subject doesn't get sleep soon they will go [[insane]]. This is an emergency.}}
{{HealthStatus table row|symbol=Dw|color=1:0:1|desc='''Drowsy''' - Subject is tired enough to go to bed, but hasn't done so yet. Also caused by syndromes.}}
{{HealthStatus table row|symbol=Na|color=2:0:1|desc='''Nauseous''' - Symptom of cave adaptation or injury to the guts. The subject may stop and [[vomit]] instead of making an action. Excessive vomiting can cause dehydration.}}
|}

===Fifth Key Column===
This column shows vision and grasping impairment, problems with nerves, and being unable to stand or fly.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=V|color=4:0:1|desc='''Vision lost''' - Subject will have a very hard time completing normal tasks}}
{{HealthStatus table row|symbol=V|color=6:0:1|desc='''Vision impaired''' - Subject will have a hard time completing normal tasks}}
{{HealthStatus table row|symbol=V|color=7:0:0|desc='''Vision ~impaired''' - Subject will have a slightly hard time completing normal tasks. Caused naturally by old age (110+ with dwarves).}}
{{HealthStatus table row|symbol=P|color=2:0:1|desc='''Popped out''' - Subject's intestines have popped out. Death is imminent.}}
{{HealthStatus table row|symbol=Sx|color=6:0:1|desc='''Cannot stand''' - Subject can only crawl due to dismemberment or lower body paralysis. Subject needs a [[crutch]] to stand or walk.}}
{{HealthStatus table row|symbol=S~|color=6:0:1|desc='''Stand impaired''' - Subject has trouble standing due to numbness or injury to the legs. Subject might need a crutch? {{verify}}}}
{{HealthStatus table row|symbol=Gx|color=6:0:1|desc='''Cannot grasp''' - Subject cannot manipulate objects due to dismemberment or paralysis.}}
{{HealthStatus table row|symbol=G~|color=6:0:1|desc='''Grasp impaired''' - Subject has trouble with fine motor control, but can still grasp things. Typically caused by injury or numbness.}}
{{HealthStatus table row|symbol=Fx|color=6:0:1|desc='''Cannot fly''' - Subject can no longer fly due to paralysis or injury. Applied only to former flyers.}}
{{HealthStatus table row|symbol=F~|color=6:0:1|desc='''Flight impaired''' - Subject has trouble flying due to injury. Applied only to flyers.}}
{{HealthStatus table row|symbol=Mn|color=3:0:1|desc='''Motor nerve''' - A motor nerve has been damaged, which can affect the subject's ability to move, stand, or fly}}
{{HealthStatus table row|symbol=Sn|color=3:0:1|desc='''Sensory nerve''' - A sensory nerve has been damaged, which can affect the subject's ability to feel sensations, to see, and to breathe{{verify}}}}
|}

===Sixth Key Column===
This column shows torn arteries, tendons and ligaments along with fractures and bruising.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=A!|color=4:0:1|desc='''Major artery torn''' - Heart injury or torn throat. This is invariably fatal.}}
{{HealthStatus table row|symbol=A+|color=4:0:1|desc='''Artery torn''' - Subject will probably suffer bleeding of some type. This can be an emergency.}}
{{HealthStatus table row|symbol=Of|color=4:0:1|desc='''Overlapping fracture''' - Typically a limb fracture with severely displaced fragments. A traction bench may be required to reconnect the bones.}}
{{HealthStatus table row|symbol=Cf|color=4:0:1|desc='''Compound fracture''' - A bone fracture exposed through an open wound. Presents an infection risk.}}
{{HealthStatus table row|symbol=Tn|color=4:0:1|desc='''Torn tendon''' - Muscle is severed from the bone. Causes severe pain and disables limb?{{verify}}}}
{{HealthStatus table row|symbol=Tn|color=6:0:1|desc='''Tendon strain''' - Muscle damage. Causes pain and limits movement?{{verify}}}}
{{HealthStatus table row|symbol=Tn|color=6:0:0|desc='''Tendon bruise''' - Slight muscle damage.}}
{{HealthStatus table row|symbol=Lg|color=4:0:1|desc='''Torn ligament''' - Broken joint. Causes severe pain and disables limb?{{verify}}}}
{{HealthStatus table row|symbol=Lg|color=6:0:1|desc='''Ligament strain''' - Joint damage. Causes pain and limits movement? {{verify}}}}
{{HealthStatus table row|symbol=Lg|color=6:0:0|desc='''Ligament bruise''' - Slight joint damage.}}
{{HealthStatus table row|symbol=Ns|color=6:0:1|desc='''Need setting''' - A [[bone doctor]] is needed to treat injuries}}
|}

===Seventh Key Column===
This column shows broken tissue, different degrees of pain, damage and swelling, and whether the subject has an infection.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=X!|color=4:0:1|desc='''Broken tissue'''}}
{{HealthStatus table row|symbol=D!|color=4:0:1|desc='''Heavy damage''' - Varying degrees of bruising. Typically caused by syndromes.}}
{{HealthStatus table row|symbol=D+|color=6:0:1|desc='''Moderate damage''' - Varying degrees of bruising. Typically caused by syndromes.}}
{{HealthStatus table row|symbol=D~|color=6:0:0|desc='''Light damage''' - Varying degrees of bruising. Typically caused by syndromes.}}
{{HealthStatus table row|symbol=X~|color=6:0:1|desc='''Partially broken tissue''' - The subject's skin or muscle is cut or torn open. Not necessarily an emergency.}}
{{HealthStatus table row|symbol=Pb!|color=6:0:1|desc='''Extreme pain''' - Not caused by injuries. Syndrome symptom?}}
{{HealthStatus table row|symbol=Pb+|color=6:0:1|desc='''Moderate pain''' - Not caused by injuries. Syndrome symptom?}}
{{HealthStatus table row|symbol=Pb~|color=6:0:1|desc='''Minor pain''' - Not caused by injuries. Syndrome symptom?}}
{{HealthStatus table row|symbol=Sw!|color=6:0:1|desc='''Extreme swelling''' - Typically caused by syndromes. Further impedes use of affected limbs and matures into necrosis. Swelling of the throat can cause suffocation.}}
{{HealthStatus table row|symbol=Sw+|color=6:0:1|desc='''Medium swelling''' - Typically caused by syndromes. Impedes use of affected limbs.}}
{{HealthStatus table row|symbol=Sw~|color=6:0:1|desc='''Minor swelling''' - Typically caused by syndromes. Slightly impedes use of affected limbs.}}
{{HealthStatus table row|symbol=In|color=5:0:1|desc='''Infection''' - Appears in open wounds either exposed to contaminated water or left untreated for too long. Cannot be treated. Subject's health attributes may affect survival rate?{{verify}}}}
|}

{{Category|Healthcare}}
{{Category|Interface}}

v0.34:Health screen

2012-04-24T09:24:44Z

AVK:

{{quality|Exceptional|23:31, 17 April 2011 (UTC)}}

In the status menu (accessed using the {{k|z}}-status key), one of the sub-menus is '''Health'''. This sub-menu becomes available when a dwarf is appointed to the [[Chief medical dwarf]] position. 
The z-health menu is used to monitor the health of friendly dwarves. A subject dwarf's status effects and injuries are cataloged in the health menu by [[Healthcare|hospital staff]] upon diagnosis. Some basic needs are automatically shown in the menu whenever a dwarf becomes hungry, thirsty, or tired. Doctors will begin treating injured or otherwise unhealthy dwarves only after diagnosis and when proper equipment is available. 
Note: The screen is entirely mouse enabled. 

Listed below are all of the conditions displayed in the z-health screen:
===First Key Column===
This is the column that lists requests and requirements of the subject.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=D|color=2:0:1|desc='''Diagnosis request''' - [[Diagnostician]] needed to diagnose the subject}}
{{HealthStatus table row|symbol=≈|color=3:0:1|desc='''Cleaning request''' - Dwarf with a water bucket and cleaning labor enabled needed to bathe off contaminants, preferably using [[soap]] }}
{{HealthStatus table row|symbol=S|color=4:0:1|desc='''Surgery required''' - [[Surgeon]] needed to excise necrotic tissue or repair organ damage}}
{{HealthStatus table row|symbol=R|color=5:0:1|desc='''Inoperable Rot''' - [[Surgeon]] needed to amputate a necrotic limb}}
{{HealthStatus table row|symbol=Ø|color=7:0:1|desc='''Suture request''' - [[Suturer]] needed to repair cuts, wounds and nerve damage (!!) using thread}}
{{HealthStatus table row|symbol=B|color=6:0:1|desc='''Setting request''' - [[Bone doctor]] needed to set the subject's fractured bones}}
{{HealthStatus table row|symbol=<s>°</s>|color=7:0:1|desc='''Dressing request''' - [[Wound dresser]] needed to top off the medical procedure using cloth bandages}}
{{HealthStatus table row|symbol=T|color=6:0:1|desc='''Traction request''' - [[Traction bench]] needed to immobilize subject with overlapping fractures}}
{{HealthStatus table row|symbol=I|color=6:0:1|desc='''Immobilization request''' - [[Gypsum plaster|Cast]] (wound dresser) or [[splint]] (bone doctor) needed to stabilize a repaired fracture}}
{{HealthStatus table row|symbol=C|color=6:0:1|desc='''Crutch required''' - [[Crutch]] needed for the subject to walk}}
|}

===Second Key Column===
This column shows different degrees of bleeding, blood loss, numbness, and paralysis.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=B!+|color=4:0:1|desc='''Heavy bleeding''' - Subject is quickly losing blood through many wounds or torn arteries. This is an emergency.}}
{{HealthStatus table row|symbol=B!~|color=4:0:0|desc='''Bleeding''' - Subject is losing blood through a wound. Typically harmless due to dwarves' fast natural healing rate.}}
{{HealthStatus table row|symbol=Bl+|color=5:0:1|desc='''Severe Blood Loss''' - Subject is Pale. Caused by massive blood loss, typically from a severed limb. This is an emergency.}}
{{HealthStatus table row|symbol=Bl~|color=5:0:1|desc='''Blood Loss''' - Subject is Faint. Caused by moderate blood loss from wounds or necrosis.}}
{{HealthStatus table row|symbol=Pz+|color=3:0:1|desc='''Paralyzed''' - Subject is completely paralyzed. Common effect of upper spinal injury. Death by suffocation is imminent}}
{{HealthStatus table row|symbol=Pz~|color=3:0:1|desc='''Partially paralyzed''' - One or more limbs unusable due to severed nerves}}
{{HealthStatus table row|symbol=Slg|color=3:0:1|desc='''Sluggish''' - Characteristic of weak or lessening paralysis}}
{{HealthStatus table row|symbol=Nm+|color=3:0:1|desc='''Completely numb''' - Symptom of syndromes or sensory nerve damage. Eliminates pain sensation in affected areas and severely hampers motor ability. Protracted syndrome effects may cause permanent damage.}}
{{HealthStatus table row|symbol=Nm~|color=3:0:1|desc='''Partially numb''' - Symptom of syndromes or sensory nerve damage. Further reduces pain in affected areas and hampers fine motor ability.}}
{{HealthStatus table row|symbol=Nm-|color=3:0:1|desc='''Slightly numb''' - Symptom of syndromes or sensory nerve damage. Reduces pain in affected areas.}}
|}

===Third Key Column===
This column shows different degrees of pain, exhaustion and fever and also shows dizziness and whether the subject is stunned.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=F!|color=4:0:1|desc='''Serious fever''' - Reduces focus stat, may stun. Typical warning sign of more dangerous syndromes.}}
{{HealthStatus table row|symbol=F+|color=4:0:1|desc='''Moderate fever''' - Reduces focus stat. Typical warning sign of more dangerous syndromes.}}
{{HealthStatus table row|symbol=F~|color=4:0:1|desc='''Slight fever''' - Reduces focus stat. Relatively harmless.}}
{{HealthStatus table row|symbol=Dz|color=3:0:1|desc='''Dizzy''' - Common symptom of snakebite. Causes subject to stumble in a random direction whenever performing an action, depending on severity.}}
{{HealthStatus table row|symbol=Pn!|color=6:0:1|desc='''Extreme pain''' - Subject can't take any more and falls unconscious, giving into pain. Typical of broken bones. Thresholds depend on subject's willpower stat.}}
{{HealthStatus table row|symbol=Pn+|color=6:0:1|desc='''Moderate pain''' - Moderate amount of pain receptors have been triggered by wounds. Interferes with actions?}}
{{HealthStatus table row|symbol=Pn~|color=6:0:1|desc='''Slight pain''' - Subject has suffered minor cuts or bruises.}}
{{HealthStatus table row|symbol=St|color=3:0:1|desc='''Stunned''' - The wind has been knocked out of the subject by an unexpected fall, impact, cave-in or takedown. Temporary and harmless in itself.}}
{{HealthStatus table row|symbol=Exh|color=6:0:1|desc='''Exhausted''' - Caused by taking too many combat actions in a turn?{{verify}}}}
{{HealthStatus table row|symbol=Ovx|color=6:0:1|desc='''Over-exerted''' - Caused by taking too many combat actions in a turn?{{verify}}}}
{{HealthStatus table row|symbol=Tir|color=6:0:1|desc='''Tired''' - Caused by taking too many combat actions in a turn?{{verify}}}}
|}

===Fourth Key Column===
This column shows breathing problems and various needs (including extreme like starvation and dehydration).
{{HealthStatus table head}}
{{HealthStatus table row|symbol=Dr|color=1:0:1|desc='''Drowning''' - Cannot breathe due to being stuck underwater. This is an emergency.}}
{{HealthStatus table row|symbol=Wd|color=7:0:0|desc='''Winded'''}}
{{HealthStatus table row|symbol=Br|color=4:0:1|desc='''Cannot breathe''' - Usually indicates severe lung injury or asphyxiation. Death is imminent unless one lung was injured a long time ago and will finish healing to the point of being able to breathe before subject dies.}}
{{HealthStatus table row|symbol=Br|color=7:0:0|desc='''Trouble breathing''' - Usually indicates lung injury or extreme exertion}}
{{HealthStatus table row|symbol=T!|color=4:0:1|desc='''Dehydrated''' - If the subject doesn't receive booze (or [[water]], if hospitalized) they will die. This is an emergency.}}
{{HealthStatus table row|symbol=T~|color=1:0:1|desc='''Thirsty'''}}
{{HealthStatus table row|symbol=H!|color=4:0:1|desc='''Starving''' - If the subject doesn't receive food they will die. This is an emergency.}}
{{HealthStatus table row|symbol=H~|color=6:0:0|desc='''Hungry'''}}
{{HealthStatus table row|symbol=Dw|color=4:0:1|desc='''Very drowsy''' - If the subject doesn't get sleep soon they will go [[insane]]. This is an emergency.}}
{{HealthStatus table row|symbol=Dw|color=1:0:1|desc='''Drowsy''' - Subject is tired enough to go to bed, but hasn't done so yet. Also caused by syndromes.}}
{{HealthStatus table row|symbol=Na|color=2:0:1|desc='''Nauseous''' - Symptom of cave adaptation or injury to the guts. The subject may stop and [[vomit]] instead of making an action. Excessive vomiting can cause dehydration.}}
|}

===Fifth Key Column===
This column shows vision and grasping impairment, problems with nerves, and being unable to stand or fly.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=V|color=4:0:1|desc='''Vision lost''' - Subject will have a very hard time completing normal tasks}}
{{HealthStatus table row|symbol=V|color=6:0:1|desc='''Vision impaired''' - Subject will have a hard time completing normal tasks}}
{{HealthStatus table row|symbol=V|color=7:0:0|desc='''Vision ~impaired''' - Subject will have a slightly hard time completing normal tasks. Caused naturally by old age (110+ with dwarves).}}
{{HealthStatus table row|symbol=P|color=2:0:1|desc='''Popped out''' - Subject's intestines have popped out. Death is imminent.}}
{{HealthStatus table row|symbol=Sx|color=6:0:1|desc='''Cannot stand''' - Subject can only crawl due to dismemberment or lower body paralysis. Subject needs a [[crutch]] to stand or walk.}}
{{HealthStatus table row|symbol=S~|color=6:0:1|desc='''Stand impaired''' - Subject has trouble standing due to numbness or injury to the legs. Subject might need a crutch? {{verify}}}}
{{HealthStatus table row|symbol=Gx|color=6:0:1|desc='''Cannot grasp''' - Subject cannot manipulate objects due to dismemberment or paralysis.}}
{{HealthStatus table row|symbol=G~|color=6:0:1|desc='''Grasp impaired''' - Subject has trouble with fine motor control, but can still grasp things. Typically caused by injury or numbness.}}
{{HealthStatus table row|symbol=Fx|color=6:0:1|desc='''Cannot fly''' - Subject can no longer fly due to paralysis or injury. Applied only to former flyers.}}
{{HealthStatus table row|symbol=F~|color=6:0:1|desc='''Flight impaired''' - Subject has trouble flying due to injury. Applied only to flyers.}}
{{HealthStatus table row|symbol=Mn|color=3:0:1|desc='''Motor nerve''' - A motor nerve has been damaged, which can affect the subject's ability to move, stand, or fly}}
{{HealthStatus table row|symbol=Sn|color=3:0:1|desc='''Sensory nerve''' - A sensory nerve has been damaged, which can affect the subject's ability to feel sensations, to see, and to breathe{{verify}}}}
|}

===Sixth Key Column===
This column shows torn arteries, tendons and ligaments along with fractures and bruising.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=A!|color=4:0:1|desc='''Major artery torn''' - Heart injury or torn throat. This is invariably fatal.}}
{{HealthStatus table row|symbol=A+|color=4:0:1|desc='''Artery torn''' - Subject will probably suffer bleeding of some type. This can be an emergency.}}
{{HealthStatus table row|symbol=Of|color=4:0:1|desc='''Overlapping fracture''' - Typically a limb fracture with severely displaced fragments. A traction bench may be required to reconnect the bones.}}
{{HealthStatus table row|symbol=Cf|color=4:0:1|desc='''Compound fracture''' - A bone fracture exposed through an open wound. Presents an infection risk.}}
{{HealthStatus table row|symbol=Tn|color=4:0:1|desc='''Torn tendon''' - Muscle is severed from the bone. Causes severe pain and disables limb?{{verify}}}}
{{HealthStatus table row|symbol=Tn|color=6:0:1|desc='''Tendon strain''' - Muscle damage. Causes pain and limits movement?{{verify}}}}
{{HealthStatus table row|symbol=Tn|color=6:0:0|desc='''Tendon bruise''' - Slight muscle damage.}}
{{HealthStatus table row|symbol=Lg|color=4:0:1|desc='''Torn ligament''' - Broken joint. Causes severe pain and disables limb?{{verify}}}}
{{HealthStatus table row|symbol=Lg|color=6:0:1|desc='''Ligament strain''' - Joint damage. Causes pain and limits movement? {{verify}}}}
{{HealthStatus table row|symbol=Lg|color=6:0:0|desc='''Ligament bruise''' - Slight joint damage.}}
{{HealthStatus table row|symbol=Ns|color=6:0:1|desc='''Need setting''' - A [[bone doctor]] is needed to treat injuries}}
|}

===Seventh Key Column===
This column shows broken tissue, different degrees of pain, damage and swelling, and whether the subject has an infection.
{{HealthStatus table head}}
{{HealthStatus table row|symbol=X!|color=4:0:1|desc='''Broken tissue'''}}
{{HealthStatus table row|symbol=D!|color=4:0:1|desc='''Heavy damage''' - Varying degrees of bruising. Typically caused by syndromes.}}
{{HealthStatus table row|symbol=D+|color=6:0:1|desc='''Moderate damage''' - Varying degrees of bruising. Typically caused by syndromes.}}
{{HealthStatus table row|symbol=D~|color=6:0:0|desc='''Light damage''' - Varying degrees of bruising. Typically caused by syndromes.}}
{{HealthStatus table row|symbol=X~|color=6:0:1|desc='''Partially broken tissue''' - The subject's skin or muscle is cut or torn open. Not necessarily an emergency.}}
{{HealthStatus table row|symbol=Pb!|color=6:0:1|desc='''Extreme pain''' - Not caused by injuries. Syndrome symptom?}}
{{HealthStatus table row|symbol=Pb+|color=6:0:1|desc='''Moderate pain''' - Not caused by injuries. Syndrome symptom?}}
{{HealthStatus table row|symbol=Pb~|color=6:0:1|desc='''Minor pain''' - Not caused by injuries. Syndrome symptom?}}
{{HealthStatus table row|symbol=Sw!|color=6:0:1|desc='''Extreme swelling''' - Typically caused by syndromes. Further impedes use of affected limbs and matures into necrosis. Swelling of the throat can cause suffocation.}}
{{HealthStatus table row|symbol=Sw+|color=6:0:1|desc='''Medium swelling''' - Typically caused by syndromes. Impedes use of affected limbs.}}
{{HealthStatus table row|symbol=Sw~|color=6:0:1|desc='''Minor swelling''' - Typically caused by syndromes. Slightly impedes use of affected limbs.}}
{{HealthStatus table row|symbol=In|color=5:0:1|desc='''Infection''' - Appears in open wounds either exposed to contaminated water or left untreated for too long. Cannot be treated. Subject's health attributes may affect survival rate?{{verify}}}}
|}

{{Category|Healthcare}}
{{Category|Interface}}