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 "23a:Entity token"

From Dwarf Fortress Wiki
Jump to navigation Jump to search
(Created page with '{{av}} These {{L|tokens}} define entities, or {{L|Civilization|civilization}}s, in entity_*.txt files. == Gameplay == {| {{prettytable}} |- bgcolor="#ddd" ! Token ! Arguments !…')
 
 
(21 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{av}}
+
{{quality|Exceptional|21:11, 30 March 2011 (UTC)}}{{av}}
These {{L|tokens}} define entities, or {{L|Civilization|civilization}}s, in entity_*.txt files.
+
These [[tokens]] define entities, or [[Civilization|civilization]]s, in entity_*.txt files.
  
  
Line 39: Line 39:
 
| MOUNTAIN_SETTLEMENTS
 
| MOUNTAIN_SETTLEMENTS
 
|
 
|
| Causes sites to be placed adjacent to mountains.
+
| Causes sites to be placed adjacent to mountains. Also specifies Dwarven-style caravans.
  
 
|-
 
|-
 
| FOREST_SETTLEMENTS
 
| FOREST_SETTLEMENTS
 
|  
 
|  
| Causes sites to be placed in forests.
+
| Causes sites to be placed in forests. Also specifies Elven-style caravans and diplomats.
  
 
|-
 
|-
 
| PLAINS_SETTLEMENTS
 
| PLAINS_SETTLEMENTS
 
|  
 
|  
| Causes sites to be placed in plains.
+
| Causes sites to be placed in plains. Also specifies Human-style caravans and diplomats.
 
 
 
|}
 
|}
 
  
 
== Flavor ==
 
== Flavor ==
Line 82: Line 80:
  
 
|-
 
|-
| CULL_SYMBOL
+
| SELECT_SYMBOL
 
|
 
|
 
* noun
 
* noun
 
* symbol
 
* symbol
| ALL
+
| ALL, CIV, SITE
Causes the entity to not use the words in these SYM sets.
+
Causes the entity to more often use these symbols in the particular SYM set.
[CULL_SYMBOL:ALL:UGLY]
+
[SELECT_SYMBOL:ALL:PEACE]
  
 
|-
 
|-
| SELECT_SYMBOL
+
| CULL_SYMBOL
 
|
 
|
 
* noun
 
* noun
 
* symbol
 
* symbol
| Causes the entity to more often use these symbols in the particular SYM set.
+
| Causes the entity to not use the words in these SYM sets.
[SELECT_SYMBOL:ALL:PEACE]
+
[CULL_SYMBOL:ALL:UGLY]
 
 
|-
 
| METAL_PREF
 
|
 
| Causes the entity to use only {{L|iron}} for weapons and armor. Without this token, the entity will randomly use {{L|copper}}, {{L|bronze}}, and {{L|iron}}.
 
 
 
|-
 
| STONE_PREF
 
|
 
|
 
 
 
|-
 
| WOOD_PREF
 
|
 
| Causes members to use wooden armor, shields, and weapons, as elves do.
 
 
 
|-
 
| GEM_PREF
 
|
 
|
 
  
 
|}
 
|}
Line 130: Line 108:
 
| AMBUSHER
 
| 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.
+
| Sends bowmen that sneak around and shoot at straggling members of your society, possibly also accompanied by a [[Druid]].
  
 
|-
 
|-
 
| BABYSNATCHER
 
| BABYSNATCHER
 
|
 
|
| Sends thieves to steal babies. May also cause sieges as population increases.
+
| Sends thieves to steal babies. Also causes sieges as population increases.
  
 
|-
 
|-
Line 145: Line 123:
 
| SIEGER
 
| SIEGER
 
|
 
|
| Will wait around at the edge of your map for a month or two, before charging.  
+
| When attacking, will start campfires and wait around at the edge of your map for up to a year.
 
 
 
|}
 
|}
  
Line 159: Line 136:
 
| AMMO
 
| AMMO
 
| item token
 
| item token
|  
+
| Allows the civilization to produce the specified type of ammo.
 
[AMMO:ITEM_AMMO_BOLTS]
 
[AMMO:ITEM_AMMO_BOLTS]
  
Line 167: Line 144:
 
* item token
 
* item token
 
* rarity
 
* rarity
| Rarity is optional.
+
| Allows the civilization to produce the specified type of armor. Permitted rarity values are RARE and UNCOMMON (anything else is treated as COMMON).
 
[ARMOR:ITEM_ARMOR_PLATEMAIL:COMMON]
 
[ARMOR:ITEM_ARMOR_PLATEMAIL:COMMON]
  
Line 173: Line 150:
 
| DIGGER
 
| DIGGER
 
| item token
 
| item token
|  
+
| Allows the civilization to produce the specified type of digging implement.
 
[DIGGER:ITEM_WEAPON_PICK]
 
[DIGGER:ITEM_WEAPON_PICK]
  
Line 181: Line 158:
 
* item token
 
* item token
 
* rarity
 
* rarity
| Rarity is optional.
+
| Allows the civilization to produce the specified type of handwear. Permitted rarity values are RARE and UNCOMMON (anything else is treated as COMMON).
 
[GLOVES:ITEM_GLOVES_GLOVES:COMMON]
 
[GLOVES:ITEM_GLOVES_GLOVES:COMMON]
  
Line 189: Line 166:
 
* item token
 
* item token
 
* rarity
 
* rarity
| Rarity is optional.
+
| Allows the civilization to produce the specified type of headgear. Permitted rarity values are RARE and UNCOMMON (anything else is treated as COMMON).
 
[HELM:ITEM_HELM_HELM:COMMON]
 
[HELM:ITEM_HELM_HELM:COMMON]
  
Line 195: Line 172:
 
| INSTRUMENT
 
| INSTRUMENT
 
| item token
 
| item token
|  
+
| Allows the civilization to produce the specified musical instrument.
 
[INSTRUMENT:ITEM_INSTRUMENT_FLUTE]
 
[INSTRUMENT:ITEM_INSTRUMENT_FLUTE]
  
Line 203: Line 180:
 
* item token
 
* item token
 
* rarity
 
* rarity
| Rarity is optional.
+
| Allows the civilization to produce the specified type of legwear. Permitted rarity values are RARE and UNCOMMON (anything else is treated as COMMON).
 
[PANTS:ITEM_PANTS_PANTS:COMMON]
 
[PANTS:ITEM_PANTS_PANTS:COMMON]
  
Line 209: Line 186:
 
| SHIELD
 
| SHIELD
 
| item token
 
| item token
|  
+
| Allows the civilization to produce the specified type of shield.
 
[SHIELD:ITEM_SHIELD_SHIELD]
 
[SHIELD:ITEM_SHIELD_SHIELD]
  
Line 217: Line 194:
 
* item token
 
* item token
 
* rarity
 
* rarity
| Rarity is optional.
+
| Allows the civilization to produce the specified type of footwear. Permitted rarity values are RARE and UNCOMMON (anything else is treated as COMMON).
 
[SHOES:ITEM_SHOES_SHOES:COMMON]
 
[SHOES:ITEM_SHOES_SHOES:COMMON]
  
Line 223: Line 200:
 
| SIEGEAMMO
 
| SIEGEAMMO
 
| item token
 
| item token
|  
+
| Allows the civilization to produce the specified type of siege engine ammunition. In practice, this is always ballista bolts.
 
[SIEGEAMMO:ITEM_SIEGEAMMO_BALLISTA]
 
[SIEGEAMMO:ITEM_SIEGEAMMO_BALLISTA]
  
Line 229: Line 206:
 
| TOY
 
| TOY
 
| item token
 
| item token
|  
+
| Allows the civilization to produce the specified toy.
 
[TOY:ITEM_TOY_PUZZLEBOX]
 
[TOY:ITEM_TOY_PUZZLEBOX]
  
Line 235: Line 212:
 
| TRAPCOMP
 
| TRAPCOMP
 
| item token
 
| item token
|  
+
| Allows the civilization to produce the specified trap component.
 
[TRAPCOMP:ITEM_TRAPCOMP_GIANTAXEBLADE]
 
[TRAPCOMP:ITEM_TRAPCOMP_GIANTAXEBLADE]
  
Line 241: Line 218:
 
| WEAPON
 
| WEAPON
 
| item token
 
| item token
|  
+
| Allows the civilization to produce the specified weapon.
 
[WEAPON:ITEM_WEAPON_AXE_BATTLE]
 
[WEAPON:ITEM_WEAPON_AXE_BATTLE]
  
Line 247: Line 224:
 
| USE_ANIMAL_PRODUCTS
 
| USE_ANIMAL_PRODUCTS
 
|
 
|
|
+
| Allows the civilization to use and trade animal products - meat, fish, and leather.
  
 
|-
 
|-
Line 257: Line 234:
 
| USE_EVIL_ANIMALS
 
| USE_EVIL_ANIMALS
 
|
 
|
| Don't have it -> EVIL creatures skipped.
+
| Don't have it -> EVIL creatures skipped. This token also allows evil non-intelligent [[cave river]] and [[chasm]] creatures (such as [[troll]]s) to be used as minions during sieges.
  
 
|-
 
|-
 
| COMMON_DOMESTIC_MOUNT
 
| COMMON_DOMESTIC_MOUNT
 
|
 
|
| If a creature has PET and the relevant COMMON_DOMESTIC_x tag (or COMMON_DOMESTIC for pets), it will be allowed if it passes the other checks.
+
| If a creature has MOUNT and the relevant COMMON_DOMESTIC_x tag (or COMMON_DOMESTIC for pets), it will be allowed if it passes the other checks.
  
 
|-
 
|-
 
| COMMON_DOMESTIC_PACK
 
| COMMON_DOMESTIC_PACK
 
|
 
|
| If a creature has PET and the relevant COMMON_DOMESTIC_x tag (or COMMON_DOMESTIC for pets), it will be allowed if it passes the other checks.
+
| If a creature has PACK_ANIMAL and the relevant COMMON_DOMESTIC_x tag (or COMMON_DOMESTIC for pets), it will be allowed if it passes the other checks.
  
 
|-
 
|-
Line 277: Line 254:
 
| COMMON_DOMESTIC_PULL
 
| COMMON_DOMESTIC_PULL
 
|
 
|
| If a creature has PET and the relevant COMMON_DOMESTIC_x tag (or COMMON_DOMESTIC for pets), it will be allowed if it passes the other checks.
+
| If a creature has WAGON_PULLER and the relevant COMMON_DOMESTIC_x tag (or COMMON_DOMESTIC for pets), it will be allowed if it passes the other checks.
  
 
|-
 
|-
 
| RIVER_PRODUCTS
 
| RIVER_PRODUCTS
 
|
 
|
| Allow civ to use river products in the goods it has available for trade.
+
| Allow civ to use river products (including [[jade]]) in the goods it has available for trade.
  
 
|-
 
|-
 
| OCEAN_PRODUCTS
 
| OCEAN_PRODUCTS
 
|
 
|
| Allow civ to use ocean products in the goods it has available for trade.
+
| Allow civ to use ocean products (including [[amber]] and [[coral]]) in the goods it has available for trade.
  
 
|-
 
|-
Line 307: Line 284:
 
| SUBTERRANEAN_CLOTHING
 
| SUBTERRANEAN_CLOTHING
 
|
 
|
| Will wear things made of spider silk and other subterranean materials.  
+
| Civ members will wear things made of spider silk and other subterranean materials.
 +
 
 +
|-
 +
| METAL_PREF
 +
|
 +
| Gives the entity access to most types of metals (excluding steel and adamantine) and allows it to use them for cages, crafts, and decorations. Also allows the entity to use [[iron]] for weapons and armor.
  
 
|-
 
|-
 
| MINOR_METAL
 
| MINOR_METAL
 
|
 
|
| Will always use {{L|copper}}.
+
| Allows the entity to use [[copper]] for weapons and armor.
 +
 
 +
|-
 +
| STONE_PREF
 +
|
 +
| Gives the entity access to all types of stone and allows it to use them for crafts and decorations.
 +
 
 +
|-
 +
| WOOD_PREF
 +
|
 +
| Makes the entity use [[wood]] for weapons, armor, and cages. If not specified, the entity randomly gains access to [[iron]], [[bronze]], or [[copper]] for weapons and armor (in addition to anything granted by [METAL_PREF] or [MINOR_METAL]).
 +
 
 +
|-
 +
| GEM_PREF
 +
|
 +
| Gives the entity access to all types of gems and allows it to use them for crafts and decorations.
  
 
|}
 
|}
  
[[Category:Modding]]
+
==Site Type==
[[Category:Tokens]]
+
Site types are determined in several different ways:
 +
* Entities with [NUISANCE] will live in Caves
 +
* Entities with [BABYSNATCHER] will live in Dark Fortresses
 +
* Entities with [CIV_CONTROLLABLE] will live in Mountain Halls
 +
* Entities with [FOREST_SETTLEMENTS] will live in Forest Retreats
 +
* All other entities will live in Towns.
 +
 
 +
{{Category|Modding}}
 +
{{Category|Tokens}}

Latest revision as of 14:47, 5 June 2014

This article is about an older version of DF.

These tokens define entities, or civilizations, in entity_*.txt files.


Gameplay[edit]

Token Arguments Description
INDIV_CONTROLLABLE Allows the "Play Now!" option adventure mode.
CIV_CONTROLLABLE Allows fortress mode.
CREATURE creature The type of creature that will inhabit the civilization. Multiple entries will be chosen from at random for each civilization.

[CREATURE:DWARF]

Placement[edit]

Token Arguments Description
MOUNTAIN_SETTLEMENTS Causes sites to be placed adjacent to mountains. Also specifies Dwarven-style caravans.
FOREST_SETTLEMENTS Causes sites to be placed in forests. Also specifies Elven-style caravans and diplomats.
PLAINS_SETTLEMENTS Causes sites to be placed in plains. Also specifies Human-style caravans and diplomats.

Flavor[edit]

Token Arguments Description
CURRENCY_BY_YEAR Causes the civ's currency to be numbered with the year it was minted.
CURRENCY
  • metal token
  • value
What kind of metals the civ uses for coin minting as well as the value of the coin.

[CURRENCY:SILVER:5]

TRANSLATION language What language raw the entity uses.
  • If an entity lacks this tag, translations appear to be drawn randomly from all translation files[Verify].

[TRANSLATION:DWARF]

SELECT_SYMBOL
  • noun
  • symbol
ALL, CIV, SITE

Causes the entity to more often use these symbols in the particular SYM set. [SELECT_SYMBOL:ALL:PEACE]

CULL_SYMBOL
  • noun
  • symbol
Causes the entity to not use the words in these SYM sets.

[CULL_SYMBOL:ALL:UGLY]

Behavior[edit]

Token Arguments Description
AMBUSHER Sends bowmen that sneak around and shoot at straggling members of your society, possibly also accompanied by a Druid.
BABYSNATCHER Sends thieves to steal babies. Also causes sieges as population increases.
NUISANCE Sends thieves to steal items. Also makes the severity of attacks depend on the extent of thievery rather than the passage of time.
SIEGER When attacking, will start campfires and wait around at the edge of your map for up to a year.

Items and Animals Used[edit]

Token Arguments Description
AMMO item token Allows the civilization to produce the specified type of ammo.

[AMMO:ITEM_AMMO_BOLTS]

ARMOR
  • item token
  • rarity
Allows the civilization to produce the specified type of armor. Permitted rarity values are RARE and UNCOMMON (anything else is treated as COMMON).

[ARMOR:ITEM_ARMOR_PLATEMAIL:COMMON]

DIGGER item token Allows the civilization to produce the specified type of digging implement.

[DIGGER:ITEM_WEAPON_PICK]

GLOVES
  • item token
  • rarity
Allows the civilization to produce the specified type of handwear. Permitted rarity values are RARE and UNCOMMON (anything else is treated as COMMON).

[GLOVES:ITEM_GLOVES_GLOVES:COMMON]

HELM
  • item token
  • rarity
Allows the civilization to produce the specified type of headgear. Permitted rarity values are RARE and UNCOMMON (anything else is treated as COMMON).

[HELM:ITEM_HELM_HELM:COMMON]

INSTRUMENT item token Allows the civilization to produce the specified musical instrument.

[INSTRUMENT:ITEM_INSTRUMENT_FLUTE]

PANTS
  • item token
  • rarity
Allows the civilization to produce the specified type of legwear. Permitted rarity values are RARE and UNCOMMON (anything else is treated as COMMON).

[PANTS:ITEM_PANTS_PANTS:COMMON]

SHIELD item token Allows the civilization to produce the specified type of shield.

[SHIELD:ITEM_SHIELD_SHIELD]

SHOES
  • item token
  • rarity
Allows the civilization to produce the specified type of footwear. Permitted rarity values are RARE and UNCOMMON (anything else is treated as COMMON).

[SHOES:ITEM_SHOES_SHOES:COMMON]

SIEGEAMMO item token Allows the civilization to produce the specified type of siege engine ammunition. In practice, this is always ballista bolts.

[SIEGEAMMO:ITEM_SIEGEAMMO_BALLISTA]

TOY item token Allows the civilization to produce the specified toy.

[TOY:ITEM_TOY_PUZZLEBOX]

TRAPCOMP item token Allows the civilization to produce the specified trap component.

[TRAPCOMP:ITEM_TRAPCOMP_GIANTAXEBLADE]

WEAPON item token Allows the civilization to produce the specified weapon.

[WEAPON:ITEM_WEAPON_AXE_BATTLE]

USE_ANIMAL_PRODUCTS Allows the civilization to use and trade animal products - meat, fish, and leather.
USE_CAVE_ANIMALS If they don't have it, creatures with exclusively subterranean biomes are skipped.
USE_EVIL_ANIMALS Don't have it -> EVIL creatures skipped. This token also allows evil non-intelligent cave river and chasm creatures (such as trolls) to be used as minions during sieges.
COMMON_DOMESTIC_MOUNT If a creature has MOUNT and the relevant COMMON_DOMESTIC_x tag (or COMMON_DOMESTIC for pets), it will be allowed if it passes the other checks.
COMMON_DOMESTIC_PACK If a creature has PACK_ANIMAL and the relevant COMMON_DOMESTIC_x tag (or COMMON_DOMESTIC for pets), it will be allowed if it passes the other checks.
COMMON_DOMESTIC_PET If a creature has PET and the relevant COMMON_DOMESTIC_x tag (or COMMON_DOMESTIC for pets), it will be allowed if it passes the other checks.
COMMON_DOMESTIC_PULL If a creature has WAGON_PULLER and the relevant COMMON_DOMESTIC_x tag (or COMMON_DOMESTIC for pets), it will be allowed if it passes the other checks.
RIVER_PRODUCTS Allow civ to use river products (including jade) in the goods it has available for trade.
OCEAN_PRODUCTS Allow civ to use ocean products (including amber and coral) in the goods it has available for trade.
INDOOR_FARMING Allow civ to use underground plant products in the goods it has available for trade.
OUTDOOR_FARMING Allow civ to use outdoor plant products in the goods it has available for trade.
CLOTHING Civ members will attempt to wear clothing.
SUBTERRANEAN_CLOTHING Civ members will wear things made of spider silk and other subterranean materials.
METAL_PREF Gives the entity access to most types of metals (excluding steel and adamantine) and allows it to use them for cages, crafts, and decorations. Also allows the entity to use iron for weapons and armor.
MINOR_METAL Allows the entity to use copper for weapons and armor.
STONE_PREF Gives the entity access to all types of stone and allows it to use them for crafts and decorations.
WOOD_PREF Makes the entity use wood for weapons, armor, and cages. If not specified, the entity randomly gains access to iron, bronze, or copper for weapons and armor (in addition to anything granted by [METAL_PREF] or [MINOR_METAL]).
GEM_PREF Gives the entity access to all types of gems and allows it to use them for crafts and decorations.

Site Type[edit]

Site types are determined in several different ways:

  • Entities with [NUISANCE] will live in Caves
  • Entities with [BABYSNATCHER] will live in Dark Fortresses
  • Entities with [CIV_CONTROLLABLE] will live in Mountain Halls
  • Entities with [FOREST_SETTLEMENTS] will live in Forest Retreats
  • All other entities will live in Towns.