Editing Entity token

{{Quality|Superior}}
{{av}}
{{Modding}}
'''Entity tokens''' define entities, or [[civilization]]s, in entity_*.txt files.

The <code>[OBJECT:ENTITY]</code> [[token]] begins the definition of an entity [[raw file]]. Each new entity definition that follows begins with the <code>[ENTITY:''entity_ID'']</code> token, where ''entity_ID'' is a unique identifier for that entity, and the entity's properties are then specified by the use of further entity tokens; or, tokens can be added to existing entities using <code>[SELECT_ENTITY:''entity_ID'']</code> instead.

All known entity tokens are listed below. 

__TOC__
{{clear}}

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

|-
| {{text anchor|ALL_MAIN_POPS_CONTROLLABLE}}
| 
| Allows adventure mode for entities with sites.

|-
| {{text anchor|SITE_CONTROLLABLE}}
| 
| Allows fortress mode. If multiple entities have the SITE_CONTROLLABLE token, then at embark the specific civs can be chosen on the civ list screen. 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. In entities with multiple possible creatures, you can manipulate the chance of one creature being chosen by adding multiple identical creature tags. For instance adding [CREATURE:DWARF][CREATURE:DWARF][CREATURE:DWARF][CREATURE:ELF] to the same entity will make the civs created about 75% dwarven, 25% elven. It should be noted that civilizations are in general weighted by this token: for example, if you have one entity with three [CREATURE:DWARF] tokens and another separate entity with a single [CREATURE:ELF] token, then you can expect to see three times as many of the former placed as the latter (assuming enough unclaimed [START_BIOME:X] space remains). Note that spawn rates are also limited by unclaimed biome space - if an entity can only spawn in a rarer set of biomes (only LAKE_TROPICAL_SALTWATER for example) then their spawn rate will end up being limited by the remaining unclaimed space in that biome type rather than the number of [CREATURE:X] tokens present in the entity raw.
|-
| {{text anchor|SOURCE_HFID}}
| integer
| 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 ==

Entity spawning during world gen is influenced by several factors:
* The "[[Advanced world generation#Number of Civilizations|Number of Civilizations]]" world gen setting places a hard limit on the total number of entities spawned.
* The "[[Advanced world generation#Playable Civilization Required|Playable Civilization Required]]" world gen setting forces at least one of each [[Entity token#SITE_CONTROLLABLE|SITE_CONTROLLABLE]] entity to spawn (presumably still limited by "Number of Civilizations").
* The number of <nowiki>[</nowiki>[[Entity token#CREATURE|CREATURE]]:X] tokens present in an entity modifies its chance of spawning. An entity containing more <nowiki>[</nowiki>[[Entity token#CREATURE|CREATURE]]:X] tokens will spawn more often (assuming other requirements are met) and may even block entities with fewer <nowiki>[</nowiki>[[Entity token#CREATURE|CREATURE]]:X] tokens from spawning altogether. You can use [SELECT_ENTITY:VANILLA_ENTITY_X] followed by any number of duplicate <nowiki>[</nowiki>[[Entity token#CREATURE|CREATURE]]:VANILLA_CREATURE_X] tokens to attempt to balance the spawn rates of the existing vanilla entities with any custom multi-creature entities you may add.
* The number of unclaimed [[Entity token#START_BIOME|START_BIOME]] or [[Entity token#EXCLUSIVE_START_BIOME|EXCLUSIVE_START_BIOME]] tiles remaining in the world limits the spawn rate for an entity and allows entities to block each other's spawns. If there is no "starting" [[Biome token|biome]] space left for an entity then it will not spawn and the game will try to spawn a different entity instead. This means that, on average, an entity that can start in ALL_MAIN [[Biome token|biomes]] will spawn more frequently than one that can start only in LAKE_TROPICAL_SALTWATER [[Biome token|biomes]]. This also means that entities whose starting [[Biome token|biomes]] do not overlap will not block each other's spawns.


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

|-
| {{text anchor|BIOME_SUPPORT}}
|
* [[Biome token|biome]]
* frequency
| Controls the expansion of the civilization's territory.  The higher the number is relative to other BIOME_SUPPORT tokens in the entity, the faster it can spread through the biome.  These numbers are evaluated relative to each other, i.e. if one biome is 1 and the other is 2, the spread will be the same as if one was 100 and the other was 200.  Civs can spread out over biomes they cannot actually build in; for example, humans spread quickly over oceans but cannot actually build in them.
[BIOME_SUPPORT:ANY_GRASSLAND:4]

|-
| {{text anchor|SETTLEMENT_BIOME}}
| [[Biome token|biome]]
| If the civ's territory crosses over this biome, it can build settlements here.
[SETTLEMENT_BIOME:ANY_GRASSLAND]

|-
| {{text anchor|START_BIOME}}
| [[Biome token|biome]]
| Combination of EXCLUSIVE_START_BIOME and SETTLEMENT_BIOME; allows the civ to start in and create settlements in the biome. Note that the civ's spawn rate may be limited if all of its START or EXCLUSIVE_START biome(s) are rare in the world or have already been fully occupied by other civ spawns.
[START_BIOME:ANY_FOREST]

|-
| {{text anchor|EXCLUSIVE_START_BIOME}}
| [[Biome token|biome]]
| The birth of the civilization can occur in this biome, but cannot (necessarily) build in it. If the civ does not have SETTLEMENT_BIOME or START_BIOME for the biome in question, it will only construct a single settlement there. Note that the civ's spawn rate may be limited if all of its START or EXCLUSIVE_START biome(s) are rare in the world or have already been fully occupied by other civ spawns.
[EXCLUSIVE_START_BIOME:MOUNTAIN]

|-
| {{text anchor|DEFAULT_SITE_TYPE}}
| site type
| Valid site types are DARK_FORTRESS (π), CAVE (•), CAVE_DETAILED (Ω), TREE_CITY (î), and CITY (#). Also recognizes PLAYER_FORTRESS  (creates a civ of hillocks only), and MONUMENT (creates a civ without visible sites (except tombs and castles), but may cause worldgen crashes). FORTRESS is no longer a valid entry, castles are currently controlled by BUILDS_OUTDOOR_FORTIFICATIONS. Defaults to CITY. Selecting CAVE causes the classic kobold behavior of not showing up on the "neighbors" section of the site selection screen. Selecting DARK_FORTRESS also allows generation of [[underworld spire|certain other structures]]. It also gives the civ a [[demon|special overlord]].
CAVE_DETAILED civilizations will create fortresses in mountainous regions and hillocks in non-mountainous regions. [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:10000]

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

|-
| {{text anchor|MAX_STARTING_CIV_NUMBER}}
| number
| Max number of civ to spawn at world generation. Worldgen picks entities in some sequential order from the raws, and 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 the 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:100]

|}

== 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 allows 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 [[cv:coin|coin]].  Due to the [[Dwarven economy]] having been disabled since version 0.31, the value doesn't actually do anything.
[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<br />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<br />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 these 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. Migrants will sometimes arrive with no name.
* 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
* [[language#language_SYM.txt|symbol]]
| ALL, REMAINING, BATTLE, BRIDGE, CIV, CRAFT_GUILD, FESTIVAL, LIBRARY, MERCHANT_COMPANY, MILITARY_UNIT, OTHER, RELIGION, ROAD, SIEGE, SITE, TEMPLE, TUNNEL, VESSEL, WALL, WAR
Causes the entity to more often use these symbols in the particular SYM set. REMAINING will select all symbols that have not already been declared above it.

[SELECT_SYMBOL:ALL:PEACE]

|-
| {{text anchor|SUBSELECT_SYMBOL}}
|
* noun
* [[language#language_SYM.txt|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
* [[Language#language_SYM.txt|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#Available_spheres|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 civs of this entity will never get FIRE as a religious sphere. Note that the DEATH sphere favours the appearance of necromancers (and therefore, towers) "in" the entity.

[RELIGION_SPHERE:FORTRESSES]

|-
| {{text anchor|SPHERE_ALIGNMENT}}
|
* [[Sphere#Available_spheres|sphere]]
* 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. Default is 256, minimum is 0, maximum is 25600.

[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. As of version 0.44.11, however, this is obsolete due to the changes in how sites are elevated in status.

|-
| {{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 (complete anathema) to 0 (neutral) to 50 (highly valued).
[VALUE:CRAFTSMANSHIP:50]

Certain values must be set to 15 or more for civs to create structures and form entities during history gen:
* 15+ KNOWLEDGE for libraries
* 15+ COOPERATION ''and'' 15+ CRAFTSMANSHIP for craft guilds
** Guilds also need guild-valid professions (see [[#PERMITTED_JOB|PERMITTED_JOB]])

|-
| {{text anchor|VARIABLE_VALUE}}
|
*value or ALL
*min
*max
| Makes values randomized rather than specified.
This tag overrides the VALUE tag. Using [VARIABLE_VALUE:ALL:x:y] and then overwriting single values with further [VARIABLE_VALUE:value:x:y] tags works.

|-
| {{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, which 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.

Mercenaries and monster hunters from the civ may visit player's fortress and petition for residency there to enlist in the military or hunt monsters in caverns, respectively.

|-
| {{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. Additionally, this token determines if the entity can settle in savage biomes.

|-
| {{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. Also causes this civ to be hostile to any entity without this token.

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. 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|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}}
|
| Merchants will engage in cross-civ trading and form companies.

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 this be fulfilled as well as at least one other non-siege trigger before visiting for non-siege activities.

|-
| {{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|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.  Prevents the civ from engaging in diplomacy or ending up at war.

|-
| {{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 the three caverns; cavern dweller raids due to [[agitation]] will pull from these. If you embark as this civ, you have access to pets and trees from all three layers, not only the first. 

|-
| {{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}}
|
| Makes civilizations generate the given instruments/forms.

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

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

|-
| {{text anchor|NO_ARTIFACT_CLAIMS}}
|
| Used for kobolds.

|-
| {{text anchor|MINING_UNDERWORLD_DISASTERS}}
|
| The civilization can breach the [[Underworld]] during world generation.

|}

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

|-
| {{text anchor|AMMO}}
| item token
| Used after a ranged weapon type.
[AMMO:ITEM_AMMO_BOLTS]

|-
| {{text anchor|ARMOR}}
|
* item token
* rarity
| Rarity is optional, and valid values are FORCED, COMMON, UNCOMMON, and RARE (anything else is treated as COMMON). FORCED items will be available 100% of the time, COMMON items 50%, UNCOMMON items 10%, and RARE items 1%. If certain armor types are lacking after performing one pass of randomised checks, the game will repeat random checks until an option is successfully chosen.
[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, and valid values are FORCED, COMMON, UNCOMMON, and RARE (anything else is treated as COMMON). Uses the same rarity values and methods as outlined in ARMOR.
[GLOVES:ITEM_GLOVES_GLOVES:COMMON]

|-
| {{text anchor|HELM}}
|
* item token
* rarity
| Rarity is optional, and valid values are FORCED, COMMON, UNCOMMON, and RARE (anything else is treated as COMMON). Uses the same rarity values and methods as outlined in ARMOR.
[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, and valid values are FORCED, COMMON, UNCOMMON, and RARE (anything else is treated as COMMON). Uses the same rarity values and methods as outlined in ARMOR.
[PANTS:ITEM_PANTS_PANTS:COMMON]

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

|-
| {{text anchor|SHOES}}
|
* item token
* rarity
| Rarity is optional, and valid values are FORCED, COMMON, UNCOMMON, and RARE (anything else is treated as COMMON). Uses the same rarity values and methods as outlined in ARMOR.
[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
| While this does not accept a rarity value, something similar can be achieved by having multiple variations of a weapon type with small differences and specifying each of them.{{cite forum|179547}}
[WEAPON:ITEM_WEAPON_AXE_BATTLE]

|-
| {{text anchor|USE_ANIMAL_PRODUCTS}}
|
| Allows use of 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 [[:Category:DF2014:Exotic pet|PET_EXOTIC]] will be available as a pet, pack animal (with PACK_ANIMAL), wagon puller (with WAGON_PULLER), mount (with [[:Category:DF2014:Mount|MOUNT]] or [[:Category:DF2014:Exotic mount|MOUNT_EXOTIC]]), or siege minion (with [[:Category:DF2014:War animals|TRAINABLE_WAR]] and ''without'' [[:Category:DF2014:Learns|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 [[:Category:DF2014:Mount|MOUNT]] or [[:Category:DF2014:Exotic mount|MOUNT_EXOTIC]]), and siege minions (with [[:Category:DF2014:War animals|TRAINABLE_WAR]] and ''without'' [[:Category:DF2014:Learns|CAN_LEARN]]).

|-
| {{text anchor|USE_EVIL_ANIMALS}}
|
| Without this, EVIL creatures are skipped, otherwise, evil creatures with SLOW_LEARNER or ''without'' [[:Category:DF2014:Learns|CAN_LEARN]] will be also available as pets (with PET), pack animals (with PACK_ANIMAL), wagon pullers (with WAGON_PULLER), mounts (with [[:Category:DF2014:Mount|MOUNT]] or [[:Category:DF2014:Exotic mount|MOUNT_EXOTIC]]), and siege minions (with [[:Category:DF2014:War animals|TRAINABLE_WAR]] or SLOW_LEARNER), even the normally untameable species.

|-
| {{text anchor|USE_EVIL_PLANTS}}
|
| Same as USE_EVIL_ANIMALS for all uses of plants.

|-
| {{text anchor|USE_EVIL_WOOD}}
|
| Same as USE_EVIL_ANIMALS for all uses of wood.

|-
| {{text anchor|USE_GOOD_ANIMALS}}
|
| Without this GOOD creatures are skipped, otherwise, good creatures ''without'' [[:Category:DF2014:Learns|CAN_LEARN]] will also be available as pets (with PET), pack animals (with PACK_ANIMAL), wagon pullers (with WAGON_PULLER), mounts (with [[:Category:DF2014:Mount|MOUNT]] or [[:Category:DF2014:Exotic mount|MOUNT_EXOTIC]]), and siege minions (with [[:Category:DF2014:War animals|TRAINABLE_WAR]]), even the normally untameable species.

|-
| {{text anchor|USE_GOOD_PLANTS}}
|
| Same as USE_GOOD_ANIMALS for all uses of plants.

|-
| {{text anchor|USE_GOOD_WOOD}}
|
| Same as USE_GOOD_ANIMALS 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|USE_NON_EXOTIC_PET_RACE}}
|
| Makes the civilization use all locally available non-exotic pets.

|-
| {{text anchor|COMMON_DOMESTIC_MOUNT}}
|
| Gives the civilization access to creatures with COMMON_DOMESTIC and [[:Category:DF2014:Mount|MOUNT]]. Additionally, all available (based on USE_ANY_PET_RACE, USE_CAVE_ANIMALS, USE_GOOD_ANIMALS, and USE_EVIL_ANIMALS) creature with [[:Category:DF2014:Mount|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 use of river products in the goods available for trade.

|-
| {{text anchor|OCEAN_PRODUCTS}}
|
| Allow use of ocean products (including [[amber]] and [[coral]]) in the goods 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 use of underground plant products in the goods available for trade. Lack of suitable vegetation in the caverns will cause [[World generation#Rejections|worldgen rejection]]s. According to Droseran: "Gives access to plants (structural material) and seeds. It only checks for [EDIBLE_RAW] or [EDIBLE_COOKED] on the plant's structural material. It doesn't check if the plant can be used in a reaction to produce something edible, only if it can be eaten raw or cooked. If an entity with this token is placed in a biome that doesn't have at least one of these tokens on the structural material, the map is rejected. Due to the randomness of plant selection in biomes, this can happen a lot as only about half of the vanilla plants have edible structural materials. Removing either of these tokens from plants dramatically increases map rejections."

|-
| {{text anchor|OUTDOOR_FARMING}}
|
| Allow use of outdoor plant products in the goods available for trade. Lack of suitable vegetation in this civilization's starting area will cause [[World generation#Rejections|worldgen rejection]]s. According to Droseran: "Gives access to plants (structural material) and seeds. It only checks for [EDIBLE_RAW] or [EDIBLE_COOKED] on the plant's structural material. It doesn't check if the plant can be used in a reaction to produce something edible, only if it can be eaten raw or cooked. If an entity with this token is placed in a biome that doesn't have at least one of these tokens on the structural material, the map is rejected. Due to the randomness of plant selection in biomes, this can happen a lot as only about half of the vanilla plants have edible structural materials. Removing either of these tokens from plants dramatically increases map rejections."

|-
| {{text anchor|INDOOR_GARDENS}}
|
| Allow use of underground plant growths (quarry bush leaves, in unmodded games) in the goods available for trade. According to Droseran: "Will never cause map rejections. It allows growths to be used, but doesn't care if none exist. If an entity doesn't have a farming token, they won't have seeds or plants available on embark/trade. But you can still farm in fortress mode with only this token, you just have to get the seeds manually or trading with another civ."

|-
| {{text anchor|OUTDOOR_GARDENS}}
|
| Allow use of outdoor plant growths in the goods available for trade. According to Droseran: "Will never cause map rejections. It allows growths to be used, but doesn't care if none exist. If an entity doesn't have a farming token, they won't have seeds or plants available on embark/trade. But you can still farm in fortress mode with only this token, you just have to get the seeds manually or trading with another civ."

|-
| {{text anchor|INDOOR_ORCHARDS}}
|
| Allows use of indoor tree growths in the goods available for trade. Not used in vanilla entities, as vanilla underground trees do not grow fruit. Needs INDOOR_WOOD to function. Will cause rejections, if growths are unavailable. According to Droseran: "Gives access to tree growths. It only checks for growths on trees that are [EDIBLE_RAW] or [EDIBLE_COOKED]. If an entity with this token is placed in a biome that does not have a tree with a growth with at least one of these tokens, the map is rejected."

|-
| {{text anchor|OUTDOOR_ORCHARDS}}
|
| Allows use of outdoor tree growths in the goods available for trade. Needs OUTDOOR_WOOD to function{{verify}}. According to Droseran: "Gives access to tree growths. It only checks for growths on trees that are [EDIBLE_RAW] or [EDIBLE_COOKED]. If an entity with this token is placed in a biome that does not have a tree with a growth with at least one of these tokens, the map is rejected."

|-
| {{text anchor|CLOTHING}}
|
| Civilization 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.

|-
| {{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.

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

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

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

|-
| {{text anchor|OUTDOOR_WOOD}}
|
| Allow use of 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 use of materials with [DIVINE] for clothing. Used for generated divine entities.

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

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

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

== Animal definitions ==

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

|-
| {{text anchor|ANIMAL}}
|
| Start an animal definition.

|-
| {{text anchor|ANIMAL_TOKEN}}
| [[creature token]]
| Select specific creature.

|-
| {{text anchor|ANIMAL_CASTE_TOKEN}}
| [[Caste|creature caste token]]
| Select specific creature caste (requires ANIMAL_TOKEN). Sites with animal populations will still include all castes, but only the selected ones will be used for specific roles.

|-
| {{text anchor|ANIMAL_CLASS}}
| [[Creature token#CREATURE_CLASS|creature class]]
| Select creature castes with this creature class (multiple uses allowed).

|-
| {{text anchor|ANIMAL_FORBIDDEN_CLASS}}
| [[Creature token#CREATURE_CLASS|creature class]]
| Forbid creature castes with this creature class (multiple uses allowed).

|-
| {{text anchor|ANIMAL_ALWAYS_PRESENT}}
|
| Animal will be present even if it does not naturally occur in the entity's terrain. All creatures, including [[demon]]s, night trolls and other generated ones will be used if no specific creature or class is selected. 

|-
|
* {{text anchor|ANIMAL_NEVER_MOUNT}}, {{text anchor|ANIMAL_ALWAYS_MOUNT}}
* {{text anchor|ANIMAL_NEVER_WAGON_PULLER}}, {{text anchor|ANIMAL_ALWAYS_WAGON_PULLER}}
* {{text anchor|ANIMAL_NEVER_SIEGE}}, {{text anchor|ANIMAL_ALWAYS_SIEGE}}
* {{text anchor|ANIMAL_NEVER_PET}}, {{text anchor|ANIMAL_ALWAYS_PET}}
* {{text anchor|ANIMAL_NEVER_PACK_ANIMAL}}, {{text anchor|ANIMAL_ALWAYS_PACK_ANIMAL}} (doesn't seem to exist in the string dump. verify)
|
| Override creature usage tokens. Respectively:
* [[Creature token#MOUNT|MOUNT]] and [[Creature token#MOUNT_EXOTIC|MOUNT_EXOTIC]]
* [[Creature token#WAGON_PULLER|WAGON_PULLER]]
* [[Creature token#TRAINABLE_WAR|TRAINABLE_WAR]] and not [[Creature token#CAN_LEARN|CAN_LEARN]]
* [[Creature token#PET|PET]] and [[Creature token#PET_EXOTIC|PET_EXOTIC]]
* [[Creature token#PACK_ANIMAL|PACK_ANIMAL]]
ALWAYS overrides NEVER if a caste is matched by more than one animal definition.

|}

== Tissue styling-related tokens ==
{| {{prettytable}}
|- bgcolor="#ddd"
! Token
! Arguments
! Description

|-
| {{text anchor|TISSUE_STYLE}}
| tissue style unit ID
| Select a tissue layer which has the ID attached using TISSUE_STYLE_UNIT token in unit raws. This allows setting further cultural style parameters for the 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.

|}

== Examples ==
:''Main articles: [[Entity examples]]''

{{Category|Modding}}
{{Category|Tokens}}
[[ru:Entity token]]
@@ Line 417: / Line 417: @@
 |
 | 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}}
@@ Line 487: / Line 482: @@
 |
 | 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.
 |-