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 Graphics 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| | + | {{Quality|Unrated}} |
{{av}} | {{av}} | ||
{{Modding}} | {{Modding}} | ||
:{{for/see|an explanation of how to use the various graphics types|[[Graphics]]}} | :{{for/see|an explanation of how to use the various graphics types|[[Graphics]]}} | ||
+ | |||
The <code>[OBJECT:GRAPHICS]</code> [[token]] defines the use of various tile-based graphics in the game. As of version 50.01, graphics tokens have been greatly expanded to accommodate the release of the Steam & Itch premium version. These tokens, and explanations on how to use them, are listed below; the list will expand as the tokens are discovered and understood. | The <code>[OBJECT:GRAPHICS]</code> [[token]] defines the use of various tile-based graphics in the game. As of version 50.01, graphics tokens have been greatly expanded to accommodate the release of the Steam & Itch premium version. These tokens, and explanations on how to use them, are listed below; the list will expand as the tokens are discovered and understood. | ||
+ | |||
== Creature Graphics == | == Creature Graphics == | ||
Creature graphics are found within graphics_creature_x files (such as graphics_creature_domestic or graphics_creature_layered). All graphics files must begin with the file name, followed by the <code>[OBJECT:GRAPHICS]</code> type that tells the game that the file contains graphics definitions. A more detailed explanation on how to use these can be found in [[Graphics#Creature_Graphics|creature graphics]]. | Creature graphics are found within graphics_creature_x files (such as graphics_creature_domestic or graphics_creature_layered). All graphics files must begin with the file name, followed by the <code>[OBJECT:GRAPHICS]</code> type that tells the game that the file contains graphics definitions. A more detailed explanation on how to use these can be found in [[Graphics#Creature_Graphics|creature graphics]]. | ||
+ | |||
=== Types === | === Types === | ||
Line 31: | Line 34: | ||
* [[Creature token|creature id]] | * [[Creature token|creature id]] | ||
* [[Caste|Caste ID]] | * [[Caste|Caste ID]] | ||
− | | Nearly the same as {{token|CREATURE_GRAPHICS|g}}, but allows a separate sprite to be defined for | + | | Nearly the same as {{token|CREATURE_GRAPHICS|g}}, but allows a separate sprite to be defined for {{token|MALE|c}} and {{token|FEMALE|c}} castes. |
A simple alternative to [[Graphics#Layered Graphics|Layered Graphics]]. | A simple alternative to [[Graphics#Layered Graphics|Layered Graphics]]. | ||
Line 41: | Line 44: | ||
* [[Creature token|creature id]] | * [[Creature token|creature id]] | ||
| Format for beginning a [[Graphics#Statue_Graphics|creature statue definition]]. Defines a 1x2 vertical rectangle to be displayed when a statue depicts one of these creatures. | | Format for beginning a [[Graphics#Statue_Graphics|creature statue definition]]. Defines a 1x2 vertical rectangle to be displayed when a statue depicts one of these creatures. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
Line 53: | Line 49: | ||
| | | | ||
* [[Creature token|creature id]] | * [[Creature token|creature id]] | ||
− | | Graphics for a 3x2 rectangle | + | | Graphics for a 3x2 rectangle that is used exclusively for representing Forgotten Beasts based on their body parts. Uses [[Graphics#Forgotten_Beast_Graphics|forgotten beast graphics]]. |
|} | |} | ||
− | === Conditions === | + | |
− | Different graphics can be defined for the same creature based on some properties about it. Below is a list of all | + | === Basic Conditions === |
+ | Different graphics can be defined for the same creature based on some properties about it. Below is a list of all conditions that can be used for creature graphics that accept a ''condition'' token. | ||
{| {{prettytable}} | {| {{prettytable}} | ||
|- bgcolor="#dddddd" | |- bgcolor="#dddddd" | ||
! Condition | ! Condition | ||
+ | ! Accepts<br>Secondary | ||
! Description | ! Description | ||
|- | |- | ||
− | | {{text anchor|DEFAULT}} || The default condition that will be displayed unless overwritten by a more specific one below | + | | {{text anchor|DEFAULT}} || No || The default condition that will be displayed unless overwritten by a more specific one below. |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
− | | {{text anchor| | + | | {{text anchor|CHILD}} || Yes || Will only be displayed if the creature is a {{token|CHILD|c}} or {{token|BABY|c}} and is younger than one of those ages. |
|- | |- | ||
− | | {{text anchor| | + | | {{text anchor|ANIMATED}} || Yes || Displayed if the creature is raised from the dead, although it is not known how this is decided. Raised status is not related to having a syndrome with the class from {{token|CONDITION_SYN_CLASS|g}} or from having {{token|NOT_LIVING|c}}/{{token|OPPOSED_TO_LIFE|c}}. |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
− | | {{ | + | | {{text anchor|CORPSE}} || Yes || Displayed as soon as the creature dies. |
|- | |- | ||
− | | {{ | + | | {{text anchor|TRAINED_HUNTER}} || Yes || Shown for hunting-trained versions of this creature. |
|- | |- | ||
− | | {{ | + | | {{text anchor|TRAINED_WAR}} || Yes || Shown for war-trained versions of this creature. |
|- | |- | ||
− | | {{ | + | | {{text anchor|LIST_ICON}} || Unknown || Displayed in menus. Useful for large images that would extend beyond the menu boxes otherwise/ |
|- | |- | ||
− | | {{ | + | | {{text anchor|SKELETON}} || Unknown || Decayed remains of the creature.{{verify}} |
|- | |- | ||
− | | {{ | + | | {{text anchor|SKELETON_WITH_SKULL}} || Unknown || Decayed remains of the creature with a skull.{{verify}} |
+ | |} | ||
− | |||
− | |||
− | |||
− | |||
=== Layered Conditions === | === Layered Conditions === | ||
Line 129: | Line 102: | ||
|- | |- | ||
− | | {{text_anchor| | + | | {{text_anchor|LAYER_GROUP}} || || Layer<br>Group |
− | + | | Begins defining a layer group. Current effect unknown.{{verify}} | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | || Layer<br> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| {{text_anchor|END_LAYER_GROUP}} || || Layer<br>Group | | {{text_anchor|END_LAYER_GROUP}} || || Layer<br>Group | ||
− | | | + | | marks the end of a layer group. Current effect unknown.{{verify}} |
|- | |- | ||
Line 171: | Line 117: | ||
|| Armor<br>Wieldables || Defines a clothing or armor graphic by the specific part it is equipped to, the type of armor it is, and the internal id of that item. | || Armor<br>Wieldables || Defines a clothing or armor graphic by the specific part it is equipped to, the type of armor it is, and the internal id of that item. | ||
For example, a condition representing a right handed mitten or glove would be defined as: | For example, a condition representing a right handed mitten or glove would be defined as: | ||
− | <code>[CONDITION_ITEM_WORN:BY_TOKEN:RH:GLOVES: | + | <code>[CONDITION_ITEM_WORN:BY_TOKEN:RH:GLOVES:ITEM_GLOVES_GLOVES:ITEM:GLOVES:MITTENS]</code> |
− | |||
|- | |- | ||
Line 181: | Line 126: | ||
* Item ID(s) | * Item ID(s) | ||
|| Armor || Causes the current layer to not be rendered if the creature has one of the items worn or equipped. Also accepts the input <code>ANY_HELD</code> or <code>WIELD</code> (e.g. <code>WIELD:WEAPON:ANY</code>). | || Armor || Causes the current layer to not be rendered if the creature has one of the items worn or equipped. Also accepts the input <code>ANY_HELD</code> or <code>WIELD</code> (e.g. <code>WIELD:WEAPON:ANY</code>). | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
Line 218: | Line 157: | ||
| {{text_anchor|CONDITION_MATERIAL_TYPE}} || | | {{text_anchor|CONDITION_MATERIAL_TYPE}} || | ||
* material token | * material token | ||
− | || Material || Changes graphics based on the material an equipped item is made of. Valid material types take the form <code>METAL:COPPER</code> where copper can be replaced with any weapons-grade metal. | + | || Material || Changes graphics based on the material an equipped item is made of. Valid material types take the form <code>METAL:COPPER</code> where copper can be replaced with any weapons-grade metal. Initial testing has shown that some [[material token]]s are not functional. {{token|CONDITION_MATERIAL_FLAG}} is a better option for any material condition other than metal. |
|- | |- | ||
| {{text_anchor|CONDITION_PROFESSION_CATEGORY}} || | | {{text_anchor|CONDITION_PROFESSION_CATEGORY}} || | ||
− | * [[Unit type token | + | * [[Unit type token|profession token(s)]] |
|| General | || General | ||
− | || Checks the profession | + | || Checks the profession of the creature to act as a condition. Multiple profession tokens can be chained together. |
|- | |- | ||
Line 249: | Line 188: | ||
|- | |- | ||
− | | {{text_anchor|CONDITION_CHILD}} || || | + | | {{text_anchor|CONDITION_CHILD}} || General || |
|| Checks if the creature is a child or baby. | || Checks if the creature is a child or baby. | ||
|- | |- | ||
− | | {{text_anchor|CONDITION_NOT_CHILD}} || || | + | | {{text_anchor|CONDITION_NOT_CHILD}} || General || |
|| Checks if the creature is an adult. | || Checks if the creature is an adult. | ||
|- | |- | ||
− | | {{text_anchor|CONDITION_GHOST}} || || | + | | {{text_anchor|CONDITION_GHOST}} || General || |
|| Checks if the creature is a ghost. | || Checks if the creature is a ghost. | ||
Line 283: | Line 222: | ||
* integer | * integer | ||
|| Tissue | || Tissue | ||
− | || Checks the current {{token|CONDITION_TISSUE_LAYER | + | || Checks the current {{token|CONDITION_TISSUE_LAYER}}'s LENGTH [[Creature_token#TISSUE_LAYER_APPEARANCE_MODIFIER|appearance modifier]]. Is true if the LENGTH is greater than the integer input. |
|- | |- | ||
Line 289: | Line 228: | ||
* integer | * integer | ||
|| Tissue | || Tissue | ||
− | || Checks the current {{token|CONDITION_TISSUE_LAYER | + | || Checks the current {{token|CONDITION_TISSUE_LAYER}}'s LENGTH [[Creature_token#TISSUE_LAYER_APPEARANCE_MODIFIER|appearance modifier]]. Is true if the LENGTH is less than the integer input. |
|- | |- | ||
Line 301: | Line 240: | ||
* styling token | * styling token | ||
|| Tissue | || Tissue | ||
− | || Checks the current {{token|CONDITION_TISSUE_LAYER | + | || Checks the current {{token|CONDITION_TISSUE_LAYER}}'s shaping (hairstyle). Valid tokens are NEATLY_COMBED, BRAIDED, DOUBLE_BRAIDS, PONY_TAILS, CLEAN_SHAVEN and STANDARD_HAIR/BEARD/MOUSTACHE/SIDEBURNS_SHAPINGS.{{verify}} |
|- | |- | ||
| {{text_anchor|TISSUE_NOT_SHAPED}} || || Tissue | | {{text_anchor|TISSUE_NOT_SHAPED}} || || Tissue | ||
− | || Checks the current {{token|CONDITION_TISSUE_LAYER | + | || Checks the current {{token|CONDITION_TISSUE_LAYER}}'s color. Accepts multiple color tokens, and is true if the any of the colors is present in the selected tissues. |
|- | |- | ||
Line 318: | Line 257: | ||
This condition should be within a [LAYER:... ] that has a similar graphic to the on in the TISSUE_SWAP. | This condition should be within a [LAYER:... ] that has a similar graphic to the on in the TISSUE_SWAP. | ||
− | The current {{token|CONDITION_TISSUE_LAYER | + | The current {{token|CONDITION_TISSUE_LAYER}} group must also include a {{token|TISSUE_MIN_LENGTH}}. |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|} | |} | ||
Line 370: | Line 269: | ||
! Description | ! Description | ||
|- | |- | ||
− | | {{text anchor|VERMIN}} || | + | | {{text anchor|VERMIN}} || Necessary for defining graphics that use the tokens below.{{verify}} |
|- | |- | ||
Line 408: | Line 307: | ||
== Item Graphics == | == Item Graphics == | ||
Item graphics can also be defined, but are mostly hardcoded. This section of the wiki needs to be fleshed out. Descriptions of the token functions is provisional. | Item graphics can also be defined, but are mostly hardcoded. This section of the wiki needs to be fleshed out. Descriptions of the token functions is provisional. | ||
− | |||
− | |||
{| {{prettytable}} | {| {{prettytable}} | ||
Line 461: | Line 358: | ||
* Item ID | * Item ID | ||
| Defines tile graphics for FOOD items. | | Defines tile graphics for FOOD items. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
Line 707: | Line 595: | ||
* y index | * y index | ||
* Item ID | * Item ID | ||
− | | Defines default graphics for TOOL items; also begins defining variant graphics | + | | Defines default graphics for TOOL items; also begins defining variant graphics when followed by the tool graphics material tokens below. |
|- | |- | ||
Line 713: | Line 601: | ||
| | | | ||
* Item ID | * Item ID | ||
− | | | + | | Alternate method to using TOOL_GRAPHICS; does not set a default graphic, uses the tool graphics material tokens below to define graphics for each material. Player-added tools that use the built-in reactions (ie. included as a TOOL in the entity definition) can use this method to define the graphics for HARD_MAT tools. |
|- | |- | ||
| {{text_anchor|TOOL_GRAPHICS_WOOD}} | | {{text_anchor|TOOL_GRAPHICS_WOOD}} | ||
| | | | ||
− | * Variant | + | * Variant number{{verify}} |
* Tile page ID | * Tile page ID | ||
* x index | * x index | ||
* y index | * y index | ||
− | | Defines additonal variant graphics for wooden TOOL items defined by TOOL_GRAPHICS; follows TOOL_GRAPHICS or ADD_TOOL_GRAPHICS. | + | | Defines additonal variant graphics for wooden TOOL items defined by TOOL_GRAPHICS; follows TOOL_GRAPHICS or ADD_TOOL_GRAPHICS. Can accept up to seven variants; the resulting tool graphic is selected randomly from these. |
|- | |- | ||
| {{text_anchor|TOOL_GRAPHICS_STONE}} | | {{text_anchor|TOOL_GRAPHICS_STONE}} | ||
| | | | ||
− | * Variant | + | * Variant number{{verify}} |
* Tile page ID | * Tile page ID | ||
* x index | * x index | ||
* y index | * y index | ||
− | | Defines additonal variant graphics for stone TOOL items defined by TOOL_GRAPHICS; follows TOOL_GRAPHICS or ADD_TOOL_GRAPHICS. | + | | Defines additonal variant graphics for stone TOOL items defined by TOOL_GRAPHICS; follows TOOL_GRAPHICS or ADD_TOOL_GRAPHICS. Can accept up to seven variants; the resulting tool graphic is selected randomly from these. |
|- | |- | ||
| {{text_anchor|TOOL_GRAPHICS_METAL}} | | {{text_anchor|TOOL_GRAPHICS_METAL}} | ||
| | | | ||
− | * Variant | + | * Variant number{{verify}} |
* Tile page ID | * Tile page ID | ||
* x index | * x index | ||
* y index | * y index | ||
− | | Defines additonal variant graphics for metal TOOL items defined by TOOL_GRAPHICS; follows TOOL_GRAPHICS or ADD_TOOL_GRAPHICS. | + | | Defines additonal variant graphics for metal TOOL items defined by TOOL_GRAPHICS; follows TOOL_GRAPHICS or ADD_TOOL_GRAPHICS. Can accept up to seven variants; the resulting tool graphic is selected randomly from these. |
|- | |- | ||
| {{text_anchor|TOOL_GRAPHICS_GLASS}} | | {{text_anchor|TOOL_GRAPHICS_GLASS}} | ||
| | | | ||
− | * Variant | + | * Variant number{{verify}} |
* Tile page ID | * Tile page ID | ||
* x index | * x index | ||
* y index | * y index | ||
− | | Defines additonal variant graphics for glass TOOL items defined by TOOL_GRAPHICS; follows TOOL_GRAPHICS or ADD_TOOL_GRAPHICS. | + | | Defines additonal variant graphics for glass TOOL items defined by TOOL_GRAPHICS; follows TOOL_GRAPHICS or ADD_TOOL_GRAPHICS. Can accept up to seven variants; the resulting tool graphic is selected randomly from these. |
|- | |- | ||
− | | {{text_anchor| | + | | {{text_anchor|TOOL_GRAPHICS_HIVE_BLD}} |
| | | | ||
* Tile page ID | * Tile page ID | ||
* x index | * x index | ||
* y index | * y index | ||
− | | Defines graphics for | + | | Defines the built item graphics for HIVE items. |
|- | |- | ||
− | | {{text_anchor| | + | | {{text_anchor|TOOL_GRAPHICS_HIVE_BLD_IN_USE}} |
| | | | ||
* Tile page ID | * Tile page ID | ||
* x index | * x index | ||
* y index | * y index | ||
− | | Defines graphics for | + | | Defines the built item graphics for HIVE items that have hives installed. |
|- | |- | ||
− | | {{text_anchor| | + | | {{text_anchor|TOOL_GRAPHICS_HIVE_PRODUCTS}} |
| | | | ||
* Tile page ID | * Tile page ID | ||
* x index | * x index | ||
* y index | * y index | ||
− | | Defines graphics for | + | | Defines the built item graphics for HIVE items that are ready to be harvested. |
|- | |- | ||
− | | {{text_anchor| | + | | {{text_anchor|TOOL_GRAPHICS_SHAPE}} |
| | | | ||
+ | * Shape ID | ||
* Tile page ID | * Tile page ID | ||
* x index | * x index | ||
* y index | * y index | ||
− | | Defines graphics for | + | | Defines graphics for shaped items; currently used for dice. |
|- | |- | ||
− | | {{text_anchor| | + | | {{text_anchor|TOOL_GRAPHICS_CONTAINER_WOOD_LIQUID}} |
| | | | ||
* Tile page ID | * Tile page ID | ||
* x index | * x index | ||
* y index | * y index | ||
− | | Defines graphics for wooden containers | + | | Defines graphics for wooden liquid-containing containers (empty); follows ADD_TOOL_GRAPHICS definition for container. |
|- | |- | ||
− | | {{text_anchor| | + | | {{text_anchor|TOOL_GRAPHICS_CONTAINER_STONE_LIQUID}} |
| | | | ||
* Tile page ID | * Tile page ID | ||
* x index | * x index | ||
* y index | * y index | ||
− | | Defines graphics for stone containers | + | | Defines graphics for stone liquid-containing containers (empty); follows ADD_TOOL_GRAPHICS definition for container. |
|- | |- | ||
− | | {{text_anchor| | + | | {{text_anchor|TOOL_GRAPHICS_CONTAINER_METAL_LIQUID}} |
| | | | ||
* Tile page ID | * Tile page ID | ||
* x index | * x index | ||
* y index | * y index | ||
− | | Defines graphics for metal (and glass?) containers | + | | Defines graphics for metal (and glass?) liquid-containing containers (empty); follows ADD_TOOL_GRAPHICS definition for container. |
+ | |||
|- | |- | ||
− | | {{text_anchor| | + | | {{text_anchor|TOOL_GRAPHICS_CONTAINER_LIQUID}} |
| | | | ||
* Tile page ID | * Tile page ID | ||
* x index | * x index | ||
* y index | * y index | ||
− | | Defines | + | | Defines graphics for the liquid filling a liquid-containing container; follows TOOL_GRAPHICS_CONTAINER_*_LIQUID. |
|- | |- | ||
− | | {{text_anchor| | + | | {{text_anchor|TOOL_GRAPHICS_CONTAINER_WOOD_ITEM}} |
| | | | ||
* Tile page ID | * Tile page ID | ||
* x index | * x index | ||
* y index | * y index | ||
− | | Defines | + | | Defines graphics for wooden containers holding items; follows ADD_TOOL_GRAPHICS definition for container. |
|- | |- | ||
− | | {{text_anchor| | + | | {{text_anchor|TOOL_GRAPHICS_CONTAINER_STONE_ITEM}} |
| | | | ||
* Tile page ID | * Tile page ID | ||
* x index | * x index | ||
* y index | * y index | ||
− | | Defines | + | | Defines graphics for stone containers holding items; follows ADD_TOOL_GRAPHICS definition for container. |
|- | |- | ||
− | | {{text_anchor| | + | | {{text_anchor|TOOL_GRAPHICS_CONTAINER_METAL_ITEM}} |
| | | | ||
− | |||
* Tile page ID | * Tile page ID | ||
* x index | * x index | ||
* y index | * y index | ||
− | | Defines graphics for | + | | Defines graphics for metal (and glass?) containers holding items; follows ADD_TOOL_GRAPHICS definition for container. |
|} | |} |