v50 Steam/Premium information for editors
  • v50 information can now be added to pages in the main namespace. v0.47 information can still be found in the DF2014 namespace. See here for more details on the new versioning policy.
  • Use this page to report any issues related to the migration.
This notice may be cached—the current version can be found here.

Difference between revisions of "Creature token"

From Dwarf Fortress Wiki
Jump to navigation Jump to search
(→‎P: added adventurers using pack animals)
(Unique demons haven't had [POWER] for a while now.)
 
(121 intermediate revisions by 38 users not shown)
Line 1: Line 1:
{{Quality|Exceptional|22:04, 20 September 2016 (UTC)}}
+
{{Quality|Exceptional}}
 
{{av}}
 
{{av}}
 
{{Modding}}
 
{{Modding}}
  
The <code>[OBJECT:CREATURE]</code> [[token]] defines the properties of [[creatures]]; <!-- The exact nature of this creatures is further specified by the ... tokens.--> this being a full list of all known creature tokens:
+
The <code>[OBJECT:CREATURE]</code> [[token]] begins the definition of a ''Dwarf Fortress'' [[creature]] [[raw file]]. Each creature definition that follows begins with the {{token|creature|c|creature ID}} token, and the creature's exact properties and behavior are then specified by the use of further creature tokens. All known creature tokens are listed below.
  
__NOTOC__
+
Vanilla creature definitions can be found in <code>[[Game folder|<Dwarf Fortress>]]\data\vanilla\vanilla_creatures\</code>.
 +
Creature ID is also used with [[graphics token]]s to make customizable [[graphics set]]s.
  
 +
The [[caste]] tokens allow defining sub-species within the broader creature definition, including true biological castes and lesser variations, such as sexes. Creature tokens can either be 'Creature' or 'CASTE-only' type which can only be applied to creature or cast respectively, or 'CASTE' which can be applied to both. In the table bellow, creature type distinguish tokens that can be applied to creature only, cast only and both ('creature', 'CASTE-only', and 'CASTE' respectively)
 +
 +
__NOTOC__
 
{{clear}}
 
{{clear}}
 
{{alphabetical TOC|style=margin: 1em auto;}}
 
{{alphabetical TOC|style=margin: 1em auto;}}
Line 22: Line 26:
 
| Caste
 
| Caste
 
|
 
|
| Prevents tamed creature from being made available for adoption, instead allowing it to automatically adopt whoever it wants. The basic requirements for adoption are intact, and the creature will only adopt individuals who have a [[preference]] for their species. Used by [[cat]]s in the vanilla game.
+
| Prevents tamed creature from being made available for adoption, instead allowing it to automatically adopt whoever it wants. The basic requirements for adoption are intact, and the creature will only adopt individuals who have a [[preference]] for their species. Used by [[cat]]s in the vanilla game. When {{k|v}}iewing a tame creature with this token, the message "This animal isn't interested in your wishes" will appear instead of "This [adorable] animal can't work" or "This animal is waiting to be trained".
  
 
|-
 
|-
Line 34: Line 38:
 
| Caste
 
| Caste
 
|   
 
|   
| Sets the creature to be active during the day, night, and twilight in Adventurer Mode. Seems to be a separate value from {{token|DIURNAL|c}}/{{token|NOCTURNAL|c}}/{{token|CREPUSCULAR|c}}, rather than implying them.
+
| When set, the creature will appear at any time of day. Overrides {{token|DIURNAL|c}}, {{token|NOCTURNAL|c}}, {{token|CREPUSCULAR|c}}, {{token|MATUTINAL|c}}, and {{token|VESPERTINE|c}}.
  
 
|-
 
|-
Line 57: Line 61:
 
|-
 
|-
 
| {{text anchor|APP_MOD_DESC_RANGE}}
 
| {{text anchor|APP_MOD_DESC_RANGE}}
| Caste
+
| Appearance Modifier
 
|
 
|
*Range
+
*Range (6 values, low to high)
| [http://www.bay12forums.com/smf/index.php?topic=60554.msg1766793#msg1766793 Forum post describing how description ranges work]
+
| Based on info from [http://www.bay12forums.com/smf/index.php?topic=113762.msg3473069#msg3473069 Wannabehero on the forums]: When used with an appearance modifier token (BP_APPEARANCE_MODIFIER or BODY_APPEARANCE_MODIFIER), tells the game what numeric ranges to map to which descriptors.
 +
 
 +
The game uses 7 descriptor levels for each modifier, with the center one generally being to omit the thing from the creature description entirely. The six values in APP_MOD_DESC_RANGE define the boundaries between each described range. If this is not specified it uses the numbers 10:50:95:105:150:190.
  
 
|-
 
|-
 
| {{text anchor|APP_MOD_GENETIC_MODEL}}
 
| {{text anchor|APP_MOD_GENETIC_MODEL}}
| Caste
+
| Appearance Modifier
 
|
 
|
 
*Model (Accepts DOMINANT_MORE, DOMINANT_LESS, and MIX)
 
*Model (Accepts DOMINANT_MORE, DOMINANT_LESS, and MIX)
Line 71: Line 77:
 
|-
 
|-
 
| {{text anchor|APP_MOD_IMPORTANCE}}
 
| {{text anchor|APP_MOD_IMPORTANCE}}
| Caste
+
| Appearance Modifier
 
|
 
|
 
*number
 
*number
Line 78: Line 84:
 
|-
 
|-
 
| {{text anchor|APP_MOD_NOUN}}
 
| {{text anchor|APP_MOD_NOUN}}
| Caste
+
| Appearance Modifier
 
|  
 
|  
 
*noun
 
*noun
Line 86: Line 92:
 
|-
 
|-
 
| {{text anchor|APP_MOD_RATE}}
 
| {{text anchor|APP_MOD_RATE}}
| Caste
+
| Appearance Modifier
 
|  
 
|  
 
*Rate (integer)
 
*Rate (integer)
Line 141: Line 147:
 
|  
 
|  
 
*token
 
*token
*bodypart
+
*selection criteria (it's complicated)
*selection criteria
 
*location
 
 
| Defines the attack name, and the body part used. See [[#Attack Tokens|below]] for valid subtokens
 
| Defines the attack name, and the body part used. See [[#Attack Tokens|below]] for valid subtokens
 
'''Example:'''<br />
 
'''Example:'''<br />
Line 157: Line 161:
 
*exported wealth
 
*exported wealth
 
*created wealth
 
*created wealth
| Specifies when a [[megabeast]] or [[semi-megabeast]] will attack the fortress. The attacks will start occuring when at least one of the requirements is met. Setting a value to 0 disables the trigger.
+
| Specifies when a [[megabeast]] or [[semi-megabeast]] will attack the fortress. The attacks will start occurring when all of the requirements are met. Setting a value to 0 disables the trigger.
  
 
|}
 
|}
Line 198: Line 202:
 
|   
 
|   
 
| The creature is non-aggressive by default, and will never automatically be engaged by companions or soldiers, running away from any creatures that are not friendly to it, and will only defend itself if it becomes enraged. Can be thought of as the counterpoint of the {{token|LARGE_PREDATOR|c}} tag. When tamed, animals with this tag will be useless for fortress defense.
 
| The creature is non-aggressive by default, and will never automatically be engaged by companions or soldiers, running away from any creatures that are not friendly to it, and will only defend itself if it becomes enraged. Can be thought of as the counterpoint of the {{token|LARGE_PREDATOR|c}} tag. When tamed, animals with this tag will be useless for fortress defense.
 +
 +
This and {{token|TRADE_CAPACITY|c}} are required for {{token|PACK_ANIMAL|c}} to function properly, if an animal contains the aforementioned requirements without this tag: items loaded by the merchants will be dropped upon departure.
  
 
|-
 
|-
Line 230: Line 236:
 
This is the body from a [[purring maggot]]. It creates a body with head, a heart, some guts, a brain, and a mouth. That's all a maggot needs.
 
This is the body from a [[purring maggot]]. It creates a body with head, a heart, some guts, a brain, and a mouth. That's all a maggot needs.
  
'''If the body is left undefined, the creature will cause a crash whenever it spawns.''' {{verify}}
+
The body parts need to be listed in an order such that any parent part appears before its connected children. For example [BODY:HEART:BODY_WITH_HEAD_FLAG] produces a "Body Token Recognized But Could Not Connect: HEART" error because HEART can't find any UPPERBODY(s) to connect to. Switching the order to [BODY:BODY_WITH_HEAD_FLAG:HEART] fixes the problem because now the UPPERBODY is created before the HEART tries to connect to it.
 +
 
 +
'''If the body is left undefined, the creature (or caste) will be tagged as [DOES_NOT_EXIST].''' {{verify}}
  
 
|-
 
|-
Line 345: Line 353:
 
| Caste
 
| Caste
 
|   
 
|   
| The creature gains [[skill]]s and can have [[labor|professions]]. If a member of a civilization (even a pet) has this token, it'll need to eat, drink and sleep. Note that this token makes the creature unable to be eaten 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.
+
| The creature gains [[skill]]s and can have [[labor|professions]]. If a member of a civilization (even a pet) has this token, it'll need to eat, drink and sleep. Note that this token makes the creature unable to be eaten 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. A creature with at least this token or the {{token|CAN_SPEAK|c}} token will be able to have [[Personality traits, values, and dreams#Values|values]] and [[Personality traits, values, and dreams#Dreams|dreams]].
  
 
|-
 
|-
Line 351: Line 359:
 
| Caste
 
| Caste
 
|   
 
|   
| Can [[talking|talk]]. Note that this is not necessary for a creature to gain social skills.
+
| Can [[talking|talk]]. Note that this is not necessary for a creature to gain social skills. A creature with at least this token or the {{token|CAN_LEARN|c}} token will be able to have [[Personality traits, values, and dreams#Values|values]] and [[Personality traits, values, and dreams#Dreams|dreams]].
  
 
|-
 
|-
Line 375: Line 383:
 
| Caste
 
| Caste
 
|   
 
|   
| Allows the creature to open [[door]]s that are set to be unpassable for pets. In adventure mode, creatures lacking this token will be unable to pass through door tiles except whilst these are occupied by other creatures.
+
| Allows the creature to open [[door]]s that are set to be unpassable for pets. In adventure mode, creatures lacking this token will be unable to pass through door tiles except whilst these are occupied by other creatures. Not currently useful in Fortress mode as doors can no longer be set unpassable for pets.{{version|50.03}}
  
 
|-
 
|-
Line 429: Line 437:
 
*plural
 
*plural
 
*adjective  
 
*adjective  
| Caste-specific {{token|NAME|c}}.
+
| While {{token|NAME|c}} describes the name of the species, {{token|CASTE_NAME|c}} names individuals of the species. Unlike other caste-specific descriptions, this token is required, even for creatures without separate castes. If left undefined, the creature will not show up in the [[arena]] and members of the species will be labeled as "nothing".
  
 
|-
 
|-
Line 453: Line 461:
 
*'character' or tile number
 
*'character' or tile number
 
| Caste-specific {{token|CREATURE_SOLDIER_TILE|c}}.
 
| Caste-specific {{token|CREATURE_SOLDIER_TILE|c}}.
 
|-
 
| {{text anchor|CASTE_SPEECH}}
 
| Caste
 
|
 
*speech file
 
| Caste-specific {{token|SPEECH|c}}.
 
  
 
|-
 
|-
Line 472: Line 473:
 
| Caste
 
| Caste
 
|   
 
|   
| Gives the creature a bonus in caves. Also causes [[cave adaptation]].  
+
| Causes [[cave adaptation]].
 +
Allows for creature's race to be involved in jokes that end in "And the [race] saw the sun and vomited on the spot!"
  
 
|-
 
|-
Line 479: Line 481:
 
|  
 
|  
 
*Varies
 
*Varies
| Specifies details for the preceding {{token|CAN_DO_INTERACTION|c}} token. See [[interaction token]].
+
| Specifies interaction details following a {{token|CAN_DO_INTERACTION|c}} token. See [[interaction token]].
  
 
|-
 
|-
Line 516: Line 518:
 
*min
 
*min
 
*max
 
*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. Defaults to 1:1 if not specified.
+
| The minimum/maximum numbers of how many creatures per spawned cluster. Vermin fish with this token in combination with temperate ocean and river biome tokens [http://www.bay12forums.com/smf/index.php?topic=51864.msg1122319#msg1122319 will perform seasonal migrations]. Defaults to 1:1 if not specified.
  
 
|-
 
|-
Line 567: Line 569:
 
|-
 
|-
 
| {{text anchor|COPY_TAGS_FROM}}
 
| {{text anchor|COPY_TAGS_FROM}}
| Spec
+
| Special
 
|  
 
|  
*CREATURE NAME
+
*creature ID
| Copies creature tags, but not caste tags, from another specified creature. Used when making creature variations (i.e. giant animals and [[animal people]]). Often used in combination with {{token|APPLY_CREATURE_VARIATION|c}} to import standard variations from a file. Variations are documented in c_variation_default.txt, which also contains the code for giant animals and animal people.
+
| Copies another specified creature. This will override any definitions made before it; essentially, it makes this creature identical to the other one, which can then be modified. Often used in combination with {{token|APPLY_CREATURE_VARIATION|c}} to import standard variations from a file. The vanilla [[giant animal]]s and [[animal person|animal people]]s are examples of this token combination.
 +
 
 +
|-
 +
| {{text anchor|CREATURE}}
 +
| Creature
 +
|
 +
*creature ID
 +
| A unique, arbitrary identifier that begins the definition of each new creature, and is used to reference the creature in other tokens and raws.
  
 
|-
 
|-
Line 604: Line 613:
 
| Caste
 
| Caste
 
|   
 
|   
| Sets the creature to be active at twilight in adventurer mode.
+
| When set, the creature will appear at dawn (between 4:30 AM and 6:00 AM) and in the evening (between 8:00 PM and 10:05 PM) in Adventurer mode.
  
 
|-
 
|-
Line 622: Line 631:
 
| Caste
 
| Caste
 
|   
 
|   
| Allows a creature to [[Steals items|steal things]] (apparently, of the highest value it can find). It will attempt to grab an item of value and immediately make its way to the map's edge, where it will disappear with it. If the creature goes on rampages in worldgen, it will often steal items instead of attacking - [[kea]] birds are infamous for this. Trained and tame instances of the creature will no longer display this behavior. Also, makes the creature unable to drop hauled items until it enters combat.
+
| Allows a creature to [[Steals items|steal things]] (apparently, of the highest value it can find). It will attempt to grab an item of value and immediately make its way to the map's edge, where it will disappear with it. If a creature with any of the CURIOUSBEAST tokens carries anything off the map, even if it is a caravan's pack animal, it will be reported as stealing everything it carries. If the creature goes on rampages in worldgen, it will often steal items instead of attacking - [[kea]] birds are infamous for this. Trained and tame instances of the creature will no longer display this behavior. Also, makes the creature unable to drop hauled items until it enters combat.
  
 
|-
 
|-
Line 653: Line 662:
 
| Caste
 
| Caste
 
|   
 
|   
| Found on generated [[demon]]s. Marks the caste to be used in the initial wave after breaking into the [[underworld]], and by the demon civilizations created during world-gen breachings{{verify}} {{version|0.47.01}}. Could not be specified in user-defined raws until version [[Release_information/0.47.01|0.47.01]].
+
| Found on generated [[demon]]s. Marks the caste to be used in the initial wave after breaking into the [[underworld]], and by the demon civilizations created during world-gen breachings{{verify}}.
  
 
|-
 
|-
Line 679: Line 688:
 
| Caste
 
| Caste
 
|   
 
|   
| Sets the creature to be active during the day in Adventurer Mode.
+
| When set, the creature will only appear during the day (between 6:00 AM and 8:00 PM) in Adventurer mode.
  
 
|-
 
|-
Line 740: Line 749:
 
| Creature
 
| Creature
 
|   
 
|   
| Makes the creature appear as a large 3x3 [[wagon]] responsible for carrying trade goods, pulled by two {{token|WAGON_PULLER|c}} creatures and driven by a merchant.
+
| Makes the creature appear as a large 3×3 [[wagon]] responsible for carrying trade goods, pulled by two {{token|WAGON_PULLER|c}} creatures and driven by a merchant.
  
 
|-
 
|-
Line 773: Line 782:
 
| Caste
 
| Caste
 
|   
 
|   
| The creature can see regardless of whether it has working eyes and has full 360 degree vision, making it impossible to strike the creature from a blind spot in combat.  
+
| The creature can see regardless of whether it has working eyes and has full 360 degree vision, making it impossible to strike the creature from a blind spot in combat. Invisible creatures will also be seen, namely [[intelligent undead]] using a "vanish" power.
 
|}
 
|}
  
Line 796: Line 805:
 
| Caste
 
| Caste
 
|
 
|
| Found on [[Animal people#Subterranean animal people|subterranean animal-man]] tribals. Currently defunct. In previous versions, it caused these creatures to crawl out of chasms and underground rivers.
+
| Found on [[Animal people#Subterranean animal people|subterranean animal-man]] tribals. Currently defunct. In previous versions{{verify}}, it caused these creatures to crawl out of chasms and underground rivers.
  
 
|-
 
|-
Line 802: Line 811:
 
| Caste
 
| Caste
 
|
 
|
| Found on [[forgotten beast]]s. Presumably makes it act as such, initiating underground attacks on fortresses, or leads to the pop-up message upon encountering one{{verify}}. Hides the creature from displaying in a world_sites_and_pops file. Does not create historical figures like generated forgotten beasts do. Could not be specified in user-defined raws until version [[Release_information/0.47.01|0.47.01]].  
+
| Found on [[forgotten beast]]s. Presumably makes it act as such, initiating underground attacks on fortresses, or leads to the pop-up message upon encountering one{{verify}}. Hides the creature from displaying in a world_sites_and_pops file. Does not create historical figures like generated forgotten beasts do.
  
 
Requires specifying a {{token|BIOME|c}} in which the creature will live, and both surface and subterranean biomes are allowed. Does not stack with {{token|LARGE_ROAMING|c}} and if both are used the creature will not spawn. Appears to be incompatible with {{token|DEMON|c}} even if used in separate castes.
 
Requires specifying a {{token|BIOME|c}} in which the creature will live, and both surface and subterranean biomes are allowed. Does not stack with {{token|LARGE_ROAMING|c}} and if both are used the creature will not spawn. Appears to be incompatible with {{token|DEMON|c}} even if used in separate castes.
Line 836: Line 845:
 
|  
 
|  
 
*temperature  
 
*temperature  
| The creature's body is constantly at this temperature, heating up or cooling the surrounding area. Alters the temperature of the creature's inventory and all adjacent tiles, [[Temperature|with all the effects that this implies]] - may trigger wildfires at high enough values. Also makes the creature immune to extreme heat or cold, as long as the temperature set is not harmful to the materials that the creature is made from.
+
| The creature's body is constantly at this temperature, heating up or cooling the surrounding area. Alters the temperature of the creature's inventory and all adjacent tiles, [[Temperature|with all the effects that this implies]] - may trigger wildfires at high enough values. Also makes the creature immune to extreme heat or cold, as long as the temperature set is not harmful to the materials that the creature is made from. Corpses and body parts of creatures with a fixed temperature maintain their temperature even after death.
  
 
Note that temperatures of 12000 and higher may cause [[path|pathfinding]] issues in fortress mode.
 
Note that temperatures of 12000 and higher may cause [[path|pathfinding]] issues in fortress mode.
Line 857: Line 866:
 
|
 
|
 
*number, max 100
 
*number, max 100
| Determines the chances of a creature appearing within its environment, with higher values resulting in more frequent appearance. Also affects the chance of a creature being brought in a caravan for trading. 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 {{token|POP_RATIO|c}}.
+
| Determines the chances of a creature appearing within its environment, with higher values resulting in more frequent appearance. Also affects the chance of a creature being brought in a caravan for trading.
 +
This value is used multiply to determine the rarity of animal populations. A creature with [FREQUENCY:50] will appear in 50% of valid biomes, and be present in 50% of the area within those biomes.
 +
When a [[Creature token#CLUSTER_NUMBER|cluster]] spawns, 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 {{token|POP_RATIO|c}}.
 
|}
 
|}
  
Line 882: Line 893:
 
* <energy expenditure>
 
* <energy expenditure>
 
* <gait flag(s)>
 
* <gait flag(s)>
| Defines a gait by which the creature can move. See [[Gait]] for more information.
+
| Defines a gait by which the creature can move. See [[Gait]] for more information. Specifically, you likely want to use one of the existing STANDARD_X_GAITS creature variations, as described in [[Gait#Gaits_and_Modding|this subsection]].
  
 
* <max speed> indicates the maximum [[Gait#Speed|speed]] achievable by a creature using this gait
 
* <max speed> indicates the maximum [[Gait#Speed|speed]] achievable by a creature using this gait
Line 1,021: Line 1,032:
 
| Special
 
| Special
 
|   
 
|   
| When using tags from an existing creature, inserts new tags after the specified tag.
+
| When using tags from an existing creature, inserts new tags ''before'' the specified tag.
  
 
|-
 
|-
Line 1,048: Line 1,059:
 
|
 
|
 
*number
 
*number
| The creature is a grazer - if tamed in fortress mode, it needs a pasture to survive. The higher the number, the less frequently it needs to eat in order to live. See [[Pasture]] for details on its issues.
+
| The creature is a grazer - if tamed in fortress mode, it needs a pasture to survive. The higher the number, the less frequently it needs to eat in order to live. Not used since 0.40.12, replaced by {{token|STANDARD_GRAZER|c}} to fix {{bugl|4113}}.
 
|}
 
|}
  
Line 1,078: Line 1,089:
 
*GIANT_NEST
 
*GIANT_NEST
 
*COLLECT_WEALTH.
 
*COLLECT_WEALTH.
These require the creature to have a {{token|LAIR|c}} to work properly, and also don't seem to work on creatures who are not a {{token|SEMIMEGABEAST|c}}, {{token|MEGABEAST|c}} or {{token|NIGHT_CREATURE_HUNTER|c}}.
+
These require the creature to have a {{token|LAIR|c}} to work properly, and also don't seem to work on creatures who are not a {{token|SEMIMEGABEAST|c}}, {{token|MEGABEAST|c}}, or{{token|NIGHT_CREATURE_HUNTER|c}}.
  
 
|-
 
|-
Line 1,098: Line 1,109:
 
|   
 
|   
 
| The creature has a shell. Seemingly no longer used - holdover from previous versions.
 
| The creature has a shell. Seemingly no longer used - holdover from previous versions.
 
|-
 
| {{text anchor|HFID}}
 
| Creature
 
|
 
*Integer (generic token?)
 
| Found on generated [[angel]]s. This is the historical figure ID of the deity with which the angel is associated.
 
  
 
|-
 
|-
Line 1,126: Line 1,130:
 
| Caste
 
| Caste
 
|
 
|
| Creature hunts and kills nearby [[vermin]].
+
| Creature hunts and kills nearby [[vermin]], randomly walking between places with food laying on the ground or in stockpiles, to check for possible [VERMIN_EATER] vermin, but they'll kill any other vermin too. Do not include this creature token on an intelligent entity that you intend to play as in fortress mode because it will prevent them from feeding themselves.
  
 
|}
 
|}
Line 1,144: Line 1,148:
 
| Caste
 
| Caste
 
|  
 
|  
| The creature cannot move. Found on [[sponge]]s. Will also stop a creature from breeding in fortress mode (MALE and FEMALE are affected, if one is IMMOBILE no breeding will happen).
+
| The creature cannot move. Found on [[sponge]]s. Will also stop a creature from breeding in fortress mode (MALE and FEMALE are affected, if one is IMMOBILE; no breeding will happen).
  
 
|-
 
|-
Line 1,156: Line 1,160:
 
| Caste
 
| Caste
 
|   
 
|   
| The creature radiates [[fire]]. It 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.
+
| The creature radiates [[fire]]. It will ignite, and potentially completely destroy, items the creature is standing on. Also gives the vermin a high chance of escaping from [[animal trap]]s and [[cage]]s made of any flammable materials (specifically ones that could be ignited by magma).
  
 
|-
 
|-
Line 1,162: Line 1,166:
 
| Caste
 
| Caste
 
|   
 
|   
| Alias for {{token|CAN_SPEAK|c}} + {{token|CAN_LEARN|c}} but additionally keeps creatures from being [[butcher|butchered]] by the AI during worldgen and post-gen. In fortress mode, {{token|CAN_LEARN|c}} is enough.
+
| Alias for {{token|CAN_SPEAK|c}} + {{token|CAN_LEARN|c}}.
  
 
|-
 
|-
Line 1,170: Line 1,174:
 
* [[item token]]
 
* [[item token]]
 
* [[material token]]
 
* [[material token]]
| Determines if the creature leaves behind a non-standard corpse (i.e. wood, statue, bars, stone, pool of liquid, etc.).
+
| Determines if the creature leaves behind a non-standard corpse (i.e. wood, statue, bars, stone, pool of liquid, etc.). [[Ethics]] may prevent actually using the item in jobs or reactions.
  
 
|-
 
|-
Line 1,228: Line 1,232:
 
| Caste
 
| Caste
 
|   
 
|   
| Will attack things that are smaller than it (like dwarves). Only one group of "large predators" (possibly two groups on "savage" maps) will appear on any given map. 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."  
+
| Will attack other creatures that are smaller than it. In [[fortress mode]], only one group of "large predators" (possibly two groups on "savage" maps) will appear on any given map. In [[adventurer 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."
 +
A single biome supports 7 large predator species, picking randomly and rolling a d100 under its {{token|FREQUENCY|c}} to add it until all 7 slots are filled.
 +
 
 +
Incompatible with {{token|PACK_ANIMAL|c}} on a technicality, if included: hauled items are likely to be dropped upon entering the map (even if {{token|TRADE_CAPACITY|c}} is present) in contrast to when the merchants depart.
  
 
|-
 
|-
Line 1,236: Line 1,243:
 
| This is the core requisite tag allowing the creature to spawn as a wild animal in the appropriate biomes. Requires specifying a {{token|BIOME|c}} in which the creature will spawn. Does not require specifying a frequency, population number, or cluster number.
 
| This is the core requisite tag allowing the creature to spawn as a wild animal in the appropriate biomes. Requires specifying a {{token|BIOME|c}} in which the creature will spawn. Does not require specifying a frequency, population number, or cluster number.
  
This tag stacks with {{token|MEGABEAST|c}}, {{token|SEMIMEGABEAST|c}}, or {{token|NIGHT_CREATURE_HUNTER|c}}; if used with one of these tags, the creature will spawn as both a boss and as a wild animal. This tag does not stack with {{token|FEATURE_BEAST|c}} and if both are used the creature will not spawn. This tag is uneffected by {{token|DEMON|c}}.
+
This tag stacks with {{token|MEGABEAST|c}}, {{token|SEMIMEGABEAST|c}}, or {{token|NIGHT_CREATURE_HUNTER|c}}; if used with one of these tags, the creature will spawn as both a boss and as a wild animal. This tag does not stack with {{token|FEATURE_BEAST|c}} and if both are used the creature will not spawn. This tag is unaffected by {{token|DEMON|c}}.
  
 
|-
 
|-
Line 1,264: Line 1,271:
 
| Caste
 
| Caste
 
|   
 
|   
| The creature will generate light, such as in adventurer mode at night.  
+
| A vermin featuring this tag will remain visible to an adventurer, even at night (without being dimmed in color along with the surrounding terrain), and from a distance (even outside the current vision cone). Subterranean vermin which feature this token will flicker in unexposed and unrevealed cavern layers while playing in Fortress Mode.
  
 
|-
 
|-
Line 1,284: Line 1,291:
 
* minimum
 
* minimum
 
* maximum
 
* maximum
| Determines the number of offspring per one birth.
+
| Determines the number of offspring per one birth; default 1-3, not used in vanilla raws. See also {{token|MULTIPLE_LITTER_RARE|c}}.
  
 
|-
 
|-
| {{text anchor|LOCAL_POPS_CONTROLLABLE}}{{version|0.42.01}}
+
| {{text anchor|LOCAL_POPS_CONTROLLABLE}}
 
| Creature
 
| Creature
 
|
 
|
Line 1,293: Line 1,300:
  
 
|-
 
|-
| {{text anchor|LOCAL_POPS_PRODUCE_HEROES}}{{version|0.42.01}}
+
| {{text anchor|LOCAL_POPS_PRODUCE_HEROES}}
|
+
| Creature
 
|
 
|
 
| Wild animals of this species may occasionally join a civilization. Prevents trading of (tame) instances of this creature in caravans.
 
| Wild animals of this species may occasionally join a civilization. Prevents trading of (tame) instances of this creature in caravans.
Line 1,358: Line 1,365:
 
|
 
|
 
*material id
 
*material id
| Begins defining a new material.{{verify}}
+
| Begins defining a new local material. Follow this with standard material definition tokens to define the material.
  
 
|-
 
|-
Line 1,373: Line 1,380:
 
| Caste
 
| Caste
 
|  
 
|  
| Sets the creature to be active at dawn in adventurer mode.  
+
| When set, the creature will only appear at dawn (between 4:30 AM and 6:00 AM) in Adventurer mode.
  
 
|-
 
|-
Line 1,388: Line 1,395:
 
| Caste
 
| Caste
 
|   
 
|   
| Makes the creature slowly stroll around, unless it's in combat or performing a job. If combined with {{token|CAN_LEARN|c}}, will severely impact their [[pathfinding]] and lead the creature to move extremely slowly when not performing any task.
+
| Makes the creature slowly stroll around, unless it's in combat or performing a job. If combined with {{token|CAN_LEARN|c}}, will severely impact their [[pathfinding]] and lead the creature to move extremely slowly when not performing any task. Problematically applies to animal people based on the animal and war trained animals{{bug|9588}}.
  
 
|-
 
|-
Line 1,473: Line 1,480:
 
| Caste
 
| Caste
 
|   
 
|   
| Allows the creature to have all-around vision as long as it has multiple heads that can see.
+
| Allows the creature to have all-around vision, as long as it has multiple heads that can see.
  
 
|-
 
|-
Line 1,479: Line 1,486:
 
| Caste
 
| Caste
 
|   
 
|   
| Makes the species usually produce a single offspring per birth, occasionally producing twins or triplets with a 1/500 chance.  Requires {{token|FEMALE|c}}.
+
| Makes the species usually produce a single offspring per birth, with a 1/500 chance of using the {{token|LITTERSIZE|c}} as usual.  Requires {{token|FEMALE|c}}.
  
 
|-
 
|-
Line 1,505: Line 1,512:
 
*plural
 
*plural
 
*adjective  
 
*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 {{token|CASTE_NAME|c}} instead. If left undefined, the creature will be labeled as "nothing" by the game.
+
| The generic name for any creature of this type - will be used for referring to the species in the abstract, such as the default material prefix. For labeling individual creatures, {{token|CASTE_NAME|c}} is necessary. If left undefined, the creature will be labeled as "nothing" by the game.
 +
 
 +
Some examples of adjective use:
 +
* "super''dwarven'' strength"
 +
* "the ''dwarven'' hillocks of X"
 +
* Deity species as in "''feline'' deity"
 +
* Megabeast attacks in worldgen. One with multiple dragons being a "''draconic'' rampage"
  
 
|-
 
|-
Line 1,526: Line 1,539:
 
*value
 
*value
 
| The creature possesses the specified [[skill]] at this level inherently - that is, it begins with the skill at this level, and the skill may never rust below that. A value of 15 is legendary.
 
| The creature possesses the specified [[skill]] at this level inherently - that is, it begins with the skill at this level, and the skill may never rust below that. A value of 15 is legendary.
 +
 +
|-
 +
| {{text anchor|NIGHT_CREATURE}}
 +
| Caste
 +
|
 +
| Creatures with this token can appear as [[experiment|experiments]].
 +
Prevents {{token|LOCAL_POPS_PRODUCE_HEROES|c}} from functioning. Causes the creature to count as {{token|NOT_LIVING|c}}. Killing a creature featuring this token provides one point of "hero" reputation. Adds the creature's description as part of the initial summary of their historical figure in legends mode. Prevents creature behavior enabled by {{token|LARGE_PREDATOR|c}}. People will react to creatures with this token as a night creature (natch). In adventure mode, ambushes involving these units will say "Night creature!" instead of "Ambush!"
 +
 +
Prevents the AI from using ANIMATE interactions, unless the newly-animated{{token|OPPOSED_TO_LIFE|c}}undead will not attack them. The check for this is specifically whether the unit is:
 +
*a ghost
 +
*an animated unit
 +
*a unit with the {{token|NO_AGING|c}} token added via {{token|CE_ADD_TAG|c}}. (This allows for the default exclusion of elves and goblins, unless raised as intelligent undead.)
 +
 +
<small>''This token should not be confused with other NIGHT_CREATURE_X tokens.''</small>
 +
<small>''This token is not well understood at the present time.''</small>
  
 
|-
 
|-
Line 1,534: Line 1,562:
  
 
|-
 
|-
| {{text anchor|NIGHT_CREATURE_EXPERIMENTER}}{{version|0.47.01}}
+
| {{text anchor|NIGHT_CREATURE_EXPERIMENTER}}
 
| Caste
 
| Caste
 
|
 
|
Line 1,550: Line 1,578:
  
 
|-
 
|-
| {{text anchor|NIGHT_CREATURE_NIGHTMARE}}{{version|0.47.01}}
+
| {{text anchor|NIGHT_CREATURE_NIGHTMARE}}
 
| Caste
 
| Caste
 
|
 
|
Line 1,595: Line 1,623:
 
| Caste
 
| Caste
 
|
 
|
| The creature is biologically sexless. Makes the creature unable to [[breeding|breed]].
+
| The creature is biologically sexless, making it unable to [[breeding|breed]].
  
 
|-
 
|-
Line 1,613: Line 1,641:
 
| Caste
 
| Caste
 
|   
 
|   
| Creature does not need to sleep. Can still be rendered unconscious by other means.
+
| Creature does not need to sleep, but can still be rendered unconscious by other means.
  
 
|-
 
|-
Line 1,667: Line 1,695:
 
| Caste
 
| Caste
 
|   
 
|   
| Sets the creature to be active at night in adventure mode.  
+
| When set, the creature will only appear at night (after 10:05 PM and before 4:30 AM) in Adventurer mode.
  
 
|-
 
|-
Line 1,679: Line 1,707:
 
| Caste
 
| Caste
 
|   
 
|   
| Creature can't become tired or over-exerted from taking too many combat actions or moving at full speed for extended periods of time.  
+
| Creature can't become tired or over-exerted from taking too many combat actions, or moving at full speed for extended periods of time.  
  
 
|-
 
|-
Line 1,691: Line 1,719:
 
| Caste
 
| Caste
 
|   
 
|   
| Creature will not drop meat when [[butcher|butchered]].
+
| Creature will not be hunted or fed to wild beasts.
  
 
|-
 
|-
Line 1,739: Line 1,767:
 
| Caste
 
| Caste
 
|   
 
|   
| Cannot be [[butcher|butchered]].
+
| Corpses from this creature cannot be [[butcher|butchered]]. Does not prevent the creature from being slaughtered while alive, however.
  
 
|-
 
|-
Line 1,769: Line 1,797:
 
|  
 
|  
 
*number
 
*number
| How easy the creature is to [[smell]]. The higher the number, the easier the creature can be smelt. Zero is odorless, default is 50.
+
| How easy the creature is to [[smell]]. The higher the number, the easier the creature is to sniff out. Defaults to 50. Vanilla creatures have values from 0 (undetectable) to 90 (noticeable by humans and dwarves).
  
 
|-
 
|-
Line 1,790: Line 1,818:
 
*MALE/FEMALE
 
*MALE/FEMALE
 
*disinterested chance
 
*disinterested chance
*lover-possible chance
+
*casual chance
*commitment-possible chance
+
*strong chance
| Determines caste's likelihood of having sexual attraction to certain sexes. Values default to 75:20:5 for the same sex and 5:20:75 for the opposite sex. The first value indicates how likely to be entirely uninterested in the sex, the second decides if the creature will become lovers but not marry, the third decides if the creature will marry this sex. The values themselves are simply ratios and do not need to add up to any particular value.
+
| Determines caste's likelihood of having sexual attraction to certain sexes. Values default to 75:20:5 for the same sex and 5:20:75 for the opposite sex. The first value indicates how likely to be entirely uninterested in the sex, the second decides if the creature will be able to become lovers with that sex, the third decides whether they will be able to marry in worldgen and post-worldgen world activities (which implies being able to become lovers). Marriage seems to be able to happen in fort mode play regardless, as long as they are lovers first.
  
 
|-
 
|-
| {{text anchor|OUTSIDER_CONTROLLABLE}}{{version|0.42.01}}
+
| {{text anchor|OUTSIDER_CONTROLLABLE}}
 
| Caste
 
| Caste
 
|
 
|
Line 1,816: Line 1,844:
 
| Caste
 
| Caste
 
|   
 
|   
| Allows the creature to be used as a pack animal. Used by [[trading|merchants]] without wagons and adventurers. Also prevents creature from dropping hauled items on its own -- do ''not'' use for player-controllable creatures!
+
| Allows the creature to be used as a pack animal. Used by [[trading|merchants]] without wagons and adventurers. Also prevents creature from dropping hauled items on its own -- do ''not'' use for player-controllable creatures! May lead to the creature being domesticated during worldgen, even if it doesn't have {{token|COMMON_DOMESTIC|c}}.
 +
 
 +
Creatures with this tag but without {{token|BENIGN|c}}, and/or with {{token|LARGE_PREDATOR|c}} leads to hauled items being dropped.
  
 
|-
 
|-
Line 1,829: Line 1,859:
 
|   
 
|   
 
| Used to control the bat riders with paralyze-dart blowguns that flew through the 2D chasm. Doesn't do anything now.
 
| Used to control the bat riders with paralyze-dart blowguns that flew through the 2D chasm. Doesn't do anything now.
 +
 +
|-
 +
| {{text anchor|PCG_LAYERING}}
 +
| Creature
 +
|
 +
*[[Procedural graphics layer|Layering type]]
 +
| Adds a layer to the current {{token|PROCEDURAL_CREATURE_GRAPHICS|c}} definition.
  
 
|-
 
|-
Line 1,841: Line 1,878:
 
|  
 
|  
 
*value  
 
*value  
| Controls the ability of [[vermin]] to find a way into containers when they are eating food from your stockpiles. The value for vermin in the game's current version ranges from 1-3. A higher value is better at penetrating containers.
+
| Controls the ability of [[vermin]] to find a way into containers when they are eating food from your stockpiles.
 +
 
 +
Objects made of most materials (e.g. metal) roll a number from 0-100, and if the resulting number is greater than the penetrate power, their contents escape for the time being. Objects made of [[wood]], [[leather]], [[amber]], or [[coral]] roll 0-95, and items made of [[cloth]] roll 0-90.
  
 
|-
 
|-
Line 1,851: Line 1,890:
 
*median
 
*median
 
*highest  
 
*highest  
| Determines the range and chance of personality traits. Standard is 0:50:100. See [[Personality trait]] for more info.
+
| Determines the range and chance of personality traits. Standard is 0:50:100. See [[Personality traits, values, and dreams#Traits|personality traits]] for more info.
  
 
|-
 
|-
Line 1,931: Line 1,970:
 
| Caste
 
| Caste
 
|   
 
|   
*number
+
*number (max 100000)
| Weighted population of caste; Lower is rarer. Not to be confused with {{token|FREQUENCY|c}}.
+
| Weighted population of caste; Lower is rarer. Not to be confused with {{token|FREQUENCY|c}}. A weight of 0 will not prevent a caste from spawning.
  
 
|-
 
|-
Line 1,946: Line 1,985:
 
| Caste
 
| Caste
 
|
 
|
| Allows the being to represent itself as a deity, allowing it to become the leader of a civilized group. Used by unique demons in the vanilla game. Requires {{token|CAN_SPEAK|c}} 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. Once the creature ascends to a position of leadership, it will proceed to act as a standard ruler for their entity and fulfill the same functions (hold tournaments, tame creatures, etc).
+
| Allows the being to represent itself as a deity, allowing it to become the leader of a civilized group. Not used by any creatures in the vanilla game. Requires {{token|CAN_SPEAK|c}} 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. Once the creature ascends to a position of leadership, it will proceed to act as a standard ruler for their entity and fulfill the same functions (hold tournaments, tame creatures, etc.).
  
 
|-
 
|-
Line 1,954: Line 1,993:
 
*string
 
*string
 
| Sets what other creatures [[Preferences|prefer]] about this creature. "Urist likes dwarves for their beards." Multiple entries will be chosen from at random. Creatures lacking a PREFSTRING token will never appear under another's preferences.
 
| Sets what other creatures [[Preferences|prefer]] about this creature. "Urist likes dwarves for their beards." Multiple entries will be chosen from at random. Creatures lacking a PREFSTRING token will never appear under another's preferences.
 +
 +
|-
 +
| {{text anchor|PROCEDURAL_CREATURE_GRAPHICS}}
 +
| Creature
 +
|
 +
* [[Graphics_token#Basic_creature_sprite_types|Sprite type]] or Caste then sprite type
 +
| Makes the creature have procedural graphics built for it, like forgotten beasts/demons/titans/experiments. Must be associated with PCG_LAYERING tokens.
  
 
|-
 
|-
Line 2,023: Line 2,069:
 
| Caste
 
| Caste
 
|
 
|
| Unknown.
+
| Nothing.
  
 
|-
 
|-
Line 2,049: Line 2,095:
 
*Second person cancel retract text
 
*Second person cancel retract text
 
*Third person cancel retract text
 
*Third person cancel retract text
| The creature will retract into 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. (eg. Turtle, Hedgehog)
+
| The creature will retract into the specified body part(s) when threatened. It will be unable to move or attack, but enemies will only be able to attack the specified body part(s). When one of the specified body part is severed off, the creature automatically unretracts and cannot retract anymore. More than one body part can be selected by using BY_TYPE or BY_CATEGORY.
  
Second-person descriptions are used for adventurer mode natural ability. "<pro_pos>" can be used in the descriptions, being replaced with the proper pronoun (or lack thereof) in-game.  
+
Second-person descriptions are used for adventurer mode natural ability. "<pro_pos>" can be used in the descriptions, being replaced with the proper pronoun (or lack thereof) in-game.
  
Undead curled up creatures are buggy{{bug|11463}}{{bug|10519}}.
+
Undead curled up creatures are buggy, specifically those that retract into their upper bodies: [[echidna]]s, [[hedgehog]]s and [[pangolin]]s.{{bug|11463}}{{bug|10519}} The upper body is prevented from collapsing by a separate body part (the middle spine), which cannot be attacked when the creature is retracted. See {{token|PREVENTS_PARENT_COLLAPSE|bo}}. Living creatures eventually succumb to blood loss, but undead creatures do not. Giant creatures also take a very long time to bleed out.
 
|-
 
|-
 
| {{text anchor|RETURNS_VERMIN_KILLS_TO_OWNER}}
 
| {{text anchor|RETURNS_VERMIN_KILLS_TO_OWNER}}
 +
| Creature
 
|
 
|
|
+
| Cat behavior. If it kills a vermin creature and has an owner, it carries the remains in its mouth and drops them at their feet. Requires {{token|HUNTS_VERMIN|c}}.
| Cat behavior. If it kills a vermin creature and has an owner, it carries the remains in its mouth and drops them at their feet. Requires {{token|HUNTS_VERMIN|c}}, obviously.
 
  
 
|-
 
|-
Line 2,216: Line 2,262:
 
*value
 
*value
 
| The rate at which all skills decay. Lower values cause the skills to decay faster. Requires {{token|CAN_LEARN|c}} or {{token|INTELLIGENT|c}} to function.
 
| The rate at which all skills decay. Lower values cause the skills to decay faster. Requires {{token|CAN_LEARN|c}} or {{token|INTELLIGENT|c}} to function.
 +
 +
|-
 +
| {{text anchor|SLAIN_CASTE_SPEECH}}
 +
| Caste
 +
|
 +
*[[Speech file|text set]]
 +
| Caste-specific {{token|SLAIN_SPEECH|c}}.
 +
 +
|-
 +
| {{text anchor|SLAIN_SPEECH}}
 +
| Creature
 +
|
 +
*[[Speech file|text set]]
 +
| Boasting speeches relating to killing this creature. Examples include [[text_dwarf.txt/raw|text_dwarf.txt]] (<code>[SLAIN_SPEECH:SLAIN_DWARF]</code>) and text_elf.txt (<code>[SLAIN_SPEECH:SLAIN_ELF]</code>) in data\vanilla\vanilla_creatures\objects.
  
 
|-
 
|-
Line 2,231: Line 2,291:
 
|-
 
|-
 
| {{text anchor|SMELL_TRIGGER}}
 
| {{text anchor|SMELL_TRIGGER}}
| Creature
+
| Caste
 
|  
 
|  
 
*value
 
*value
Line 2,259: Line 2,319:
 
* Out of sight reads "You hear '''a loud bark'''"
 
* Out of sight reads "You hear '''a loud bark'''"
 
with the text in bold being the description arguments of the token.
 
with the text in bold being the description arguments of the token.
 +
 +
|-
 +
| {{text anchor|SOURCE_HFID}}
 +
| Creature
 +
|
 +
*Integer
 +
| Found on generated [[angel]]s. This is the historical figure ID of the deity with which the angel is associated. Since HFIDs are not predictable before worldgen, this isn't terribly usable in mods.
  
 
|-
 
|-
Line 2,267: Line 2,334:
 
* Plant/creature ID
 
* Plant/creature ID
 
| Creature will only appear in biomes with this plant or creature available. Grazers given a specific type of grass (such as [[panda]]s and [[bamboo]]) will only eat that grass and nothing else, risking starvation if there's none available.  
 
| Creature will only appear in biomes with this plant or creature available. Grazers given a specific type of grass (such as [[panda]]s and [[bamboo]]) will only eat that grass and nothing else, risking starvation if there's none available.  
 
|-
 
| {{text anchor|SPEECH}}
 
| Creature
 
|
 
*speech file
 
| Boasting speeches relating to killing this creature. Examples include dwarf.txt and elf.txt in data\speech.
 
 
|-
 
| {{text anchor|SPEECH_FEMALE}}
 
| Creature
 
|
 
*speech file
 
| Boasting speeches relating to killing females of this creature.
 
 
|-
 
| {{text anchor|SPEECH_MALE}}
 
| Creature
 
|
 
*speech file
 
| Boasting speeches relating to killing males of this creature.
 
  
 
|-
 
|-
Line 2,294: Line 2,340:
 
|  
 
|  
 
* [[Sphere#Available_spheres|sphere]]
 
* [[Sphere#Available_spheres|sphere]]
| Sets what religious spheres the creature is aligned to, for purposes of being worshipped via the {{token|POWER|c}} token. Also affects the layout of hidden fun stuff, and the creature's name.
+
| Sets what religious spheres the creature is aligned to, for purposes of being worshipped via the {{token|POWER|c}} token. Also affects the creature's name.
  
 
|-
 
|-
Line 2,309: Line 2,355:
  
 
|-
 
|-
| {{text anchor|SPREAD_EVIL_SPHERES_IF_RULER}}{{version|0.47.01}}
+
| {{text anchor|SPREAD_EVIL_SPHERES_IF_RULER}}
 
| Caste
 
| Caste
 
|
 
|
Line 2,327: Line 2,373:
  
 
|-
 
|-
| {{text anchor|STRANGE_MOODS}}{{version|0.42.01}}
+
| {{text anchor|STRANGE_MOODS}}
 
| Caste
 
| Caste
 
|
 
|
Line 2,351: Line 2,397:
  
 
|-
 
|-
| {{text anchor|SYNDROME_DILUTION_FACTOR}}{{version|0.42.01}}
+
| {{text anchor|SYNDROME_DILUTION_FACTOR}}
 
| Caste
 
| Caste
 
| <[[Syndrome#SYN_IDENTIFIER|syndrome identifier]]>:<percentage>
 
| <[[Syndrome#SYN_IDENTIFIER|syndrome identifier]]>:<percentage>
Line 2,386: Line 2,432:
 
|  
 
|  
 
*name  
 
*name  
| Begins defining a tissue in the creature file.
+
| Begins defining a tissue in the creature file. Follow this with standard tissue definition tokens to define the tissue properties.
  
 
|-
 
|-
Line 2,407: Line 2,453:
 
*TISSUE
 
*TISSUE
 
*LOCATION  
 
*LOCATION  
| Presumably a counterpart to TISSUE_LAYER_UNDER (see below).
+
| Alias for TISSUE_LAYER
  
 
|-
 
|-
Line 2,431: Line 2,477:
 
|   
 
|   
 
*number
 
*number
| How much the creature can carry when used by merchants.  
+
| How much the creature can carry when used by merchants. 1000 by default. Completely ignored if the animal does not also have PACK_ANIMAL or WAGON, instead using BODY_SIZE^(2/3)/20, even if they're a pack animal due to ANIMAL_ALWAYS_PACK_ANIMAL.
  
 
|-
 
|-
Line 2,469: Line 2,515:
 
*min
 
*min
 
*max  
 
*max  
| A large swarm of vermin can be disturbed, usually in adventurer mode.{{verify}}
+
| A large swarm of vermin can be disturbed, usually in adventurer mode.
  
 
|-
 
|-
Line 2,494: Line 2,540:
 
| Creature
 
| Creature
 
|
 
|
| Creature will occur in every region with the correct biome. Does not apply to {{token|EVIL|c}}/{{token|GOOD|c}} tags.
+
| Creature will occur in every region with the correct biome. Does not apply to {{token|EVIL|c}}/{{token|GOOD|c}} tags. Supersedes {{token|FREQUENCY|c}} for the purposes of distributing populations through the map, they are present in every part of the valid biome. Respects {{token|FREQUENCY|c}} for the frequency of unit [[Creature token#CLUSTER_NUMBER|cluster]] spawns being of this species.
  
 
|-
 
|-
Line 2,514: Line 2,560:
 
| Caste
 
| Caste
 
|   
 
|   
| 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. Could not be specified in user-defined raws prior to version [[Release_information/0.47.01|0.47.01]].
+
| 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.
  
 
|-
 
|-
Line 2,523: Line 2,569:
 
*old 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."
 
| 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."
 +
Roostre: "When DF detects duplicate tokens in the raws of the same object, a failsafe seems to kick in; it takes the bottom-most of the duplicates, and disregards the others. In the case of tokens added by a mod, it prioritizes the duplicate in the mod." This means that if a tag is defined in the base-caste and redefined in the derived caste, the derived tag overwrites the base tag.
  
 
|-
 
|-
Line 2,538: Line 2,585:
 
*new material token
 
*new material token
 
*material template  
 
*material template  
| Defines a new local creature material and populates it with all properties defined in the specified template.
+
| Defines a new local creature material and populates it with all properties defined in the specified template. [http://www.bay12forums.com/smf/index.php?topic=175437.msg8441368#msg8441368 There seems to be a limit of 200 materials per creature].
  
 
|-
 
|-
Line 2,558: Line 2,605:
 
|-
 
|-
 
| {{text anchor|UTTERANCES}}
 
| {{text anchor|UTTERANCES}}
| Caste
+
| Creature
 
|   
 
|   
 
| 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 {{token|SKULKING|e}} civ, it will tend to start wars with all nearby civilizations and will be unable to make peace treaties due to 'inability to communicate'.
 
| 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 {{token|SKULKING|e}} civ, it will tend to start wars with all nearby civilizations and will be unable to make peace treaties due to 'inability to communicate'.
Line 2,665: Line 2,712:
 
| Caste
 
| Caste
 
|   
 
|   
| Sets the creature to be active during the evening in adventurer mode.  
+
| When set, the creature will only appear in the evening (between 8:00 PM and 10:05 PM) in Adventurer mode.
  
 
|-
 
|-
Line 2,680: Line 2,727:
 
*binocular vision arc
 
*binocular vision arc
 
*non-binocular vision arc
 
*non-binocular vision arc
| The width of the creature's vision arcs, in degrees (i.e. 0 to 360). The first number is binocular vision, the second is non-binocular vision.  Binocular vision has a minimum of about 10 degrees, monocular, a maximum of about 350 degrees. Values past these limits will be accepted, but will default to ~10 degrees and ~350 degrees respectively.
+
| The width of the creature's vision arcs, in degrees (i.e. 0 to 360). The first number is binocular vision, the second is non-binocular vision.  Binocular vision has a minimum of about 10 degrees, monocular, a maximum of about 350 degrees. Values past these limits will be accepted, but will default to ~10 degrees and ~350 degrees respectively. Defaults are 60:120.
 
|}
 
|}
  
Line 2,714: Line 2,761:
  
 
==Attack Tokens==
 
==Attack Tokens==
 +
 +
Attacks can use four different part selection criteria; while all vanilla attacks use only BODYPART (e.g. ATTACK:PUNCH:BODYPART:BY_TYPE:GRASP), there are other options available.
 +
 +
{| {{prettytable}}
 +
|- bgcolor="#ddd"
 +
! width="20%" | Part type token
 +
! width="30%" | Arguments
 +
! width="60%" | Description
 +
 +
|-
 +
| {{text anchor|BODYPART}}
 +
|
 +
* BY_TYPE/BY_TOKEN/BY_CATEGORY
 +
* type/token/category
 +
| This attack uses a particular body part; for example, BY_TYPE:GRASP will make it use any part that can hold onto an object.
 +
 +
|-
 +
| {{text anchor|TISSUE_LAYER}}
 +
|
 +
* BY_TYPE/BY_TOKEN/BY_CATEGORY
 +
* type/token/category
 +
* tissue layer
 +
| This attack uses a specific tissue layer on a specific body part; BY_TYPE:GRASP:BONE will make it use the bone of the hands.
 +
 +
|-
 +
| {{text anchor|CHILD_BODYPART_GROUP}}
 +
|
 +
* BY_TYPE/BY_TOKEN/BY_CATEGORY
 +
* type/token/category
 +
* BY_TYPE/BY_TOKEN/BY_CATEGORY
 +
* type/token/category
 +
| Uses a body part that is subordinate to another; BY_CATEGORY:ARM_LOWER:BY_TYPE:GRASP will make it use every hand attached to each lower arm (so it will generate one attack per lower arm, each of which will use every hand on that arm, assuming there are multiple hands per arm).
 +
 +
|-
 +
| {{text anchor|CHILD_TISSUE_LAYER_GROUP}}
 +
|
 +
* BY_TYPE/BY_TOKEN/BY_CATEGORY
 +
* type/token/category
 +
* BY_TYPE/BY_TOKEN/BY_CATEGORY
 +
* type/token/category
 +
* tissue layer
 +
| As CHILD_BODYPART_GROUP, but specifying a tissue, too.
 +
 +
|}
 +
 
{| {{prettytable}}
 
{| {{prettytable}}
 
|- bgcolor="#ddd"
 
|- bgcolor="#ddd"
Line 2,878: Line 2,970:
 
| Caste
 
| Caste
 
|  
 
|  
*TISSUE
 
 
*BY_CATEGORY, BY_TYPE, BY_TOKEN
 
*BY_CATEGORY, BY_TYPE, BY_TOKEN
 
*Location - category, type, or token
 
*Location - category, type, or token

Latest revision as of 00:33, 30 October 2024

This article is about the current version of DF.
Note that some content may still need to be updated.


The [OBJECT:CREATURE] token begins the definition of a Dwarf Fortress creature raw file. Each creature definition that follows begins with the [CREATURE:creature ID] token, and the creature's exact properties and behavior are then specified by the use of further creature tokens. All known creature tokens are listed below.

Vanilla creature definitions can be found in <Dwarf Fortress>\data\vanilla\vanilla_creatures\. Creature ID is also used with graphics tokens to make customizable graphics sets.

The caste tokens allow defining sub-species within the broader creature definition, including true biological castes and lesser variations, such as sexes. Creature tokens can either be 'Creature' or 'CASTE-only' type which can only be applied to creature or cast respectively, or 'CASTE' which can be applied to both. In the table bellow, creature type distinguish tokens that can be applied to creature only, cast only and both ('creature', 'CASTE-only', and 'CASTE' respectively)


Contents A B C D E F G H I J K L M N O P Q R S T U V W X Y Z top

A[edit]

Token Type Arguments Description
ADOPTS_OWNER Caste Prevents tamed creature from being made available for adoption, instead allowing it to automatically adopt whoever it wants. The basic requirements for adoption are intact, and the creature will only adopt individuals who have a preference for their species. Used by cats in the vanilla game. When viewing a tame creature with this token, the message "This animal isn't interested in your wishes" will appear instead of "This [adorable] animal can't work" or "This animal is waiting to be trained".
ALCOHOL_DEPENDENT Caste Makes the creature need alcohol to get through the working day; it will choose to drink booze instead of water if possible. Going sober for too long reduces speed.
ALL_ACTIVE Caste When set, the creature will appear at any time of day. Overrides [DIURNAL], [NOCTURNAL], [CREPUSCULAR], [MATUTINAL], and [VESPERTINE].
ALTTILE Creature
  • 'character' or tile number
If set, the creature will blink between its [TILE] and its ALTTILE.
AMBUSHPREDATOR Caste Found on [LARGE_PREDATOR]s who ambush their prey. Instead of charging relentlessly at prey, the predator will wait till the prey is within a few squares before charging. May or may not work on other creatures.[Verify]
AMPHIBIOUS Caste Allows a creature to breathe both in and out of water (unlike [AQUATIC]) - does not prevent drowning in magma.
APP_MOD_DESC_RANGE Appearance Modifier
  • Range (6 values, low to high)
Based on info from Wannabehero on the forums: When used with an appearance modifier token (BP_APPEARANCE_MODIFIER or BODY_APPEARANCE_MODIFIER), tells the game what numeric ranges to map to which descriptors.

The game uses 7 descriptor levels for each modifier, with the center one generally being to omit the thing from the creature description entirely. The six values in APP_MOD_DESC_RANGE define the boundaries between each described range. If this is not specified it uses the numbers 10:50:95:105:150:190.

APP_MOD_GENETIC_MODEL Appearance Modifier
  • 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 Appearance Modifier
  • number
Determines how important the appearance modifier is, for determining whether it shows up in the creature description.[Verify]
APP_MOD_NOUN Appearance Modifier
  • noun
  • SINGULAR or PLURAL
Creates a noun for the appearance, and whether it is singular or plural.
APP_MOD_RATE Appearance Modifier
  • Rate (integer)
  • Scale (DAILY, YEARLY)
  • min (growth)
  • max (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 Caste
  • creature variation ID
  • (optional) any amount of arbitrary arguments
Applies the specified creature variation. See Creature_variation_token#Arguments_and_conditional_tokens for how the subsequent arguments may be used.
APPLY_CURRENT_CREATURE_VARIATION Special Applies the effects of all pending [CV_ADD_TAG] and [CV_REMOVE_TAG] tokens that have been defined in the current creature.
AQUATIC Caste Enables the creature to breathe in water, but causes it to air-drown on dry land.
ARENA_RESTRICTED Caste Causes the creature to be excluded from the object testing arena's creature spawning list. Typically applied to spoileriffic creatures.
ARTIFICIAL_HIVEABLE Creature Enables the creature to be kept in artificial hives by beekeepers.
AT_PEACE_WITH_WILDLIFE Caste Prevents the creature from attacking or frightening creatures with the [NATURAL] tag.
ATTACK Caste
  • token
  • selection criteria (it's complicated)
Defines the attack name, and the body part used. See 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
  • population
  • exported wealth
  • created wealth
Specifies when a megabeast or semi-megabeast will attack the fortress. The attacks will start occurring when all of the requirements are met. Setting a value to 0 disables the trigger.
Contents A B C D E F G H I J K L M N O P Q R S T U V W X Y Z top

B[edit]

Token Type Arguments Description
BABY Caste
  • integer
Age at which creature is considered a child, the 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
  • integer
Creature may be subject to beaching, becoming stranded on shores, where they will eventually air-drown. The number indicates the frequency of the occurrence. Presumably requires the creature to be [AQUATIC]. Used by orcas, sperm whales and sea nettle jellyfish in the vanilla game.
BENIGN Caste The creature is non-aggressive by default, and will never automatically be engaged by companions or soldiers, running away from any creatures that are not friendly to it, and will only defend itself if it becomes enraged. Can be thought of as the counterpoint of the [LARGE_PREDATOR] tag. When tamed, animals with this tag will be useless for fortress defense.

This and [TRADE_CAPACITY] are required for [PACK_ANIMAL] to function properly, if an animal contains the aforementioned requirements without this tag: items loaded by the merchants will be dropped upon departure.

BIOME Creature Select a biome the creature may appear in.
BLOOD Caste Specifies what the creature's blood is made of.
BLOODSUCKER Caste Causes vampire-like behaviour; the creature will suck the blood of unconscious victims when its thirst for blood grows sufficiently large. When controlling the creature in adventure mode, this can be done at will. Seems to be required to make the creature denouncable (in-world) 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. That's all a maggot needs.

The body parts need to be listed in an order such that any parent part appears before its connected children. For example [BODY:HEART:BODY_WITH_HEAD_FLAG] produces a "Body Token Recognized But Could Not Connect: HEART" error because HEART can't find any UPPERBODY(s) to connect to. Switching the order to [BODY:BODY_WITH_HEAD_FLAG:HEART] fixes the problem because now the UPPERBODY is created before the HEART tries to connect to it.

If the body is left undefined, the creature (or caste) will be tagged as [DOES_NOT_EXIST].[Verify]

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
  • Arguments
Loads a plan from 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 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. Its birth size would be 10,000 cm3 (~10 kg). At 1 year and 168 days old it would be 50,000 cm3 (~50 kg). And as an adult (at 12 years old) it 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]. Adventurers with this token are currently unable to eat bones.Bug:11069
BP_ADD_TYPE Caste Adds a type to a body part - used with [SET_BP_GROUP]. In vanilla DF, this is used for adding the type 'GELDABLE' to the lower body of certain creatures.
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)
BP_REMOVE_TYPE Caste Removes a type from a body part. Used with [SET_BP_GROUP].
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.
Contents A B C D E F G H I J K L M N O P Q R S T U V W X Y Z top

C[edit]

Token Type Arguments Description
CAN_DO_INTERACTION Caste
  • interaction token
The creature can perform an interaction. See interaction token.
CAN_LEARN Caste The creature gains skills and can have professions. If a member of a civilization (even a pet) has this token, it'll need to eat, drink and sleep. Note that this token makes the creature unable to be eaten 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. A creature with at least this token or the [CAN_SPEAK] token will be able to have values and dreams.
CAN_SPEAK Caste Can talk. Note that this is not necessary for a creature to gain social skills. A creature with at least this token or the [CAN_LEARN] token will be able to have values and dreams.
CANNOT_CLIMB Caste Creature cannot climb, even if it has free grasp parts.
CANNOT_JUMP Caste Creature cannot jump.
CANNOT_UNDEAD Caste Acts like [NOT_LIVING], except that [OPPOSED_TO_LIFE] creatures will attack them.
CANOPENDOORS Caste Allows the creature to open doors that are set to be unpassable for pets. In adventure mode, creatures lacking this token will be unable to pass through door tiles except whilst these are occupied by other creatures. Not currently useful in Fortress mode as doors can no longer be set unpassable for pets.v50.03
CARNIVORE Caste Creature only eats meat. If the creature goes on rampages in worldgen, it will often devour the people/animals it kills. Does not seem to affect the diet of the adventurer in adventure mode.
CASTE Creature
  • name
Defines a caste.
CASTE_ALTTILE Caste
  • tile number or "letter"
Caste-specific [ALTTILE]. Requires [CASTE_TILE].
CASTE_COLOR Caste
  • fg
  • bg
  • brightness
Caste-specific [COLOR].
CASTE_GLOWCOLOR Caste
  • fg
  • bg
  • brightness
Caste-specific [GLOWCOLOR].
CASTE_GLOWTILE Caste
  • tile value or "letter"
Caste-specific [GLOWTILE].
CASTE_NAME Caste
  • singular
  • plural
  • adjective
While [NAME] describes the name of the species, [CASTE_NAME] names individuals of the species. Unlike other caste-specific descriptions, this token is required, even for creatures without separate castes. If left undefined, the creature will not show up in the arena and members of the species will be labeled as "nothing".
CASTE_PROFESSION_NAME Caste Caste-specific [PROFESSION_NAME].
CASTE_SOLDIER_ALTTILE Caste
  • 'character' or tile number
Caste-specific [SOLDIER_ALTTILE]. Requires [CASTE_SOLDIER_TILE].
CASTE_SOLDIER_TILE Caste
  • 'character' or tile number
Caste-specific [CREATURE_SOLDIER_TILE].
CASTE_TILE Caste
  • tile number or "letter"
Caste-specific [CREATURE_TILE].
CAVE_ADAPT Caste Causes cave adaptation.

Allows for creature's race to be involved in jokes that end in "And the [race] saw the sun and vomited on the spot!"

CDI Caste
  • Varies
Specifies interaction details following a [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.
CHANGE_FREQUENCY_PERC Creature
  • integer
Multiplies frequency by a factor of (integer)%.
CHILD Caste
  • integer
Age at which creature is considered an adult - one can think of this as the duration of the child stage. Allows the creature's offspring to be rendered fully tame if trained during their childhood.
CHILDNAME Caste
  • singular
  • plural
Defines a new name for a creature in the 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. Vermin fish with this token in combination with temperate ocean and river biome tokens will perform seasonal migrations. Defaults to 1:1 if not specified.
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. See Color for usage.
COMMON_DOMESTIC Caste When combined with any of [PET], [PACK_ANIMAL], [WAGON_PULLER] and/or [MOUNT], the creature is guaranteed to be domesticated by any civilization with [COMMON_DOMESTIC_PET], [COMMON_DOMESTIC_PACK], [COMMON_DOMESTIC_PULL] and/or [COMMON_DOMESTIC_MOUNT] respectively. Such civilizations will always have access to the creature, even in the absence of wild populations. This token is invalid on [FANCIFUL] creatures.
CONVERTED_SPOUSE Caste Creatures of this caste's species with the [SPOUSE_CONVERTER] and [NIGHT_CREATURE_HUNTER] tokens will kidnap [SPOUSE_CONVERSION_TARGET]s 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/cleaned. Used by some water-dwelling vermin such as mussels, nautiluses and oysters.
CRAZED Caste Creature is 'berserk' and will attack all other creatures, except members of its own species that also have the CRAZED tag. It will show Berserk in the unit list. Berserk creatures go on rampages during worldgen much more frequently than non-berserk ones.
COPY_TAGS_FROM Special
  • creature ID
Copies another specified creature. This will override any definitions made before it; essentially, it makes this creature identical to the other one, which can then be modified. Often used in combination with [APPLY_CREATURE_VARIATION] to import standard variations from a file. The vanilla giant animals and animal peoples are examples of this token combination.
CREATURE Creature
  • creature ID
A unique, arbitrary identifier that begins the definition of each new creature, and is used to reference the creature in other tokens and raws.
CREATURE_CLASS Caste
  • classname
An arbitrary creature classification. Can be set to anything, but the only vanilla uses are GENERAL_POISON (used in syndromes), EDIBLE_GROUND_BUG (used as targets for [GOBBLE_VERMIN_CLASS]), MAMMAL, and POISONOUS (both used for kobold pet eligibility). A single creature can have multiple classes.

The full list of tokens that use creature classes is:

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 When set, the creature will appear at dawn (between 4:30 AM and 6:00 AM) and in the evening (between 8:00 PM and 10:05 PM) in Adventurer mode.
CURIOUSBEAST_EATER Caste Allows a creature to steal and eat edible items from a site. It will attempt to grab a food item and immediately make its way to the map's edge, where it will disappear with it. If the creature goes on rampages during worldgen, it will often steal food instead of attacking. Trained and tame instances of the creature will no longer display this behavior.
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. Unlike food or item thieves, drink thieves will consume your alcohol on the spot rather than run away with one piece of it. Trained and tame instances of the creature will no longer display this behavior.
CURIOUSBEAST_ITEM Caste Allows a creature to steal things (apparently, of the highest value it can find). It will attempt to grab an item of value and immediately make its way to the map's edge, where it will disappear with it. If a creature with any of the CURIOUSBEAST tokens carries anything off the map, even if it is a caravan's pack animal, it will be reported as stealing everything it carries. If the creature goes on rampages in worldgen, it will often steal items instead of attacking - kea birds are infamous for this. Trained and tame instances of the creature will no longer display this behavior. Also, makes the creature unable to drop hauled items until it enters combat.
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.
Contents A B C D E F G H I J K L M N O P Q R S T U V W X Y Z top

D[edit]

Token Type Arguments Description
DEMON Caste Found on generated demons. Marks the caste to be used in the initial wave after breaking into the underworld, and by the demon civilizations created during world-gen breachings[Verify].
DESCRIPTION Caste
  • text
A brief description of the creature type, as displayed when viewing the creature's description/thoughts & preferences screen.
DIE_WHEN_VERMIN_BITE Caste Causes the creature to die upon attacking. Used by honey bees to simulate them dying after using their stingers.
DIFFICULTY Caste
  • integer
Increases experience gain during adventure mode. Creatures with a difficulty of 11 or higher are not assigned for quests in adventure mode.
DIURNAL Caste When set, the creature will only appear during the day (between 6:00 AM and 8:00 PM) in Adventurer mode.
DIVE_HUNTS_VERMIN Caste The creature hunts vermin by diving from the air. On tame creatures, it has the same effect as [HUNTS_VERMIN]. Found on peregrine falcons.
DOES_NOT_EXIST Creature Adding this token to a creature prevents it from appearing in generated worlds (unless it's marked as always present for a particular civilisation). For example, adding it to dogs will lead to worlds being generated without dogs in them. Also removes the creature from the object testing arena's spawn list. If combined with [FANCIFUL], artistic depictions of the creature will occur regardless. Used by centaurs, chimeras and griffons in the vanilla game.

Note: a creature tagged as DOES_NOT_EXIST can still be summoned successfully, as long as it has a body defined in its raws. [1]. It's also possible for another creature to transform into it.

Contents A B C D E F G H I J K L M N O P Q R S T U V W X Y Z top

E[edit]

Token Type Arguments Description
EBO_ITEM Caste Defines the item that the creature drops upon being butchered. Used with [EXTRA_BUTCHER_OBJECT].
EBO_SHAPE Caste
  • gem shape
The shape of the creature's extra butchering drop. Used with [EXTRA_BUTCHER_OBJECT].
EGG_MATERIAL Caste Defines the material composition of eggs laid by the creature. Egg-laying creatures in the default game 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 laid eggs. Doesn't affect hatching or cooking, but bigger eggs will be heavier, and may take longer to be hauled depending on the hauler's strength.
EQUIPMENT_WAGON Creature Makes the creature appear as a large 3×3 wagon responsible for carrying trade goods, pulled by two [WAGON_PULLER] creatures and driven by a merchant.
EQUIPS Caste Allows the creature to wear or wield items.
EVIL Creature The creature is considered evil and will only show up in evil biomes. Civilizations with [USE_EVIL_ANIMALS] can domesticate them regardless of exotic status. Has no effect on cavern creatures except to restrict taming. A civilization with evil creatures can colonise evil areas.
EXTRA_BUTCHER_OBJECT Caste
  • BY_CATEGORY, BY_TYPE, BY_TOKEN
  • TYPE, CATEGORY, or TOKEN
The creature drops an additional object when butchered, as defined by [EBO_ITEM] and [EBO_SHAPE]. Used for gizzard stones in default creatures. For some materials, needs to be defined after caste definitions with SELECT_CASTE:ALLBug:6355
EXTRACT Caste Defines a creature extract which can be obtained via small animal dissection.
EXTRAVISION Caste The creature can see regardless of whether it has working eyes and has full 360 degree vision, making it impossible to strike the creature from a blind spot in combat. Invisible creatures will also be seen, namely intelligent undead using a "vanish" power.
Contents A B C D E F G H I J K L M N O P Q R S T U V W X Y Z top

F[edit]

Token Type Arguments Description
FANCIFUL Creature The creature is a thing of legend and known to all civilizations. Its materials cannot be requested or preferred. The tag also adds some art value modifiers. Used by a number of creatures. Conflicts with [COMMON_DOMESTIC].
FEATURE_ATTACK_GROUP Caste Found on subterranean animal-man tribals. Currently defunct. In previous versions[Verify], it caused these creatures to crawl out of chasms and underground rivers.
FEATURE_BEAST Caste Found on forgotten beasts. Presumably makes it act as such, initiating underground attacks on fortresses, or leads to the pop-up message upon encountering one[Verify]. Hides the creature from displaying in a world_sites_and_pops file. Does not create historical figures like generated forgotten beasts do.

Requires specifying a [BIOME] in which the creature will live, and both surface and subterranean biomes are allowed. Does not stack with [LARGE_ROAMING] and if both are used the creature will not spawn. Appears to be incompatible with [DEMON] even if used in separate castes.

FEMALE Caste Makes the creature biologically female, enabling her to bear young. Usually specified inside a caste.
FIREIMMUNE Caste Makes the creature immune to FIREBALL and FIREJET attacks, and allows it to path through high temperature zones, like lava or fires. Does not, by itself, make the creature immune to the damaging effects of burning in fire, and does not prevent general heat damage or melting on its own (this would require adjustments to be made to the creature's body materials - see the dragon raws for an example).
FIREIMMUNE_SUPER Caste Like [FIREIMMUNE], but also renders the creature immune to DRAGONFIRE attacks.
FISHITEM Caste The creature's corpse is a single FISH_RAW food item that needs to be cleaned (into a FISH item) at a fishery to become edible. Before being cleaned the item is referred to as "raw". The food item is categorized under "fish" on the food and stocks screens, and when uncleaned it is sorted under "raw fish" in the stocks (but does not show up on the food screen).

Without this or [COOKABLE_LIVE], fished vermin will turn into food the same way as non-vermin creatures, resulting in multiple units of food (meat, brain, lungs, eyes, spleen etc.) from a single fished vermin. These units of food are categorized as meat by the game.

FIXED_TEMP Caste
  • temperature
The creature's body is constantly at this temperature, heating up or cooling the surrounding area. Alters the temperature of the creature's inventory and all adjacent tiles, with all the effects that this implies - may trigger wildfires at high enough values. Also makes the creature immune to extreme heat or cold, as long as the temperature set is not harmful to the materials that the creature is made from. Corpses and body parts of creatures with a fixed temperature maintain their temperature even after death.

Note that temperatures of 12000 and higher may cause pathfinding issues in fortress mode.

FLEEQUICK Caste If engaged in combat, the creature will flee at the first sign of resistance. Used by kobolds in the vanilla game.
FLIER Caste Allows a creature to fly, independent of it having wings or not. Fortress Mode pathfinding only partially incorporates flying - flying creatures 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. Winged creatures with this token can lose their ability to fly if their wings are crippled or severed. Winged creatures without this token will be unable to fly. (A 'wing' in this context refers to any body part with its own FLIER token).
FREQUENCY Creature
  • number, max 100
Determines the chances of a creature appearing within its environment, with higher values resulting in more frequent appearance. Also affects the chance of a creature being brought in a caravan for trading.

This value is used multiply to determine the rarity of animal populations. A creature with [FREQUENCY:50] will appear in 50% of valid biomes, and be present in 50% of the area within those biomes. When a cluster spawns, 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].

Contents A B C D E F G H I J K L M N O P Q R S T U V W X Y Z top

G[edit]

Token Type Arguments Description
GAIT Caste
  • <gait type>
  • <gait name>
  • <max speed>
  • <build up time>
  • <max turning speed>
  • <start speed>
  • <energy expenditure>
  • <gait flag(s)>
Defines a gait by which the creature can move. See Gait for more information. Specifically, you likely want to use one of the existing STANDARD_X_GAITS creature variations, as described in this subsection.
  • <max speed> indicates the maximum speed achievable by a creature using this gait
  • <start speed> indicates the creature's speed when it starts moving using this gait
  • <build up time> indicates how long it will take for a creature using this gait to go from <start speed> to <max speed>. For example, a value of 10 means that it should be able to reach the maximum speed by moving 10 tiles in a straight line over even terrain.
  • <max turning speed> indicates the maximum speed permissible when the creature suddenly changes its direction of motion. The creature's speed will be reduced to <max turning speed> if travelling at a higher speed than this before turning.
  • <energy expenditure> indicates how energy-consuming the gait is. Higher values cause the creature to tire out faster. Persistent usage of a high-intensity gait will eventually lead to exhaustion and collapse.

NO_BUILD_UP can be specified instead of a <start speed> value to make the <max speed> instantly achievable upon initiating movement (this is equivalent to a <build up time> of 0). Note that <build up time> and <max turning speed> are both ignored if specified alongside this (as NO_BUILD_UP trumps <build up time> and preserves <max speed> whilst turning, and <max turning speed> cannot exceed <max speed>) so it is permissible to omit them so long as they are both omitted together.

It's possible to specify a <start speed> greater than the <max speed>; the moving creature will decelerate towards its <max speed> in this case.


valid gait types:

  • WALK

Used for moving normally over ground tiles.

  • CRAWL

Used for moving over ground tiles whilst prone.

  • SWIM

Used for moving through tiles containing water or magma at a depth of at least 4/7.

  • FLY

Used for moving through open space.

  • CLIMB

Used for moving whilst climbing.


valid gait flags:

  • AGILITY

Speeds/slows movement depending on the creature's Agility stat.

  • STRENGTH

Speeds/slows movement depending on the creature's Strength stat.

  • LAYERS_SLOW

Makes THICKENS_ON_ENERGY_STORAGE and THICKENS_ON_STRENGTH tissue layers slow movement depending on how thick they are. Adding the STRENGTH gait flag counteracts the impact of the latter layer.

  • STEALTH_SLOWS:<percentage>

Slows movement by the specified percentage when the creature is sneaking.

GENERAL_BABY_NAME Creature
  • singular
  • plural
Like [BABYNAME], but applied regardless of caste.
GENERAL_CHILD_NAME Creature
  • singular
  • plural
Like [CHILDNAME], but applied regardless of caste.
GENERAL_MATERIAL_FORCE_MULTIPLIER Caste
  • value A
  • value B
Has the same function as [MATERIAL_FORCE_MULTIPLIER], but applies to all attacks instead of just those involving a specific material. Appears to be overridden by MATERIAL_FORCE_MULTIPLIER (werebeasts, for example, use both tokens to provide resistance to all materials, with one exception to which they are especially vulnerable).
GENERATED Creature Found on procedurally generated creatures like forgotten beasts, titans, demons, angels, and night creatures. Cannot be specified in user-defined raws.
GETS_INFECTIONS_FROM_ROT Caste Makes the creature get infections from necrotic tissue.
GETS_WOUND_INFECTIONS Caste Makes the creature's wounds become infected if left untreated for too long.
GLOWCOLOR Creature
  • foreground
  • background
  • brightness
The colour of the creature's [GLOWTILE].
GLOWTILE Creature
  • ascii character
If present, the being glows in the dark (generally used for Adventurer 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 traps and cages using the specified verb, depending on the material from which it is made (normally wood).
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 before the specified tag.
GOOD Creature Creature is considered good and will only show up in good biomes - unicorns, for example. Civilizations with [USE_GOOD_ANIMALS] can domesticate them regardless of exotic status. Has no effect on cavern creatures except to restrict taming. A civilization that has good creatures can colonise good areas in world-gen.
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
The creature is a grazer - if tamed in fortress mode, it needs a pasture to survive. The higher the number, the less frequently it needs to eat in order to live. Not used since 0.40.12, replaced by [STANDARD_GRAZER] to fix Bug 4113.
Contents A B C D E F G H I J K L M N O P Q R S T U V W X Y Z top

H[edit]

Token Type Arguments 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
  • COLLECT_WEALTH.

These require the creature to have a [LAIR] to work properly, and also don't seem to work on creatures who are not a [SEMIMEGABEAST], [MEGABEAST], or[NIGHT_CREATURE_HUNTER].

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.".[1] All lists of HABITs are preceded by [HABIT_NUM:TEST_ALL]
HAS_NERVES Caste The creature has nerves in its muscles. Cutting the muscle tissue can sever motor and sensory nerves.
HASSHELL Caste The creature has a shell. Seemingly no longer used - holdover from previous versions.
HIVE_PRODUCT Creature What product is harvested from beekeeping.
HOMEOTHERM Caste
  • number or NONE
Default 'NONE'. The creature's normal body temperature. Creature ceases maintaining temperature on death unlike fixed material temperatures. Provides minor protection from environmental temperature to the creature.
HUNTS_VERMIN Caste Creature hunts and kills nearby vermin, randomly walking between places with food laying on the ground or in stockpiles, to check for possible [VERMIN_EATER] vermin, but they'll kill any other vermin too. Do not include this creature token on an intelligent entity that you intend to play as in fortress mode because it will prevent them from feeding themselves.
Contents A B C D E F G H I J K L M N O P Q R S T U V W X Y Z top

I[edit]

Token Type Arguments Description
IMMOBILE Caste The creature cannot move. Found on sponges. Will also stop a creature from breeding in fortress mode (MALE and FEMALE are affected, 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 The creature radiates fire. It will ignite, and potentially completely destroy, items the creature is standing on. Also gives the vermin a high chance of escaping from animal traps and cages made of any flammable materials (specifically ones that could be ignited by magma).
INTELLIGENT Caste Alias for [CAN_SPEAK] + [CAN_LEARN].
ITEMCORPSE Caste Determines if the creature leaves behind a non-standard corpse (i.e. wood, statue, bars, stone, pool of liquid, etc.). Ethics may prevent actually using the item in jobs or reactions.
ITEMCORPSE_QUALITY Caste
  • number
The quality of an item-type corpse left behind. Valid values are: 0 for ordinary, 1 for well-crafted, 2 for finely-crafted, 3 for superior, 4 for exceptional, 5 for masterpiece.
Contents A B C D E F G H I J K L M N O P Q R S T U V W X Y Z top

L[edit]

Token Type Arguments Description
LAIR Caste
  • type
  • probability
Found on megabeasts, semimegabeasts, and night creatures. 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
  • 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 other creatures that are smaller than it. In fortress mode, only one group of "large predators" (possibly two groups on "savage" maps) will appear on any given map. In adventurer 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."

A single biome supports 7 large predator species, picking randomly and rolling a d100 under its [FREQUENCY] to add it until all 7 slots are filled.

Incompatible with [PACK_ANIMAL] on a technicality, if included: hauled items are likely to be dropped upon entering the map (even if [TRADE_CAPACITY] is present) in contrast to when the merchants depart.

LARGE_ROAMING Creature This is the core requisite tag allowing the creature to spawn as a wild animal in the appropriate biomes. Requires specifying a [BIOME] in which the creature will spawn. Does not require specifying a frequency, population number, or cluster number.

This tag stacks with [MEGABEAST], [SEMIMEGABEAST], or [NIGHT_CREATURE_HUNTER]; if used with one of these tags, the creature will spawn as both a boss and as a wild animal. This tag does not stack with [FEATURE_BEAST] and if both are used the creature will not spawn. This tag is unaffected by [DEMON].

LAYS_EGGS Caste Creature lays eggs instead of giving birth to live young.
LAYS_UNUSUAL_EGGS Caste Creature lays the specified item instead of regular eggs.
LIGAMENTS Caste The creature has ligaments in its [CONNECTIVE_TISSUE_ANCHOR] tissues (bone or chitin by default). Cutting the bone/chitin tissue severs the ligaments, disabling motor function if the target is a limb.
LIGHT_GEN Caste A vermin featuring this tag will remain visible to an adventurer, even at night (without being dimmed in color along with the surrounding terrain), and from a distance (even outside the current vision cone). Subterranean vermin which feature this token will flicker in unexposed and unrevealed cavern layers while playing in Fortress Mode.
LIKES_FIGHTING Caste The creature will attack enemies rather than flee from them. This tag has the same effect on player-controlled creatures - including modded dwarves. Retired as of v0.40.14 in favor of [LARGE_PREDATOR].
LISP Caste Creature uses "sssssnake talk" (multiplies 'S' when talking - "My name isss Recisssiz."). Used by serpent men and reptile men in the vanilla game. C's with the same pronunciation (depending on the word) are not affected by this token.
LITTERSIZE Caste
  • minimum
  • maximum
Determines the number of offspring per one birth; default 1-3, not used in vanilla raws. See also [MULTIPLE_LITTER_RARE].
LOCAL_POPS_CONTROLLABLE Creature Allows you to play as a wild animal of this species in adventurer mode. Prevents trading of (tame) instances of this creature in caravans.
LOCAL_POPS_PRODUCE_HEROES Creature Wild animals of this species may occasionally join a civilization. Prevents trading of (tame) instances of this creature in caravans.
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.
LOW_LIGHT_VISION Caste
  • number
Determines how well a creature can see in the dark - higher is better. Dwarves have 10000, which amounts to perfect nightvision.
Contents A B C D E F G H I J K L M N O P Q R S T U V W X Y Z top

M[edit]

Token Type Arguments Description
MAGICAL Caste According to Toady One, this is completely interchangeable with [AT_PEACE_WITH_WILDLIFE] and might have been used in very early versions of the game by wandering wizards or the ent-type tree creatures that used to be animated by elves. [2]
MAGMA_VISION Caste The creature is able to see while submerged in magma.
MALE Caste Makes the creature biologically male. Usually declared inside a caste.
MANNERISM_* Caste
  • occasionally body part
Adds a possible mannerism to the creature's profile. See creature mannerism token for further info.
MATERIAL Creature
  • material id
Begins defining a new local material. Follow this with standard material definition tokens to define the material.
MATERIAL_FORCE_MULTIPLIER Caste When struck with a weapon made of the specified material, the force exerted will be multiplied by A/B, thus making the creature more or less susceptible to this material. For example, if A is 2 and B is 1, the force exerted by the defined material will be doubled. If A is 1 and B is 2, it will be halved instead. See also [GENERAL_MATERIAL_FORCE_MULTIPLIER], which can be used to make this sort of effect applicable to all materials.
MATUTINAL Caste When set, the creature will only appear at dawn (between 4:30 AM and 6:00 AM) in Adventurer mode.
MAXAGE Caste
  • min
  • max
Determines the creature's natural lifespan, using the specified minimum and maximum age values (in years). Each individual creature with this token is generated with a predetermined date (calculated down to the exact tick!) between these values, at which it is destined to die of old age, should it live long enough. Note that the probability of death at any given age does not increase as the creature gets older [3].

Creatures which lack this token are naturally immortal. The NO_AGING syndrome tag will prevent death by old age from occurring. Also note that, among civilized creatures, castes which lack this token will refuse to marry others with it, and vice versa.

MEANDERER Caste Makes the creature slowly stroll around, unless it's in combat or performing a job. If combined with [CAN_LEARN], will severely impact their pathfinding and lead the creature to move extremely slowly when not performing any task. Problematically applies to animal people based on the animal and war trained animalsBug:9588.
MEGABEAST Caste A 'boss' creature. A small number of the creatures 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. They will remain hostile to military even after being tamed.Bug:10731 See megabeast page for more details.

Requires specifying a [BIOME] in which the creature will live. Subterranean biomes appear to not be allowed. Does stack with [LARGE_ROAMING] and if both are used the creature will spawn as both historical bosses and as wild animals.

MENT_ATT_CAP_PERC Caste Default is 200. This means you can increase your attribute to 200% of its starting value (or the average value + your starting value if that is higher).
MENT_ATT_RANGE Caste
  • ATTRIBUTE
  • lowest
  • lower
  • low
  • median
  • high
  • higher
  • highest
Sets up a mental attribute's range of values (0-5000). All mental attribute ranges default to 200:800:900:1000:1100:1300:2000.
MENT_ATT_RATES Caste
  • ATTRIBUTE Token
  • cost to improve
  • unused counter rate
  • rust counter rate
  • demotion counter rate
Mental attribute gain/decay rates. Lower numbers in the last three slots make decay occur faster. Defaults are 500:4:5:4.
MILKABLE Caste Allows the creature to be milked in the farmer's workshop. The frequency is the amount of ticks the creature needs to "recharge" (i.e. how much time needs to pass before it can be milked again). Does not work on sentient creatures, regardless of ethics.
MISCHIEVIOUS Caste Alias for [MISCHIEVOUS].
MISCHIEVOUS Caste The creature spawns stealthed and will attempt to path into the fortress, pulling any levers it comes across. It will be invisible on the map and unit list until spotted by a citizen, at which point the game will pause and recenter on the creature. Used by gremlins in the vanilla game. "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. No use for the player in fortress mode, but enemy sieging forces may arrive with cavalry. Mounts are usable in adventure mode.
MOUNT_EXOTIC Caste Creature may be used as a mount, but civilizations cannot domesticate it in worldgen without certain exceptions.
MULTIPART_FULL_VISION Caste Allows the creature to have all-around vision, as long as it has multiple heads that can see.
MULTIPLE_LITTER_RARE Caste Makes the species usually produce a single offspring per birth, with a 1/500 chance of using the [LITTERSIZE] as usual. Requires [FEMALE].
MUNDANE Creature Marks if the creature is an actual real-life creature. Only used for age-names at present.
Contents A B C D E F G H I J K L M N O P Q R S T U V W X Y Z top

N[edit]

Token Type Arguments Description
NAME Creature
  • singular
  • plural
  • adjective
The generic name for any creature of this type - will be used for referring to the species in the abstract, such as the default material prefix. For labeling individual creatures, [CASTE_NAME] is necessary. If left undefined, the creature will be labeled as "nothing" by the game.

Some examples of adjective use:

  • "superdwarven strength"
  • "the dwarven hillocks of X"
  • Deity species as in "feline deity"
  • Megabeast attacks in worldgen. One with multiple dragons being a "draconic rampage"
NATURAL Caste Animal is considered to be natural. NATURAL animals will not engage creatures tagged with [AT_PEACE_WITH_WILDLIFE] in combat unless they are members of a hostile entity and vice-versa.
NATURAL_ANIMAL Caste Alias of [NATURAL].
NATURAL_SKILL Caste The creature possesses the specified skill at this level inherently - that is, it begins with the skill at this level, and the skill may never rust below that. A value of 15 is legendary.
NIGHT_CREATURE Caste Creatures with this token can appear as experiments.

Prevents [LOCAL_POPS_PRODUCE_HEROES] from functioning. Causes the creature to count as [NOT_LIVING]. Killing a creature featuring this token provides one point of "hero" reputation. Adds the creature's description as part of the initial summary of their historical figure in legends mode. Prevents creature behavior enabled by [LARGE_PREDATOR]. People will react to creatures with this token as a night creature (natch). In adventure mode, ambushes involving these units will say "Night creature!" instead of "Ambush!"

Prevents the AI from using ANIMATE interactions, unless the newly-animated[OPPOSED_TO_LIFE]undead will not attack them. The check for this is specifically whether the unit is:

  • a ghost
  • an animated unit
  • a unit with the [NO_AGING] token added via [CE_ADD_TAG]. (This allows for the default exclusion of elves and goblins, unless raised as intelligent undead.)

This token should not be confused with other NIGHT_CREATURE_X tokens. This token is not well understood at the present time.

NIGHT_CREATURE_BOGEYMAN Caste Creatures with this token can appear in bogeyman ambushes in adventure mode, where they adopt classical bogeyman traits such as stalking the adventurer and vaporising when dawn breaks. Such traits do not manifest if the creature is encountered outside of a bogeyman ambush (for instance, as a megabeast or a civilised being). In addition, their corpses and severed body parts turn into smoke after a short while. Note that setting the "Number of Bogeyman Types" in advanced world generation to 0 will only remove randomly-generated bogeymen.
NIGHT_CREATURE_EXPERIMENTER Caste Found on some necromancers. Creatures with this tag may periodically "perform horrible experiments" offscreen, during which they can use creature-targeting interactions with an [I_SOURCE:EXPERIMENT] tag on living creatures in their area. Worlds are generated with a list of procedurally-generated experiments, allowing necromancers to turn living people and animals into ghouls and other experimental creatures, and these will automatically be available to all experimenters; it does not appear possible to prevent this. You can mod in your own custom experiment interactions, but these are used very infrequently due to the large number of generated experiments.
NIGHT_CREATURE_HUNTER Caste Found on night trolls and werebeasts. Implies that the creature is a night creature, and shows its description in legends mode entry. The creature is always hostile and will start no quarter combat with any nearby creatures, except for members of its own race. Note that this tag does not override the creature's normal behavior in fortress mode except for the aforementioned aggression, and doesn't prevent the creature from fleeing the battles it started. It also removes the creature's materials from stockpile settings list, making them be stored there regardless of settings.

Does stack with [LARGE_ROAMING] and if both are used the creature will spawn as both historical hunters and as wild animals; this requires specifying a [BIOME] in which the creature will live, and subterranean biomes are allowed.

This tag causes the usual behaviour of werebeasts 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 vampires. When paired with SPOUSE_CONVERTER, 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. It will actively attempt to seek out potential conversion targets to abduct, convert, and have children with (if possible).

NIGHT_CREATURE_NIGHTMARE Caste Found on nightmares. Corpses and severed body parts derived from creatures with this token turn into smoke after a short while.
NO_AUTUMN Caste The creature caste does not appear in 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. Seems to cause worldgen crashes if it is part of an entity with [PERMITTED_JOB:FISHERMAN][Verify]
NO_FEVERS Caste Creature cannot suffer fevers.
NO_GENDER Caste The creature is biologically sexless, making it unable to breed.
NO_PHYS_ATT_GAIN Caste The creature cannot raise any physical attributes.
NO_PHYS_ATT_RUST Caste The creature cannot lose any physical attributes.
NO_SLEEP Caste Creature does not need to sleep, but can still be rendered unconscious by other means.
NO_SPRING Caste The creature caste does not appear in spring.
NO_SUMMER Caste The creature caste does not appear in 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_UNIT_TYPE_COLOR Caste Prevents creature from selecting its color based on its profession (e.g. Miner, Hunter, Wrestler).
NO_VEGETATION_PERTURB Caste[Verify] Likely prevents the creature from leaving broken vegetation tracks.[Verify]
NO_WINTER Caste The creature caste does not appear in winter.
NOBONES Caste Creature has no bones.
NOBREATHE Caste Creature doesn't need to breathe or have [BREATHE] parts in body, nor can it drown or be strangled. Creatures living in magma must have this tag, otherwise they will drown.
NOCTURNAL Caste When set, the creature will only appear at night (after 10:05 PM and before 4:30 AM) in Adventurer mode.
NOEMOTION Caste Creature has no emotions. It is immune to the effects of stress and unable to rage, and its needs cannot be fulfilled in any way. Used on undead in the vanilla game.
NOEXERT Caste Creature can't become tired or over-exerted from taking too many combat actions, or moving at full speed for extended periods of time.
NOFEAR Caste Creature doesn't feel fear and will never flee from battle, and will be immune to ghosts' attempts to 'scare it to death'. Additionally, it causes bogeymen and nightmares to become friendly towards the creature.
NOMEAT Caste Creature will not be hunted or fed to wild beasts.
NONAUSEA Caste Creature isn't nauseated by gut hits and cannot vomit.
NOPAIN Caste Creature doesn't feel pain.
NOSKIN Caste Creature will not drop a hide when butchered.
NOSKULL Caste Creature will not drop a skull on butchering, rot, or decay of severed head.
NOSMELLYROT Caste Does not produce miasma when rotting.
NOSTUCKINS Caste Weapons can't get stuck in the creature.
NOSTUN Caste Creature can't be stunned and knocked unconscious by pain or head injuries. Creatures with this tag never wake up from sleep in Fortress Mode. If this creature needs to sleep while playing, it will die.
NOT_BUTCHERABLE Caste Corpses from this creature cannot be butchered. Does not prevent the creature from being slaughtered while alive, however.
NOT_LIVING Caste Cannot be raised from the dead by necromancers or evil clouds. Implies the creature is not a normal living being. Used by vampires, mummies and inorganic creatures like the amethyst man and bronze colossus. Creatures who are [OPPOSED_TO_LIFE] (undead) will be docile towards creatures with this token.
NOTHOUGHT Caste Creature doesn't require a [THOUGHT] body part to survive. Has the added effect of preventing speech, though directly controlling creatures that would otherwise be capable of speaking allows them to engage in conversation.
Contents A B C D E F G H I J K L M N O P Q R S T U V W X Y Z top

O[edit]

Token Type Arguments Description
ODOR_LEVEL Caste
  • number
How easy the creature is to smell. The higher the number, the easier the creature is to sniff out. Defaults to 50. Vanilla creatures have values from 0 (undetectable) to 90 (noticeable by humans and dwarves).
ODOR_STRING Caste
  • string
What the creature smells like. If no odor string is defined, the creature name (not the caste name) is used.
OPPOSED_TO_LIFE Caste Is hostile to all creatures except undead and other non-living ones and will show Opposed to life in the unit list. Used by undead in the vanilla game. Functions without the [NOT_LIVING] token, and seems to imply said token as well. Undead will not be hostile to otherwise-living creatures given this token. Living creatures given this token will attack living creatures that lack it, while ignoring other living creatures that also have this token.
ORIENTATION Caste
  • MALE/FEMALE
  • disinterested chance
  • casual chance
  • strong chance
Determines caste's likelihood of having sexual attraction to certain sexes. Values default to 75:20:5 for the same sex and 5:20:75 for the opposite sex. The first value indicates how likely to be entirely uninterested in the sex, the second decides if the creature will be able to become lovers with that sex, the third decides whether they will be able to marry in worldgen and post-worldgen world activities (which implies being able to become lovers). Marriage seems to be able to happen in fort mode play regardless, as long as they are lovers first.
OUTSIDER_CONTROLLABLE Caste Lets you play as an outsider of this species in adventure mode.
Contents A B C D E F G H I J K L M N O P Q R S T U V W X Y Z top

P[edit]

Token Type Arguments Description
PACK_ANIMAL Caste Allows the creature to be used as a pack animal. Used by merchants without wagons and adventurers. Also prevents creature from dropping hauled items on its own -- do not use for player-controllable creatures! May lead to the creature being domesticated during worldgen, even if it doesn't have [COMMON_DOMESTIC].

Creatures with this tag but without [BENIGN], and/or with [LARGE_PREDATOR] leads to hauled items being dropped.

PARALYZEIMMUNE Caste The creature is immune to all paralyzing special attacks.
PATTERNFLIER Caste Used to control the bat riders with paralyze-dart blowguns that flew through the 2D chasm. Doesn't do anything now.
PCG_LAYERING Creature Adds a layer to the current [PROCEDURAL_CREATURE_GRAPHICS] definition.
PEARL Caste In earlier versions, creature would generate pearls. Does nothing in the current version.[Verify]
PENETRATEPOWER Caste
  • value
Controls the ability of vermin to find a way into containers when they are eating food from your stockpiles.

Objects made of most materials (e.g. metal) roll a number from 0-100, and if the resulting number is greater than the penetrate power, their contents escape for the time being. Objects made of wood, leather, amber, or coral roll 0-95, and items made of cloth roll 0-90.

PERSONALITY Caste
  • ATTRIBUTE
  • lowest
  • median
  • highest
Determines the range and chance of personality traits. Standard is 0:50:100. See personality traits for more info.
PET Caste Allows the creature to be tamed in Fortress mode. Prerequisite for all other working animal roles. Civilizations that encounter it in worldgen will tame and domesticate it for their own use. Adding this to civilization members will classify them as pets instead of citizens, with all the problems that entails. However, you can solve these problems using the popular plugin Dwarf Therapist, which is completely unaffected by the tag.
PET_EXOTIC Caste Allows the creature to be tamed in Fortress mode. Prequisite for all other working animal roles. Civilizations cannot domesticate it in worldgen, with certain exceptions. More difficult to tame?[Verify] Adding this to civilization members will classify them as pets instead of citizens, with all the problems that entails. (Example).
PETVALUE Caste
  • value
How valuable a tamed animal is. Actual cost in points in the embarking screen is 1+(PETVALUE/2) for an untrained animal, 1+PETVALUE for a war/hunting one.
PETVALUE_DIVISOR Caste
  • value
Divides the creature's [PETVALUE] by the specified number. Used by honey bees to prevent a single hive from being worth a fortune.
PHYS_ATT_CAP_PERC Caste Default is 200. This means you can increase your attribute to 200% of its starting value (or the average value + your starting value if that is higher).
PHYS_ATT_RANGE Caste
  • ATTRIBUTE
  • lowest
  • lower
  • low
  • median
  • high
  • higher
  • highest
Sets up a physical attribute's range of values (0-5000). All physical attribute ranges default to 200:700:900:1000:1100:1300:2000.
PHYS_ATT_RATES Caste
  • ATTRIBUTE Token
  • cost to improve
  • unused counter rate
  • rust counter rate
  • demotion counter rate
Physical attribute gain/decay rates. Lower numbers in the last three slots make decay occur faster. 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
  • number (max 100000)
Weighted population of caste; Lower is rarer. Not to be confused with [FREQUENCY]. A weight of 0 will not prevent a caste from spawning.
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. Defaults to 1:1 if not specified.
POWER Caste Allows the being to represent itself as a deity, allowing it to become the leader of a civilized group. Not used by any creatures in the vanilla game. 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. Once the creature ascends to a position of leadership, it will proceed to act as a standard ruler for their entity and fulfill the same functions (hold tournaments, tame creatures, etc.).
PREFSTRING Creature
  • string
Sets what other creatures prefer about this creature. "Urist likes dwarves for their beards." Multiple entries will be chosen from at random. Creatures lacking a PREFSTRING token will never appear under another's preferences.
PROCEDURAL_CREATURE_GRAPHICS Creature Makes the creature have procedural graphics built for it, like forgotten beasts/demons/titans/experiments. Must be associated with PCG_LAYERING tokens.
PROFESSION_NAME Creature 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
  • Chance
Creature has a percentage chance to flip out at visible non-friendly creatures. Enraged creatures attack anything regardless of timidity and get a strength bonus to their hits. This is what makes badgers so hardcore.
PUS Caste The creature has pus. Specifies the stuff secreted by infected wounds.
Contents A B C D E F G H I J K L M N O P Q R S T U V W X Y Z top

R[edit]

Token Type Arguments 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 the creature's remains are called.
REMAINS_COLOR Caste What color the 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 Nothing.
REMOVE_MATERIAL Creature
  • material token
Removes a material from the creature.
REMOVE_TISSUE Creature
  • tissue token
Removes a tissue from the creature.
RETRACT_INTO_BP Caste
  • BY_TYPE, BY_CATEGORY or BY_TOKEN
  • body type, category, or token
  • Second person ("You") retract verb text
  • Third person ("The giant snail") retract verb text
  • Second person cancel retract text
  • Third person cancel retract text
The creature will retract into the specified body part(s) when threatened. It will be unable to move or attack, but enemies will only be able to attack the specified body part(s). When one of the specified body part is severed off, the creature automatically unretracts and cannot retract anymore. More than one body part can be selected by using BY_TYPE or BY_CATEGORY.

Second-person descriptions are used for adventurer mode natural ability. "<pro_pos>" can be used in the descriptions, being replaced with the proper pronoun (or lack thereof) in-game.

Undead curled up creatures are buggy, specifically those that retract into their upper bodies: echidnas, hedgehogs and pangolins.Bug:11463Bug:10519 The upper body is prevented from collapsing by a separate body part (the middle spine), which cannot be attacked when the creature is retracted. See [PREVENTS_PARENT_COLLAPSE]. Living creatures eventually succumb to blood loss, but undead creatures do not. Giant creatures also take a very long time to bleed out.

RETURNS_VERMIN_KILLS_TO_OWNER Creature Cat behavior. If it kills a vermin creature and has an owner, it carries the remains in its mouth and drops them at their feet. Requires [HUNTS_VERMIN].
ROOT_AROUND Caste
  • BY_TYPE, BY_CATEGORY or BY_TOKEN
  • body type, category, or token
  • Second person ("You") verb text
  • Third person ("The hen") verb text
Creature will occasionally root around in the grass, looking for insects. Used for flavor in Adventurer Mode, spawns vermin edible for this creature in Fortress Mode. Creatures missing the specified body part will be unable to perform this action. The action produces a message (visible in adventure mode) in the form:

[creature] [verb text] the [description of creature's location]

In adventure mode, the "rooting around" ability will be included in the "natural abilities" menu, represented by its second person verb text.

Contents A B C D E F G H I J K L M N O P Q R S T U V W X Y Z top

S[edit]

Token Type Arguments Description
SAVAGE Creature The creature will only show up in "savage" biomes. Has no effect on cavern creatures. Cannot be combined with [GOOD] or [EVIL].
SECRETION Caste Causes the specified tissue layer(s) of the indicated body part(s) to secrete the designated material. A size 100 ('covering') contaminant is created over the affected body part(s) in its specified material state (and at the temperature appropriate to this state) when the trigger condition is met, as long as one of the secretory tissue layers is still intact. Valid triggers are:
  • CONTINUOUS

Secretion occurs once every 40 ticks in fortress mode, and every tick in adventurer mode.

  • EXERTION

Secretion occurs continuously (at the rate described above) whilst the creature is at minimum Tired following physical exertion. Note that this cannot occur if the creature has [NOEXERT].

  • EXTREME_EMOTION

Secretion occurs continuously (as above) whilst the creature is distressed. Cannot occur in creatures with [NOEMOTION].

SELECT_ADDITIONAL_CASTE Creature
  • <caste>
Adds an additional previously defined caste to the selection. Used after [SELECT_CASTE].
SELECT_CASTE Creature
  • <caste> or ALL
Selects a previously defined caste
SELECT_MATERIAL Creature Selects a locally defined material. Can be ALL.
SELECT_TISSUE Creature
  • tissue token
Selects a tissue for editing.
SEMIMEGABEAST Caste Essentially the same as [MEGABEAST], but more of them are created during worldgen. See the semi-megabeast page for details.
SENSE_CREATURE_CLASS Caste Gives the creature the ability to sense creatures belonging to the specified creature class even when they lie far beyond line of sight, including through walls and floors. It also appears to reduce or negate the combat penalty of blind units when fighting creatures they can sense. In adventure mode, the specified tile will be used to represent sensed creatures when they cannot be seen directly.
SET_BP_GROUP Caste
  • selection criteria BY_TYPE, BY_CATEGORY, BY_TOKEN
  • category, type, or token
Begins a selection of body parts.
SKILL_LEARN_RATE Caste 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
  • <% of improvement points gained>
  • <unused counter rate>
  • <rust counter rate>
  • <demotion counter rate>
Like [SKILL_RATES], but applies to individual skills instead. Requires [CAN_LEARN] or [INTELLIGENT] to function.
SKILL_RATES Caste
  • <% of improvement points gained>
  • <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]. Requires [CAN_LEARN] or [INTELLIGENT] to function.

SKILL_RUST_RATE Caste 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.
SLAIN_CASTE_SPEECH Caste Caste-specific [SLAIN_SPEECH].
SLAIN_SPEECH Creature Boasting speeches relating to killing this creature. Examples include text_dwarf.txt ([SLAIN_SPEECH:SLAIN_DWARF]) and text_elf.txt ([SLAIN_SPEECH:SLAIN_ELF]) in data\vanilla\vanilla_creatures\objects.
SLOW_LEARNER Caste Shorthand for [CAN_LEARN] + [SKILL_LEARN_RATES:50].[Verify] Used by a number of 'primitive' creatures (like ogres, giants and troglodytes) in the vanilla game. Applicable to player races. Prevents a player from recruiting nobility, even basic ones. Subterranean creatures with this token combined with [EVIL] will become servants of goblins in their civilizations, in the style of trolls.
SMALL_REMAINS Caste Creature leaves "remains" instead of a corpse. Used by vermin.
SMELL_TRIGGER Caste
  • value
Determines how keen a creature's sense of smell is - lower is better. At 10000, a creature cannot smell at all.
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.
  • First-person reads "You bark"
  • Third-person reads "The capybara barks"
  • Out of sight reads "You hear a loud bark"

with the text in bold being the description arguments of the token.

SOURCE_HFID Creature
  • Integer
Found on generated angels. This is the historical figure ID of the deity with which the angel is associated. Since HFIDs are not predictable before worldgen, this isn't terribly usable in mods.
SPECIFIC_FOOD Caste
  • PLANT or CREATURE
  • Plant/creature ID
Creature will only appear in biomes with this plant or creature available. Grazers given a specific type of grass (such as pandas and bamboo) will only eat that grass and nothing else, risking starvation if there's none available.
SPHERE Creature Sets what religious spheres the creature is aligned to, for purposes of being worshipped via the [POWER] token. Also affects the creature's name.
SPOUSE_CONVERSION_TARGET Caste This creature can be converted by a night creature with [SPOUSE_CONVERTER].
SPOUSE_CONVERTER Caste If the creature has the [NIGHT_CREATURE_HUNTER] tag, it will kidnap [SPOUSE_CONVERSION_TARGET]s and transform them into the caste of its species with the [CONVERTED_SPOUSE] tag during worldgen. It may also start families this way.
SPREAD_EVIL_SPHERES_IF_RULER Caste If the creature rules over a site, it will cause the local landscape to be corrupted into evil surroundings associated with the creature's spheres. The creature must have at least one of the following spheres for this to take effect: BLIGHT, DEATH, DISEASE, DEFORMITY, NIGHTMARES. The first three kill vegetation, while the others sometimes do. The last two get evil plants and evil animals sometimes. NIGHTMARES gets bogeymen. [4] Used by demons in the vanilla game.
STANCE_CLIMBER Caste Caste does not require [GRASP] body parts to climb -- it can climb with [STANCE] parts instead.
STANDARD_GRAZER Caste Acts as [GRAZER] but set to 20000*G*(max size)^(-3/4), where G defaults to 100 but can be set in d_init, and the whole thing is trapped between 150 and 3 million. Used for all grazers in the default creature raws.
STRANGE_MOODS Caste The creature will get strange moods in fortress mode and can produce artifacts.
SUPERNATURAL Caste Gives the creature knowledge of any secrets with [SUPERNATURAL_LEARNING_POSSIBLE] that match its spheres and also prevents it from becoming a vampire or werebeast. Other effects are unknown.
SWIMS_INNATE Caste The creature naturally knows how to swim perfectly and does not use the swimmer skill, as opposed to [SWIMS_LEARNED] below. However, Fortress mode AI never paths into water anyway, so it's less useful there.
SWIMS_LEARNED Caste The creature swims only as well as their present swimming skill allows them to.
SYNDROME_DILUTION_FACTOR Caste <syndrome identifier>:<percentage> Dilutes the effects of syndromes which have the specified identifier. A percentage of 100 is equal to the regular syndrome effect severity, higher percentages reduce severity.
Contents A B C D E F G H I J K L M N O P Q R S T U V W X Y Z top

T[edit]

Token Type Arguments Description
TENDONS Caste The creature has tendons in its [CONNECTIVE_TISSUE_ANCHOR] tissues (bone or chitin by default). Cutting the bone/chitin tissue severs the tendons, disabling motor function if the target is a limb.
THICKWEB Caste The creature's webs can catch larger creatures.
TISSUE Creature
  • name
Begins defining a tissue in the creature file. Follow this with standard tissue definition tokens to define the tissue properties.
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
Alias for TISSUE_LAYER
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 the 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]

TITAN Caste Found on titans. Cannot be specified in user-defined raws.
TRADE_CAPACITY Caste
  • number
How much the creature can carry when used by merchants. 1000 by default. Completely ignored if the animal does not also have PACK_ANIMAL or WAGON, instead using BODY_SIZE^(2/3)/20, even if they're a pack animal due to ANIMAL_ALWAYS_PACK_ANIMAL.
TRAINABLE Caste Shortcut for [TRAINABLE_HUNTING] + [TRAINABLE_WAR].
TRAINABLE_HUNTING Caste Can be trained as a hunting beast, increasing speed.
TRAINABLE_WAR Caste Can be trained as a war beast, increasing strength and endurance.
TRANCES Caste Allows the creature to go into martial trances. Used by dwarves in the vanilla game.
TRAPAVOID Caste The creature will never trigger traps it steps on. Used by a number of creatures. Doesn't make the creature immune to remotely activated traps (like retractable spikes being triggered while the creature is standing over them). TRAPAVOID creatures lose this power if they're immobilized while standing in a trap, be it by stepping on thick web, being paralyzed or being knocked unconscious.
TRIGGERABLE_GROUP Creature
  • min
  • max
A large swarm of vermin can be disturbed, usually in adventurer mode.
TSU_NOUN Caste
  • noun
  • SINGULAR or PLURAL
Noun for the [TISSUE_STYLE_UNIT], used in the description of the tissue layer's style.
Contents A B C D E F G H I J K L M N O P Q R S T U V W X Y Z top

U[edit]

Token Type Arguments Description
UBIQUITOUS Creature Creature will occur in every region with the correct biome. Does not apply to [EVIL]/[GOOD] tags. Supersedes [FREQUENCY] for the purposes of distributing populations through the map, they are present in every part of the valid biome. Respects [FREQUENCY] for the frequency of unit cluster spawns being of this species.
UNDERGROUND_DEPTH Creature
  • mindepth
  • maxdepth
Depth that 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. Values from 1-3 are the respective cavern levels, 4 is the magma sea and 5 is the HFS. A single argument may be used instead of min and max. Demons use only 5:5; user-defined creatures with both this depth and [FLIER] will take part in the initial wave from the HFS alongside generated demons, but without [FLIER] they will only spawn from the map edges. Civilizations that can use underground plants or animals will only export (via the embark screen or caravans) things that are available at depth 1.
UNDERSWIM Caste The creature is displayed as blue when in 7/7 water. Used on fish and amphibious creatures which swim under the water.
UNIQUE_DEMON Caste Found on generated demons; causes the game to create a single named instance of the demon which will emerge from the underworld and take over civilizations during worldgen.
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."

Roostre: "When DF detects duplicate tokens in the raws of the same object, a failsafe seems to kick in; it takes the bottom-most of the duplicates, and disregards the others. In the case of tokens added by a mod, it prioritizes the duplicate in the mod." This means that if a tag is defined in the base-caste and redefined in the derived caste, the derived tag overwrites the base tag.

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. There seems to be a limit of 200 materials per creature.
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 Creature 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'.
Contents A B C D E F G H I J K L M N O P Q R S T U V W X Y Z top

V[edit]

Token Type Arguments Description
VEGETATION Caste Like [AT_PEACE_WITH_WILDLIFE], but also makes the creature more valued in artwork by civilisations with the PLANT sphere. [5] Used by grimelings in the vanilla game.
VERMIN_BITE Caste Enables vermin to bite other creatures, injecting the specified material. See [SPECIALATTACK_INJECT_EXTRACT] for details about injection - this token presumably works in a similar manner.[Verify]
VERMIN_EATER Creature The vermin creature will attempt to eat exposed food. See [PENETRATEPOWER]. Distinct 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. See the list of hateable vermin for details.
VERMIN_MICRO Caste This makes the creature move in a swarm of creatures of the same race as it (e.g. swarm of flies, swarm of ants).
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 The vermin are attracted to rotting stuff and loose food left in the open and cause unhappy thoughts to dwarves who encounter them. Present on flies, knuckle worms, acorn flies, and blood gnats. Speeds up decay?[Verify]
VERMIN_SOIL Creature The creature randomly appears near dirt or mud, and may be uncovered by creatures that have the [ROOT_AROUND] interaction such as geese and chickens. Dwarves will ignore the creature when given the "Capture live land animal" task.
VERMIN_SOIL_COLONY Creature The vermin will appear in a single tile cluster of many vermin, such as a colony of ants.
VERMINHUNTER Caste Old shorthand for "does cat stuff". Contains [AT_PEACE_WITH_WILDLIFE] + [RETURNS_VERMIN_KILLS_TO_OWNER] + [HUNTS_VERMIN] + [ADOPTS_OWNER].
VESPERTINE Caste When set, the creature will only appear in the evening (between 8:00 PM and 10:05 PM) in Adventurer mode.
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.
VISION_ARC Caste
  • binocular vision arc
  • non-binocular vision arc
The width of the creature's vision arcs, in degrees (i.e. 0 to 360). The first number is binocular vision, the second is non-binocular vision. Binocular vision has a minimum of about 10 degrees, monocular, a maximum of about 350 degrees. Values past these limits will be accepted, but will default to ~10 degrees and ~350 degrees respectively. Defaults are 60:120.
Contents A B C D E F G H I J K L M N O P Q R S T U V W X Y Z top

W[edit]

Token Type Arguments Description
WAGON_PULLER Caste Allows the creature to pull caravan wagons. If a civilization doesn't have access to any, it is restricted to trading with pack animals.
WEBBER Caste 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. Used by creatures who can shoot thick webs (such as giant cave spiders) in order to make them immune to their own attacks.

Attack Tokens[edit]

Attacks can use four different part selection criteria; while all vanilla attacks use only BODYPART (e.g. ATTACK:PUNCH:BODYPART:BY_TYPE:GRASP), there are other options available.

Part type token Arguments Description
BODYPART
  • BY_TYPE/BY_TOKEN/BY_CATEGORY
  • type/token/category
This attack uses a particular body part; for example, BY_TYPE:GRASP will make it use any part that can hold onto an object.
TISSUE_LAYER
  • BY_TYPE/BY_TOKEN/BY_CATEGORY
  • type/token/category
  • tissue layer
This attack uses a specific tissue layer on a specific body part; BY_TYPE:GRASP:BONE will make it use the bone of the hands.
CHILD_BODYPART_GROUP
  • BY_TYPE/BY_TOKEN/BY_CATEGORY
  • type/token/category
  • BY_TYPE/BY_TOKEN/BY_CATEGORY
  • type/token/category
Uses a body part that is subordinate to another; BY_CATEGORY:ARM_LOWER:BY_TYPE:GRASP will make it use every hand attached to each lower arm (so it will generate one attack per lower arm, each of which will use every hand on that arm, assuming there are multiple hands per arm).
CHILD_TISSUE_LAYER_GROUP
  • BY_TYPE/BY_TOKEN/BY_CATEGORY
  • type/token/category
  • BY_TYPE/BY_TOKEN/BY_CATEGORY
  • type/token/category
  • tissue layer
As CHILD_BODYPART_GROUP, but specifying a tissue, too.
Token Type Arguments Description
ATTACK_SKILL Caste Defines the skill used by the attack.
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. Note that all attack percentages can be more than 100%.
ATTACK_PENETRATION_PERC Caste
  • % value
The penetration value of the attack, measured in % of the body part's volume. Requires ATTACK_FLAG_EDGE. Maximum value: 15000.
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 Displays the name of the body part used to perform an attack while announcing it, e.g. "The weaver punches the bugbat with his right hand".
ATTACK_FLAG_EDGE Caste The attack is edged, with all the effects on physical resistance and contact area that it entails.
ATTACK_PREPARE_AND_RECOVER Caste
  • Preparation time
  • Recovery time
Determines the length of time to prepare this attack and until one can perform this attack again. Values appear to be calculated in adventure mode ticks.
ATTACK_FLAG_BAD_MULTIATTACK Caste Multiple strikes with this attack cannot be performed effectively.
ATTACK_FLAG_INDEPENDENT_MULTIATTACK Caste Multiple strikes with this attack can be performed with no penalty. The creature will use all attacks with this token at once.
SPECIALATTACK_INJECT_EXTRACT Caste When added to an attack, causes the attack to inject the specified material into the victim's bloodstream. Once injected, the material will participate in thermal exchange within the creature - injecting something like molten iron (INORGANIC:IRON:LIQUID) would cause most unmodded creatures to melt (note that some of the injected material also splatters over the bodypart used to carry out the attack, so it should be protected appropriately). If the injected material has an associated syndrome with the [SYN_INJECTED] token, it will be transmitted to the victim. If the attack is blunt, the injected material lacks the [ENTERS_BLOOD] token, the attacked bodypart has no [VASCULAR] tissues, or the victim is bloodless, the material will splatter over the attacked body part instead.
SPECIALATTACK_INTERACTION Caste
  • interaction
When this attack lands successfully, a specified interaction 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. If the attack would break skin, the interaction will occur before the attack actually lands.
SPECIALATTACK_SUCK_BLOOD Caste
  • min
  • max
Successful attack draws out an amount of blood randomized between the min and max value. Beware that this will trigger any ingestion syndromes attached to the target creature's blood - for example, using this attack on a vampire will turn you into one too.

Tissue Layer Tokens[edit]

Tissue layers are added to a creature's body parts by the creature tokens TISSUE_LAYER, TISSUE_LAYER_OVER, TISSUE_LAYER_UNDER, and the body detail plan token TL_LAYERS.

These tissue layers are not the same thing as tissues, which are defined at creature level, but rather applications of the tissues. If the SKIN tissue of a creature is the more general and abstract notion of what skin is for that creature, then a tissue layer may be the "actual" skin on the creature's nose, head, or second toe. As most creatures have more than one body part, tissue layers are normally selected en masse.

Some tissue layer tokens are analogous to tissue definition tokens, e.g. TL_CONNECTS to CONNECTS.

Token Type Arguments Description
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.
Begins a selection of tissue layers.

[SELECT_TISSUE_LAYER:HEART:BY_TYPE:HEART]

PLUS_TISSUE_LAYER Caste
  • TISSUE
  • BY_CATEGORY, BY_TYPE, BY_TOKEN
  • Location - category, type, or token
Adds tissue layers to those selected.
SET_TL_GROUP Caste
  • TISSUE
  • BY_CATEGORY, BY_TYPE, BY_TOKEN
  • Location - category, type, or token
  • tissue
Begins a selection of tissue layers. Only usable for descriptor and cosmetic purposes.

Research has implied it may be redundant with SELECT_TISSUE_LAYER, as the latter allows for cosmetics as well as "functional" tokens such as TL_MAJOR_ARTERIES. Vanilla raws still use SET_TL_GROUP though, for all cosmetic purposes. More research is needed on this subject.

PLUS_TL_GROUP Caste
  • BY_CATEGORY, BY_TYPE, BY_TOKEN
  • Location - category, type, or token
  • tissue
Adds tissue layers to those selected. Like SET_TL_GROUP, it may be redundant even if used in the vanilla raws.
SET_LAYER_TISSUE Caste
  • TISSUE
Sets a selected tissue layer to be made of a different tissue.
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 (for example, a llama's wool must have a LENGTH of 300 before it is shearable).
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 style unit ID
  • shaping
Sets tissue layer to be the target of TISSUE_STYLE token specified for an entity, works only on entity members. Mostly used with tissues HAIR, BEARD, MOUSTACHE, SIDEBURNS.
TL_COLOR_MODIFIER Caste
  • COLOR
  • freq
  • COLOR
  • freq etc.
Creates a list of colors/color patterns, giving each a relative frequency. If the given color or pattern does not exist, the tissue is described as being "transparent".
TLCM_GENETIC_MODEL Caste The way the color modifier is passed on to offspring. May or may not work right now.[Verify]
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. Also used by Stonesense for colouring body parts.
TLCM_TIMING Caste
  • ROOT
  • start change window years
  • days
  • end change window years
  • days
Determines the point in the creature's life when the color change begins and ends.
TL_CONNECTS Caste Gives the CONNECTS attribute to selected layers.
TL_HEALING_RATE Caste
  • value
Changes the HEALING_RATE of the selected tissue layers.
TL_MAJOR_ARTERIES Caste Gives the "major arteries" attribute to selected layers. Used to add massive bleeding properties to the throat, made from skin.
TL_PAIN_RECEPTORS Caste
  • value
Changes the number of pain receptors for selected tissue layers.
TL_RELATIVE_THICKNESS Caste
  • value
Changes the relative thickness for selected tissue layers.
TL_VASCULAR Caste
  • value
Sets a new VASCULAR value (which modulates bleeding) for selected tissue layers.

See Also[edit]