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 Building 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|Fine}}
+
{{Quality|Superior|21:42, 20 September 2016 (UTC)}}
 
{{av}}
 
{{av}}
−
{{Modding}}
 
  
−
'''Building tokens''' control the functionality of custom [[building]]s.
+
'''Building tokens''' control the functionality of custom buildings.
  
−
All custom buildings are defined as objects of type BUILDING_WORKSHOP or BUILDING_FURNACE; [[workshop]]s show up in the Build > Workshops ({{Menu icon|b|o}}) menu, while [[furnace]]s show up in the Build > Workshops > Furnaces ({{Menu icon|b|o|u}}) menu.
+
All custom buildings are defined as objects of type BUILDING_WORKSHOP or BUILDING_FURNACE; workshops show up in the {{K|b}}-{{K|w}} menu, while furnaces show up in the {{K|b}}-{{K|e}} menu.
  
 
You also must add any new custom buildings to the [[Entity token|civilization]] that you want to use it.
 
You also must add any new custom buildings to the [[Entity token|civilization]] that you want to use it.
  
−
Additionally, furnaces must be designed by an [[mason]] before being constructed (and will gain [[quality]] accordingly), though they will always use the labor(s) specified in the building definition, rather than ones based on the materials being used.
+
Additionally, furnaces must be designed by an [[architect]] before being constructed (and will gain [[quality]] accordingly), though they will always use the labor(s) specified in the building definition rather than ones based on the materials being used.
−
{{clear}}
 
  
 
{| {{prettytable}}
 
{| {{prettytable}}
Line 26: Line 24:
 
| {{text anchor|NAME_COLOR}}
 
| {{text anchor|NAME_COLOR}}
 
| [[Color#Modding_color|fg:bg:bright]]
 
| [[Color#Modding_color|fg:bg:bright]]
−
| The [[color]] of the building's name when {{K|q}}uerying it. Seemingly ignored for furnaces, which are hardcoded to 4:0:1.
+
| The color of the building's name when {{K|q}}uerying it. Seemingly ignored for furnaces, which are hardcoded to 4:0:1.
  
 
|-
 
|-
Line 41: Line 39:
 
| {{text anchor|BUILD_LABOR}}
 
| {{text anchor|BUILD_LABOR}}
 
| [[labor token]]
 
| [[labor token]]
−
| The labor required to construct the custom building. If multiple BUILD_LABOR tokens are specified, then any of the indicated labors can be used to construct the building; if none are specified, then no labors are required.
+
| The labor required to construct the custom building. If multiple BUILD_LABOR tokens are specified, then any of the indicated labors can be used to construct the building; if none are specified, then no labors are required.<br />For furnaces, this labor does not come into play until after the workshop has been designed by an [[architect]].
  
 
|-
 
|-
 
| {{text anchor|BUILD_KEY}}
 
| {{text anchor|BUILD_KEY}}
−
| [[Interface.txt#Key_bindings|key bind]]
+
| key token
−
| The shortcut key used in the Build menu for selecting the custom building. For example: "CUSTOM_SHIFT_S"
+
| The shortcut key used in the Build menu for selecting the custom building.
  
 
|-
 
|-
Line 69: Line 67:
 
* row
 
* row
 
* colors...
 
* colors...
−
| Specifies the [[Color|colors]] in which the custom building's tiles will be displayed. The first parameter is the building stage, the 2nd parameter is the row number, and subsequent parameters are either sets of 3 numbers (foreground:background:brightness), or the token "MAT" to use the color of the primary building material, for each tile in the row. MAT may not be available on BUILDING_FURNACEs.{{verify}} However a color settings of 4:0:1 will translate into MAT for furnaces instead.
+
| Specifies the colors in which the custom building's tiles will be displayed. The first parameter is the building stage, the 2nd parameter is the row number, and subsequent parameters are either sets of 3 numbers (foreground:background:brightness) or the token "MAT" to use the color of the primary building material. MAT may not be available on BUILDING_FURNACEs.{{verify}}
  
 
|-
 
|-
Line 83: Line 81:
 
|
 
|
 
| Specifies that one of the building's tiles (other than the WORK_LOCATION) must be hanging over [[magma]] in order for the building to function. Buildings with this token also ignore the [FUEL] token in their reactions.
 
| Specifies that one of the building's tiles (other than the WORK_LOCATION) must be hanging over [[magma]] in order for the building to function. Buildings with this token also ignore the [FUEL] token in their reactions.
−
|
 
−
 
−
|-
 
−
| {{text anchor|TOOLTIP}}
 
−
| tooltip
 
−
| Adds a tooltip for the building.
 
 
|}
 
|}
  
Line 99: Line 91:
 
! Meaning
 
! Meaning
 
|-
 
|-
−
| [{{text anchor|ANY_BONE_MATERIAL}}]
+
| [{{text anchor|REACTION_CLASS}}:X]
−
| Item material must have the [BONE] token.
+
| Item's material has a [REACTION_CLASS] token with the appropriate ID.
 
|-
 
|-
−
| [{{text anchor|ANY_HORN_MATERIAL}}]
+
| [{{text anchor|HAS_MATERIAL_REACTION_PRODUCT}}:X]
−
| Item material must have the [HORN] token.
+
| Item's material has a [MATERIAL_REACTION_PRODUCT] token with the appropriate ID.
 
|-
 
|-
−
| [{{text anchor|ANY_LEATHER_MATERIAL}}]
+
| [{{text anchor|UNROTTEN}}]
−
| Item material must have the [LEATHER] token.
+
| Item must not be rotten, mainly for organic materials.
 
|-
 
|-
−
| [{{text anchor|ANY_PEARL_MATERIAL}}]
+
| [{{text anchor|CONTAINS_LYE}}]
−
| Item material must have the [PEARL] token.
+
| Item must be a BARREL or TOOL which contains at least one item of type LIQUID_MISC made of LYE.
 
|-
 
|-
−
| [{{text anchor|ANY_PLANT_MATERIAL}}]  
+
| [{{text anchor|POTASHABLE}}]
−
| Item material must be subordinate to a PLANT object.
+
| Alias for [CONTAINS_LYE].
 
|-
 
|-
−
| [{{text anchor|ANY_SHELL_MATERIAL}}]
+
| [{{text anchor|NOT_WEB}}]
−
| Item material must have the [SHELL] token.
+
| Item must be collected (to distinguish silk thread from webs). Only makes sense for items of type THREAD.
 
|-
 
|-
−
| [{{text anchor|ANY_SILK_MATERIAL}}]  
+
| [{{text anchor|WEB_ONLY}}]
−
| Item material must have the [SILK] token.
+
| Item must be undisturbed (to distinguish silk thread from webs). Only makes sense for items of type THREAD.
 
|-
 
|-
−
| [{{text anchor|ANY_SOAP_MATERIAL}}]
+
| [{{text anchor|EMPTY}}]
−
| Item material must have the [SOAP] token.
+
| If the item is a container, it must be empty.
 
|-
 
|-
−
| [{{text anchor|ANY_STRAND_TISSUE}}]
+
| [{{text anchor|NOT_CONTAIN_BARREL_ITEM}}]
−
| Item is made of a tissue having [TISSUE_SHAPE:STRANDS], intended for matching hair and wool. Must be used with [USE_BODY_COMPONENT].
+
| If the item is a container, it must not contain [[lye]] or [[milk]]. Not necessary if specifying [EMPTY].
−
|-
 
−
| [{{text anchor|ANY_TOOTH_MATERIAL}}]
 
−
| Item material must have the [TOOTH] token.
 
−
|-
 
−
| [{{text anchor|ANY_YARN_MATERIAL}}]
 
−
| Item material must have the [YARN] token.
 
 
|-
 
|-
 
| [{{text anchor|BAG}}]
 
| [{{text anchor|BAG}}]
 
| Item must be a bag - that is, a BOX made of plant fiber, silk, yarn, or leather.
 
| Item must be a bag - that is, a BOX made of plant fiber, silk, yarn, or leather.
 +
|-
 +
| [{{text anchor|GLASS_MATERIAL}}]
 +
| Item material must have the [IS_GLASS] token. All 3 types of [[glass]] have this token hardcoded.
 
|-
 
|-
 
| [{{text anchor|BUILDMAT}}]
 
| [{{text anchor|BUILDMAT}}]
 
| Item must be a general [[building material]] - BAR, BLOCKS, BOULDER, or WOOD.
 
| Item must be a general [[building material]] - BAR, BLOCKS, BOULDER, or WOOD.
 +
|-
 +
| [{{text anchor|FIRE_BUILD_SAFE}}]
 +
| Item material must be stable at temperatures below 11000. Only works with items of type BAR, BLOCKS, BOULDER, WOOD, and ANVIL - all others are considered unsafe.
 +
|-
 +
| [{{text anchor|MAGMA_BUILD_SAFE}}]
 +
| Item material must be stable at temperatures below 12000. Only works with items of type BAR, BLOCKS, BOULDER, WOOD, and ANVIL - all others are considered unsafe.
 
|-
 
|-
 
| [{{text anchor|CAN_USE_ARTIFACT}}]
 
| [{{text anchor|CAN_USE_ARTIFACT}}]
 
| Item can be an Artifact.
 
| Item can be an Artifact.
 
|-
 
|-
−
| [{{text anchor|CONTAINS_LYE}}]
+
| [{{text anchor|WORTHLESS_STONE_ONLY}}]
−
| Item must be a BARREL or TOOL which contains at least one item of type LIQUID_MISC made of LYE.
+
| Item material must be non-[[economic]].
 
|-
 
|-
−
| [{{text anchor|EMPTY}}]
+
| [{{text anchor|ANY_PLANT_MATERIAL}}]  
−
| If the item is a container, it must be empty.
+
| Item material must be subordinate to a PLANT object.
 
|-
 
|-
−
| [{{text anchor|FIRE_BUILD_SAFE}}]
+
| [{{text anchor|ANY_SILK_MATERIAL}}]  
−
| Item material must be stable at temperatures below 11000. Only works with items of type BAR, BLOCKS, BOULDER, WOOD, and ANVIL - all others are considered unsafe.
+
| Item material must have the [SILK] token.
 
|-
 
|-
−
| [{{text anchor|GLASS_MATERIAL}}]  
+
| [{{text anchor|ANY_YARN_MATERIAL}}]  
−
| Item material must have the [IS_GLASS] token. All 3 types of [[glass]] have this token hardcoded.
+
| Item material must have the [YARN] token.
 
|-
 
|-
−
| [{{text anchor|HAS_MATERIAL_REACTION_PRODUCT}}:X]
+
| [{{text anchor|ANY_SOAP_MATERIAL}}]
−
| Item's material has a [MATERIAL_REACTION_PRODUCT] token with the appropriate ID.
+
| Item material must have the [SOAP] token.
 
|-
 
|-
−
| [{{text anchor|HAS_TOOL_USE}}:X]
+
| [{{text anchor|ANY_LEATHER_MATERIAL}}]
−
| Item must be a [[tool]] with the specific TOOL_USE value. The item type must be TOOL:NONE for this to make any sense.
+
| Item material must have the [LEATHER] token.
 
|-
 
|-
−
| [{{text anchor|MAGMA_BUILD_SAFE}}]
+
| [{{text anchor|ANY_BONE_MATERIAL}}]
−
| Item material must be stable at temperatures below 12000. Only works with items of type BAR, BLOCKS, BOULDER, WOOD, and ANVIL - all others are considered unsafe.
+
| Item material must have the [BONE] token.
 
|-
 
|-
−
| [{{text anchor|METAL_ORE}}:X]
+
| [{{text anchor|ANY_STRAND_TISSUE}}]
−
| Item material must be an ore of the specified metal.
+
| Item is made of a tissue having [TISSUE_SHAPE:STRANDS], intended for matching hair and wool. Must be used with [USE_BODY_COMPONENT].
 
|-
 
|-
−
| [{{text anchor|MIN_DIMENSION}}:X]
+
| [{{text anchor|ANY_SHELL_MATERIAL}}]
−
| Item's dimension must be at least this large. The item type must be BAR, POWDER_MISC, LIQUID_MISC, DRINK, THREAD, or CLOTH for this to work.
+
| Item material must have the [SHELL] token.
 
|-
 
|-
−
| [{{text anchor|NO_EDGE_ALLOWED}}]
+
| [{{text anchor|ANY_TOOTH_MATERIAL}}]
−
| Item must not have an edge, so must be blunt. Sharp stones (produced using knapping) and most types of weapon/ammo can not be used with this token.
+
| Item material must have the [TOOTH] token.
 
|-
 
|-
−
| [{{text anchor|NOT_CONTAIN_BARREL_ITEM}}]
+
| [{{text anchor|ANY_HORN_MATERIAL}}]
−
| If the item is a container, it must not contain [[lye]] or [[milk]]. Not necessary if specifying [EMPTY].
+
| Item material must have the [HORN] token.
 
|-
 
|-
−
| [{{text anchor|NOT_ENGRAVED}}]
+
| [{{text anchor|ANY_PEARL_MATERIAL}}]
−
| Item can not be engraved. For example, a memorial slab can not be engraved.
+
| Item material must have the [PEARL] token.
 
|-
 
|-
−
| [{{text anchor|NOT_WEB}}]
+
| [{{text anchor|USE_BODY_COMPONENT}}]
−
| Item must be collected (to distinguish silk thread from webs). Only makes sense for items of type THREAD.
+
| Item must be a body part (CORPSE or CORPSEPIECE).
 
|-
 
|-
−
| [{{text anchor|POTASHABLE}}] (Deprecated)
+
| [{{text anchor|NO_EDGE_ALLOWED}}]
−
| Alias for [CONTAINS_LYE].
+
| Item must not have an edge - excludes sharp stones (produced using knapping) and most types of weapon/ammo.
 
|-
 
|-
−
| [{{text anchor|REACTION_CLASS}}:X]
+
| [{{text anchor|NOT_ENGRAVED}}]
−
| Item's material has a [REACTION_CLASS] token with the appropriate ID.
+
| Item has not been engraved (excludes memorial slabs).
 
|-
 
|-
−
| [{{text anchor|UNROTTEN}}]
+
| [{{text anchor|METAL_ORE}}:X]
−
| Item must not be rotten, mainly for organic materials.
+
| Item material must be an ore of the specified metal.
 
|-
 
|-
−
| [{{text anchor|USE_BODY_COMPONENT}}]
+
| [{{text anchor|MIN_DIMENSION}}:X]
−
| Item must be a body part (CORPSE or CORPSEPIECE).
+
| Item's dimension must be at least this large. The item type must be BAR, POWDER_MISC, LIQUID_MISC, DRINK, THREAD, or CLOTH for this to work.
 
|-
 
|-
−
| [{{text anchor|WEB_ONLY}}]
+
| [{{text anchor|HAS_TOOL_USE}}:X]
−
| Item must be undisturbed (to distinguish silk thread from webs). Only makes sense for items of type THREAD.
+
| Item must be a [[tool]] with the specific TOOL_USE value. The item type must be TOOL:NONE for this to make any sense.
−
|-
 
−
| [{{text anchor|WORTHLESS_STONE_ONLY}}]
 
−
| Item material must be non-[[economic]].
 
 
|}
 
|}
  
 
{{Category|Modding}}
 
{{Category|Modding}}
 
{{Category|Tokens}}
 
{{Category|Tokens}}
−
[[ru:Building 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:

Retrieved from "https://dwarffortresswiki.org/index.php/Building_token"