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"
Jump to navigation
Jump to search
(→P: added default for PETVALUE based on embark cost, geese and ducks cost 6) |
(in this edit, ive added important new information to the HUNTS_VERMIN creature token) |
||
| (74 intermediate revisions by 24 users not shown) | |||
| Line 1: | Line 1: | ||
| − | {{Quality|Exceptional | + | {{Quality|Exceptional}} |
{{av}} | {{av}} | ||
{{Modding}} | {{Modding}} | ||
| − | The <code>[OBJECT:CREATURE]</code> [[token]] | + | 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. |
| − | + | Vanilla creature definitions can be found in <code>[[Game folder|<Dwarf Fortress>]]\data\vanilla\vanilla_creatures\</code>. | |
| + | Creature ID is also used with [[graphics token]]s to make customizable [[graphics set]]s. | ||
| + | The [[caste]] tokens allow defining sub-species within the broader creature definition, including true biological castes and lesser variations, such as sexes. Creature tokens can either be 'Creature' or 'CASTE-only' type which can only be applied to creature or cast respectively, or 'CASTE' which can be applied to both. In the table bellow, creature type distinguish tokens that can be applied to creature only, cast only and both ('creature', 'CASTE-only', and 'CASTE' respectively) | ||
| + | |||
| + | __NOTOC__ | ||
{{clear}} | {{clear}} | ||
{{alphabetical TOC|style=margin: 1em auto;}} | {{alphabetical TOC|style=margin: 1em auto;}} | ||
| Line 57: | Line 61: | ||
|- | |- | ||
| {{text anchor|APP_MOD_DESC_RANGE}} | | {{text anchor|APP_MOD_DESC_RANGE}} | ||
| − | | | + | | Appearance Modifier |
| | | | ||
*Range (6 values, low to high) | *Range (6 values, low to high) | ||
| − | | [http://www.bay12forums.com/smf/index.php?topic= | + | | 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. | ||
|- | |- | ||
| {{text anchor|APP_MOD_GENETIC_MODEL}} | | {{text anchor|APP_MOD_GENETIC_MODEL}} | ||
| − | | | + | | 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}} | ||
| − | | | + | | Appearance Modifier |
| | | | ||
*number | *number | ||
| Line 78: | Line 84: | ||
|- | |- | ||
| {{text anchor|APP_MOD_NOUN}} | | {{text anchor|APP_MOD_NOUN}} | ||
| − | | | + | | Appearance Modifier |
| | | | ||
*noun | *noun | ||
| Line 86: | Line 92: | ||
|- | |- | ||
| {{text anchor|APP_MOD_RATE}} | | {{text anchor|APP_MOD_RATE}} | ||
| − | | | + | | Appearance Modifier |
| | | | ||
*Rate (integer) | *Rate (integer) | ||
| Line 141: | Line 147: | ||
| | | | ||
*token | *token | ||
| − | + | *selection criteria (it's complicated) | |
| − | *selection criteria | ||
| − | |||
| 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 | + | | 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 230: | Line 234: | ||
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 | + | 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 375: | Line 381: | ||
| Caste | | Caste | ||
| | | | ||
| − | | Allows the creature to open [[door]]s that are set to be unpassable for pets. In adventure mode, creatures lacking this token will be unable to pass through door tiles except whilst these are occupied by other creatures. | + | | Allows the creature to open [[door]]s that are set to be unpassable for pets. In adventure mode, creatures lacking this token will be unable to pass through door tiles except whilst these are occupied by other creatures. Not currently useful in Fortress mode as doors can no longer be set unpassable for pets.{{version|50.03}} |
|- | |- | ||
| Line 429: | Line 435: | ||
*plural | *plural | ||
*adjective | *adjective | ||
| − | | | + | | 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 459: | ||
*'character' or tile number | *'character' or tile number | ||
| Caste-specific {{token|CREATURE_SOLDIER_TILE|c}}. | | Caste-specific {{token|CREATURE_SOLDIER_TILE|c}}. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| Line 479: | Line 478: | ||
| | | | ||
*Varies | *Varies | ||
| − | | Specifies details | + | | Specifies interaction details following a {{token|CAN_DO_INTERACTION|c}} token. See [[interaction token]]. |
|- | |- | ||
| Line 516: | Line 515: | ||
*min | *min | ||
*max | *max | ||
| − | | The minimum/maximum numbers of how many creatures per spawned cluster. | + | | The minimum/maximum numbers of how many creatures per spawned cluster. Vermin fish with this token in combination with temperate ocean and river biome tokens [http://www.bay12forums.com/smf/index.php?topic=51864.msg1122319#msg1122319 will perform seasonal migrations]. Defaults to 1:1 if not specified. |
|- | |- | ||
| Line 567: | Line 566: | ||
|- | |- | ||
| {{text anchor|COPY_TAGS_FROM}} | | {{text anchor|COPY_TAGS_FROM}} | ||
| − | | | + | | Special |
| | | | ||
| − | * | + | *creature ID |
| − | | Copies | + | | 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 622: | Line 628: | ||
| 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 659: | ||
| 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}} | + | | 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 773: | Line 779: | ||
| 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 802: | ||
| 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 808: | ||
| 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 | + | | Found on [[forgotten beast]]s. Presumably makes it act as such, initiating underground attacks on fortresses, or leads to the pop-up message upon encountering one{{verify}}. Hides the creature from displaying in a world_sites_and_pops file. Does not create historical figures like generated forgotten beasts do. |
Requires specifying a {{token|BIOME|c}} in which the creature will live, and both surface and subterranean biomes are allowed. Does not stack with {{token|LARGE_ROAMING|c}} and if both are used the creature will not spawn. Appears to be incompatible with {{token|DEMON|c}} even if used in separate castes. | Requires specifying a {{token|BIOME|c}} in which the creature will live, and both surface and subterranean biomes are allowed. Does not stack with {{token|LARGE_ROAMING|c}} and if both are used the creature will not spawn. Appears to be incompatible with {{token|DEMON|c}} even if used in separate castes. | ||
| Line 836: | Line 842: | ||
| | | | ||
*temperature | *temperature | ||
| − | | The creature's body is constantly at this temperature, heating up or cooling the surrounding area. Alters the temperature of the creature's inventory and all adjacent tiles, [[Temperature|with all the effects that this implies]] - may trigger wildfires at high enough values. Also makes the creature immune to extreme heat or cold, as long as the temperature set is not harmful to the materials that the creature is made from. | + | | The creature's body is constantly at this temperature, heating up or cooling the surrounding area. Alters the temperature of the creature's inventory and all adjacent tiles, [[Temperature|with all the effects that this implies]] - may trigger wildfires at high enough values. Also makes the creature immune to extreme heat or cold, as long as the temperature set is not harmful to the materials that the creature is made from. Corpses and body parts of creatures with a fixed temperature maintain their temperature even after death. |
Note that temperatures of 12000 and higher may cause [[path|pathfinding]] issues in fortress mode. | Note that temperatures of 12000 and higher may cause [[path|pathfinding]] issues in fortress mode. | ||
| Line 857: | Line 863: | ||
| | | | ||
*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. | + | | Determines the chances of a creature appearing within its environment, with higher values resulting in more frequent appearance. Also affects the chance of a creature being brought in a caravan for trading. |
| + | This value is used multiply to determine the rarity of animal populations. A creature with [FREQUENCY:50] will appear in 50% of valid biomes, and be present in 50% of the area within those biomes. | ||
| + | When a [[Creature token#CLUSTER_NUMBER|cluster]] spawns, the game effectively considers all creatures that can possibly appear and uses the FREQUENCY value as a ''weight'' - for example, if there are three creatures with frequencies 10/25/50, the creature with [FREQUENCY:50] will appear approximately 58.8% of the time. Defaults to 50 if not specified. Not to be confused with {{token|POP_RATIO|c}}. | ||
|} | |} | ||
| Line 882: | Line 890: | ||
* <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,029: | ||
| Special | | Special | ||
| | | | ||
| − | | When using tags from an existing creature, inserts new tags | + | | When using tags from an existing creature, inserts new tags ''before'' the specified tag. |
|- | |- | ||
| Line 1,078: | Line 1,086: | ||
*GIANT_NEST | *GIANT_NEST | ||
*COLLECT_WEALTH. | *COLLECT_WEALTH. | ||
| − | These require the creature to have a {{token|LAIR|c}} to work properly, and also don't seem to work on creatures who are not a {{token|SEMIMEGABEAST|c}}, {{token|MEGABEAST|c}} or {{token|NIGHT_CREATURE_HUNTER|c}}. | + | These require the creature to have a {{token|LAIR|c}} to work properly, and also don't seem to work on creatures who are not a {{token|SEMIMEGABEAST|c}}, {{token|MEGABEAST|c}}, or{{token|NIGHT_CREATURE_HUNTER|c}}. |
|- | |- | ||
| Line 1,098: | Line 1,106: | ||
| | | | ||
| 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. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| Line 1,126: | Line 1,127: | ||
| 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,156: | Line 1,157: | ||
| Caste | | Caste | ||
| | | | ||
| − | | The creature radiates [[fire]]. It will ignite, and potentially completely destroy, items the creature is standing on | + | | 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,163: | ||
| Caste | | Caste | ||
| | | | ||
| − | | Alias for {{token|CAN_SPEAK|c}} + {{token|CAN_LEARN|c}} | + | | Alias for {{token|CAN_SPEAK|c}} + {{token|CAN_LEARN|c}}. |
|- | |- | ||
| Line 1,228: | Line 1,229: | ||
| Caste | | Caste | ||
| | | | ||
| − | | Will attack | + | | Will attack other creatures that are smaller than it. In [[fortress mode]], only one group of "large predators" (possibly two groups on "savage" maps) will appear on any given map. In [[adventurer mode]], large predators will try to ambush and attack you (and your party will attack them back). When tamed, large predators tend to be much more aggressive to enemies than non-large predators, making them a good choice for an animal army. They may go on rampages in worldgen, and adventurers may receive quests to kill them. Also, they can be mentioned in the intro paragraph when starting a fortress e.g. "ere the wolves get hungry." |
| + | A single biome supports 7 large predator species, picking randomly and rolling a d100 under its {{token|FREQUENCY|c}} to add it until all 7 slots are filled. | ||
|- | |- | ||
| Line 1,236: | Line 1,238: | ||
| 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 | + | 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,284: | Line 1,286: | ||
* 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 | + | | {{text anchor|LOCAL_POPS_CONTROLLABLE}} |
| Creature | | Creature | ||
| | | | ||
| Line 1,293: | Line 1,295: | ||
|- | |- | ||
| − | | {{text anchor|LOCAL_POPS_PRODUCE_HEROES | + | | {{text anchor|LOCAL_POPS_PRODUCE_HEROES}} |
| | | | ||
| | | | ||
| Line 1,358: | Line 1,360: | ||
| | | | ||
*material id | *material id | ||
| − | | Begins defining a new material. | + | | Begins defining a new local material. Follow this with standard material definition tokens to define the material. |
|- | |- | ||
| Line 1,388: | Line 1,390: | ||
| 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,479: | Line 1,481: | ||
| Caste | | Caste | ||
| | | | ||
| − | | Makes the species usually produce a single offspring per birth, | + | | 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,507: | ||
*plural | *plural | ||
*adjective | *adjective | ||
| − | | The generic name for any creature of this type - will be used | + | | 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,534: | Line 1,542: | ||
|- | |- | ||
| − | | {{text anchor|NIGHT_CREATURE_EXPERIMENTER | + | | {{text anchor|NIGHT_CREATURE_EXPERIMENTER}} |
| Caste | | Caste | ||
| | | | ||
| Line 1,550: | Line 1,558: | ||
|- | |- | ||
| − | | {{text anchor|NIGHT_CREATURE_NIGHTMARE | + | | {{text anchor|NIGHT_CREATURE_NIGHTMARE}} |
| Caste | | Caste | ||
| | | | ||
| Line 1,691: | Line 1,699: | ||
| Caste | | Caste | ||
| | | | ||
| − | | Creature will not | + | | Creature will not be hunted or fed to wild beasts. |
|- | |- | ||
| Line 1,790: | Line 1,798: | ||
*MALE/FEMALE | *MALE/FEMALE | ||
*disinterested chance | *disinterested chance | ||
| − | * | + | *casual chance |
| − | * | + | *strong chance |
| − | | Determines caste's likelihood of having sexual attraction to certain sexes. Values default to 75:20:5 for the same sex and 5:20:75 for the opposite sex. The first value indicates how likely to be entirely uninterested in the sex, the second decides if the creature will become lovers | + | | Determines caste's likelihood of having sexual attraction to certain sexes. Values default to 75:20:5 for the same sex and 5:20:75 for the opposite sex. The first value indicates how likely to be entirely uninterested in the sex, the second decides if the creature will be able to become lovers with that sex, the third decides whether they will be able to marry in worldgen and post-worldgen world activities (which implies being able to become lovers). Marriage seems to be able to happen in fort mode play regardless, as long as they are lovers first. |
|- | |- | ||
| − | | {{text anchor|OUTSIDER_CONTROLLABLE | + | | {{text anchor|OUTSIDER_CONTROLLABLE}} |
| Caste | | Caste | ||
| | | | ||
| Line 1,816: | Line 1,824: | ||
| Caste | | Caste | ||
| | | | ||
| − | | Allows the creature to be used as a pack animal. Used by [[trading|merchants]] without wagons and adventurers. Also prevents creature from dropping hauled items on its own -- do ''not'' use for player-controllable creatures! | + | | Allows the creature to be used as a pack animal. Used by [[trading|merchants]] without wagons and adventurers. Also prevents creature from dropping hauled items on its own -- do ''not'' use for player-controllable creatures! May lead to the creature being domesticated during worldgen, even if it doesn't have {{token|COMMON_DOMESTIC|c}}. |
|- | |- | ||
| Line 1,829: | Line 1,837: | ||
| | | | ||
| Used to control the bat riders with paralyze-dart blowguns that flew through the 2D chasm. Doesn't do anything now. | | Used to control the bat riders with paralyze-dart blowguns that flew through the 2D chasm. Doesn't do anything now. | ||
| + | |||
| + | |- | ||
| + | | {{text anchor|PCG_LAYERING}} | ||
| + | | Creature | ||
| + | | | ||
| + | *[[Procedural graphics layer|Layering type]] | ||
| + | | Adds a layer to the current {{token|PROCEDURAL_CREATURE_GRAPHICS|c}} definition. | ||
|- | |- | ||
| Line 1,872: | Line 1,887: | ||
| | | | ||
*value | *value | ||
| − | | | + | | How valuable a tamed animal is. Actual cost in points in the embarking screen is 1+(PETVALUE/2) for an untrained animal, 1+PETVALUE for a war/hunting one. |
|- | |- | ||
| Line 1,933: | Line 1,948: | ||
| Caste | | Caste | ||
| | | | ||
| − | *number | + | *number (max 100000) |
| − | | Weighted population of caste; Lower is rarer. Not to be confused with {{token|FREQUENCY|c}}. | + | | Weighted population of caste; Lower is rarer. Not to be confused with {{token|FREQUENCY|c}}. A weight of 0 will not prevent a caste from spawning. |
|- | |- | ||
| Line 1,948: | Line 1,963: | ||
| Caste | | Caste | ||
| | | | ||
| − | | Allows the being to represent itself as a deity, allowing it to become the leader of a civilized group. Used by unique demons in the vanilla game. Requires {{token|CAN_SPEAK|c}} to actually do anything more than settle at a location (e.g. write books, lead armies, profane temples). Doesn't appear to do anything for creatures that are already civilized. Once the creature ascends to a position of leadership, it will proceed to act as a standard ruler for their entity and fulfill the same functions (hold tournaments, tame creatures, etc). | + | | Allows the being to represent itself as a deity, allowing it to become the leader of a civilized group. Used by unique demons in the vanilla game. Requires {{token|CAN_SPEAK|c}} to actually do anything more than settle at a location (e.g. write books, lead armies, profane temples). Doesn't appear to do anything for creatures that are already civilized. Once the creature ascends to a position of leadership, it will proceed to act as a standard ruler for their entity and fulfill the same functions (hold tournaments, tame creatures, etc.). |
|- | |- | ||
| Line 1,956: | Line 1,971: | ||
*string | *string | ||
| Sets what other creatures [[Preferences|prefer]] about this creature. "Urist likes dwarves for their beards." Multiple entries will be chosen from at random. Creatures lacking a PREFSTRING token will never appear under another's preferences. | | Sets what other creatures [[Preferences|prefer]] about this creature. "Urist likes dwarves for their beards." Multiple entries will be chosen from at random. Creatures lacking a PREFSTRING token will never appear under another's preferences. | ||
| + | |||
| + | |- | ||
| + | | {{text anchor|PROCEDURAL_CREATURE_GRAPHICS}} | ||
| + | | Creature | ||
| + | | | ||
| + | * [[Graphics_token#Basic_creature_sprite_types|Sprite type]] or Caste then sprite type | ||
| + | | Makes the creature have procedural graphics built for it, like forgotten beasts/demons/titans/experiments. Must be associated with PCG_LAYERING tokens. | ||
|- | |- | ||
| Line 2,051: | Line 2,073: | ||
*Second person cancel retract text | *Second person cancel retract text | ||
*Third person cancel retract text | *Third person cancel retract text | ||
| − | | The creature will retract into | + | | The creature will retract into the specified body part(s) when threatened. It will be unable to move or attack, but enemies will only be able to attack the specified body part(s). When one of the specified body part is severed off, the creature automatically unretracts and cannot retract anymore. More than one body part can be selected by using BY_TYPE or BY_CATEGORY. |
| − | Second-person descriptions are used for adventurer mode natural ability. "<pro_pos>" can be used in the descriptions, being replaced with the proper pronoun (or lack thereof) in-game. | + | Second-person descriptions are used for adventurer mode natural ability. "<pro_pos>" can be used in the descriptions, being replaced with the proper pronoun (or lack thereof) in-game. |
| − | Undead curled up creatures are buggy{{bug|11463}}{{bug|10519}}. | + | Undead curled up creatures are buggy, specifically those that retract into their upper bodies: [[echidna]]s, [[hedgehog]]s and [[pangolin]]s.{{bug|11463}}{{bug|10519}} The upper body is prevented from collapsing by a separate body part (the middle spine), which cannot be attacked when the creature is retracted. See {{token|PREVENTS_PARENT_COLLAPSE|bo}}. Living creatures eventually succumb to blood loss, but undead creatures do not. Giant creatures also take a very long time to bleed out. |
|- | |- | ||
| {{text anchor|RETURNS_VERMIN_KILLS_TO_OWNER}} | | {{text anchor|RETURNS_VERMIN_KILLS_TO_OWNER}} | ||
| | | | ||
| | | | ||
| − | | Cat behavior. If it kills a vermin creature and has an owner, it carries the remains in its mouth and drops them at their feet. Requires {{token|HUNTS_VERMIN|c}} | + | | Cat behavior. If it kills a vermin creature and has an owner, it carries the remains in its mouth and drops them at their feet. Requires {{token|HUNTS_VERMIN|c}}. |
|- | |- | ||
| Line 2,220: | Line 2,242: | ||
|- | |- | ||
| − | | {{text anchor| | + | | {{text anchor|SLAIN_CASTE_SPEECH}} |
| Caste | | Caste | ||
| − | | | + | | |
| + | *text set | ||
| + | | Caste-specific {{token|SLAIN_SPEECH|c}}. | ||
| + | |||
| + | |- | ||
| + | | {{text anchor|SLAIN_SPEECH}} | ||
| + | | Creature | ||
| + | | | ||
| + | *text set | ||
| + | | Boasting speeches relating to killing this creature. Examples include text_dwarf.txt and text_elf.txt in data\vanilla\vanilla_creatures\objects. | ||
| + | |||
| + | |- | ||
| + | | {{text anchor|SLOW_LEARNER}} | ||
| + | | Caste | ||
| + | | | ||
| Shorthand for {{token|CAN_LEARN|c}} + <code>[[Creature_token#SKILL_LEARN_RATES|[SKILL_LEARN_RATES:50]]]</code>.{{verify}} Used by a number of 'primitive' creatures (like [[ogre]]s, [[giant]]s and [[troglodyte]]s) in the vanilla game. Applicable to player races. Prevents a player from recruiting nobility, even basic ones. Subterranean creatures with this token combined with {{token|EVIL|c}} will become servants of goblins in their civilizations, in the style of [[troll]]s. | | Shorthand for {{token|CAN_LEARN|c}} + <code>[[Creature_token#SKILL_LEARN_RATES|[SKILL_LEARN_RATES:50]]]</code>.{{verify}} Used by a number of 'primitive' creatures (like [[ogre]]s, [[giant]]s and [[troglodyte]]s) in the vanilla game. Applicable to player races. Prevents a player from recruiting nobility, even basic ones. Subterranean creatures with this token combined with {{token|EVIL|c}} will become servants of goblins in their civilizations, in the style of [[troll]]s. | ||
| Line 2,261: | Line 2,297: | ||
* Out of sight reads "You hear '''a loud bark'''" | * Out of sight reads "You hear '''a loud bark'''" | ||
with the text in bold being the description arguments of the token. | with the text in bold being the description arguments of the token. | ||
| + | |||
| + | |- | ||
| + | | {{text anchor|SOURCE_HFID}} | ||
| + | | Creature | ||
| + | | | ||
| + | *Integer | ||
| + | | Found on generated [[angel]]s. This is the historical figure ID of the deity with which the angel is associated. Since HFIDs are not predictable before worldgen, this isn't terribly usable in mods. | ||
|- | |- | ||
| Line 2,269: | Line 2,312: | ||
* Plant/creature ID | * Plant/creature ID | ||
| Creature will only appear in biomes with this plant or creature available. Grazers given a specific type of grass (such as [[panda]]s and [[bamboo]]) will only eat that grass and nothing else, risking starvation if there's none available. | | Creature will only appear in biomes with this plant or creature available. Grazers given a specific type of grass (such as [[panda]]s and [[bamboo]]) will only eat that grass and nothing else, risking starvation if there's none available. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
| Line 2,311: | Line 2,333: | ||
|- | |- | ||
| − | | {{text anchor|SPREAD_EVIL_SPHERES_IF_RULER | + | | {{text anchor|SPREAD_EVIL_SPHERES_IF_RULER}} |
| Caste | | Caste | ||
| | | | ||
| Line 2,329: | Line 2,351: | ||
|- | |- | ||
| − | | {{text anchor|STRANGE_MOODS | + | | {{text anchor|STRANGE_MOODS}} |
| Caste | | Caste | ||
| | | | ||
| Line 2,353: | Line 2,375: | ||
|- | |- | ||
| − | | {{text anchor|SYNDROME_DILUTION_FACTOR | + | | {{text anchor|SYNDROME_DILUTION_FACTOR}} |
| Caste | | Caste | ||
| <[[Syndrome#SYN_IDENTIFIER|syndrome identifier]]>:<percentage> | | <[[Syndrome#SYN_IDENTIFIER|syndrome identifier]]>:<percentage> | ||
| Line 2,388: | Line 2,410: | ||
| | | | ||
*name | *name | ||
| − | | Begins defining a tissue in the creature file. | + | | Begins defining a tissue in the creature file. Follow this with standard tissue definition tokens to define the tissue properties. |
|- | |- | ||
| Line 2,409: | Line 2,431: | ||
*TISSUE | *TISSUE | ||
*LOCATION | *LOCATION | ||
| − | | | + | | Alias for TISSUE_LAYER |
|- | |- | ||
| Line 2,433: | Line 2,455: | ||
| | | | ||
*number | *number | ||
| − | | How much the creature can carry when used by merchants. | + | | How much the creature can carry when used by merchants. 1000 by default. If a civilization uses a custom pack animal via ALWAYS_PACK, you must manually add a capacity to the raws of that creature itself. Capacity defaults to null leading to empty caravans. |
|- | |- | ||
| Line 2,496: | Line 2,518: | ||
| Creature | | Creature | ||
| | | | ||
| − | | Creature will occur in every region with the correct biome. Does not apply to {{token|EVIL|c}}/{{token|GOOD|c}} tags. | + | | Creature will occur in every region with the correct biome. Does not apply to {{token|EVIL|c}}/{{token|GOOD|c}} tags. Supersedes {{token|FREQUENCY|c}} for the purposes of distributing populations through the map, they are present in every part of the valid biome. Respects {{token|FREQUENCY|c}} for the frequency of unit [[Creature token#CLUSTER_NUMBER|cluster]] spawns being of this species. |
|- | |- | ||
| Line 2,516: | Line 2,538: | ||
| Caste | | Caste | ||
| | | | ||
| − | | Found on generated [[demon]]s; causes the game to create a single named instance of the demon which will emerge from the underworld and take over civilizations during worldgen | + | | Found on generated [[demon]]s; causes the game to create a single named instance of the demon which will emerge from the underworld and take over civilizations during worldgen. |
|- | |- | ||
| Line 2,525: | Line 2,547: | ||
*old caste token | *old caste token | ||
| Defines a new caste derived directly from a previous caste. The new caste inherits all properties of the old one. The effect of this tag is automatic if one has not yet defined any castes: "Any caste-level tag that occurs before castes are explicitly declared is saved up and placed on any caste that is declared later, unless the caste is explicitly derived from another caste." | | Defines a new caste derived directly from a previous caste. The new caste inherits all properties of the old one. The effect of this tag is automatic if one has not yet defined any castes: "Any caste-level tag that occurs before castes are explicitly declared is saved up and placed on any caste that is declared later, unless the caste is explicitly derived from another caste." | ||
| + | Roostre: "When DF detects duplicate tokens in the raws of the same object, a failsafe seems to kick in; it takes the bottom-most of the duplicates, and disregards the others. In the case of tokens added by a mod, it prioritizes the duplicate in the mod." This means that if a tag is defined in the base-caste and redefined in the derived caste, the derived tag overwrites the base tag. | ||
|- | |- | ||
| Line 2,540: | Line 2,563: | ||
*new material token | *new material token | ||
*material template | *material template | ||
| − | | Defines a new local creature material and populates it with all properties defined in the specified template. | + | | Defines a new local creature material and populates it with all properties defined in the specified template. [http://www.bay12forums.com/smf/index.php?topic=175437.msg8441368#msg8441368 There seems to be a limit of 200 materials per creature]. |
|- | |- | ||
| Line 2,560: | Line 2,583: | ||
|- | |- | ||
| {{text anchor|UTTERANCES}} | | {{text anchor|UTTERANCES}} | ||
| − | | | + | | Creature |
| | | | ||
| Changes the language of the creature into unintelligible 'kobold-speak', which creatures of other species will be unable to understand. If a civilized creature has this and is not part of a {{token|SKULKING|e}} civ, it will tend to start wars with all nearby civilizations and will be unable to make peace treaties due to 'inability to communicate'. | | Changes the language of the creature into unintelligible 'kobold-speak', which creatures of other species will be unable to understand. If a civilized creature has this and is not part of a {{token|SKULKING|e}} civ, it will tend to start wars with all nearby civilizations and will be unable to make peace treaties due to 'inability to communicate'. | ||
| Line 2,682: | Line 2,705: | ||
*binocular vision arc | *binocular vision arc | ||
*non-binocular vision arc | *non-binocular vision arc | ||
| − | | The width of the creature's vision arcs, in degrees (i.e. 0 to 360). The first number is binocular vision, the second is non-binocular vision. Binocular vision has a minimum of about 10 degrees, monocular, a maximum of about 350 degrees. Values past these limits will be accepted, but will default to ~10 degrees and ~350 degrees respectively. | + | | The width of the creature's vision arcs, in degrees (i.e. 0 to 360). The first number is binocular vision, the second is non-binocular vision. Binocular vision has a minimum of about 10 degrees, monocular, a maximum of about 350 degrees. Values past these limits will be accepted, but will default to ~10 degrees and ~350 degrees respectively. Defaults are 60:120. |
|} | |} | ||
| Line 2,716: | Line 2,739: | ||
==Attack Tokens== | ==Attack Tokens== | ||
| + | |||
| + | Attacks can use four different part selection criteria; while all vanilla attacks use only BODYPART (e.g. ATTACK:PUNCH:BODYPART:BY_TYPE:GRASP), there are other options available. | ||
| + | |||
| + | {| {{prettytable}} | ||
| + | |- bgcolor="#ddd" | ||
| + | ! width="20%" | Part type token | ||
| + | ! width="30%" | Arguments | ||
| + | ! width="60%" | Description | ||
| + | |||
| + | |- | ||
| + | | {{text anchor|BODYPART}} | ||
| + | | | ||
| + | * BY_TYPE/BY_TOKEN/BY_CATEGORY | ||
| + | * type/token/category | ||
| + | | This attack uses a particular body part; for example, BY_TYPE:GRASP will make it use any part that can hold onto an object. | ||
| + | |||
| + | |- | ||
| + | | {{text anchor|TISSUE_LAYER}} | ||
| + | | | ||
| + | * BY_TYPE/BY_TOKEN/BY_CATEGORY | ||
| + | * type/token/category | ||
| + | * tissue layer | ||
| + | | This attack uses a specific tissue layer on a specific body part; BY_TYPE:GRASP:BONE will make it use the bone of the hands. | ||
| + | |||
| + | |- | ||
| + | | {{text anchor|CHILD_BODYPART_GROUP}} | ||
| + | | | ||
| + | * BY_TYPE/BY_TOKEN/BY_CATEGORY | ||
| + | * type/token/category | ||
| + | * BY_TYPE/BY_TOKEN/BY_CATEGORY | ||
| + | * type/token/category | ||
| + | | Uses a body part that is subordinate to another; BY_CATEGORY:ARM_LOWER:BY_TYPE:GRASP will make it use every hand attached to each lower arm (so it will generate one attack per lower arm, each of which will use every hand on that arm, assuming there are multiple hands per arm). | ||
| + | |||
| + | |- | ||
| + | | {{text anchor|CHILD_TISSUE_LAYER_GROUP}} | ||
| + | | | ||
| + | * BY_TYPE/BY_TOKEN/BY_CATEGORY | ||
| + | * type/token/category | ||
| + | * BY_TYPE/BY_TOKEN/BY_CATEGORY | ||
| + | * type/token/category | ||
| + | * tissue layer | ||
| + | | As CHILD_BODYPART_GROUP, but specifying a tissue, too. | ||
| + | |||
| + | |} | ||
| + | |||
{| {{prettytable}} | {| {{prettytable}} | ||
|- bgcolor="#ddd" | |- bgcolor="#ddd" | ||
| Line 2,880: | Line 2,948: | ||
| Caste | | Caste | ||
| | | | ||
| − | |||
*BY_CATEGORY, BY_TYPE, BY_TOKEN | *BY_CATEGORY, BY_TYPE, BY_TOKEN | ||
*Location - category, type, or token | *Location - category, type, or token | ||
Revision as of 13:51, 17 March 2024
v50.13 · v0.47.05 This article is about the current version of DF.Note that some content may still need to be updated. |
| Modding |
|---|
| Tokens |
| Audio · Biome · Graphics · Interaction · Mod info · Plant · Speech · Sphere · Syndrome · World |
| Body tokens |
| Body · Body detail plan · Bodygloss · Tissue |
| Creature tokens |
| Creature · Creature mannerism · Personality · Creature variation · Procedural graphics layer |
| Descriptor tokens |
| Descriptor color · Color · Descriptor pattern · Descriptor shape |
| Entity tokens |
| Entity · Ethic · Language · Position |
| Job tokens |
| Building · Labor · Reaction · Skill · Unit type |
| Item tokens |
| Item type · Item definition · Ammo · Armor · Instrument · Tool · Trap component · Weapon |
| Material tokens |
| Material type · Material definition · Inorganic material definition |
The [OBJECT:CREATURE] token begins the definition of a Dwarf Fortress creature raw file. Each creature definition that follows begins with the [CREATURE:creature ID] token, and the creature's exact properties and behavior are then specified by the use of further creature tokens. All known creature tokens are listed below.
Vanilla creature definitions can be found in <Dwarf Fortress>\data\vanilla\vanilla_creatures\.
Creature ID is also used with graphics tokens to make customizable graphics sets.
The caste tokens allow defining sub-species within the broader creature definition, including true biological castes and lesser variations, such as sexes. Creature tokens can either be 'Creature' or 'CASTE-only' type which can only be applied to creature or cast respectively, or 'CASTE' which can be applied to both. In the table bellow, creature type distinguish tokens that can be applied to creature only, cast only and both ('creature', 'CASTE-only', and 'CASTE' respectively)
| Contents A B C D E F G H I J K L M N O P Q R S T U V W X Y Z top |
A
| Token | Type | Arguments | Description |
|---|---|---|---|
| ADOPTS_OWNER | Caste | Prevents tamed creature from being made available for adoption, instead allowing it to automatically adopt whoever it wants. The basic requirements for adoption are intact, and the creature will only adopt individuals who have a preference for their species. Used by cats in the vanilla game. When viewing a tame creature with this token, the message "This animal isn't interested in your wishes" will appear instead of "This [adorable] animal can't work" or "This animal is waiting to be trained". | |
| ALCOHOL_DEPENDENT | Caste | Makes the creature need alcohol to get through the working day; it will choose to drink booze instead of water if possible. Going sober for too long reduces speed. | |
| ALL_ACTIVE | Caste | 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.[Verify]
| |
| ALTTILE | Creature |
|
If set, the creature will blink between its [TILE] and its ALTTILE.
|
| AMBUSHPREDATOR | Caste | Found on [LARGE_PREDATOR]s who ambush their prey. Instead of charging relentlessly at prey, the predator will wait till the prey is within a few squares before charging. May or may not work on other creatures.[Verify]
| |
| AMPHIBIOUS | Caste | Allows a creature to breathe both in and out of water (unlike [AQUATIC]) - does not prevent drowning in magma.
| |
| APP_MOD_DESC_RANGE | Appearance Modifier |
|
Based on info from Wannabehero on the forums: When used with an appearance modifier token (BP_APPEARANCE_MODIFIER or BODY_APPEARANCE_MODIFIER), tells the game what numeric ranges to map to which descriptors.
The game uses 7 descriptor levels for each modifier, with the center one generally being to omit the thing from the creature description entirely. The six values in APP_MOD_DESC_RANGE define the boundaries between each described range. |
| APP_MOD_GENETIC_MODEL | Appearance Modifier |
|
Defines a genetic model for the relevant appearance modifier(s). May or may not do anything significant at present. |
| APP_MOD_IMPORTANCE | Appearance Modifier |
|
Determines how important the appearance modifier is, for determining whether it shows up in the creature description.[Verify] |
| APP_MOD_NOUN | Appearance Modifier |
|
Creates a noun for the appearance, and whether it is singular or plural. |
| APP_MOD_RATE | Appearance Modifier |
|
Setting the growth rate of the modifier. The last two tokens can be replaced by NO_END to have growth continue indefinitely. |
| APPLY_CREATURE_VARIATION | Caste |
|
Applies the specified creature variation. See Creature_variation_token#Arguments_and_conditional_tokens for how the subsequent arguments may be used. |
| APPLY_CURRENT_CREATURE_VARIATION | Special | Applies the effects of all pending [CV_ADD_TAG] and [CV_REMOVE_TAG] tokens that have been defined in the current creature.
| |
| AQUATIC |