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
(Undo revision 266155 by Ziusudra (talk) I'm tired and did the wrong grep)
Tag: Undo
 
(147 intermediate revisions by 45 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 caste respectively, or 'CASTE' which can be applied to both. In the table bellow, creature type distinguishes tokens that can be applied to creature only, caste 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. 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".
+
| Prevents the 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.{{verify|code}}
+
| 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 47: Line 51:
 
| Caste
 
| Caste
 
|   
 
|   
−
| 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}}
+
| Makes the creature start out hidden and remain near its original location until its prey draws near. When combined with {{token|WEBBER|c}}, causes them to lay gigantic webs near their spawn location, though only for creatures present during embark.
  
 
|-
 
|-
Line 57: Line 61:
 
|-
 
|-
 
| {{text anchor|APP_MOD_DESC_RANGE}}
 
| {{text anchor|APP_MOD_DESC_RANGE}}
−
| Caste
+
| Appearance Modifier
 
|
 
|
 
*Range (6 values, low to high)
 
*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 288: Line 296:
 
| Caste
 
| Caste
 
|   
 
|   
−
| Creature eats bones. Implies {{token|CARNIVORE|c}}. [[Adventurer mode|Adventurers]] with this token are currently unable to eat bones.{{Bug|11069}}
+
| Creature eats bones. Implies {{token|CARNIVORE|c}}. Currently does not work due to a bug ({{Bug|11069}}).
  
 
|-
 
|-
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 value|values]] and [[Personality goal|goals]].
  
 
|-
 
|-
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 but to make friends in fortress mode. A creature with at least this token or the {{token|CAN_LEARN|c}} token will be able to have [[Personality value|values]] and [[Personality goal|goals]].
  
 
|-
 
|-
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.
+
| Defunct, as doors cannot be set as tightly closed anymore.
  
 
|-
 
|-
Line 381: 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. Does not seem to affect the diet of the adventurer in adventure mode.
+
| Creature ''only'' eats [[meat]]. If the creature goes on rampages in worldgen, it will often devour the people/animals it kills.
  
 
|-
 
|-
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 the creature to develop [[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 482:
 
|  
 
|  
 
*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 519:
 
*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 539: Line 542:
 
*background
 
*background
 
*brightness  
 
*brightness  
−
| Color of the creature's tile. See [[Color]] for usage.
+
| Color of the creature's tile. (See [[Color]] for usage.)
  
 
|-
 
|-
Line 557: Line 560:
 
| Caste
 
| 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 [[mussel]]s, [[nautilus]]es and [[oyster]]s.
+
| Set this to allow the creature to be cooked in meals while it is still alive, as well as when it's dead but not yet [[fishery|cleaned]]. Used by some water-dwelling vermin such as [[mussel]]s, [[nautilus]]es and [[oyster]]s. Currently does not work correctly when applied to non-{{token|FISHITEM|c}} vermin.{{bug|13200}}
  
 
|-
 
|-
Line 567: Line 570:
 
|-
 
|-
 
| {{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 614:
 
| 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 632:
 
| 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 663:
 
| 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.
 +
 
 +
At least 1 demon generated, or custom must have the {{token|FLIER|c}} token in order for the [[Underworld|horrifying screams]] event to trigger.
  
 
|-
 
|-
Line 679: Line 691:
 
| 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 693: Line 705:
 
| 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.  
 
| 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.
+
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], or, another creature can [[Syndrome#CE_BODY_TRANSFORMATION|transform]] into it.
 
|}
 
|}
  
Line 740: Line 752:
 
| 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 752: Line 764:
 
| Creature
 
| Creature
 
|   
 
|   
−
| 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.
+
| 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 colonize evil areas.
 +
 
 +
Civilizations which list evil creatures as one of their main population options will potentially emerge following an underworld mining disaster, with the added caveat that a demon will be in charge of the civ. The rules which govern which noble position the demon in charge adopts however, are unclear. It either picks one of the predefined positions, or simply makes its own.  
  
 
|-
 
|-
Line 758: Line 772:
 
| Caste
 
| Caste
 
|  
 
|  
−
* BY_CATEGORY, BY_TYPE, BY_TOKEN
+
* [[Body token#CATEGORY|BY_CATEGORY]] or [[Body token#CONTYPE|BY_TYPE]] or [[Body token#BP|BY_TOKEN]]
 
* TYPE, CATEGORY, or TOKEN
 
* TYPE, CATEGORY, or TOKEN
 
| 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}}
 
| 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 773: Line 787:
 
| 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 810:
 
| 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 816:
 
| 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}}. Displays the creature's {{token|DESCRIPTION|c}} in its [[legends mode]] entry and 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 850:
 
|  
 
|  
 
*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 851: Line 865:
 
|   
 
|   
 
| 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).
 
| 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).
 +
 +
At least 1 [[Demon]] must have the flier token in order for the [[Underworld|horrifying screams]] event to trigger.
  
 
|-
 
|-
Line 857: Line 873:
 
|
 
|
 
*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}}.
+
| The {{token|FREQUENCY|c}} value plays two separate roles. The first is in determining the initial distribution of creatures across the world map. Each creature is randomly assigned a single x, y co-ordinate on the world map, which act as the epicenter for that creature's distribution. A square is drawn around that x, y co-ordinate with a Manhattan radius equal to the {{token|FREQUENCY|c}} value divided by 100 times the world map size. For example, in a 256 by 256 size world map, the [[lion]] might be assigned 14, 112. The [[lion]] has {{token|FREQUENCY:5|c}}, and so a square is drawn by moving 13 tiles in each direction from the [[lion]]'s x, y co-ordinate. This is the [[lion]]'s "territory".
 +
 
 +
Each sub-region in the world will attempt to fill lists of wildlife. There are five lists - {{token|VERMIN_GROUNDER|c}}, {{token|VERMIN_SOIL|c}}, {{token|VERMIN_SOIL_COLONY|c}}, {{token|LARGE_ROAMING|c}}, and {{token|LARGE_PREDATOR|c}}, corresponding with the relevant tokens. The game will attempt to place seven creatures in each list for each sub-region. The game will select the seven nearest valid creatures. Creatures are valid for sub-region's list if they have the requisite token for that list, if they have the valid token for that sub-region's biome (for example, the [lion] can only be selected for {{token|BIOME:SAVANNA_TROPICAL|c}}, {{token|BIOME:GRASSLAND_TROPICAL|c}}, and {{token|BIOME:SHRUBLAND_TROPICAL|c}}, and if their "territory" as defined by their random epicenter and {{token|FREQUENCY|c}} radius overlaps with that sub-region. These lists then determine the creatures that can actually appear within that sub-region during gameplay.
 +
 
 +
There are some exceptions to the above. If the game was not capable of filling all seven entries in a list, it will drop the overlapping territory requirement, and simply pull the nearest creature which has the correct token and biome availability. Conversely, if a creature has an epicenter but has not appeared on any of the list for any of the world map's sub-regions, the creature will be assigned to the relevant list for the nearest appropriate sub-region - meaning it is occasionally possible to have lists of eight creatures or more. This is more common in smaller worlds where there are less possible sub-regions to be assigned towards. Creatures with the {{token|GOOD|c}} and {{token|EVIL|c}} tokens ignore the epicenter distribution system altogether. They are always capable of appearing in appropriate biomes which are {{token|GOOD|b}} or {{token|EVIL|b}} respectively. This is not true for {{token|SAVAGE|c}}, which acts more like the biome tokens. Creatures with {{token|UBIQUITOUS|c}} have a "territory" which covers the entire map, regardless of their epicenter (although they can still fail to be chosen if there are 7 creatures which are eligible and have nearer epicenters to the sub-region in question).
 +
 
 +
The second use for {{token|FREQUENCY|c}} is to determine how often a creature actually appears on map. In Fortress Mode, the game will try and spawn large wildlife (creatures with {{token|LARGE_ROAMING|c}} or {{token|LARGE_PREDATOR|c}} in fairly regular waves. These waves include {{token|LARGE_ROAMING|c}}, {{token|LARGE_ROAMING|c}} combined with {{token|FLIER|c}}, {{token|LARGE_PREDATOR|c}}, and {{token|CURIOUS_BEAST|c}} - so a [[lion]] does not compete for selection with a [[gazelle]]. When the game decides it needs to spawn in a fresh wave of e.g. {{token|LARGE_ROAMING|c}} creatures, it will select one of the creatures available to it from the lists for that sub-region at random, with all creatures weighted equally. Once it has selected a creature, it then effectively rolls a d100 against the relevant creature's {{token|FREQUENCY|c}}. If the d100 is equal to the creature's {{token|FREQUENCY|c}} or less, that creature is then spawned in. If the d100 is above the creature's {{token|FREQUENCY|c}}, the game returns to the relevant list and selects again. {{token|UBIQUITOUS|c}} acts as {{token|FREQUENCY:100|c}} for these purposes - in other words, the creature cannot fail the d100 check and will always be spawned in if it is selected from the list.
 +
 
 
|}
 
|}
  
Line 882: Line 905:
 
* <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,044:
 
| 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,078: Line 1,101:
 
*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,091: Line 1,114:
 
| Caste
 
| Caste
 
|   
 
|   
−
| The creature has nerves in its muscles. Cutting the muscle tissue can sever motor and sensory nerves.
+
| The creature has nerves in its muscles. Cutting the muscle tissue can sever motor and sensory nerves, disabling the limb.
  
 
|-
 
|-
Line 1,098: Line 1,121:
 
|   
 
|   
 
| 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,142:
 
| 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,160:
 
| 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,172:
 
| 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 any flammable materials (specifically ones that could be ignited by magma).
+
| 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,178:
 
| 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,228: Line 1,244:
 
| 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. Tamed large predators will still attack wildlife. 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,255:
 
| 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,283:
 
| 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.
 +
 
 +
Subterranean vermin which feature this token will flicker in unexposed and unrevealed cavern layers while playing in Fortress Mode.
  
 
|-
 
|-
Line 1,284: Line 1,305:
 
* 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,314:
  
 
|-
 
|-
−
| {{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,379:
 
|
 
|
 
*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,394:
 
| 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,409:
 
| 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,494:
 
| 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,500:
 
| 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,526:
 
*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,553:
 
*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]]. 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. 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 creature behavior enabled by {{token|LARGE_PREDATOR|c}}
 +
 +
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,579:
  
 
|-
 
|-
−
| {{text anchor|NIGHT_CREATURE_EXPERIMENTER}}{{version|0.47.01}}
+
| {{text anchor|NIGHT_CREATURE_EXPERIMENTER}}
 
| Caste
 
| Caste
 
|
 
|
Line 1,550: Line 1,595:
  
 
|-
 
|-
−
| {{text anchor|NIGHT_CREATURE_NIGHTMARE}}{{version|0.47.01}}
+
| {{text anchor|NIGHT_CREATURE_NIGHTMARE}}
 
| Caste
 
| Caste
 
|
 
|
Line 1,583: Line 1,628:
 
| Caste
 
| Caste
 
|   
 
|   
−
| Creature does not need to [[food|eat]]. Seems to cause worldgen crashes if it is part of an entity with [[entity_token#PERMITTED_JOB|[PERMITTED_JOB:FISHERMAN]]]{{verify}}
+
| Creature does not need to [[food|eat]].
  
 
|-
 
|-
Line 1,595: Line 1,640:
 
| 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,658:
 
| 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,631: Line 1,676:
 
| Caste
 
| Caste
 
|   
 
|   
−
| Creature doesn't require an organ with the {{token|THOUGHT|body}} tag to survive or attack; generally used on creatures that don't have brains.
+
| The bodyparts of this creature don't need to be connected to an organ with the {{token|THOUGHT|body}} tag in order to have motor function. Generally used on creatures that don't have brains. If a creature doesn't have a thought part and doesn't have this token, it will be unable to grasp or stand. Nautilus men experience this issue in vanilla.
  
 
|-
 
|-
Line 1,661: Line 1,706:
 
| Caste
 
| Caste
 
|   
 
|   
−
| Creature doesn't need to breathe or have {{token|BREATHE|body}} parts in body, nor can it drown or be strangled. Creatures living in magma must have this tag, otherwise they will drown.
+
| Creature doesn't need to breathe or have {{token|BREATHE|body}}parts in its body, nor can it drown or be strangled. Creatures living in magma must have this tag, otherwise they will drown.
  
 
|-
 
|-
Line 1,667: Line 1,712:
 
| 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,673: Line 1,718:
 
| Caste
 
| Caste
 
|   
 
|   
−
| Creature has no emotions. It is immune to the effects of [[stress]] and unable to rage, and its [[need]]s cannot be fulfilled in any way. Used on [[undead]] in the vanilla game.
+
| Creature has no emotions, thus; it is immune to the effects of [[stress]] and unable to rage, and its [[need]]s cannot be fulfilled in any way. Used on [[undead]] in the vanilla game.
  
 
|-
 
|-
Line 1,679: Line 1,724:
 
| 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,736:
 
| 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,784:
 
| 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,790: Line 1,835:
 
*MALE/FEMALE
 
*MALE/FEMALE
 
*disinterested chance
 
*disinterested chance
−
*lover-possible chance
+
*casual chance
−
*commitment-possible chance
+
*strong c