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

From Dwarf Fortress Wiki
Jump to navigation Jump to search
m (Removing {{migrated article}})
(→‎Tokens: Hyperlinks)
 
(31 intermediate revisions by 22 users not shown)
Line 1: Line 1:
−
{{quality|unrated}}{{av}}
+
{{Quality|Superior}}
 +
{{av}}
 +
{{Modding}}
  
 +
{{clear}}
 +
 +
==Tokens==
 
{| {{prettytable}}
 
{| {{prettytable}}
 
|- bgcolor="#999999"
 
|- bgcolor="#999999"
Line 8: Line 13:
  
 
|-
 
|-
−
| NAME
+
| {{text anchor|NAME}}
 
|  
 
|  
 
*singular
 
*singular
 
*plural
 
*plural
−
| Name of the tool. <font color="red">Required</font>.
+
| Name of the tool. <font color="red">Required.</font>
 +
 
 +
|-
 +
| {{text anchor|BONE_MAT}}
 +
|
 +
| Permits the tool to be made from any [[bone]]. Default jobs for [[bone]] tools can only be performed by work order. {{bug|12689}}
 +
 
 +
|-
 +
| {{text anchor|CERAMIC_MAT}}
 +
|
 +
| Permits the tool to be made from any material that {{token|IS_CERAMIC|md}}.
 +
 
 +
|-
 +
| {{text anchor|DESCRIPTION}}
 +
|
 +
| Allows a string to describe the tool when {{key|v}}iewed. The text box can accommodate up to 325 characters until it cuts off, but the spacing of actual sentences puts the realistic limit closer to 300.  Multiple DESCRIPTION tokens can be used in the same tool definition, with each appearing on a new line.
 +
 
 +
|-
 +
| {{text anchor|GLASS_MAT}}
 +
|
 +
| Permits the tool to be made from any [[glass]].
 +
 
 +
|-
 +
| {{text anchor|HARD_MAT}}
 +
|
 +
| Permits the tool to be made from anything with the {{token|ITEMS_HARD|md}} token, such as [[wood]], [[stone]] or [[metal]].
 +
 
 +
|-
 +
| {{text anchor|LEATHER_MAT}}
 +
|
 +
| Permits the tool to be made from any [[leather]].
 +
 
 +
|-
 +
| {{text anchor|METAL_MAT}}
 +
|
 +
| Permits the tool to be made from anything with the {{token|IS_METAL|md}} token.
 +
 
 +
|-
 +
| {{text anchor|METAL_WEAPON_MAT}}
 +
|
 +
| Permits the tool to be made from any [[metal]] with the {{token|ITEMS_WEAPON|md}} token.
 +
 
 +
|-
 +
| {{text anchor|SHEET_MAT}}
 +
|
 +
| Permits the tool to be made from any [[sheet]] material, such as papyrus, paper, and parchment. Connected to the PAPER_SLURRY/PAPER_PLANT reaction classes?{{verify}}
 +
 
 +
|-
 +
| {{text anchor|SHELL_MAT}}
 +
|
 +
| Permits the tool to be made from any [[shell]].
 +
 
 +
|-
 +
| {{text anchor|SILK_MAT}}
 +
|
 +
| Permits the tool to be made from any [[silk]].
 +
 
 +
|-
 +
| {{text anchor|SOFT_MAT}}
 +
|
 +
| Permits the tool to be made from any material with the {{token|ITEMS_SOFT|md}} token, such as leather or textiles.
 +
 
 +
|-
 +
| {{text anchor|STONE_MAT}}
 +
|
 +
| Permits the tool to be made from any stone. Presumably connected to the {{token|IS_STONE|md}} token.
  
 
|-
 
|-
−
| HARD_MAT
+
| {{text anchor|THREAD_PLANT_MAT}}
 
|
 
|
−
| Permits the tool to be made from any "hard" material, such as stone.
+
| Permits the tool to be made from any [[plant fiber]], such as [[pig tail]]s.
  
 
|-
 
|-
−
| METAL_MAT
+
| {{text anchor|WOOD_MAT}}
 
|
 
|
−
| Permits the tool to be made from any metal.
+
| Permits the tool to be made from any [[wood]].
  
 
|-
 
|-
−
| METAL_WEAPON_MAT
+
| {{text anchor|INCOMPLETE_ITEM}}
 
|
 
|
−
| Permits the tool to be made from any weapons-grade metal.
+
| According to Toady, "Won't be used in world gen libraries (to differentiate scrolls from quires). Also put it on bindings, rollers, instr. pieces for completeness/future use".  Used on scroll rollers, book bindings, and quires.
  
 
|-
 
|-
−
| WOOD_MAT
+
| {{text anchor|DEFAULT_IMPROVEMENT}}
 
|
 
|
−
| Permits the tool to be made from any wood.
+
*improvement type and subtype (latter only really applicable to SPECIFIC)
 +
*tool material flag like {{token|HARD_MAT|tool}} or {{token|SILK_MAT|tool}}
 +
| Items that appear in the wild come standard with this kind of improvement. Used on scrolls: [DEFAULT_IMPROVEMENT:SPECIFIC:ROLLERS:HARD_MAT]
 +
Currently bugged, the effect is also applied to everything made in-game. This causes scrolls to have two sets of rollers, for example.
  
 
|-
 
|-
−
| UNIMPROVABLE
+
| {{text anchor|UNIMPROVABLE}}
 
|
 
|
−
| Prevents the tool from being improved.  Used on honeycombs.
+
| Prevents the tool from being [[decoration|improved]].  Used on honeycombs, scroll rollers, book bindings, and quires.
  
 
|-
 
|-
−
| VALUE
+
| {{text anchor|VALUE}}
 
|
 
|
 
*num
 
*num
−
| Defines the item value of the tool. <font color="red">Required</font>.
+
| Defines the [[Value|item value]] of the tool. <font color="red">Required.</font>
  
 
|-
 
|-
−
| TILE
+
| {{text anchor|TILE}}
 
|
 
|
 
*num
 
*num
−
| Defines the tile used to represent the tool. <font color="red">Required</font>.
+
| Defines the tile used to represent the tool. <font color="red">Required.</font>
 +
 
 +
|-
 +
| {{text anchor|INVERTED_TILE}}
 +
|
 +
| The background of the tile will be colored, instead of the foreground.
 +
 
 +
|-
 +
| {{text anchor|NO_DEFAULT_JOB}}
 +
|
 +
| According to Toady, "only custom reactions are used to make this item". Found on [[scroll]]s and [[quire]]s.  
  
 
|-
 
|-
−
| TOOL_USE
+
| {{text anchor|TOOL_USE}}
 
|  
 
|  
−
*tool use, see below
+
*[[Tool token#Valid tool uses|tool use, see below]]
 
| Defines the task performed using the tool.
 
| Defines the task performed using the tool.
  
 
|-
 
|-
−
| FURNITURE
+
| {{text anchor|FURNITURE}}
 
|
 
|
−
| Allows item to be stored in a furniture stockpile.
+
| Allows item to be stored in a [[Stockpile#Furniture Storage|furniture stockpile]], and default jobs (unless disabled with {{token|NO_DEFAULT_JOB|tool}}) are considered [[furniture]]-making tasks instead of [[Finished good|crafts]].
 +
 
 +
The jobs for wood and stone will be done at the [[carpenter's workshop]] or [[stoneworker's workshop]] instead of the [[craftsdwarf's workshop]]. Likewise, the jobs for metal tools will use the [[blacksmith]] skill instead of [[metal crafter]].
  
 
|-
 
|-
−
| ADJECTIVE
+
| {{text anchor|SHAPE_CATEGORY}}
 +
|
 +
*shape category
 +
| Category of shapes to choose from for the tool as defined by the [[Descriptor shape token#CATEGORY|CATEGORY]] token in descriptor_shape_standard.txt or a custom descriptor definition.
 +
 
 +
|-
 +
| {{text anchor|USES_FACE_IMAGE_SET}}
 +
|
 +
| Used on dice.
 +
 
 +
|-
 +
| {{text anchor|ADJECTIVE}}
 
|  
 
|  
 
*adjective
 
*adjective
Line 69: Line 165:
  
 
|-
 
|-
−
| SIZE / WEIGHT
+
| {{text anchor|SIZE}} / {{text anchor|WEIGHT}}
 
|  
 
|  
 
*size
 
*size
−
| Volume of tool in mL or cubic centimeters. <font color="red">Required</font>.
+
| [[Size|Volume]] of tool in mL or cubic centimeters. <font color="red">Required.</font>
  
 
|-
 
|-
−
| CONTAINER_CAPACITY
+
| {{text anchor|CONTAINER_CAPACITY}}
 
|
 
|
 
*amount
 
*amount
−
| How much the item can contain. Defaults to 0.
+
| How much the item can [[Size#Items|contain]]. Defaults to 0.
  
 
|-
 
|-
−
| SHOOT_FORCE
+
| {{text anchor|SHOOT_FORCE}}
 
|  
 
|  
 
*value
 
*value
−
| <font color="red">Required</font> for weapons.
+
| <font color="red">Required for weapons.</font>
  
 
|-
 
|-
−
| SHOOT_MAXVEL
+
| {{text anchor|SHOOT_MAXVEL}}
 
|  
 
|  
 
*value
 
*value
−
| <font color="red">Required</font> for weapons.
+
| <font color="red">Required for weapons.</font>
  
 
|-
 
|-
−
| SKILL
+
| {{text anchor|SKILL}}
 
|  
 
|  
−
*Skill token
+
*[[Skill token]]
−
| The skill to determine effectiveness in melee with this tool. <font color="red">Required</font> for weapons.
+
| The skill to determine effectiveness in melee with this tool. <font color="red">Required for weapons.</font>
  
 
|-
 
|-
−
| RANGED
+
| {{text anchor|RANGED}}
 
|  
 
|  
−
*Skill token
+
*[[Skill token]]
 
*Ammo item token
 
*Ammo item token
 
| Makes this tool a ranged weapon that uses the specified ammo. The specified skill determines accuracy in ranged combat.
 
| Makes this tool a ranged weapon that uses the specified ammo. The specified skill determines accuracy in ranged combat.
  
 
|-
 
|-
−
| TWO_HANDED
+
| {{text anchor|TWO_HANDED}}
 
|  
 
|  
 
*size
 
*size
−
| Creatures under this size (in cm^3) must use the tool two-handed. <font color="red">Required</font> for weapons.
+
| Creatures under this size (in cm^3) must use the tool two-handed. <font color="red">Required for weapons.</font>
  
 
|-
 
|-
−
| MINIMUM_SIZE
+
| {{text anchor|MINIMUM_SIZE}}
 
|  
 
|  
 
*size
 
*size
−
| Minimum body size (in cm^3) to use the tool at all (multigrasp required until TWO_HANDED value) <font color="red">Required</font> for weapons.
+
| Minimum body size (in cm^3) to use the tool at all (multigrasp required until TWO_HANDED value) <font color="red">Required for weapons.</font>
  
 
|-
 
|-
−
| MATERIAL_SIZE
+
| {{text anchor|MATERIAL_SIZE}}
 
|  
 
|  
 
*value
 
*value
−
| Number of bar units needed for forging, as well as the amount gained from melting. <font color="red">Required</font> for weapons.
+
| Number of [[bar]] units needed for forging, as well as the amount gained from [[Melt item|melting]]. <font color="red">Required for weapons.</font>
  
 
|-
 
|-
−
| ATTACK
+
| {{text anchor|ATTACK}}
 
|  
 
|  
 
*attacktype:BLUNT or EDGE
 
*attacktype:BLUNT or EDGE
Line 133: Line 229:
 
*noun:string
 
*noun:string
 
*velocity_multiplier:value
 
*velocity_multiplier:value
−
| You can have many ATTACK tags and one will be randomly selected for each attack, with EDGE attacks 100 times more common than BLUNT attacks. <font color="red">Required</font> for weapons.
+
| You can have many ATTACK tags and one will be randomly selected for each attack, with EDGE attacks 100 times more common than BLUNT attacks. <font color="red">Required for weapons.</font>
 
|}
 
|}
  
−
Valid tool uses (and the default tools used for these tasks) are as follows:
+
{{text anchor|Valid tool uses}} (and the default tools used for these tasks) are as follows:
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|- bgcolor="#999999"
 
|- bgcolor="#999999"
Line 143: Line 239:
 
! Usage
 
! Usage
 
|-
 
|-
−
| 0 || LIQUID_COOKING || cauldron
+
| 0 || LIQUID_COOKING || cauldron || adventure mode decoration / weapon
 +
|-
 +
| 1 || LIQUID_SCOOP || ladle || adventure mode decoration / weapon
 +
|-
 +
| 2 || GRIND_POWDER_RECEPTACLE || mortar || adventure mode decoration / weapon
 +
|-
 +
| 3 || GRIND_POWDER_GRINDER || pestle || adventure mode decoration / weapon
 +
|-
 +
| 4 || MEAT_CARVING || carving knife || adventure mode decoration / weapon
 +
|-
 +
| 5 || MEAT_BONING || boning knife || adventure mode decoration / weapon
 +
|-
 +
| 6 || MEAT_SLICING || slicing knife || adventure mode decoration / weapon
 +
|-
 +
| 7 || MEAT_CLEAVING || meat cleaver || adventure mode decoration / weapon
 +
|-
 +
| 8 || HOLD_MEAT_FOR_CARVING || carving fork || adventure mode decoration / weapon
 +
|-
 +
| 9 || MEAL_CONTAINER || bowl || adventure mode decoration / weapon
 
|-
 
|-
−
| 1 || LIQUID_SCOOP || ladle
+
| 10 || LIQUID_CONTAINER || [[jug]] || can store honey or oil
 
|-
 
|-
−
| 2 || GRIND_POWDER_RECEPTACLE || mortar
+
| 11 || FOOD_STORAGE || [[large pot]] || can store beer
 
|-
 
|-
−
| 3 || GRIND_POWDER_GRINDER || pestle
+
| 12 || HIVE || [[hive]] || can make honey
 
|-
 
|-
−
| 4 || MEAT_CARVING || carving knife
+
| 13 || NEST_BOX || [[nest box]] || for your birds to lay eggs
 
|-
 
|-
−
| 5 || MEAT_BONING || boning knife
+
| 14 || SMALL_OBJECT_STORAGE || [[pouch]] || adventure mode coin purse
 
|-
 
|-
−
| 6 || MEAT_SLICING || slicing knife
+
| 15 || TRACK_CART || [[minecart]] || item hauling / weapon
 
|-
 
|-
−
| 7 || MEAT_CLEAVING || meat cleaver
+
| 16 || HEAVY_OBJECT_HAULING || [[wheelbarrow]] || allows hauling items faster
 
|-
 
|-
−
| 8 || HOLD_MEAT_FOR_CARVING || carving fork
+
| 17 || STAND_AND_WORK_ABOVE || [[stepladder]] || allows gathering fruit from trees
 
|-
 
|-
−
| 9 || MEAL_CONTAINER || bowl
+
| 18 || ROLL_UP_SHEET || scroll rollers ||  
 
|-
 
|-
−
| 10 || NEST_BOX || nest box
+
| 19 || PROTECT_FOLDED_SHEETS || book binding ||
 
|-
 
|-
−
| 11 || LIQUID_CONTAINER || jug
+
| 20 || CONTAIN_WRITING || scroll & quire ||
 
|-
 
|-
−
| 12 || FOOD_STORAGE || large pot
+
| 21 || BOOKCASE || [[bookcase]] ||
 
|-
 
|-
−
| 13 || HIVE || hive
+
| 22 || DISPLAY_OBJECT || [[pedestal]] & [[display case]] || for museums
 
|-
 
|-
−
| 14 || SMALL_OBJECT_STORAGE || pouch
+
| 23 || PLACE_OFFERING || [[altar]] || for (eventually) offering sacrifices
 
|-
 
|-
−
| 15 || TRACK_CART || minecart
+
| 24 || DIVINATION || [[dice]] ||  
 
|-
 
|-
−
| 16 || HEAVY_OBJECT_HAULING || wheelbarrow
+
| 25 || GAMES_OF_CHANCE || dice||  
  
 
|}
 
|}
Line 181: Line 295:
 
{{Category|Modding}}
 
{{Category|Modding}}
 
{{Category|Tokens}}
 
{{Category|Tokens}}
 +
[[ru:Tool token]]

Latest revision as of 18:49, 17 May 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


Tokens[edit]

Token Arguments Description
NAME
  • singular
  • plural
 Name of the tool. Required.
BONE_MAT Permits the tool to be made from any bone. Default jobs for bone tools can only be performed by work order. Bug:12689
CERAMIC_MAT Permits the tool to be made from any material that [IS_CERAMIC].
DESCRIPTION Allows a string to describe the tool when viewed. The text box can accommodate up to 325 characters until it cuts off, but the spacing of actual sentences puts the realistic limit closer to 300. Multiple DESCRIPTION tokens can be used in the same tool definition, with each appearing on a new line.
GLASS_MAT Permits the tool to be made from any glass.
HARD_MAT Permits the tool to be made from anything with the [ITEMS_HARD] token, such as wood, stone or metal.
LEATHER_MAT Permits the tool to be made from any leather.
METAL_MAT Permits the tool to be made from anything with the [IS_METAL] token.
METAL_WEAPON_MAT Permits the tool to be made from any metal with the [ITEMS_WEAPON] token.
SHEET_MAT Permits the tool to be made from any sheet material, such as papyrus, paper, and parchment. Connected to the PAPER_SLURRY/PAPER_PLANT reaction classes?[Verify]
SHELL_MAT Permits the tool to be made from any shell.
SILK_MAT Permits the tool to be made from any silk.
SOFT_MAT Permits the tool to be made from any material with the [ITEMS_SOFT] token, such as leather or textiles.
STONE_MAT Permits the tool to be made from any stone. Presumably connected to the [IS_STONE] token.
THREAD_PLANT_MAT Permits the tool to be made from any plant fiber, such as pig tails.
WOOD_MAT Permits the tool to be made from any wood.
INCOMPLETE_ITEM According to Toady, "Won't be used in world gen libraries (to differentiate scrolls from quires). Also put it on bindings, rollers, instr. pieces for completeness/future use". Used on scroll rollers, book bindings, and quires.
DEFAULT_IMPROVEMENT
  • improvement type and subtype (latter only really applicable to SPECIFIC)
  • tool material flag like [HARD_MAT] or [SILK_MAT]
 Items that appear in the wild come standard with this kind of improvement. Used on scrolls: [DEFAULT_IMPROVEMENT:SPECIFIC:ROLLERS:HARD_MAT]

Currently bugged, the effect is also applied to everything made in-game. This causes scrolls to have two sets of rollers, for example.

UNIMPROVABLE Prevents the tool from being improved. Used on honeycombs, scroll rollers, book bindings, and quires.
VALUE
  • num
 Defines the item value of the tool. Required.
TILE
  • num
 Defines the tile used to represent the tool. Required.
INVERTED_TILE The background of the tile will be colored, instead of the foreground.
NO_DEFAULT_JOB According to Toady, "only custom reactions are used to make this item". Found on scrolls and quires.
TOOL_USE Defines the task performed using the tool.
FURNITURE Allows item to be stored in a furniture stockpile, and default jobs (unless disabled with [NO_DEFAULT_JOB]) are considered furniture-making tasks instead of crafts.

The jobs for wood and stone will be done at the carpenter's workshop or stoneworker's workshop instead of the craftsdwarf's workshop. Likewise, the jobs for metal tools will use the blacksmith skill instead of metal crafter.

SHAPE_CATEGORY
  • shape category
 Category of shapes to choose from for the tool as defined by the CATEGORY token in descriptor_shape_standard.txt or a custom descriptor definition.
USES_FACE_IMAGE_SET Used on dice.
ADJECTIVE
  • adjective
 Adjective preceding the material name (e.g. "large copper dagger")
SIZE / WEIGHT
  • size
 Volume of tool in mL or cubic centimeters. Required.
CONTAINER_CAPACITY
  • amount
 How much the item can contain. Defaults to 0.
SHOOT_FORCE
  • value
 Required for weapons.
SHOOT_MAXVEL
  • value
 Required for weapons.
SKILL The skill to determine effectiveness in melee with this tool. Required for weapons.
RANGED Makes this tool a ranged weapon that uses the specified ammo. The specified skill determines accuracy in ranged combat.
TWO_HANDED
  • size
 Creatures under this size (in cm^3) must use the tool two-handed. Required for weapons.
MINIMUM_SIZE
  • size
 Minimum body size (in cm^3) to use the tool at all (multigrasp required until TWO_HANDED value) Required for weapons.
MATERIAL_SIZE
  • value
 Number of bar units needed for forging, as well as the amount gained from melting. Required for weapons.
ATTACK
  • attacktype:BLUNT or EDGE
  • contact_area:value
  • penetration_size:value
  • verb2nd:string
  • verb3rd:string
  • noun:string
  • velocity_multiplier:value
 You can have many ATTACK tags and one will be randomly selected for each attack, with EDGE attacks 100 times more common than BLUNT attacks. Required for weapons.

Valid tool uses (and the default tools used for these tasks) are as follows:

ID Token Usage
0 LIQUID_COOKING cauldron adventure mode decoration / weapon
1 LIQUID_SCOOP ladle adventure mode decoration / weapon
2 GRIND_POWDER_RECEPTACLE mortar adventure mode decoration / weapon
3 GRIND_POWDER_GRINDER pestle adventure mode decoration / weapon
4 MEAT_CARVING carving knife adventure mode decoration / weapon
5 MEAT_BONING boning knife adventure mode decoration / weapon
6 MEAT_SLICING slicing knife adventure mode decoration / weapon
7 MEAT_CLEAVING meat cleaver adventure mode decoration / weapon
8 HOLD_MEAT_FOR_CARVING carving fork adventure mode decoration / weapon
9 MEAL_CONTAINER bowl adventure mode decoration / weapon
10 LIQUID_CONTAINER jug can store honey or oil
11 FOOD_STORAGE large pot can store beer
12 HIVE hive can make honey
13 NEST_BOX nest box for your birds to lay eggs
14 SMALL_OBJECT_STORAGE pouch adventure mode coin purse
15 TRACK_CART minecart item hauling / weapon
16 HEAVY_OBJECT_HAULING wheelbarrow allows hauling items faster
17 STAND_AND_WORK_ABOVE stepladder allows gathering fruit from trees
18 ROLL_UP_SHEET scroll rollers
19 PROTECT_FOLDED_SHEETS book binding
20 CONTAIN_WRITING scroll & quire
21 BOOKCASE bookcase
22 DISPLAY_OBJECT pedestal & display case for museums
23 PLACE_OFFERING altar for (eventually) offering sacrifices
24 DIVINATION dice
25 GAMES_OF_CHANCE dice
Retrieved from "https://dwarffortresswiki.org/index.php?title=Tool_token&oldid=301526"