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
m
m
 
(229 intermediate revisions by 47 users not shown)
Line 1: Line 1:
{{Quality|Exceptional|22:04, 20 September 2016 (UTC)}}
+
{{Quality|Exceptional}}
 
{{av}}
 
{{av}}
 +
{{Modding}}
  
A full list of all known [[creature]] [[token]]s.
+
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.
  
<div align="center">
+
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)
{{alphabetical TOC}}
+
 
</div>
+
__NOTOC__
 +
{{clear}}
 +
{{alphabetical TOC|style=margin: 1em auto;}}
  
 
==A==
 
==A==
Line 22: Line 26:
 
| Caste
 
| Caste
 
|
 
|
| Tame creature cannot be made available for adoption, instead automatically adopting whoever it wants, used by [[cat]]s in the vanilla game. The basic requirements for adoption are intact, and the creature will only adopt individuals who have a [[preference]] for their species.
+
| 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 28: Line 32:
 
| Caste
 
| Caste
 
|   
 
|   
| Creature needs alcohol to get through the working day, choosing to drink booze instead of water if possible. Going sober for too long reduces speed.
+
| 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.
  
 
|-
 
|-
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 DIURNAL/NOCTURNAL/CREPUSCULAR, rather than implying them.
+
| 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.{{verify|code}}
  
 
|-
 
|-
Line 41: Line 45:
 
|  
 
|  
 
*'character' or tile number
 
*'character' or tile number
| If set, the creature will blink between its TILE and its ALTTILE.  
+
| If set, the creature will blink between its {{token|TILE|c}} and its ALTTILE.  
  
 
|-
 
|-
Line 47: Line 51:
 
| Caste
 
| Caste
 
|   
 
|   
| Found on LARGE_PREDATORs 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}}
+
| Found on {{token|LARGE_PREDATOR|c}}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}}
  
 
|-
 
|-
Line 53: Line 57:
 
| Caste
 
| Caste
 
|   
 
|   
| Allows a creature to breathe with or without [[water]] - does not prevent drowning in [[magma]].
+
| Allows a creature to breathe both in and out of [[water]] (unlike {{token|AQUATIC|c}}) - does not prevent drowning in [[magma]].
  
 
|-
 
|-
 
| {{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
 
*SINGULAR or PLURAL  
 
*SINGULAR or PLURAL  
| Creates a noun for the appearance and whether it is singular or plural.
+
| Creates a noun for the appearance, and whether it is singular or plural.
  
 
|-
 
|-
 
| {{text anchor|APP_MOD_RATE}}
 
| {{text anchor|APP_MOD_RATE}}
| Caste
+
| Appearance Modifier
 
|  
 
|  
 
*Rate (integer)
 
*Rate (integer)
Line 102: Line 108:
 
| Caste
 
| Caste
 
|  
 
|  
*CV TEMPLATE NAME
+
*creature variation ID
| Applies the specified [[creature variation token|creature variation]].
+
*(optional) any amount of arbitrary arguments
 +
| Applies the specified [[creature variation token|creature variation]]. See [[Creature_variation_token#Arguments_and_conditional_tokens]] for how the subsequent arguments may be used.
  
 
|-
 
|-
Line 109: Line 116:
 
| Special
 
| Special
 
|   
 
|   
| Applies the effects of all pending [[#CV_ADD_TAG|CV_ADD_TAG]] and [[#CV_REMOVE_TAG|CV_REMOVE_TAG]] tokens that have been defined in the current creature.
+
| Applies the effects of all pending {{token|CV_ADD_TAG|c}} and {{token|CV_REMOVE_TAG|c}} tokens that have been defined in the current creature.
  
 
|-
 
|-
Line 115: Line 122:
 
| Caste
 
| Caste
 
|   
 
|   
| Creature can breathe in water, but air-drowns on dry land.  
+
| Enables the creature to breathe in water, but causes it to air-drown on dry land.  
  
 
|-
 
|-
Line 121: Line 128:
 
| Caste
 
| Caste
 
|   
 
|   
| Does not appear in the object testing arena's creature spawning list.
+
| Causes the creature to be excluded from the [[object testing arena]]'s creature spawning list.  Typically applied to spoileriffic creatures.
  
 
|-
 
|-
Line 127: Line 134:
 
| Creature
 
| Creature
 
|
 
|
| Can be kept in artificial hives by beekeepers.
+
| Enables the creature to be kept in artificial [[hive]]s by [[beekeeper]]s.
  
 
|-
 
|-
Line 133: Line 140:
 
| Caste
 
| Caste
 
|
 
|
| Does not attack or frighten creatures with the NATURAL tag.
+
| Prevents the creature from attacking or frightening creatures with the {{Token|NATURAL|c}} tag.
  
 
|-
 
|-
Line 140: 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 />
[ATTACK:GORE:BODYPART:BY_CATEGORY:HORN]<br />
+
<code>[ATTACK:GORE:BODYPART:BY_CATEGORY:HORN]</code><br />
''GORE'' : name of the attack<br />
+
''GORE'' = name of the attack<br />
''BODYPART:BY_CATEGORY:HORN'' : the horn is used to attack (presuming the creature has one)
+
''BODYPART:BY_CATEGORY:HORN'' = the horn is used to attack (presuming the creature has one)
  
 
|-
 
|-
Line 156: 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.
  
 
|}
 
|}
  
<div align="center">
+
{{alphabetical TOC|style=margin: 1em auto;}}
{{alphabetical TOC}}
 
</div>
 
  
 
==B==
 
==B==
Line 185: Line 188:
 
*singular
 
*singular
 
*plural  
 
*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.
+
| Defines a new name for a creature in baby state at the caste level. For non-caste-specific baby names, see {{token|GENERAL_BABY_NAME|c}}.
  
 
|-
 
|-
Line 192: Line 195:
 
|  
 
|  
 
*integer
 
*integer
| Creature may be subject to [[beaching]], becoming stranded on [[Beach|shores]], where they will eventually air-drown. The number indicates the frequency of the occurrence. Presumably requires the creature to be aquatic. Used by [[orca]]s, [[sperm whale]]s and [[sea nettle jellyfish]] in the vanilla game.
+
| Creature may be subject to [[beaching]], becoming stranded on [[Beach|shores]], where they will eventually air-drown. The number indicates the frequency of the occurrence. Presumably requires the creature to be {{token|AQUATIC|c}}. Used by [[orca]]s, [[sperm whale]]s and [[sea nettle jellyfish]] in the vanilla game.
  
 
|-
 
|-
Line 198: Line 201:
 
| Caste
 
| Caste
 
|   
 
|   
| The creature is non-aggressive by default, and will never automatically be engaged by companions or soldiers. It will run 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 219: Line 224:
 
| Caste
 
| Caste
 
|  
 
|  
| Causes [[vampire]]-like behaviour; the creature will suck the [[Creature_token#BLOOD|blood]] of unconscious victims when its [[Syndrome#TIME_SINCE_SUCKED_BLOOD|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 as a creature of the night.
+
| Causes [[vampire]]-like behaviour; the creature will suck the [[Creature_token#BLOOD|blood]] of unconscious victims when its [[Syndrome#TIME_SINCE_SUCKED_BLOOD|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.
  
 
|-
 
|-
Line 231: 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.'''
+
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 257: Line 264:
 
*PlanName
 
*PlanName
 
*Arguments  
 
*Arguments  
| loads a plan listed OBJECT:BODY_DETAIL_PLAN files, such as b_detail_plan_default.txt. Mass applies USE_MATERIAL_TEMPLATE, mass alters RELSIZE, alters body part positions, and will allow tissue layers to be defined. Tissue layers are defined in order of skin to bone here.
+
| 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:'''<br />
 
'''Example:'''<br />
 
[BODY_DETAIL_PLAN:VERTEBRATE_TISSUE_LAYERS:SKIN:FAT:MUSCLE:BONE:CARTILAGE] <br />
 
[BODY_DETAIL_PLAN:VERTEBRATE_TISSUE_LAYERS:SKIN:FAT:MUSCLE:BONE:CARTILAGE] <br />
Line 289: Line 296:
 
| Caste
 
| Caste
 
|   
 
|   
| Creature eats bones. Implies CARNIVORE. [[Adventurer mode|Adventurers]] with this token are currently unable to eat bones.{{Bug|11069}}
+
| Creature eats bones. Implies {{token|CARNIVORE|c}}. [[Adventurer mode|Adventurers]] with this token are currently unable to eat bones.{{Bug|11069}}
  
 
|-
 
|-
Line 295: Line 302:
 
| Caste
 
| Caste
 
|  
 
|  
| Adds a type to a body part. Used with SET_BP_GROUP.  
+
| Adds a type to a body part - used with {{token|SET_BP_GROUP|c}}. In vanilla DF, this is used for adding the type '[[Body token#GELDABLE|GELDABLE]]' to the lower body of certain [[cat|creatures]].  
In vanilla DF, this is used for adding the type 'GELDABLE' to the lower body of certain [[cat|creatures]].  
 
  
 
|-
 
|-
Line 316: Line 322:
 
| Caste
 
| Caste
 
|  
 
|  
| Removes a type from a body part. Used with SET_BP_GROUP.  
+
| Removes a type from a body part. Used with {{token|SET_BP_GROUP|c}}.  
 
   
 
   
 
|-
 
|-
Line 326: Line 332:
 
|}
 
|}
  
<div align="center">
+
{{alphabetical TOC|style=margin: 1em auto;}}
{{alphabetical TOC}}
 
</div>
 
  
 
==C==
 
==C==
Line 349: Line 353:
 
| Caste
 
| 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.
+
| 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.
  
 
|-
 
|-
Line 355: Line 359:
 
| Caste
 
| Caste
 
|   
 
|   
| Can 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.
  
 
|-
 
|-
Line 361: Line 365:
 
| Caste
 
| Caste
 
|   
 
|   
| Creature cannot climb, even if it has free grasp parts.
+
| Creature cannot [[climber|climb]], even if it has free grasp parts.
  
 
|-
 
|-
Line 367: Line 371:
 
| Caste
 
| Caste
 
|   
 
|   
| Creature cannot jump.
+
| Creature cannot [[jump]].
  
 
|-
 
|-
Line 373: Line 377:
 
| Caste
 
| Caste
 
|   
 
|   
| Acts as NOT_LIVING, except that [OPPOSED_TO_LIFE] creatures will attack them.
+
| Acts like {{token|NOT_LIVING|c}}, except that {{token|OPPOSED_TO_LIFE|c}} creatures will attack them.
  
 
|-
 
|-
Line 379: Line 383:
 
| Caste
 
| Caste
 
|   
 
|   
| Allows the creature to open doors that are set to be unpassable for pets.  
+
| 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 385: Line 389:
 
| Caste
 
| Caste
 
|   
 
|   
| Creature ''only'' eats meat. If the creature goes on rampages in worldgen, it will often devour the people/animals it kills.  
+
| 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.
  
 
|-
 
|-
Line 399: Line 403:
 
|
 
|
 
*tile number or "letter"
 
*tile number or "letter"
| Caste-specific ALTTILE. Requires CASTE_TILE.
+
| Caste-specific {{token|ALTTILE|c}}. Requires {{token|CASTE_TILE|c}}.
  
 
|-
 
|-
Line 408: Line 412:
 
*bg
 
*bg
 
*brightness
 
*brightness
| Caste-specific COLOR.
+
| Caste-specific {{token|COLOR|c}}.
  
 
|-
 
|-
Line 417: Line 421:
 
*bg
 
*bg
 
*brightness
 
*brightness
| Caste-specific GLOWCOLOR.
+
| Caste-specific {{token|GLOWCOLOR|c}}.
  
 
|-
 
|-
Line 424: Line 428:
 
|
 
|
 
*tile value or "letter"
 
*tile value or "letter"
| Caste-specific GLOWTILE.
+
| Caste-specific {{token|GLOWTILE|c}}.
  
 
|-
 
|-
Line 433: Line 437:
 
*plural
 
*plural
 
*adjective  
 
*adjective  
| Caste-specific NAME.
+
| 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 442: Line 446:
 
*singular
 
*singular
 
*plural  
 
*plural  
| Caste-specific PROFESSION_NAME.
+
| Caste-specific {{token|PROFESSION_NAME|c}}.
  
 
|-
 
|-
Line 449: Line 453:
 
|  
 
|  
 
*'character' or tile number
 
*'character' or tile number
| Caste-specific SOLDIER_ALTTILE. Requires CASTE_SOLDIER_TILE.
+
| Caste-specific {{token|SOLDIER_ALTTILE|c}}. Requires {{token|CASTE_SOLDIER_TILE|c}}.
  
 
|-
 
|-
Line 456: Line 460:
 
|  
 
|  
 
*'character' or tile number
 
*'character' or tile number
| Caste-specific CREATURE_SOLDIER_TILE.
+
| Caste-specific {{token|CREATURE_SOLDIER_TILE|c}}.
 
 
|-
 
| {{text anchor|CASTE_SPEECH}}
 
| Caste
 
|
 
*speech file
 
| Caste-specific SPEECH.
 
  
 
|-
 
|-
Line 470: Line 467:
 
|
 
|
 
* tile number or "letter"
 
* tile number or "letter"
| Caste-specific CREATURE_TILE.
+
| Caste-specific {{token|CREATURE_TILE|c}}.
  
 
|-
 
|-
Line 483: Line 480:
 
|  
 
|  
 
*Varies
 
*Varies
| Specifies details for the preceding CAN_DO_INTERACTION token. See [[interaction token]].
+
| Specifies interaction details following a {{token|CAN_DO_INTERACTION|c}} token. See [[interaction token]].
  
 
|-
 
|-
Line 504: Line 501:
 
|  
 
|  
 
*integer  
 
*integer  
| Age at which creature is considered an adult. One can think of this as the duration of the child stage. If available to animal trainers, allows the creature's offspring to be rendered fully tame if trained during their childhood.  
+
| Age at which creature is considered an adult - one can think of this as the duration of the [[children|child]] stage. Allows the creature's offspring to be rendered fully tame if [[animal trainer|trained]] during their childhood.  
  
 
|-
 
|-
Line 512: Line 509:
 
*singular
 
*singular
 
*plural  
 
*plural  
| Defines a new name for a creature in child state at the caste level. For non-caste-specific child names, see GENERAL_CHILD_NAME.
+
| Defines a new name for a creature in the child state at the caste level. For non-caste-specific child names, see {{token|GENERAL_CHILD_NAME|c}}.
  
 
|-
 
|-
Line 520: Line 517:
 
*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 528: Line 525:
 
*min
 
*min
 
*max
 
*max
|Number of eggs laid in one sitting.
+
|Number of [[egg]]s laid in one sitting.
  
 
|-
 
|-
Line 549: Line 546:
 
| Caste
 
| Caste
 
|   
 
|   
| Any civilization with USE_COMMON_DOMESTIC tag (humans, dwarves) has domesticated this creature by default and always has access to it, even without any wild populations. Useless without PET, PACK_ANIMAL, WAGON_PULLER or MOUNT tags and invalid on FANCIFUL creatures.
+
| When combined with any of {{token|PET|c}}, {{token|PACK_ANIMAL|c}}, {{token|WAGON_PULLER|c}} and/or {{token|MOUNT|c}}, the creature is guaranteed to be domesticated by any [[civilization]] with {{token|COMMON_DOMESTIC_PET|e}}, {{token|COMMON_DOMESTIC_PACK|e}},  {{token|COMMON_DOMESTIC_PULL|e}} and/or {{token|COMMON_DOMESTIC_MOUNT|e}} respectively. Such civilizations will always have access to the creature, even in the absence of wild populations. This token is invalid on {{token|FANCIFUL|c}} creatures.
  
 
|-
 
|-
Line 555: Line 552:
 
| Caste
 
| Caste
 
|
 
|
| Creatures of this caste's species with the SPOUSE_CONVERTER and NIGHT_CREATURE_HUNTER tokens will kidnap SPOUSE_CONVERSION_TARGETs of an appropriate sex and convert them into castes with CONVERTED_SPOUSE.
+
| Creatures of this caste's species with the {{token|SPOUSE_CONVERTER|c}} and {{token|NIGHT_CREATURE_HUNTER|c}} tokens will kidnap {{token|SPOUSE_CONVERSION_TARGET|c}}s of an appropriate sex and convert them into castes with CONVERTED_SPOUSE.
  
 
|-
 
|-
Line 567: Line 564:
 
| Caste
 
| 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 {{DFtext|Berserk|4:1}} at the [[unit list]]. Berserk creatures go on rampages during [[world generation|worldgen]] much more frequently than non-berserk ones.
+
| Creature is '[[insanity|berserk]]' and will attack all other creatures, except members of its own species that '''also''' have the CRAZED tag. It will show {{DFtext|Berserk|4:1}} in the [[unit list]]. Berserk creatures go on rampages during [[world generation|worldgen]] much more frequently than non-berserk ones.
  
 
|-
 
|-
 
| {{text anchor|COPY_TAGS_FROM}}
 
| {{text anchor|COPY_TAGS_FROM}}
| Spec
+
| Special
 
|  
 
|  
*CREATURE NAME
+
*creature ID
| Copies Creature, 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 [[#APPLY_CREATURE_VARIATION]] 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 581: Line 585:
 
|
 
|
 
*classname
 
*classname
| An arbitrary creature classification. Can be set to anything, but only existing uses are GENERAL_POISON (used in syndromes), EDIBLE_GROUND_BUG (valid targets for GOBBLE_VERMIN_x tokens), and MAMMAL (self-explanatory). A single creature can have multiple classes. Eligibility for certain entity positions can also be permitted or restricted by this tag.
+
| 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 {{token|GOBBLE_VERMIN_CLASS|c}}), 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 tokens: {{token|GOBBLE_VERMIN_CLASS|c}}, {{token|GOBBLE_VERMIN_CLASS|c}}
 +
* Interaction tokens: {{token|IT_AFFECTED_CLASS|in}}, {{token|IT_IMMUNE_CLASS|in}}
 +
* Animal definition (Entity) tokens: {{token|ANIMAL_CLASS|e}}, {{token|ANIMAL_FORBIDDEN_CLASS|e}}
 +
* Position (Entity) token: {{token|ALLOWED_CLASS|po}}
 +
* Syndrome tokens: {{token|SYN_AFFECTED_CLASS|sy}}, {{token|SYN_IMMUNE_CLASS|sy}}, {{token|CE_SENSE_CREATURE_CLASS|sy}}
 
|-
 
|-
 
| {{text anchor|CREATURE_SOLDIER_TILE}}
 
| {{text anchor|CREATURE_SOLDIER_TILE}}
Line 588: Line 599:
 
|  
 
|  
 
*'character' or tile number
 
*'character' or tile number
| Creatures active in their civilization's military will use this tile instead.
+
| Creatures active in their civilization's [[military]] will use this tile instead.
  
 
|-
 
|-
Line 601: Line 612:
 
| Caste
 
| Caste
 
|   
 
|   
| Sets the creature to be active at twilight in Adventurer Mode.
+
| Sets the creature to be active at twilight in adventurer mode.
  
 
|-
 
|-
Line 619: Line 630:
 
| 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 636: Line 647:
 
|}
 
|}
  
<div align="center">
+
{{alphabetical TOC|style=margin: 1em auto;}}
{{alphabetical TOC}}
 
</div>
 
  
 
==D==
 
==D==
Line 652: Line 661:
 
| 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 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 659: Line 668:
 
|  
 
|  
 
*text  
 
*text  
| A brief description of the creature type.
+
| A brief description of the creature type, as displayed when viewing the creature's description/[[Thoughts and preferences|thoughts & preferences]] screen.
  
 
|-
 
|-
Line 665: Line 674:
 
| Caste
 
| Caste
 
|
 
|
| Dies upon attacking. Used by [[honey bee]]s to simulate them dying after using their stingers.
+
| Causes the creature to die upon attacking. Used by [[honey bee]]s to simulate them dying after using their stingers.
  
 
|-
 
|-
Line 672: Line 681:
 
|  
 
|  
 
*integer  
 
*integer  
| Increases experience gain during adventure mode. Creatures with 11 or higher are not assigned for quests in adventure mode.
+
| Increases experience gain during adventure mode. Creatures with a difficulty of 11 or higher are not assigned for quests in adventure mode.
  
 
|-
 
|-
Line 684: Line 693:
 
| Caste
 
| Caste
 
|  
 
|  
| The creature hunts vermin by diving from the air. On tame creatures it works the same as normal [[#HUNTS_VERMIN|HUNTS_VERMIN]]. Found on [[peregrine falcon]]s.
+
| The creature hunts vermin by diving from the air. On tame creatures, it has the same effect as {{token|HUNTS_VERMIN|c}}. Found on [[peregrine falcon]]s.
  
 
|-
 
|-
Line 690: Line 699:
 
| Creature
 
| Creature
 
|   
 
|   
| Creature does not physically exist. Adding this token to a creature causes it to not appear in generated worlds (if it isn't ALWAYS_PRESENT for a civ), i.e. adding it to [[dog]]s 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 {{token|FANCIFUL|c}}, the creature will be known to civilizations, allowing artists to depict them in engravings, statues and other such crafts. Used by [[centaur]]s, [[chimera]]s and [[griffon]]s in the vanilla game. Note as long as the creature has a body defined in its raws this does NOT preclude summoning (something tagged as DOES_NOT_EXIST can still be summoned) [http://www.bay12forums.com/smf/index.php?topic=165213.msg8086938#msg8086938]
+
| Adding this token to a creature prevents it from appearing in generated worlds (unless it's marked as [[Entity_token#ANIMAL_ALWAYS_PRESENT|always present]] for a particular civilisation). For example, adding it to [[dog]]s 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 {{token|FANCIFUL|c}}, artistic depictions of the creature will occur regardless. Used by [[centaur]]s, [[chimera]]s and [[griffon]]s in the vanilla game.  
 +
 
 +
Note: a creature tagged as DOES_NOT_EXIST can still be [[Interaction_token#I_EFFECT|summoned]] successfully, as long as it has a body defined in its raws. [http://www.bay12forums.com/smf/index.php?topic=165213.msg8086938#msg8086938]. It's also possible for another creature to [[Syndrome#CE_BODY_TRANSFORMATION|transform]] into it.
 
|}
 
|}
  
<div align="center">
+
{{alphabetical TOC|style=margin: 1em auto;}}
{{alphabetical TOC}}
 
</div>
 
  
 
==E==
 
==E==
Line 711: Line 720:
 
*[[item token]]
 
*[[item token]]
 
*[[material token]] (ANY_HARD_STONE can be used for the material)
 
*[[material token]] (ANY_HARD_STONE can be used for the material)
| Defines the item that the creature drops upon being butchered. Used with EXTRA_BUTCHER_OBJECT.
+
| Defines the item that the creature drops upon being [[butcher|butchered]]. Used with {{token|EXTRA_BUTCHER_OBJECT|c}}.
  
 
|-
 
|-
Line 718: Line 727:
 
|  
 
|  
 
*gem shape
 
*gem shape
| The shape of the extra item of the creature upon butchering. Used with EXTRA_BUTCHER_OBJECT.
+
| The shape of the creature's extra [[butcher|butchering]] drop. Used with {{token|EXTRA_BUTCHER_OBJECT|c}}.
  
 
|-
 
|-
Line 726: Line 735:
 
* <[[material token]]>
 
* <[[material token]]>
 
* <[[Material_definition_token#Material_States|material state]]>
 
* <[[Material_definition_token#Material_States|material state]]>
| Egg material. Egg-laying creatures will define this 3 times, using LOCAL_CREATURE_MAT:EGGSHELL, LOCAL_CREATURE_MAT:EGG_WHITE, and then LOCAL_CREATURE_MAT:EGG_YOLK. Eggs will be made out of eggshell. Edibility is determined by tags on whites or yolk, but they otherwise do not exist.
+
| Defines the material composition of [[egg]]s laid by the creature. [[creature_token#LAYS_EGGS|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.
  
 
|-
 
|-
Line 733: Line 742:
 
|
 
|
 
*size
 
*size
| Determines the size of 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.
+
| Determines the size of laid [[egg]]s. 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.
  
 
|-
 
|-
Line 739: Line 748:
 
| Creature
 
| Creature
 
|   
 
|   
| Makes the creature into a large 3x3 creature responsible for carrying trade goods, pulled by two [WAGON_PULLER]s and driven by a merchant.
+
| 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 751: Line 760:
 
| Creature
 
| Creature
 
|   
 
|   
| 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.
+
| The creature is considered evil and will only show up in evil biomes. Civilizations with {{token|USE_EVIL_ANIMALS|e}} 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.
  
 
|-
 
|-
Line 759: Line 768:
 
* BY_CATEGORY, BY_TYPE, BY_TOKEN
 
* BY_CATEGORY, BY_TYPE, BY_TOKEN
 
* TYPE, CATEGORY, or TOKEN
 
* TYPE, CATEGORY, or TOKEN
| The creature drops an additional object when butchered (typically a gizzard stone), defined by EBO_ITEM and EBO_SHAPE.
+
| The creature drops an additional object when [[butcher|butchered]], as defined by {{token|EBO_ITEM|c}} and {{token|EBO_SHAPE|c}}. Used for [[gizzard stone]]s in default creatures. For some materials, needs to be defined after caste definitions with SELECT_CASTE:ALL{{Bug|6355}}
  
 
|-
 
|-
Line 772: Line 781:
 
| Caste
 
| Caste
 
|   
 
|   
| Creature can see regardless of whether it has working eyes.  
+
| 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.
 
|}
 
|}
  
<div align="center">
+
{{alphabetical TOC|style=margin: 1em auto;}}
{{alphabetical TOC}}
 
</div>
 
  
 
==F==
 
==F==
Line 791: Line 798:
 
| Creature
 
| 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 [[Fanciful|number of creatures]]. Conflicts with {{token|COMMON_DOMESTIC|c}}
+
| 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 [[Fanciful|number of creatures]]. Conflicts with {{token|COMMON_DOMESTIC|c}}.
  
 
|-
 
|-
Line 797: Line 804:
 
| 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.
 +
 
 
|-
 
|-
 
| {{text anchor|FEATURE_BEAST}}
 
| {{text anchor|FEATURE_BEAST}}
 
| 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}}. Could not be specified in user-defined raws until 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.
  
 
|-
 
|-
Line 808: Line 818:
 
| Caste
 
| Caste
 
|   
 
|   
| The creature is female and can bear young. Usually determined inside a caste.
+
| Makes the creature biologically female, enabling her to [[Breeding|bear young]]. Usually specified inside a caste.
  
 
|-
 
|-
Line 814: Line 824:
 
| Caste
 
| Caste
 
|   
 
|   
| The creature is immune to FIREBALL and FIREJET attacks. 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. Allows the creature to path through high temperature zones, like lava or fires.
+
| Makes the creature immune to [[Interaction_token#FIREBALL|FIREBALL]] and [[Interaction_token#FIREJET|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 [[Material_definition_token|materials]] - see the [[Dragon/raw|dragon raws]] for an example).
  
 
|-
 
|-
Line 820: Line 830:
 
| Caste
 
| Caste
 
|   
 
|   
| The creature is immune to DRAGONFIRE attacks. Implies {{token|FIREIMMUNE|c}}.  
+
| Like {{token|FIREIMMUNE|c}}, but also renders the creature immune to [[Interaction_token#DRAGONFIRE|DRAGONFIRE]] attacks.  
  
 
|-
 
|-
Line 826: Line 836:
 
| Caste
 
| Caste
 
|   
 
|   
| The creature's corpse is a single food item that needs to be cleaned 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).  
+
| The creature's corpse is a single [[Item_token#FISH_RAW|FISH_RAW]] food item that needs to be cleaned (into a [[Item_token#FISH|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 {{token|COOKABLE_LIVE|c}}, 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.
+
Without this or {{token|COOKABLE_LIVE|c}}, [[fishing|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.
  
 
|-
 
|-
Line 834: Line 844:
 
|  
 
|  
 
*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 it implies]]. May trigger wildfires on 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 12000 and higher may cause pathfinding issues in fortress mode.
+
Note that temperatures of 12000 and higher may cause [[path|pathfinding]] issues in fortress mode.
  
 
|-
 
|-
Line 848: Line 858:
 
| Caste
 
| 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.
+
| 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 [[Body_token#FLIER|FLIER]] token).
  
 
|-
 
|-
Line 855: Line 865:
 
|
 
|
 
*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}}.
 
|}
 
|}
  
<div align="center">
+
{{alphabetical TOC|style=margin: 1em auto;}}
{{alphabetical TOC}}
 
</div>
 
  
 
==G==
 
==G==
Line 874: Line 884:
 
| Caste
 
| Caste
 
|  
 
|  
* type (WALK, CLIMB, SWIM, CRAWL, or FLY)
+
* <gait type>
* gait name
+
* <gait name>
* full speed
+
* <max [[Gait#Speed|speed]]>
* build up time
+
* <build up time>
* max turning speed
+
* <max turning [[Gait#Speed|speed]]>
* start speed (or NO_BUILD_UP for instant use)
+
* <start [[Gait#Speed|speed]]>
* energy use
+
* <energy expenditure>
* Optional flags:
+
* <gait flag(s)>
** LAYERS_SLOW - if gait is slowed by increased weight
+
| 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]].
** STRENGTH - if gait is affected by Strength stat
+
 
** AGILITY - if gait is affected by Agility stat
+
* <max speed> indicates the maximum [[Gait#Speed|speed]] achievable by a creature using this gait
** STEALTH_SLOWS
+
* <start speed> indicates the creature's speed when it starts moving using this gait
*penalty - if gait is slowed by being stealthed
+
* <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 [[tile]]s in a straight line over even terrain.
| Defines a gait at which the creature can move. See [[Gait]] for more information.
+
* <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 [[Status_icon#Non-flashing|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.
  
|-
 
| {{text anchor|GENERAL_BABY_NAME}}
 
| Creature
 
|
 
*singular
 
*plural
 
| BABYNAME applied regardless of caste.
 
  
|-
+
'''valid gait types:'''
| {{text anchor|GENERAL_CHILD_NAME}}
+
*'''WALK'''<br>
 +
Used for moving normally over ground tiles.
 +
 
 +
*'''CRAWL'''<br>
 +
Used for moving over ground tiles whilst [[Status_icon#Non-flashing|prone]].
 +
 
 +
*'''SWIM'''<br>
 +
Used for moving through tiles containing [[water]] or [[magma]] at a [[Water#Depth|depth]] of at least 4/7.
 +
 
 +
*'''FLY'''<br>
 +
Used for moving through [[open space]].
 +
 
 +
*'''CLIMB'''<br>
 +
Used for moving whilst [[Climber|climbing]].
 +
 
 +
 
 +
'''valid gait flags:'''
 +
* '''AGILITY'''<br>
 +
Speeds/slows movement depending on the creature's [[Attribute#Agility|Agility]] stat.
 +
 
 +
* '''STRENGTH'''<br>
 +
Speeds/slows movement depending on the creature's [[Attribute#Strength|Strength]] stat.
 +
 
 +
* '''LAYERS_SLOW'''<br>
 +
Makes [[Tissue_definition_token#THICKENS_ON_ENERGY_STORAGE|THICKENS_ON_ENERGY_STORAGE]] and [[Tissue_definition_token#THICKENS_ON_STRENGTH|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><br>
 +
Slows movement by the specified percentage when the creature is [[Ambusher|sneaking]].
 +
 
 +
|-
 +
| {{text anchor|GENERAL_BABY_NAME}}
 +
| Creature
 +
|
 +
*singular
 +
*plural
 +
| Like {{token|BABYNAME|c}}, but applied regardless of caste.
 +
 
 +
|-
 +
| {{text anchor|GENERAL_CHILD_NAME}}
 
| Creature
 
| Creature
 
|  
 
|  
 
*singular
 
*singular
 
*plural  
 
*plural  
| CHILDNAME applied regardless of caste.
+
| Like {{token|CHILDNAME|c}}, but applied regardless of caste.
  
 
|-
 
|-
Line 911: Line 957:
 
*value A
 
*value A
 
*value B
 
*value B
| Has the same function as [[Creature_token#MATERIAL_FORCE_MULTIPLIER|MATERIAL_FORCE_MULTIPLIER]], but applies to all attacks instead of just those involving a specific material. Appears to be overridden by MATERIAL_FORCE_MULTIPLIER ([[werebeast]]s, for example, use both tokens to provide resistance to all materials, with one exception to which they are especially vulnerable).
+
| Has the same function as {{token|MATERIAL_FORCE_MULTIPLIER|c}}, but applies to all attacks instead of just those involving a specific material. Appears to be overridden by MATERIAL_FORCE_MULTIPLIER ([[werebeast]]s, for example, use both tokens to provide resistance to all materials, with one exception to which they are especially vulnerable).
  
 
|-
 
|-
Line 917: Line 963:
 
| Creature
 
| Creature
 
|   
 
|   
| Found on procedurally generated creatures like [[Forgotten beast]]s, (biome name) [[titan]]s, [[Demon]]s, and [[night creature]]s. Cannot be specified in user-defined raws.
+
| Found on procedurally generated creatures like [[forgotten beast]]s, [[titan]]s, [[demon]]s, [[angel]]s, and [[night creature]]s. Cannot be specified in user-defined raws.
  
 
|-
 
|-
Line 923: Line 969:
 
| Caste
 
| Caste
 
|   
 
|   
| Creature can get infections from necrotic tissue.
+
| Makes the creature get [[Health_care#Infection|infections]] from necrotic tissue.
  
 
|-
 
|-
Line 929: Line 975:
 
| Caste
 
| Caste
 
|   
 
|   
| This creature's wounds can become infected if left untreated for too long.
+
| Makes the creature's wounds become [[Health_care#Infection|infected]] if left untreated for too long.
  
 
|-
 
|-
Line 938: Line 984:
 
*background
 
*background
 
*brightness  
 
*brightness  
| The colour of the creature's GLOWTILE.
+
| The colour of the creature's {{token|GLOWTILE|c}}.
  
 
|-
 
|-
Line 945: Line 991:
 
|  
 
|  
 
*ascii character  
 
*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.
+
| 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 {{token|CASTE_GLOWTILE|c}} instead.
  
 
|-
 
|-
Line 967: Line 1,013:
 
*creature
 
*creature
 
*caste
 
*caste
| The creature eats a specified vermin.
+
| The creature eats a specified [[vermin]].
  
 
|-
 
|-
Line 985: Line 1,031:
 
| 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 991: Line 1,037:
 
| Creature
 
| Creature
 
|   
 
|   
| Creature is considered good and will only show up in good biomes - [[unicorn]]s, 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.
+
| Creature is considered good and will only show up in good biomes - [[unicorn]]s, for example. Civilizations with {{token|USE_GOOD_ANIMALS|e}} 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.
  
 
|-
 
|-
Line 998: Line 1,044:
 
|  
 
|  
 
*value  
 
*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.
+
| 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.
  
 
|-
 
|-
Line 1,012: Line 1,058:
 
|
 
|
 
*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}}.
 
|}
 
|}
  
<div align="center">
+
{{alphabetical TOC|style=margin: 1em auto;}}
{{alphabetical TOC}}
 
</div>
 
  
 
==H==
 
==H==
Line 1,033: Line 1,077:
 
*type
 
*type
 
*probability
 
*probability
| Defines certain behaviors for the creature. The habit types are COLLECT_TROPHIES, COOK_PEOPLE, COOK_VERMIN, GRIND_VERMIN, COOK_BLOOD, GRIND_BONE_MEAL, EAT_BONE_PORRIDGE, USE_ANY_MELEE_WEAPON, GIANT_NEST, and COLLECT_WEALTH. These require the creature to have a lair to work properly, and also don't seem to work on creatures who are not (SEMI)MEGABEASTs or NIGHT_CREATURE_HUNTERs.
+
| 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 {{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,053: Line 1,108:
 
|   
 
|   
 
| 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 to which the angel is associated.
 
  
 
|-
 
|-
Line 1,081: Line 1,129:
 
| 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.
  
 
|}
 
|}
  
<div align="center">
+
{{alphabetical TOC|style=margin: 1em auto;}}
{{alphabetical TOC}}
 
</div>
 
  
 
==I==
 
==I==
Line 1,101: Line 1,147:
 
| 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,107: Line 1,153:
 
| Caste
 
| Caste
 
|   
 
|   
| The creature is immobile while on land. Only works on AQUATIC creatures which can't breathe on land.
+
| The creature is immobile while on land. Only works on {{token|AQUATIC|c}} creatures which can't breathe on land.
  
 
|-
 
|-
Line 1,113: Line 1,159:
 
| 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,119: Line 1,165:
 
| Caste
 
| Caste
 
|   
 
|   
| Alias for [CAN_SPEAK] + [CAN_LEARN] but additionally keeps creatures from being butchered by the AI during worldgen and post-gen. In fortress mode, CAN_LEARN is enough.
+
| Alias for {{token|CAN_SPEAK|c}} + {{token|CAN_LEARN|c}}.
  
 
|-
 
|-
Line 1,127: Line 1,173:
 
* [[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,137: Line 1,183:
 
|}
 
|}
  
<div align="center">
+
{{alphabetical TOC|style=margin: 1em auto;}}
{{alphabetical TOC}}
 
</div>
 
  
 
==L==
 
==L==
Line 1,155: Line 1,199:
 
*type
 
*type
 
*probability
 
*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, and LABYRINTH.
+
| 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
  
 
|-
 
|-
Line 1,182: Line 1,231:
 
| Caste
 
| Caste