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
(added text anchors for {{token}})
Line 9: Line 9:
  
 
|-
 
|-
−
| 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>
  
 
|-
 
|-
−
| BONE_MAT{{version|0.42.01}}
+
| {{text anchor|BONE_MAT}}{{version|0.42.01}}
 
|
 
|
 
| Permits the tool to be made from any bone.
 
| Permits the tool to be made from any bone.
  
 
|-
 
|-
−
| CERAMIC_MAT{{version|0.42.01}}
+
| {{text anchor|CERAMIC_MAT}}{{version|0.42.01}}
 
|
 
|
 
| Permits the tool to be made from any ceramic material.
 
| Permits the tool to be made from any ceramic material.
  
 
|-
 
|-
−
|DESCRIPTION{{version|0.42.01}}
+
| {{text anchor|DESCRIPTION}}{{version|0.42.01}}
 
|
 
|
−
| Allows a string to describe the tool when (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.
+
| 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.
  
 
|-
 
|-
−
| GLASS_MAT{{version|0.42.01}}
+
| {{text anchor|GLASS_MAT}}{{version|0.42.01}}
 
|
 
|
 
| Permits the tool to be made from any glass.
 
| Permits the tool to be made from any glass.
  
 
|-
 
|-
−
| HARD_MAT
+
| {{text anchor|HARD_MAT}}
 
|
 
|
 
| Permits the tool to be made from anything with the [ITEMS_HARD] token, such as wood, stone or metal.
 
| Permits the tool to be made from anything with the [ITEMS_HARD] token, such as wood, stone or metal.
  
 
|-
 
|-
−
| LEATHER_MAT{{version|0.42.01}}
+
| {{text anchor|LEATHER_MAT}}{{version|0.42.01}}
 
|
 
|
 
| Permits the tool to be made from any leather.
 
| Permits the tool to be made from any leather.
  
 
|-
 
|-
−
| METAL_MAT
+
| {{text anchor|METAL_MAT}}
 
|
 
|
 
| Permits the tool to be made from anything with the [IS_METAL] token.
 
| Permits the tool to be made from anything with the [IS_METAL] token.
  
 
|-
 
|-
−
| METAL_WEAPON_MAT
+
| {{text anchor|METAL_WEAPON_MAT}}
 
|
 
|
 
| Permits the tool to be made from any metal with the [ITEMS_WEAPON] token.
 
| Permits the tool to be made from any metal with the [ITEMS_WEAPON] token.
  
 
|-
 
|-
−
| SHEET_MAT{{version|0.42.01}}
+
| {{text anchor|SHEET_MAT}}{{version|0.42.01}}
 
|
 
|
−
| 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}}
+
| 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{{version|0.42.01}}
+
| {{text anchor|SHELL_MAT}}{{version|0.42.01}}
 
|
 
|
 
| Permits the tool to be made from any shell.
 
| Permits the tool to be made from any shell.
  
 
|-
 
|-
−
| SILK_MAT{{version|0.42.01}}
+
| {{text anchor|SILK_MAT}}{{version|0.42.01}}
 
|
 
|
 
| Permits the tool to be made from any silk.
 
| Permits the tool to be made from any silk.
  
 
|-
 
|-
−
| SOFT_MAT
+
| {{text anchor|SOFT_MAT}}
 
|
 
|
 
| Permits the tool to be made from any material with the [ITEMS_SOFT] token, such as leather or textiles.
 
| Permits the tool to be made from any material with the [ITEMS_SOFT] token, such as leather or textiles.
  
 
|-
 
|-
−
| STONE_MAT{{version|0.42.01}}
+
| {{text anchor|STONE_MAT}}{{version|0.42.01}}
 
|
 
|
 
| Permits the tool to be made from any stone. Presumably connected to the [IS_STONE] token.
 
| Permits the tool to be made from any stone. Presumably connected to the [IS_STONE] token.
  
 
|-
 
|-
−
| THREAD_PLANT_MAT{{version|0.42.01}}
+
| {{text anchor|THREAD_PLANT_MAT}}{{version|0.42.01}}
 
|
 
|
 
| Permits the tool to be made from any "plant fibre" material, such as pig tails.
 
| Permits the tool to be made from any "plant fibre" material, such as pig tails.
  
 
|-
 
|-
−
| WOOD_MAT
+
| {{text anchor|WOOD_MAT}}
 
|
 
|
 
| Permits the tool to be made from any wood.
 
| Permits the tool to be made from any wood.
  
 
|-
 
|-
−
| INCOMPLETE_ITEM{{version|0.42.01}}
+
| {{text anchor|INCOMPLETE_ITEM}}{{version|0.42.01}}
 
|
 
|
 
| 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.
 
| 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{{version|0.42.01}}
+
| {{text anchor|DEFAULT_IMPROVEMENT}}{{version|0.42.01}}
 
|
 
|
 
*improvement type and subtype (latter only really applicable to SPECIFIC)
 
*improvement type and subtype (latter only really applicable to SPECIFIC)
Line 104: Line 104:
  
 
|-
 
|-
−
| UNIMPROVABLE
+
| {{text anchor|UNIMPROVABLE}}
 
|
 
|
 
| Prevents the tool from being improved.  Used on honeycombs, (scroll rollers, book bindings, and quires.){{version|0.42.01}}
 
| Prevents the tool from being improved.  Used on honeycombs, (scroll rollers, book bindings, and quires.){{version|0.42.01}}
  
 
|-
 
|-
−
| VALUE
+
| {{text anchor|VALUE}}
 
|
 
|
 
*num
 
*num
−
| Defines the item value of the tool. <font color="red">Required</font>.
+
| Defines the 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>
  
 
|-
 
|-
−
| INVERTED_TILE
+
| {{text anchor|INVERTED_TILE}}
 
|
 
|
 
| The background of the tile will be colored, instead of the foreground.
 
| The background of the tile will be colored, instead of the foreground.
  
 
|-
 
|-
−
| NO_DEFAULT_JOB{{version|0.42.01}}
+
| {{text anchor|NO_DEFAULT_JOB}}{{version|0.42.01}}
 
|  
 
|  
 
| According to Toady, "only custom reactions are used to make this item". Found on scroll and quire.  
 
| According to Toady, "only custom reactions are used to make this item". Found on scroll and quire.  
  
 
|-
 
|-
−
| TOOL_USE
+
| {{text anchor|TOOL_USE}}
 
|  
 
|  
 
*tool use, see below
 
*tool use, see below
Line 137: Line 137:
  
 
|-
 
|-
−
| FURNITURE
+
| {{text anchor|FURNITURE}}
 
|
 
|
 
| Allows item to be stored in a furniture stockpile.
 
| Allows item to be stored in a furniture stockpile.
  
 
|-
 
|-
−
| ADJECTIVE
+
| {{text anchor|ADJECTIVE}}
 
|  
 
|  
 
*adjective
 
*adjective
Line 148: Line 148:
  
 
|-
 
|-
−
| SIZE / WEIGHT
+
| {{text anchor|SIZE}} / {{text anchor|WEIGHT}}
 
|  
 
|  
 
*size
 
*size
−
| Volume of tool in mL or cubic centimeters. <font color="red">Required</font>.
+
| Volume of tool in mL or cubic centimeters. <font color="red">Required.</font>
  
 
|-
 
|-
−
| CONTAINER_CAPACITY
+
| {{text anchor|CONTAINER_CAPACITY}}
 
|
 
|
 
*amount
 
*amount
Line 160: Line 160:
  
 
|-
 
|-
−
| 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
Line 185: Line 185:
  
 
|-
 
|-
−
| 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 melting. <font color="red">Required for weapons.</font>
  
 
|-
 
|-
−
| ATTACK
+
| {{text anchor|ATTACK}}
 
|  
 
|  
 
*attacktype:BLUNT or EDGE
 
*attacktype:BLUNT or EDGE
Line 212: Line 212:
 
*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>
 
|}
 
|}
  

Revision as of 16:05, 4 January 2018

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.
Token Arguments Description
NAME
  • singular
  • plural
 Name of the tool. Required.
BONE_MATv0.42.01 Permits the tool to be made from any bone.
CERAMIC_MATv0.42.01 Permits the tool to be made from any ceramic material.
DESCRIPTIONv0.42.01 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.
GLASS_MATv0.42.01 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_MATv0.42.01 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_MATv0.42.01 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_MATv0.42.01 Permits the tool to be made from any shell.
SILK_MATv0.42.01 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_MATv0.42.01 Permits the tool to be made from any stone. Presumably connected to the [IS_STONE] token.
THREAD_PLANT_MATv0.42.01 Permits the tool to be made from any "plant fibre" material, such as pig tails.
WOOD_MAT Permits the tool to be made from any wood.
INCOMPLETE_ITEMv0.42.01 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_IMPROVEMENTv0.42.01
  • 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.)v0.42.01
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_JOBv0.42.01 According to Toady, "only custom reactions are used to make this item". Found on scroll and quire.
TOOL_USE
  • tool use, see below
 Defines the task performed using the tool.
FURNITURE Allows item to be stored in a furniture stockpile.
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
  • Skill token
 The skill to determine effectiveness in melee with this tool. Required for weapons.
RANGED
  • Skill token
  • Ammo item token
 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
1 LIQUID_SCOOP ladle
2 GRIND_POWDER_RECEPTACLE mortar
3 GRIND_POWDER_GRINDER pestle
4 MEAT_CARVING carving knife
5 MEAT_BONING boning knife
6 MEAT_SLICING slicing knife
7 MEAT_CLEAVING meat cleaver
8 HOLD_MEAT_FOR_CARVING carving fork
9 MEAL_CONTAINER bowl
10 NEST_BOX nest box
11 LIQUID_CONTAINER jug
12 FOOD_STORAGE large pot
13 HIVE hive
14 SMALL_OBJECT_STORAGE pouch
15 TRACK_CART minecart
16 HEAVY_OBJECT_HAULING wheelbarrow
17 STAND_AND_WORK_ABOVE stepladder
18? ROLL_UP_SHEETv0.42.01 scroll rollersv0.42.01
19? PROTECT_FOLDED_SHEETSv0.42.01 book bindingv0.42.01
20? CONTAIN_WRITINGv0.42.01 scroll & quirev0.42.01
21? BOOKCASEv0.42.01 bookcasev0.42.01
Retrieved from "https://dwarffortresswiki.org/index.php?title=Tool_token&oldid=234604"