v50 Steam/Premium information for editors
  • v50 information can now be added to pages in the main namespace. v0.47 information can still be found in the DF2014 namespace. See here for more details on the new versioning policy.
  • Use this page to report any issues related to the migration.
This notice may be cached—the current version can be found here.

Difference between revisions of "Entity token"

From Dwarf Fortress Wiki
Jump to navigation Jump to search
 
(94 intermediate revisions by 39 users not shown)
Line 1: Line 1:
{{Quality|Exceptional|19:21, 13 October 2015 (UTC)}}
+
{{Quality|Superior}}
 
{{av}}
 
{{av}}
'''Entity tokens''' define entities, or civilizations, in entity_*.txt files.
+
{{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 ==
 
== Gameplay ==
Line 12: Line 19:
  
 
|-
 
|-
| {{text anchor|ALL_MAIN_POPS_CONTROLLABLE}}{{version|0.42.01}} / {{text anchor|ADVENTURE_TIER}}
+
| {{text anchor|ALL_MAIN_POPS_CONTROLLABLE}}
| 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]], effectively replaced by ALL_MAIN_POPS_CONTROLLABLE.
 
 
 
|-
 
| {{text anchor|INDIV_CONTROLLABLE}} / {{text anchor|OUTSIDER_CONTROLLABLE}}{{version|0.42.01}}  
 
 
|  
 
|  
| 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.
+
| Allows adventure mode for entities with sites.
 
 
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}}
+
| {{text anchor|SITE_CONTROLLABLE}}
 
|  
 
|  
| Allows fortress mode. If multiple entities have the CIV_CONTROLLABLE token, then at embark 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.
+
| 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}}
 
| {{text anchor|CREATURE}}
 
| 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.  
+
|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}}
 
| {{text anchor|SOURCE_HFID}}
| integer (or generic token?)
+
| 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]].
 
| 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]].
  
Line 45: Line 40:
  
 
== Placement ==
 
== 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}}
 
{| {{prettytable}}
Line 57: Line 59:
 
* [[Biome token|biome]]
 
* [[Biome token|biome]]
 
* frequency
 
* frequency
| Higher numbers make the entity more likely to settle there.
+
| 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]
 
[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}}
 
| {{text anchor|START_BIOME}}
 
| [[Biome token|biome]]
 
| [[Biome token|biome]]
| Birth of the civilization can be performed in this 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]
 
[START_BIOME:ANY_FOREST]
  
Line 69: Line 77:
 
| {{text anchor|EXCLUSIVE_START_BIOME}}
 
| {{text anchor|EXCLUSIVE_START_BIOME}}
 
| [[Biome token|biome]]
 
| [[Biome token|biome]]
| Birth of the civilization only occurs in this 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]
 
[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}}
 
| {{text anchor|DEFAULT_SITE_TYPE}}
 
| 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, 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]].
+
| 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]].
[DEFAULT_SITE_TYPE:CAVE_DETAILED]
+
CAVE_DETAILED civilizations will create fortresses in mountainous regions and hillocks in non-mountainous regions. [DEFAULT_SITE_TYPE:CAVE_DETAILED]
  
 
|-
 
|-
Line 119: Line 121:
 
| 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 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]
+
[MAX_POP_NUMBER:10000]
  
 
|-
 
|-
Line 125: Line 127:
 
| number  
 
| number  
 
| Max historical population per individual site. Defaults to 50.
 
| Max historical population per individual site. Defaults to 50.
[MAX_SITE_POP_NUMBER:200]
+
[MAX_SITE_POP_NUMBER:120]
  
 
|-
 
|-
 
| {{text anchor|MAX_STARTING_CIV_NUMBER}}
 
| {{text anchor|MAX_STARTING_CIV_NUMBER}}
 
| 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 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:3]
+
[MAX_STARTING_CIV_NUMBER:100]
  
 
|}
 
|}
Line 157: Line 159:
 
| {{text anchor|PERMITTED_REACTION}}
 
| {{text anchor|PERMITTED_REACTION}}
 
| reaction name  
 
| 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.
+
| 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]
 
[PERMITTED_REACTION:TAN_A_HIDE]
  
Line 170: Line 172:
 
* inorganic material
 
* inorganic material
 
* value
 
* value
| What kind of metals the civ uses for coin minting as well as the value of the coin.
+
| 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]
 
[CURRENCY:SILVER:5]
  
Line 210: Line 212:
 
| language
 
| language
 
| What language raw the entity uses.
 
| 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 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.
 
* 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]
 
[TRANSLATION:DWARF]
Line 218: Line 220:
 
|
 
|
 
* noun
 
* noun
* symbol
+
* [[language#language_SYM.txt|symbol]]
| ALL, REMAINING, BATTLE, BRIDGE, CIV, LIBRARY{{version|0.42.01}}, MILITARY_UNIT, RELIGION, ROAD, SIEGE, SITE, TEMPLE, TUNNEL, VESSEL, WALL, WAR
+
| 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.
+
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]
 
[SELECT_SYMBOL:ALL:PEACE]
  
Line 227: Line 230:
 
|
 
|
 
* noun
 
* noun
* symbol
+
* [[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.
 
| 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]
 
[SELECT_SYMBOL:SIEGE:NAME_SIEGE]
Line 236: Line 239:
 
|
 
|
 
* noun
 
* noun
* symbol
+
* [[Language#language_SYM.txt|symbol]]
 
| Causes the entity to not use the words in these SYM sets.
 
| Causes the entity to not use the words in these SYM sets.
 
[CULL_SYMBOL:ALL:UGLY]
 
[CULL_SYMBOL:ALL:UGLY]
Line 268: Line 271:
 
|-
 
|-
 
| {{text anchor|RELIGION_SPHERE}}
 
| {{text anchor|RELIGION_SPHERE}}
| 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 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.
+
| 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]
 
[RELIGION_SPHERE:FORTRESSES]
Line 276: Line 279:
 
| {{text anchor|SPHERE_ALIGNMENT}}
 
| {{text anchor|SPHERE_ALIGNMENT}}
 
|
 
|
* type
+
* [[Sphere#Available_spheres|sphere]]
 
* number
 
* 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.
+
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]
 
[SPHERE_ALIGNMENT:TREES:512]
Line 309: Line 312:
 
| {{text anchor|SITE_VARIABLE_POSITIONS}}
 
| {{text anchor|SITE_VARIABLE_POSITIONS}}
 
| Position responsibility or ALL
 
| 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}}
+
| 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}}
  
 
|-
 
|-
Line 338: Line 341:
 
*value
 
*value
 
*number
 
*number
| Sets the civ's [[personality trait|cultural values]]. Numbers range from -50 (completely anathema) to 0 (neutral) to 50 (highly valued).
+
| Sets the civ's [[personality trait|cultural values]]. Numbers range from -50 (complete anathema) to 0 (neutral) to 50 (highly valued).
 
[VALUE:CRAFTSMANSHIP:50]
 
[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}}{{version|0.42.01}}
+
| {{text anchor|VARIABLE_VALUE}}
 
|
 
|
 
*value or ALL
 
*value or ALL
Line 349: Line 357:
 
| Makes values randomized rather than specified.
 
| 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.
 
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.
 
  
 
|-
 
|-
Line 359: Line 366:
 
| {{text anchor|WANDERER}}, {{text anchor|BEAST_HUNTER}}, {{text anchor|SCOUT}}, {{text anchor|MERCENARY}}
 
| {{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.
+
| 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.
  
If the civ sends out mercenaries, they may come to the player's fort to enlist in the military.{{version|0.42.01}}
+
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.
  
 
|-
 
|-
Line 382: Line 389:
 
| {{text anchor|AT_PEACE_WITH_WILDLIFE}}
 
| {{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.
+
| 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}}
 
| {{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.
+
| 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.
 
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.
Line 394: Line 401:
 
| {{text anchor|BUILDS_OUTDOOR_FORTIFICATIONS}}
 
| {{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}}
+
| 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}}
  
 
|-
 
|-
Line 440: Line 447:
 
| {{text anchor|MERCHANT_NOBILITY}}
 
| {{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.
+
| 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}}
 
| {{text anchor|PROGRESS_TRIGGER_POPULATION}}
 
| level
 
| 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.
+
| 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.
  
 
|-
 
|-
Line 487: Line 496:
 
| {{text anchor|SKULKING}}
 
| {{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.
+
| 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}}
 
| {{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.
+
| 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}}
 
| {{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, in groups of 5-10 soldiers who will hunt down nearby cavern creatures. If you embark as this civ, you have access to pets and trees from all three layers, not only the first.  
+
| 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|UNDEAD_CANDIDATE}}
+
| {{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}}
|
 
| 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.
 
| Makes civilizations generate the given instruments/forms.
  
 
|-
 
|-
| {{text anchor|SCHOLAR}}{{version|0.42.01}}
+
| {{text anchor|SCHOLAR}}
 
| scholar type
 
| scholar type
 
| ALL, ASTRONOMER, CHEMIST, DOCTOR, ENGINEER, GEOGRAPHER, HISTORIAN, MATHEMATICIAN, NATURALIST, PHILOSOPHER
 
| ALL, ASTRONOMER, CHEMIST, DOCTOR, ENGINEER, GEOGRAPHER, HISTORIAN, MATHEMATICIAN, NATURALIST, PHILOSOPHER
  
 
|-
 
|-
| {{text anchor|SET_SCHOLARS_ON_VALUES_AND_JOBS}}{{version|0.42.01}}
+
| {{text anchor|SET_SCHOLARS_ON_VALUES_AND_JOBS}}
 
|
 
|
 
| Generates scholars based on the values generated with the VARIABLE_VALUE tag.
 
| Generates scholars based on the values generated with the VARIABLE_VALUE tag.
  
 
|-
 
|-
| {{text anchor|NO_ARTIFACT_CLAIMS}}{{version|0.44.01}}
+
| {{text anchor|NO_ARTIFACT_CLAIMS}}
 
|
 
|
 
| Used for kobolds.
 
| Used for kobolds.
 +
 +
|-
 +
| {{text anchor|MINING_UNDERWORLD_DISASTERS}}
 +
|
 +
| The civilization can breach the [[Underworld]] during world generation.
  
 
|}
 
|}
Line 536: Line 545:
 
| {{text anchor|AMMO}}
 
| {{text anchor|AMMO}}
 
| item token
 
| item token
|  
+
| Used after a ranged weapon type.
 
[AMMO:ITEM_AMMO_BOLTS]
 
[AMMO:ITEM_AMMO_BOLTS]
  
Line 544: Line 553:
 
* item token
 
* item token
 
* rarity
 
* rarity
|Rarity is optional.  Permitted rarity values are RARE, UNCOMMON, FORCED (anything else is treated as COMMON).
+
| 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]
 
[ARMOR:ITEM_ARMOR_PLATEMAIL:COMMON]
  
Line 550: Line 559:
 
| {{text anchor|DIGGER}}
 
| {{text anchor|DIGGER}}
 
| item token
 
| 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].
+
| 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]
 
[DIGGER:ITEM_WEAPON_PICK]
  
Line 558: Line 567:
 
* item token
 
* item token
 
* rarity
 
* rarity
| Rarity is optional.  Permitted rarity values are RARE, UNCOMMON, FORCED (anything else is treated as COMMON).
+
| 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]
 
[GLOVES:ITEM_GLOVES_GLOVES:COMMON]
  
Line 566: Line 575:
 
* item token
 
* item token
 
* rarity
 
* rarity
| Rarity is optional.  Permitted rarity values are RARE, UNCOMMON, FORCED (anything else is treated as COMMON).
+
| 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]
 
[HELM:ITEM_HELM_HELM:COMMON]
  
Line 580: Line 589:
 
* item token
 
* item token
 
* rarity
 
* rarity
| Rarity is optional.  Permitted rarity values are RARE, UNCOMMON, FORCED (anything else is treated as COMMON).
+
| 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]
 
[PANTS:ITEM_PANTS_PANTS:COMMON]
  
Line 586: Line 595:
 
| {{text anchor|SHIELD}}
 
| {{text anchor|SHIELD}}
 
| item token
 
| item token
|  
+
|
 
[SHIELD:ITEM_SHIELD_SHIELD]
 
[SHIELD:ITEM_SHIELD_SHIELD]
  
Line 594: Line 603:
 
* item token
 
* item token
 
* rarity
 
* rarity
| Rarity is optional.  Permitted rarity values are RARE, UNCOMMON, FORCED (anything else is treated as COMMON).
+
| 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]
 
[SHOES:ITEM_SHOES_SHOES:COMMON]
  
Line 600: Line 609:
 
| {{text anchor|SIEGEAMMO}}
 
| {{text anchor|SIEGEAMMO}}
 
| item token
 
| item token
|  
+
|
 
[SIEGEAMMO:ITEM_SIEGEAMMO_BALLISTA]
 
[SIEGEAMMO:ITEM_SIEGEAMMO_BALLISTA]
  
Line 606: Line 615:
 
| {{text anchor|TOOL}}