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.

Editing Tool token

Jump to navigation Jump to search

Warning: You are not logged in.
Your IP address will be recorded in this page's edit history.

If you are creating a redirect to the current version's page, do not use any namespace. For example: use #REDIRECT [[Cat]], not #REDIRECT [[Main:Cat]] or #REDIRECT [[cv:Cat]]. See DF:Versions for more information.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

Latest revision Your text
Line 1: Line 1:
{{Quality|Superior}}
+
{{Quality|Superior|12:23, 18 May 2015 (UTC)}}
 
{{av}}
 
{{av}}
{{Modding}}
 
  
{{clear}}
 
 
==Tokens==
 
 
{| {{prettytable}}
 
{| {{prettytable}}
 
|- bgcolor="#999999"
 
|- bgcolor="#999999"
Line 13: Line 9:
  
 
|-
 
|-
| {{text anchor|NAME}}
+
| 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}}
+
| HARD_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}}
+
| Permits the tool to be made from any "hard" material, such as stone.
  
 
|-
 
|-
| {{text anchor|SHELL_MAT}}
+
| METAL_MAT
 
|
 
|
| Permits the tool to be made from any [[shell]].
+
| Permits the tool to be made from any metal.
  
 
|-
 
|-
| {{text anchor|SILK_MAT}}
+
| METAL_WEAPON_MAT
 
|
 
|
| Permits the tool to be made from any [[silk]].
+
| Permits the tool to be made from any weapons-grade metal.
  
 
|-
 
|-
| {{text anchor|SOFT_MAT}}
+
| SOFT_MAT
 
|
 
|
| Permits the tool to be made from any material with the {{token|ITEMS_SOFT|md}} token, such as leather or textiles.
+
| Permits the tool to be made from any "soft" material, such as leather.
  
 
|-
 
|-
| {{text anchor|STONE_MAT}}
+
| WOOD_MAT
 
|
 
|
| Permits the tool to be made from any stone. Presumably connected to the {{token|IS_STONE|md}} token.
+
| Permits the tool to be made from any wood.
  
 
|-
 
|-
| {{text anchor|THREAD_PLANT_MAT}}
+
| UNIMPROVABLE
 
|
 
|
| Permits the tool to be made from any [[plant fiber]], such as [[pig tail]]s.
+
| Prevents the tool from being improved.  Used on honeycombs.
  
 
|-
 
|-
| {{text anchor|WOOD_MAT}}
+
| VALUE
|
 
| Permits the tool to be made from any [[wood]].
 
 
 
|-
 
| {{text anchor|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.
 
 
 
|-
 
| {{text anchor|DEFAULT_IMPROVEMENT}}
 
|
 
*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.
 
 
 
|-
 
| {{text anchor|UNIMPROVABLE}}
 
|
 
| Prevents the tool from being [[decoration|improved]].  Used on honeycombs, scroll rollers, book bindings, and quires.
 
 
 
|-
 
| {{text anchor|VALUE}}
 
 
|
 
|
 
*num
 
*num
| Defines the [[Value|item value]] of the tool. <font color="red">Required.</font>
+
| Defines the item value of the tool. <font color="red">Required</font>.
  
 
|-
 
|-
| {{text anchor|TILE}}
+
| 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}}
+
| 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.
  
 
|-
 
|-
| {{text anchor|NO_DEFAULT_JOB}}
+
| TOOL_USE
 
|  
 
|  
| According to Toady, "only custom reactions are used to make this item". Found on [[scroll]]s and [[quire]]s.
+
*tool use, see below
 
 
|-
 
| {{text anchor|TOOL_USE}}
 
|
 
*[[Tool token#Valid tool uses|tool use, see below]]
 
 
| Defines the task performed using the tool.
 
| Defines the task performed using the tool.
  
 
|-
 
|-
| {{text anchor|FURNITURE}}
+
| FURNITURE
 
|
 
|
| 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]].
+
| Allows item to be stored in a furniture stockpile.
 
 
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]].
 
  
 
|-
 
|-
| {{text anchor|SHAPE_CATEGORY}}
+
| ADJECTIVE
|
 
*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 165: Line 80:
  
 
|-
 
|-
| {{text anchor|SIZE}} / {{text anchor|WEIGHT}}
+
| SIZE / WEIGHT
 
|  
 
|  
 
*size
 
*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>.
  
 
|-
 
|-
| {{text anchor|CONTAINER_CAPACITY}}
+
| CONTAINER_CAPACITY
 
|
 
|
 
*amount
 
*amount
| How much the item can [[Size#Items|contain]]. Defaults to 0.
+
| How much the item can contain. Defaults to 0.
  
 
|-
 
|-
| {{text anchor|SHOOT_FORCE}}
+
| SHOOT_FORCE
 
|  
 
|  
 
*value
 
*value
| <font color="red">Required for weapons.</font>
+
| <font color="red">Required</font> for weapons.
  
 
|-
 
|-
| {{text anchor|SHOOT_MAXVEL}}
+
| SHOOT_MAXVEL
 
|  
 
|  
 
*value
 
*value
| <font color="red">Required for weapons.</font>
+
| <font color="red">Required</font> for weapons.
  
 
|-
 
|-
| {{text anchor|SKILL}}
+
| SKILL
 
|  
 
|  
*[[Skill token]]
+
*Skill token
| The skill to determine effectiveness in melee with this tool. <font color="red">Required for weapons.</font>
+
| The skill to determine effectiveness in melee with this tool. <font color="red">Required</font> for weapons.
  
 
|-
 
|-
| {{text anchor|RANGED}}
+
| 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.
  
 
|-
 
|-
| {{text anchor|TWO_HANDED}}
+
| TWO_HANDED
 
|  
 
|  
 
*size
 
*size
| Creatures under this size (in cm^3) must use the tool two-handed. <font color="red">Required for weapons.</font>
+
| Creatures under this size (in cm^3) must use the tool two-handed. <font color="red">Required</font> for weapons.
  
 
|-
 
|-
| {{text anchor|MINIMUM_SIZE}}
+
| 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 for weapons.</font>
+
| 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.
  
 
|-
 
|-
| {{text anchor|MATERIAL_SIZE}}
+
| MATERIAL_SIZE
 
|  
 
|  
 
*value
 
*value
| Number of [[bar]] units needed for forging, as well as the amount gained from [[Melt item|melting]]. <font color="red">Required for weapons.</font>
+
| Number of bar units needed for forging, as well as the amount gained from melting. <font color="red">Required</font> for weapons.
  
 
|-
 
|-
| {{text anchor|ATTACK}}
+
| ATTACK
 
|  
 
|  
 
*attacktype:BLUNT or EDGE
 
*attacktype:BLUNT or EDGE
Line 229: Line 144:
 
*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 for weapons.</font>
+
| 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.
 
|}
 
|}
  
{{text anchor|Valid tool uses}} (and the default tools used for these tasks) are as follows:
+
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 239: Line 154:
 
! Usage
 
! Usage
 
|-
 
|-
| 0 || LIQUID_COOKING || cauldron || adventure mode decoration / weapon
+
| 0 || LIQUID_COOKING || cauldron
|-
 
| 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||  
+
| 17 || STAND_AND_WORK_ABOVE || stepladder
  
 
|}
 
|}
Line 295: Line 194:
 
{{Category|Modding}}
 
{{Category|Modding}}
 
{{Category|Tokens}}
 
{{Category|Tokens}}
[[ru:Tool token]]
 

Please note that all contributions to Dwarf Fortress Wiki are considered to be released under the GFDL & MIT (see Dwarf Fortress Wiki:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!

To protect the wiki against automated edit spam, we kindly ask you to solve the following CAPTCHA:

Cancel Editing help (opens in new window)

Templates used on this page:

This page is a member of 2 hidden categories: