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 "Item token"

From Dwarf Fortress Wiki
Jump to navigation Jump to search
(→‎Standard item tokens: Added BAG item token.)
 
(4 intermediate revisions by one other user not shown)
Line 1: Line 1:
−
{{migrated article}}
+
{{Quality|Superior}}
−
{{Quality|Unrated}}
 
 
{{av}}
 
{{av}}
 
{{Modding}}
 
{{Modding}}
Line 45: Line 44:
 
| 12 || {{text anchor|GOBLET}} || NONE || [[Goblet]]s, mugs, and cups.
 
| 12 || {{text anchor|GOBLET}} || NONE || [[Goblet]]s, mugs, and cups.
 
|-
 
|-
−
| 13 || {{text anchor|INSTRUMENT}} || item_instrument.txt || Musical [[instrument]]s.
+
| 13 || {{text anchor|INSTRUMENT}} || item_instrument.txt || Musical [[instrument]]s.  There is no vanilla item_instrument.txt as all vanilla instruments are generated.
 
|-
 
|-
−
| 14 || {{text anchor|TOY}} || item_toy.txt || [[Toy]]s.
+
| 14 || {{text anchor|TOY}} || [https://github.com/DF-Wiki/DFRawFunctions/blob/master/raws/v50/item_toy.txt item_toy.txt] || [[Toy]]s.
 
|-
 
|-
 
| 15 || {{text anchor|WINDOW}} || NONE || Glass [[window]]s.
 
| 15 || {{text anchor|WINDOW}} || NONE || Glass [[window]]s.
Line 67: Line 66:
 
| 23 || {{text anchor|CORPSE}} || NONE || [[Corpse]]s. Does not have a material that can be specified for reactions, but GET_MATERIAL_FROM_REAGENT will return the "dominant" material (normally flesh).
 
| 23 || {{text anchor|CORPSE}} || NONE || [[Corpse]]s. Does not have a material that can be specified for reactions, but GET_MATERIAL_FROM_REAGENT will return the "dominant" material (normally flesh).
 
|-
 
|-
−
| 24 || {{text anchor|WEAPON}} || item_weapon.txt || [[Weapon]]s.
+
| 24 || {{text anchor|WEAPON}} || [https://github.com/DF-Wiki/DFRawFunctions/blob/master/raws/v50/item_weapon.txt item_weapon.txt] || [[Weapon]]s.
 
|-
 
|-
−
| 25 || {{text anchor|ARMOR}} || item_armor.txt || [[Armor]] and clothing worn on the upper body.
+
| 25 || {{text anchor|ARMOR}} || [https://github.com/DF-Wiki/DFRawFunctions/blob/master/raws/v50/item_armor.txt item_armor.txt] || [[Armor]] and clothing worn on the upper body.
 
|-
 
|-
−
| 26 || {{text anchor|SHOES}} || item_shoes.txt || Armor and clothing worn on the feet.
+
| 26 || {{text anchor|SHOES}} || [https://github.com/DF-Wiki/DFRawFunctions/blob/master/raws/v50/item_shoes.txt item_shoes.txt] || Armor and clothing worn on the feet.
 
|-
 
|-
−
| 27 || {{text anchor|SHIELD}} || item_shield.txt || [[Shield]]s and bucklers.
+
| 27 || {{text anchor|SHIELD}} || [https://github.com/DF-Wiki/DFRawFunctions/blob/master/raws/v50/item_shield.txt item_shield.txt] || [[Shield]]s and bucklers.
 
|-
 
|-
−
| 28 || {{text anchor|HELM}} || item_helm.txt || Armor and clothing worn on the head.
+
| 28 || {{text anchor|HELM}} || [https://github.com/DF-Wiki/DFRawFunctions/blob/master/raws/v50/item_helm.txt item_helm.txt] || Armor and clothing worn on the head.
 
|-
 
|-
−
| 29 || {{text anchor|GLOVES}} || item_gloves.txt || Armor and clothing worn on the hands.
+
| 29 || {{text anchor|GLOVES}} || [https://github.com/DF-Wiki/DFRawFunctions/blob/master/raws/v50/item_gloves.txt item_gloves.txt] || Armor and clothing worn on the hands.
 
|-
 
|-
 
| 30 || {{text anchor|BOX}} || NONE || [[Container|Chest]]s (wood), coffers (stone), and boxes (glass, default).
 
| 30 || {{text anchor|BOX}} || NONE || [[Container|Chest]]s (wood), coffers (stone), and boxes (glass, default).
Line 97: Line 96:
 
| 38 || {{text anchor|SCEPTER}} || NONE || [[Finished_goods#Crafts|Scepter]]s.
 
| 38 || {{text anchor|SCEPTER}} || NONE || [[Finished_goods#Crafts|Scepter]]s.
 
|-
 
|-
−
| 39 || {{text anchor|AMMO}} || item_ammo.txt || [[Ammunition]] for hand-held weapons.
+
| 39 || {{text anchor|AMMO}} || [https://github.com/DF-Wiki/DFRawFunctions/blob/master/raws/v50/item_ammo.txt item_ammo.txt] || [[Ammunition]] for hand-held weapons.
 
|-
 
|-
 
| 40 || {{text anchor|CROWN}} || NONE || [[Jewelry|Crown]]s.
 
| 40 || {{text anchor|CROWN}} || NONE || [[Jewelry|Crown]]s.
Line 139: Line 138:
 
| 59 || {{text anchor|TOTEM}} || NONE || Skull [[totem]]s.
 
| 59 || {{text anchor|TOTEM}} || NONE || Skull [[totem]]s.
 
|-
 
|-
−
| 60 || {{text anchor|PANTS}} || item_pants.txt || Armor and clothing worn on the legs.
+
| 60 || {{text anchor|PANTS}} || [https://github.com/DF-Wiki/DFRawFunctions/blob/master/raws/v50/item_pants.txt item_pants.txt] || Armor and clothing worn on the legs.
 
|-
 
|-
 
| 61 || {{text anchor|BACKPACK}} || NONE || [[Backpack]]s.
 
| 61 || {{text anchor|BACKPACK}} || NONE || [[Backpack]]s.
Line 149: Line 148:
 
| 64 || {{text anchor|BALLISTAPARTS}} || NONE || [[Ballista]] parts.
 
| 64 || {{text anchor|BALLISTAPARTS}} || NONE || [[Ballista]] parts.
 
|-
 
|-
−
| 65 || {{text anchor|SIEGEAMMO}} || item_siegeammo.txt || Siege engine ammunition.
+
| 65 || {{text anchor|SIEGEAMMO}} || [https://github.com/DF-Wiki/DFRawFunctions/blob/master/raws/v50/item_siegeammo.txt item_siegeammo.txt] || Siege engine ammunition.
 
|-
 
|-
 
| 66 || {{text anchor|BALLISTAARROWHEAD}} || NONE || Ballista arrow heads.
 
| 66 || {{text anchor|BALLISTAARROWHEAD}} || NONE || Ballista arrow heads.
Line 155: Line 154:
 
| 67 || {{text anchor|TRAPPARTS}} || NONE || [[Mechanism]]s.
 
| 67 || {{text anchor|TRAPPARTS}} || NONE || [[Mechanism]]s.
 
|-
 
|-
−
| 68 || {{text anchor|TRAPCOMP}} || item_trapcomp.txt || [[Trap component]]s.
+
| 68 || {{text anchor|TRAPCOMP}} || [https://github.com/DF-Wiki/DFRawFunctions/blob/master/raws/v50/item_trapcomp.txt item_trapcomp.txt] || [[Trap component]]s.
 
|-
 
|-
 
| 69 || {{text anchor|DRINK}} || NONE || [[Alcohol]]ic drinks. Standard dimension = 150.
 
| 69 || {{text anchor|DRINK}} || NONE || [[Alcohol]]ic drinks. Standard dimension = 150.
Line 163: Line 162:
 
| 71 || {{text anchor|CHEESE}} || NONE || Pieces of [[cheese]].
 
| 71 || {{text anchor|CHEESE}} || NONE || Pieces of [[cheese]].
 
|-
 
|-
−
| 72 || {{text anchor|FOOD}} || item_food.txt || [[Prepared meal]]s.
+
| 72 || {{text anchor|FOOD}} || [https://github.com/DF-Wiki/DFRawFunctions/blob/master/raws/v50/item_food.txt item_food.txt] || [[Prepared meal]]s.
 
|-
 
|-
 
| 73 || {{text anchor|LIQUID_MISC}} || NONE || Liquids such as [[water]], [[lye]], and extracts. Standard dimension = 150.
 
| 73 || {{text anchor|LIQUID_MISC}} || NONE || Liquids such as [[water]], [[lye]], and extracts. Standard dimension = 150.
Line 191: Line 190:
 
| 85 || {{text anchor|ORTHOPEDIC_CAST}} || NONE || [[Cast]]s.
 
| 85 || {{text anchor|ORTHOPEDIC_CAST}} || NONE || [[Cast]]s.
 
|-
 
|-
−
| 86 || {{text anchor|TOOL}} || item_tool.txt || [[Tool]]s.
+
| 86 || {{text anchor|TOOL}} || [https://github.com/DF-Wiki/DFRawFunctions/blob/master/raws/v50/item_tool.txt item_tool.txt] || [[Tool]]s.
 
|-
 
|-
 
| 87 || {{text anchor|SLAB}} || NONE || [[Slab]]s, memorials, and shop signs.
 
| 87 || {{text anchor|SLAB}} || NONE || [[Slab]]s, memorials, and shop signs.
 
|-
 
|-
−
| 88 || {{text anchor|EGG}} || NONE || [[Egg]]s. Material is CREATURE_ID:CASTE.
+
| 88 || {{text anchor|EGG}} || NONE || [[Egg]]s. Material is CREATURE_ID:CASTE; in reactions this currently works in PRODUCTs but not REAGENTs.
 
|-
 
|-
 
| 89 || {{text anchor|BOOK}} || NONE || [[Book]]s.
 
| 89 || {{text anchor|BOOK}} || NONE || [[Book]]s.

Latest revision as of 16:13, 2 April 2024

xTATTEREDx  · +FINE+  · *SUPERIOR*  · ≡EXCEPTIONAL≡  · ☼MASTERWORK☼
v50.14 · v0.47.05
This article is about the current version of DF.
Note that some content may still need to be updated.

Modding
Tokens
Audio · Biome · Graphics · Interaction · Mod info · Plant · Speech · Sphere · Syndrome · World
Body tokens
Body · Body detail plan · Bodygloss · Tissue
Creature tokens
Creature · Creature mannerism · Personality · Creature variation · Procedural graphics layer
Descriptor tokens
Descriptor color · Color · Descriptor pattern · Descriptor shape
Entity tokens
Entity · Ethic · Language · Value · Position
Job tokens
Building · Labor · Reaction · Skill · Unit type
Item tokens
Item type · Item definition · Ammo · Armor · Instrument · Tool · Trap component · Weapon
Material tokens
Material type · Material definition · Inorganic material definition
v · t · e


Item tokens are the first part in defining the target item in reactions, containing the item type and subtype. They determine the most basic form of the item, made more specific by material tokens. Most item tokens do not have a subtype; for these, either NO_SUBTYPE or NONE must be specified.

Nearly all items are made of a material, though several types expect a creature ID and caste ID (e.g. ANT:SOLDIER) instead.

Actually defining an item in the item raws is done with item definition tokens.

Standard item tokens[edit]

# Token Subtype Description
0 BAR NONE Bars, such as metal, fuel, or soap. Standard dimension = 150.
1 SMALLGEM NONE Cut gemstones usable in the jeweler's workshop
2 BLOCKS NONE Blocks of any kind.
3 ROUGH NONE Rough gemstones or raw glass.
4 BOULDER / STONE NONE Raw mined stone.
5 WOOD NONE Wooden logs.
6 DOOR NONE Doors and glass portals.
7 FLOODGATE NONE Floodgates.
8 BED NONE Beds.
9 CHAIR NONE Chairs and thrones.
10 CHAIN NONE Chains and ropes.
11 FLASK NONE Flasks, vials, and waterskins.
12 GOBLET NONE Goblets, mugs, and cups.
13 INSTRUMENT item_instrument.txt Musical instruments. There is no vanilla item_instrument.txt as all vanilla instruments are generated.
14 TOY item_toy.txt Toys.
15 WINDOW NONE Glass windows.
16 CAGE NONE Cages and terrariums.
17 BARREL NONE Barrels.
18 BUCKET NONE Buckets.
19 ANIMALTRAP NONE Animal traps.
20 TABLE NONE Tables.
21 COFFIN NONE Coffins, caskets, and sarcophagi.
22 STATUE NONE Statues.
23 CORPSE NONE Corpses. Does not have a material that can be specified for reactions, but GET_MATERIAL_FROM_REAGENT will return the "dominant" material (normally flesh).
24 WEAPON item_weapon.txt Weapons.
25 ARMOR item_armor.txt Armor and clothing worn on the upper body.
26 SHOES item_shoes.txt Armor and clothing worn on the feet.
27 SHIELD item_shield.txt Shields and bucklers.
28 HELM item_helm.txt Armor and clothing worn on the head.
29 GLOVES item_gloves.txt Armor and clothing worn on the hands.
30 BOX NONE Chests (wood), coffers (stone), and boxes (glass, default).
31 BAG NONE Bags (plant cloth, silk or leather).
32 BIN NONE Bins.
33 ARMORSTAND NONE Armor stands.
34 WEAPONRACK NONE Weapon racks.
35 CABINET NONE Cabinets.
36 FIGURINE NONE Figurines.
37 AMULET NONE Amulets.
38 SCEPTER NONE Scepters.
39 AMMO item_ammo.txt Ammunition for hand-held weapons.
40 CROWN NONE Crowns.
41 RING NONE Rings.
42 EARRING NONE Earrings.
43 BRACELET NONE Bracelets.
44 GEM NONE Large gems.
45 ANVIL NONE Anvils.
46 CORPSEPIECE NONE Body parts. Does not have a material that can be specified for reactions, but GET_MATERIAL_FROM_REAGENT will return the "dominant" material.
47 REMAINS NONE Dead vermin bodies. Material is CREATURE_ID:CASTE.
48 MEAT NONE Butchered meat.
49 FISH NONE Prepared fish. Material is CREATURE_ID:CASTE.
50 FISH_RAW NONE Freshly-caught fish. Material is CREATURE_ID:CASTE.
51 VERMIN NONE Live vermin. Material is CREATURE_ID:CASTE.
52 PET NONE Tame vermin. Material is CREATURE_ID:CASTE.
53 SEEDS NONE Seeds from plants.
54 PLANT NONE Plants.
55 SKIN_TANNED NONE Leather.
56 PLANT_GROWTH growth ID Plant growths. Subtype is the GROWTH's identifier within the plant raws (e.g. "LEAVES" or "FLOWERS" for most trees)
57 THREAD NONE Thread (made at the farmer's workshop), webs (collected or undisturbed), and strands extracted from suitable stones. Standard dimension = 15000.
58 CLOTH NONE Cloth made at the loom. Standard dimension = 10000.
59 TOTEM NONE Skull totems.
60 PANTS item_pants.txt Armor and clothing worn on the legs.
61 BACKPACK NONE Backpacks.
62 QUIVER NONE Quivers.
63 CATAPULTPARTS NONE Catapult parts.
64 BALLISTAPARTS NONE Ballista parts.
65 SIEGEAMMO item_siegeammo.txt Siege engine ammunition.
66 BALLISTAARROWHEAD NONE Ballista arrow heads.
67 TRAPPARTS NONE Mechanisms.
68 TRAPCOMP item_trapcomp.txt Trap components.
69 DRINK NONE Alcoholic drinks. Standard dimension = 150.
70 POWDER_MISC NONE Powders such as flour, dye, sand, or gypsum plaster. Standard dimension = 150.
71 CHEESE NONE Pieces of cheese.
72 FOOD item_food.txt Prepared meals.
73 LIQUID_MISC NONE Liquids such as water, lye, and extracts. Standard dimension = 150.
74 COIN NONE Coins.
75 GLOB NONE Fat, tallow, pastes/pressed objects, and small bits of molten rock/metal. Standard dimension = 150.
76 ROCK NONE Small rocks (usually sharpened and/or thrown in adventurer mode).
77 PIPE_SECTION NONE Pipe sections and glass tubes.
78 HATCH_COVER NONE Hatch covers.
79 GRATE NONE Grates.
80 QUERN NONE Querns.
81 MILLSTONE NONE Millstones.
82 SPLINT NONE Splints.
83 CRUTCH NONE Crutches.
84 TRACTION_BENCH NONE Traction benches.
85 ORTHOPEDIC_CAST NONE Casts.
86 TOOL item_tool.txt Tools.
87 SLAB NONE Slabs, memorials, and shop signs.
88 EGG NONE Eggs. Material is CREATURE_ID:CASTE; in reactions this currently works in PRODUCTs but not REAGENTs.
89 BOOK NONE Books.
90 SHEET NONE Sheets. Paper, papyrus, or parchment. Used for making quires and scrolls.
91 BRANCH NONE Branches plucked from trees, used for making stone axes in adventurer mode.

Special use item tokens[edit]

In several specific locations, the values below can be substituted for the item type and subtype (and be followed directly by the material token).

Token Subtype Valid Uses Description
ANY_CRAFT NONE Reaction [REAGENT] Matches FIGURINE, AMULET, SCEPTER, CROWN, RING, EARRING, or BRACELET.
ANY_RAW_MATERIAL NONE Reaction [REAGENT] Matches POWDER_MISC, BAR, BOULDER, or GLOB.
CRAFTS NONE Reaction [PRODUCT] Produces 1-3 items of any type possible to make with the specified material, normally the types FIGURINE, AMULET, SCEPTER, CROWN, RING, EARRING, or BRACELET, however GEM is also possible for some materials and there may be other possible results. The output depends entirely on the material used, and incredibly unusual materials may produce nothing at all, although most vanilla materials will produce GEMs at the very least.

Related tokens[edit]

These tokens are not Item Tokens at all, but can take the place of them in some circumstances.

Token Subtype Valid Uses Description
METAL_ORE Metal Reaction [REAGENT] Matches a BOULDER item made of a material having [METAL_ORE:<Metal>:###].

See also[edit]

Retrieved from "https://dwarffortresswiki.org/index.php?title=Item_token&oldid=298903"