Dwarf Fortress Wiki - User contributions [en]

CMV

2018-02-22T08:43:16Z

Bearskie:

{{Quality|Superior|06:16, 17 May 2015 (UTC)}}
{{av}}
The '''CMV''' file format is used for recording movies within Dwarf Fortress. Movies can be recorded ingame by pressing {{key|;}} from anywhere within the game and following the instructions. CMV files can be played back ingame from the same menu (which works from the opening menu screen) or by using a 3rd party player. There is a standalone [[Main:Utilities#CMVPlayer|CMV player]] for windows and an online [http://mkv25.net/dfma/movie-1-tragicmule flash based CMV player] on the [[Utility:Dwarf Fortress Map Archive|DF Map Archive]].

Tools also exist to convert CMV files to animated .gif format, such as milo christiansen's [http://www.bay12forums.com/smf/index.php?topic=147803.0 CMV to GIF] command line utility.

==Movie Archive==
Since September 2007, members of the DF community have been able to [http://mkv25.net/dfma/addmovie.php share] and [http://mkv25.net/dfma/browsemovies.php watch] CMV movies with other players in the community through the movie pages on the DF Map Archive. This was thanks in part to '''gonbon''' who wrote and provided the flash based CMV Player for use in the community.

==Historical notes==
In August 2008 [[Main:Toady One|Toady One]] upgraded the recording capabilities of Dwarf Fortress to support grid sizes larger than the standard 80x25.

==CCMV File format==
In order to boost the compression of CMV files, SL introduced a Compressed CMV file format (CCMV) using a single pass through zlib on the final file data. This compression is compatible with the Flash player on the DFMA. The smaller file size means quicker downloads but breaks any streaming functionality that would have been possible with the standard CMV file format.

==File format==
* Jifodus's user page has a table describing the [[User:Jifodus/CMV_file_format|CMV file format]].
* Markavian's user page has an updated version expressed as a [[User:Markavian/CMV_file_format|C# CMV Class]], based on optimization code written by [http://shadowlord13.googlepages.com/dfmap-index.html SL], and header information forwarded by Toady One.

{{Category|Interface}}

Tool token

2018-02-02T13:52:31Z

Bearskie:

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

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

|-
| {{text anchor|NAME}}
|
*singular
*plural
| Name of the tool. Required.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

|-
| {{text anchor|WOOD_MAT}}
|
| Permits the tool to be made from any wood.

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

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

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

|-
| {{text anchor|VALUE}}
|
*num
| Defines the item value of the tool. Required.

|-
| {{text anchor|TILE}}
|
*num
| Defines the tile used to represent the tool. Required.

|-
| {{text anchor|INVERTED_TILE}}
|
| The background of the tile will be colored, instead of the foreground.

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

|-
| {{text anchor|TOOL_USE}}
|
*tool use, see below
| Defines the task performed using the tool.

|-
| {{text anchor|FURNITURE}}
|
| Allows item to be stored in a furniture stockpile.

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

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

|-
| {{text anchor|CONTAINER_CAPACITY}}
|
*amount
| How much the item can contain. Defaults to 0.

|-
| {{text anchor|SHOOT_FORCE}}
|
*value
| Required for weapons.

|-
| {{text anchor|SHOOT_MAXVEL}}
|
*value
| Required for weapons.

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

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

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

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

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

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

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

|}

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

Entity token

2018-01-29T02:16:06Z

Bearskie: All entities can now plant indoor/outdoor crops irrespective of INDOOR/OUTDOOR_FARMING/GARDENS tags (if they can obtain the required seeds).

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

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

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

[ADVENTURE_TIER:4]

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

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

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

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

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

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

|}

== Placement ==

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

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

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

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

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

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

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

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

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

|}

== Population ==

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

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

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

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

|}

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

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

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

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

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

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

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

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

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

[ART_IMAGE_ELEMENT_MODIFIER:TREE:512]

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

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

[ITEM_IMPROVEMENT_MODIFIER:SPIKES:0]

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

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

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

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

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

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

[FRIENDLY_COLOR:1:0:1]

|}

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

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

[RELIGION:PANTHEON]

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

[RELIGION_SPHERE:FORTRESSES]

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

[SPHERE_ALIGNMENT:TREES:512]

|}

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

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

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

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

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

|}

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

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

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

|-
| {{text anchor|VARIABLE_VALUE}}{{version|0.42.01}}
|
*value or ALL
*min
*max
| Makes values randomized rather than specified.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

|}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

|}

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

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

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

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

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

Interaction token

2015-12-20T04:34:55Z

Bearskie: /* Interaction Definitions */ I_EFFECT:CONTACT does not require touchable interaction range; line of sight from distance works just as well.

{{av}}

The following tokens can be used to define and use interactions.

==Interaction Definitions==
{| {{prettytable}}
|- bgcolor="#C0C0C0"
! Token
! Context
! Arguments
! Description

|-
| {{text anchor|I_SOURCE}}
| Global
| type
| Defines what things are capable of triggering this interaction. Can be specified multiple times. Valid values:
* REGION - The interaction takes place in particular types of regions in the world.
* SECRET - The interaction is a secret that can be learned by particular individuals.
* DISTURBANCE - The interaction is triggered when disturbing a [[tomb]].
* DEITY - The interaction is inflicted upon mortals by the gods.
* ATTACK - The interaction is triggered by an attack during combat.
* INGESTION - The interaction is triggered by eating or drinking something.
* CREATURE_ACTION - The interaction is triggered by an explicit action.
* UNDERGROUND_SPECIAL - The interaction takes place in [[Demonic fortress|curious underground structure]]s.

|-
| {{text anchor|IS_HIST_STRING_1}}
| Within I_SOURCE
| text
| Describes what the interaction did to a historical figure. Displayed after the name of the historical figure that performed the interaction.

[IS_HIST_STRING_1: cursed ]

|-
| {{text anchor|IS_HIST_STRING_2}}
| Within I_SOURCE
| text
| Describes what the interaction did to a historical figure. Displayed after the name of the historical figure that was targeted by the interaction.

[IS_HIST_STRING_2: to assume the form of a lizard-like monster every full moon]

|-
| {{text anchor|IS_FREQUENCY}}
| Within I_SOURCE
| Number
| Presumably, the probability of biome specified by [IS_REGION] to have this interaction.

|-
| {{text anchor|IS_NAME}}
| Within I_SOURCE
| string
| Generally used with secrets, describes what the secret is about.

|-
| {{text anchor|IS_REGION}}
| Within I_SOURCE:REGION
| Region type
| Indicates what types regions are capable of performing this interaction. Can be specified multiple times. Valid values:
* ANY
* ANY_TERRAIN
* NORMAL_ALLOWED
* EVIL_ALLOWED
* GOOD_ALLOWED
* SAVAGE_ALLOWED
* EVIL_ONLY
* GOOD_ONLY
* SAVAGE_ONLY
* Region type - SWAMP, DESERT, FOREST, MOUNTAINS, OCEAN, LAKE, GLACIER, TUNDRA, GRASSLAND, HILLS

|-
| {{text anchor|IS_SPHERE}}
| Within I_SOURCE:SECRET
| [[Sphere]]
| Indicates the sphere to which this secret pertains. Only one sphere can be defined for each [I_SOURCE:SECRET] token, thus several [I_SOURCE:SECRET] tokens required to create a valid custom secret, which belongs to several different spheres

|-
| {{text anchor|IS_SECRET_GOAL}}
| Within I_SOURCE:SECRET
| Secret Goal token
| Indicates why somebody would want to learn the secret. Valid values:
* STAY_ALIVE
* MAINTAIN_ENTITY_STATUS
* START_A_FAMILY
* RULE_THE_WORLD
* CREATE_A_GREAT_WORK_OF_ART
* CRAFT_A_MASTERWORK
* BRING_PEACE_TO_THE_WORLD
* BECOME_A_LEGENDARY_WARRIOR
* MASTER_A_SKILL
* FALL_IN_LOVE
* SEE_THE_GREAT_NATURAL_SITES
* IMMORTALITY
However, currently only immortality will result in a secret being pursued during world-gen.

|-
| {{text anchor|IS_SECRET}}
| Within I_SOURCE:SECRET
| Secret Flag
| Indicates how the secret can be learned. Valid values:
* SUPERNATURAL_LEARNING_POSSIBLE - the secret can be learned by supernatural means
* MUNDANE_RESEARCH_POSSIBLE - the secret can be researched by mundane means
* MUNDANE_TEACHING_POSSIBLE - the secret can be taught to apprentices
* MUNDANE_RECORDING_POSSIBLE:objects/text/(book_title).txt:objects/text/(book_topic).txt - the secret can be written in books with the specified title. If this tag is present, a slab will be created upon learning the secret by supernatural means.
|-
| {{text anchor|IS_USAGE_HINT}}
| Within I_SOURCE:DEITY
| Usage Hint token
| Indicates why a deity would choose to perform this interaction. See CDI:USAGE_HINT below for valid values - in this context, MAJOR_CURSE is the only value that makes sense.

|-
| {{text anchor|I_TARGET}}
| Global
| id, type
| Specifies what things this interaction acts upon. Can be specified multiple times. Valid values:
* CORPSE - Also includes pieces of corpses
* CREATURE
* MATERIAL
* LOCATION

|-
| {{text anchor|IT_LOCATION}}
| Within I_TARGET
| Location
| Narrows down exactly what the interaction targets. Valid values:
* CONTEXT_REGION - Can only be used by IS_REGION interactions.
* CONTEXT_CREATURE
* CONTEXT_CREATURE_OR_LOCATION - Lets projectiles be aimed at specific creatures.
* CONTEXT_ITEM - Used when the target is a CORPSE.
* CONTEXT_BP - Use body part from CDI:BP_REQUIRED token (below).
* CONTEXT_LOCATION
* CONTEXT_MATERIAL
|-
| {{text anchor|IT_MANUAL_INPUT}}
| Within I_TARGET
| text
| Tells the player what they should be selecting.

|-
| {{text anchor|IT_AFFECTED_CREATURE}}
| Within I_TARGET:CORPSE or I_TARGET:CREATURE
| CREATURE:CASTE
| Specifies specific creatures the interaction can target.

|-
| {{text anchor|IT_AFFECTED_CLASS}}
| Within I_TARGET:CORPSE or I_TARGET:CREATURE
| Creature class
| Specifies creature classes the interaction can target.

|-
| {{text anchor|IT_IMMUNE_CREATURE}}
| Within I_TARGET:CORPSE or I_TARGET:CREATURE
| CREATURE:CASTE
| Specifies specific creatures the interaction cannot target.

|-
| {{text anchor|IT_IMMUNE_CLASS}}
| Within I_TARGET:CORPSE or I_TARGET:CREATURE
| Creature class
| Specifies creature classes the interaction cannot target.

|-
| {{text anchor|IT_REQUIRES}}
| Within I_TARGET:CORPSE or I_TARGET:CREATURE
| Creature token or property
| Indicates that the target must have the specified property. Valid values:
* FIT_FOR_ANIMATION - Any corpse or body part that can become a zombie (heads, hands, etc.)
* FIT_FOR_RESURRECTION - The target corpse's UPPERBODY must be attached.
* HAS_BLOOD
* MORTAL
* NO_AGING
* STERILE
* Creature token: BLOODSUCKER, CAN_LEARN, CAN_SPEAK, CRAZED, EXTRAVISION, LIKES_FIGHTING (or LIKESFIGHTING), MISCHIEVOUS (or MISCHIEVIOUS), NO_CONNECTIONS_FOR_MOVEMENT, NO_DIZZINESS, NO_DRINK, NO_EAT, NO_FEVERS, NO_PHYS_ATT_GAIN, NO_PHYS_ATT_RUST, NO_SLEEP, NO_THOUGHT_CENTER_FOR_MOVEMENT, NOBREATHE, NOEMOTION, NOEXERT, NOFEAR, NONAUSEA, NOPAIN, NOSTUN, NOT_LIVING, NOTHOUGHT, OPPOSED_TO_LIFE, PARALYZEIMMUNE, SUPERNATURAL, TRANCES, UTTERANCES

|-
| {{text anchor|IT_FORBIDDEN}}
| Within I_TARGET:CORPSE or I_TARGET:CREATURE
| Creature token or property
| Indicates that the target must not have the specified property. Valid values are the same as for IT_REQUIRES.

|-
| {{text anchor|IT_CANNOT_TARGET_IF_ALREADY_AFFECTED}}
| Within I_TARGET:CORPSE or I_TARGET:CREATURE
|
| Prevents the interaction from targeting a creature that's already under the effect of the same interaction.

|-
| {{text anchor|IT_CANNOT_HAVE_SYNDROME_CLASS}}
| Within I_TARGET:CORPSE or I_TARGET:CREATURE
| [[Syndrome]] class
| Prevents the interaction from targeting a creature under the effects of a syndrome having the specified SYN_CLASS value.

|-
| {{text anchor|IT_MATERIAL}}
| Within I_TARGET:MATERIAL
| Type
| Specifies the type of material the interaction targets. Valid values:
* FLOW:Breath attack token - Specifies an attack not made of any material.
* MATERIAL:[[Material token]]:Breath attack token - Specifies an attack made of a specific material.
* CONTEXT_MATERIAL - Use material from CDI:MATERIAL token (below).

|-
| {{text anchor|I_EFFECT}}
| Global
| type
| Specifies what the interaction does to the targets. Can be specified multiple times. Valid values:
* ANIMATE - Raises the target corpse/bodypart as a zombie. The zombie will always be hostile to life and will retain no information about its original personality/loyalties. Syndromes can also be specified within this tag.
* ADD_SYNDROME - Adds one or more syndromes. The actual syndrome is specified with the [SYNDROME] tag.
* RESURRECT - Returns the creature to life. This can be used on parts that are not FIT_FOR_RESURRECTION, but only the main part (with an UPPERBODY attached) will remain loyal to its original faction. Syndromes can also be specified within this tag.
* CLEAN - Cleans off most liquids/dust covering the creature.
* CONTACT - Causes the creatures to touch.
* MATERIAL_EMISSION - Used within the MATERIAL_EMISSION interaction.
* HIDE - Allows the creature to hide even if another creature can see it.

|-
| {{text anchor|IE_TARGET}}
| Within I_EFFECT
| ID
| Specifies which I_TARGET this effect will be applied to

|-
| {{text anchor|IE_INTERMITTENT}}
| Within I_EFFECT
| Frequency
| Indicates that the effect happens intermittently and specifies roughly how often. Valid values:
* WEEKLY
* MONTHLY
note:
DAILY and YEARLY also exist in the string dump but haven't been tested fully.
|-
| {{text anchor|IE_IMMEDIATE}}
| Within I_EFFECT
|
| Indicates that the effect happens immediately.

|-
| {{text anchor|IE_LOCATION}}
| Within I_EFFECT
| Location Hint
| Indicates where the effect can take place. Valid values:
* IN_WATER
* IN_MAGMA
* NO_WATER
* NO_MAGMA

|-
| {{text anchor|IE_ARENA_NAME}}
| Within I_EFFECT
| text
| Allows the interaction to be applied to newly spawned creatures in Arena mode.

|-
| {{text anchor|IE_GRIME_LEVEL}}
| Within I_EFFECT:CLEAN
| amount?
| [IE_GRIME_LEVEL:2] appears in the default cleaning interaction, and may indicate amount of grime cleaned.

|-
| {{text anchor|IE_SYNDROME_TAG}}
| Within I_EFFECT:CLEAN
| Syndrome flag
| Indicates that cleaning off materials will activate their syndromes if they have this flag.

|-
| {{text anchor|GENERATED}}
| Global
|
| Indicates that this is a generated interaction. Cannot be specified in user-defined raws.

|}

==Interaction Usage==
In order to actually use an interaction, add the [[creature token]] [CAN_DO_INTERACTION:NAME] followed by a series of [CDI:...] tokens. Interactions can also be granted through [[syndrome]]s using the token [CE_CAN_DO_INTERACTION] (plus the same series of CDI tokens).

The following CDI tokens can be specified:
{| {{prettytable}}
|- bgcolor="#C0C0C0"
! Token
! Arguments
! Description

|-
| {{text anchor|INTERACTION}}
| id
| Specifies which interaction can be performed. Only to be used with syndromes, since CE_CAN_DO_INTERACTION does not allow specifying the interaction ID directly.

|-
| {{text anchor|TARGET}}
| target ID, target types
| Specifies how the creature chooses what to . Target ID refers to an I_TARGET defined in the interaction itself. Multiple target types can be specified. If no target is specified, creature will target any available target within range, even through walls. Valid target types:
* LINE_OF_SIGHT - the source needs to be able to see the target
* TOUCHABLE - the source needs to be able to touch the target
* DISTURBER_ONLY - the target must be whoever disturbed the source
* SELF_ALLOWED - the target can be the source
* SELF_ONLY - the target '''must''' be the source

|-
| {{text anchor|TARGET_RANGE}}
| target ID, range
| Specifies how far away the target can be, in tiles.

|-
| {{text anchor|LOCATION_HINT}}
| Location Hint (see above)
| ?

|-
| {{text anchor|USAGE_HINT}}
| Usage hint token
| Indicates when and how CPU-controlled creatures will use the interaction. If no hint is specified, the interaction will be used whenever a valid target is available. Valid values:
* MAJOR_CURSE - Used in disturbance curses and deity curses. Targets the tomb disturber/temple defiler.
* GREETING - Creatures will target 'friendly' creatures, usually at random.
* CLEAN_SELF - Creature targets itself when covered in liquids or dust.
* CLEAN_FRIEND - Same, but targets other friendly units.
* ATTACK - Targets enemy creatures in combat. If the interaction specifies SELF_ONLY, CPU-controlled creatures will never use it.
* FLEEING - Used when fleeing an enemy. Creature will target itself.
* NEGATIVE_SOCIAL_RESPONSE - Used when a creature is expressing contempt (for example, to a murderer). Used for spitting by civilised races.
* TORMENT

|-
| {{text anchor|ADV_NAME}}
| text
| Specifies the interaction's name when used in Adventurer mode.

|-
| {{text anchor|MAX_TARGET_NUMBER}}
| ID, number
| Specifies the maximum number of things that can be selected for a particular I_TARGET.

|-
| {{text anchor|WAIT_PERIOD}}
| number
| Controls how often the interaction can be used.

|-
| {{text anchor|VERBAL}}
|
| Only creatures that can speak will be able to use the interaction. Might also be needed for VERBAL_SPEECH.

|-
| {{text anchor|VERBAL_SPEECH}}
| filename
| Specifies what the creature says when they perform the interaction. Filename path is relative to /data/speech.

|-
| {{text anchor|CAN_BE_MUTUAL}}
|
| Presumably, allows two creatures with this same interaction to use it on each other simultaneously, for example cats cleaning each other.

|-
| {{text anchor|FREE_ACTION}}
|
| Indicates that performing the interaction doesn't take any time.

|-
| {{text anchor|VERB}}
| self:other:mutual
| When a creature uses the interaction, a message will display, describing the source as doing this.

|-
| {{text anchor|VERB_REVERSE}}
| ?
| ?

|-
| {{text anchor|TARGET_VERB}}
| self:other
| When a creature uses the interaction, a message will display, describing the target as doing this.

|-
| {{text anchor|BP_REQUIRED}}
| Body part criteria
| Indicates that a particular body part must be present in order to perform the interaction. Criteria are BY_CATEGORY:category, BY_TYPE:type, or BY_TOKEN:token.

|-
| {{text anchor|FLOW}}
| [[#Breath Attack Types|Breath attack token]]
| Causes the interaction to create an effect not made of any material. Only makes sense for FIREBALL, FIREJET, or DRAGONFIRE.

|-
| {{text anchor|MATERIAL}}
| [[Material token]]:Breath attack token
| Causes the interaction to create an effect made of a specific material. Doesn't make sense for FIREBALL, FIREJET, or DRAGONFIRE.

|}

==Breath attacks==
Breath attacks are controlled by the MATERIAL_EMISSION interaction, like so:

[CAN_DO_INTERACTION:MATERIAL_EMISSION]
[CDI:ADV_NAME:Breath custom material]
[CDI:USAGE_HINT:ATTACK]
[CDI:BP_REQUIRED:BY_CATEGORY:MOUTH]
[CDI:MATERIAL:LOCAL_CREATURE_MAT:CUSTOMMATERIAL:TRAILING_VAPOR_FLOW]
[CDI:TARGET:C:LINE_OF_SIGHT]
[CDI:TARGET_RANGE:C:15]
[CDI:MAX_TARGET_NUMBER:C:1]
[CDI:WAIT_PERIOD:50]

The most important part is this line:

[CDI:MATERIAL:LOCAL_CREATURE_MAT:CUSTOMMATERIAL:TRAILING_VAPOR_FLOW]

The CDI refers to CAN_DO_INTERACTION; the MATERIAL states that this line shows what the material is. LOCAL_CREATURE_MAT:CUSTOMMATERIAL is your material, and TRAILING_VAPOR_FLOW refers to the breath attack type. Other types are seen below. Also important is this line:

[CDI:TARGET:C:LINE_OF_SIGHT]

LINE_OF_SIGHT refers to where the target C may be; others include SELF_ALLOWED (presumably like LINE_OF_SIGHT, but with the creature allowed to target itself), SELF_ONLY (preferable for undirected attacks and TOUCHABLE (for up-close attacks, as trailing flows tend to be).

===Breath Attack Types===

{| {{prettytable}}
|- bgcolor="#ddd"
! Token
! Description
|-
| TRAILING_DUST_FLOW
| Lets out a cloud of solid dust. Appears to use cave-in dust physics, causing this to fling around anything it comes in contact with, making it capable of smashing creatures into the ground and flinging them over walls. Creature will attack as normal.
|-
| TRAILING_VAPOR_FLOW
| Shoots a trail of liquid mist at the target which can condense and trigger contact syndromes. Creature will attack as normal.
|-
| TRAILING_GAS_FLOW
| Shoots a trail of gas substance at the creature which can be inhaled. Creature will attack as normal.
|-
| TRAILING_ITEM_FLOW:[[item token]]
| Shoots a "cloud" of items at the target, leaving piles of this item on the floor. Note that this does ''not'' create the actual items or use falling item mechanics (meaning no flying daggers or Touhou-style barrages, unfortunately). Instead, this token acts as TRAILING_GAS_FLOW, except that the material will use its ''normal'' temperature - for example, a breath attack of steel anvils will envelop the target in a "burst of steel". Creature will attack as normal.
|-
| SOLID_GLOB
| Shoots a solid glob of spinning substance at the creature, leaving symbols similar to broken arrows. Essentially a projectile weapon. If the cooldown rate is short enough, some creatures with this breath attack will not move, preferring instead to stay and shoot globs at you, even when you are literally right next to them.
|-
| LIQUID_GLOB
| Shoots a liquid glob of substance at the creature. Contact syndromes will take effect if the glob hits the target's exposed skin.
|-
| SPATTER_POWDER
| Creates a pile of powder at the specified location.
|-
| SPATTER_LIQUID
| Creates a pool of liquid at the specified location.
|-
| UNDIRECTED_GAS
| Creature occasionally releases a cloud of gas substance. Similar to TRAILING_GAS_FLOW, but undirected, thus affecting a larger area but losing the distance. Creature will attack as normal.
|-
| UNDIRECTED_VAPOR
| Creature occasionally releases a cloud of liquid mist. Similar to TRAILING_VAPOR_FLOW, but undirected, thus affecting a larger area but losing the distance. Creature will attack as normal.
|-
| UNDIRECTED_DUST
| Creature occasionally releases a cloud of solid dust, which will spread and dissipate. Similar to TRAILING_DUST_FLOW, but undirected, thus affecting a larger area but losing the distance - range is roughly the same as that of a cave-in. Creature will attack as normal. <s>DO NOT USE THIS TAG UNLESS YOU WANT TO KILL THE CREATURE AND EVERYTHING NEAR IT AND SEND PEOPLE FLYING.</s> You know you want to.
|-
| UNDIRECTED_ITEM_CLOUD:[[item token]]
| Creature occasionally releases a "cloud" of items at the target, leaving piles of this item on the floor. The same comments apply as TRAILING_ITEM_FLOW. Creature will attack as normal.
|-
| WEB_SPRAY
| Emits a burst of [[web]]s that entangle target creatures.
|-
| DRAGONFIRE
| Emits a wide cone of [[dragon]] [[fire]] that burns target creatures at a scorching {{ct|50000}}. For this you want FLOW instead of a material.
|-
| FIREJET
| Emits a narrow cone of [[fire]] that burns target creatures at {{ct|11000}}. For this you want FLOW instead of a material.
|-
| FIREBALL
| Emits a fireball that burns the target creature. For this you want FLOW instead of a material.
|-
| WEATHER_CREEPING_GAS
| Creates a cloud of gas that appears at the edge of the map and slowly creeps across the map. Not usable by creatures.
|-
| WEATHER_CREEPING_VAPOR
| Creates a cloud of creeping vapor. Not usable by creatures.
|-
| WEATHER_CREEPING_DUST
| Creates a cloud of creeping dust. Not usable by creatures.
|-
| WEATHER_FALLING_MATERIAL
| Causes it to start raining a particular material. If the material is solid at the outdoor temperatures, it will snow the material instead. Regardless of the nature of the material, being caught in it will give dwarves the bad thought of being 'caught in freakish weather lately'. Not usable by creatures.
|}

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

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

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

==See Also==
* [[Syndrome]]

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

Entity token

2015-12-20T04:31:33Z

Bearskie: /* Flavor */ Tested and verified; no translation tags result in random translations on an individual basis. Also tested multiple translation tags.

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

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

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

[ADVENTURE_TIER:4]

Removed in [[:Category:Version 0.42.01|Version 0.42.01]].

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

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

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

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

|}

== Placement ==

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

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

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

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

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

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

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

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

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

|}

== Population ==

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

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

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

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

|}

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

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

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

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

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

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

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

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

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

[ART_IMAGE_ELEMENT_MODIFIER:TREE:512]

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

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

[ITEM_IMPROVEMENT_MODIFIER:SPIKES:0]

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

|-
| {{text anchor|TRANSLATION}}
| language
| What language raw the entity uses.
* If an entity lacks this tag, translations are drawn randomly from all translation files. Multiple translation tags will only result in the last one being used.
[TRANSLATION:DWARF]

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

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

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

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

|}

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

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

[RELIGION:PANTHEON]

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

[RELIGION_SPHERE:FORTRESSES]

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

[SPHERE_ALIGNMENT:TREES:512]

|}

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

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

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

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

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

|}

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

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

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

|-
| {{text anchor|VARIABLE_VALUE}}{{version|0.42.01}}
|
*value or ALL
*min
*max
|

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

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

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

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

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

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

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

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

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

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

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

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

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

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

|-
| {{text anchor|LOCAL_BANDITRY}}
|
| Causes the entity to send out patrols that can ambush adventurers. Said patrols will be hostile to any adventurers they encounter, regardless of race or nationality. Adding this tag to playable entities will also make adventurers with this token willing to move-attack non-hostile villagers, rather than having to make an aimed attack.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

|-
| {{text anchor|SET_SCHOLARS_ON_VALUES_AND_JOBS}}{{version|0.42.01}}
|
|

|}

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

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

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

|-
| {{text anchor|DIGGER}}
| item token
| Causes the selected weapon to fall under the "digging tools" section of the embark screen. Also forces the weapon to be made out of metal, which can cause issues if a modded entity has access to picks without access to metal. For those cases, listing the pick under the [WEAPON] token works just as well.
[DIGGER:ITEM_WEAPON_PICK]

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

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

|-
| {{text anchor|INSTRUMENT}}
| item token
|
[INSTRUMENT:ITEM_INSTRUMENT_FLUTE]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

|}

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

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

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

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

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

Tool token

2015-12-04T07:50:26Z

Bearskie: Added some tags from 'file changes.txt' along with Toady's explanation of them. Didn't touch DEFAULT_IMPROVEMENT, still unsure about that.

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

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

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

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

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

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

|-
| HARD_MAT
|
| Permits the tool to be made from any "hard" material, such as stone.

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

|-
| METAL_MAT
|
| Permits the tool to be made from any metal.

|-
| METAL_WEAPON_MAT
|
| Permits the tool to be made from any weapons-grade metal.

|-
| SHEET_MAT{{version|0.42.01}}
|
| Permits the tool to be made from any "sheet" material, such as papyrus, paper, and parchment.

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

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

|-
| SOFT_MAT
|
| Permits the tool to be made from any "soft" material, such as leather.

|-
| STONE_MAT{{version|0.42.01}}
|
| Permits the tool to be made from any stone.

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

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

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

|-
| DEFAULT_IMPROVEMENT{{version|0.42.01}}
|
*improvement type
*possibly specific type or part token
*material token?
| UNKNOWN (I assume it puts the improvement on by default). Used on scrolls: [DEFAULT_IMPROVEMENT:SPECIFIC:ROLLERS:HARD_MAT]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

|}

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