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

From Dwarf Fortress Wiki
Jump to navigation Jump to search
m (added {{old}} template)
m (→‎Layered Conditions: added missing DISTURBED_DEAD syndrome class)
 
(45 intermediate revisions by 14 users not shown)
Line 1: Line 1:
−
{{Quality|Unrated}}
+
{{Quality|Exceptional}}
 
{{av}}
 
{{av}}
 
{{Modding}}
 
{{Modding}}
−
{{old}}
+
:{{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 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.
  
−
__NOTOC__
+
== 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]].
  
−
{{clear}}
+
=== Types ===
−
{{alphabetical TOC|style=margin: 1em auto;}}
+
{| {{prettytable}}
 +
|- bgcolor="#dddddd"
 +
! Type
 +
! Arguments
 +
! Description
 +
 
 +
|-
 +
| {{text anchor|CREATURE_GRAPHICS}}
 +
|
 +
* [[Creature token|creature id]]
 +
| The simplest and most common form of creature graphics for defining one sprite for each [[#Condition|basic condition]].
 +
 
 +
Further conditions are required for this to function following the [[Graphics#Basic_Graphics|creature graphics]] format. Accepts [[Graphics#Large_Graphics|large graphics tokens]].
 +
 
 +
Additionally used to start defining a [[Graphics#Layered_Graphics|layered graphics]] set.
 +
 
 +
|-
 +
| {{text anchor|CREATURE_CASTE_GRAPHICS}}
 +
|
 +
* [[Creature token|creature id]]
 +
* [[Caste|Caste ID]]
 +
| Nearly the same as {{token|CREATURE_GRAPHICS|g}}, but allows a separate sprite to be defined for each caste.
 +
A simple alternative to [[Graphics#Layered Graphics|Layered Graphics]].
 +
 
 +
Requires conditions defined in [[Graphics#Basic_Graphics|creature graphics]] format. Accepts [[Graphics#Large_Graphics|large graphics tokens]].
 +
 
 +
|-
 +
| {{text anchor|STATUE_CREATURE_GRAPHICS}}
 +
|
 +
* [[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.
 +
 
 +
|-
 +
| {{text anchor|STATUE_CREATURE_CASTE_GRAPHICS}}
 +
|
 +
* [[Creature token|creature id]]
 +
* [[Caste|Caste ID]]
 +
| Format for beginning a [[Graphics#Statue_Graphics|creature statue definition]] while specifying caste. Defines a 1x2 vertical rectangle to be displayed when a statue depicts one of these creatures.
 +
 
 +
|-
 +
| {{text anchor|TILE_GRAPHICS_RECTANGLE}}
 +
|
 +
* [[Creature token|creature id]]
 +
| Graphics for a 3x2 rectangle; for creatures, this is used exclusively for representing Forgotten Beasts based on their body parts. Uses [[Graphics#Forgotten_Beast_Graphics|forgotten beast graphics]]. It's also, however, used for interface graphics, see [[graphics_interface.txt]].
 +
 
 +
|}
 +
 
 +
=== Conditions ===
 +
Different graphics can be defined for the same creature based on some properties about it. Below is a list of all the basic "creature texture" types that can be used as additional conditions to various basic sprites.
 +
 
 +
{| {{prettytable}}
 +
|- bgcolor="#dddddd"
 +
! Condition
 +
! Description
 +
|-
 +
| {{text anchor|DEFAULT}} || The default condition that will be displayed unless overwritten by a more specific one below.
 +
 
 +
|-
 +
| {{text anchor|LAW_ENFORCE}} || Displayed if the unit is law enforcement.
 +
 
 +
|-
 +
| {{text anchor|TAX_ESCORT}} || Displayed if the unit escorts a tax collector (unused).
 +
 
 +
|-
 +
| {{text anchor|ANIMATED}} || Displayed if the creature is raised from the dead using an I_EFFECT:ANIMATE interaction.
 +
 
 +
|-
 +
| {{text anchor|GHOST}} || Displayed if the creature is a ghost.
 +
 
 +
|-
 +
| {{text anchor|ADVENTURER}} || Displayed if the creature is an adventurer.
 +
 
 +
|-
 +
| {{text anchor|CORPSE}} || Displayed for corpses.
 +
 
 +
|}
 +
 
 +
=== Basic creature sprite types ===
 +
 
 +
An individual sprite can be of any of the following classes. If "accepts secondary" is "yes", it can also have an extra condition tacked on at the end.
 +
 
 +
{| {{prettytable}}
 +
|- bgcolor="#dddddd"
 +
! Condition
 +
! Description
 +
|-
 +
| {{text_anchor|Basic Condition}} || Any of the [[Graphics token#Conditions|above conditions]] can be used on their own, as the default for that condition class.
 +
 
 +
|-
 +
| {{text_anchor|Unit type}} || Any [[Unit type token]] can be used. You may also append a [[Graphics token#Conditions|basic condition as above]] to further specify.
 +
 
 +
|-
 +
| {{text_anchor|Position}} || Any [[Position token]] can be used, such as MONARCH, BROKER etc. All position tokens are raw-defined; any modded positions can have their own graphics. You may also append a [[Graphics token#Conditions|basic condition as above]] to further specify.
 +
 
 +
|-
 +
| {{text_anchor|LIST_ICON}} || The default icon for this creature in lists, such as [[Arena]] mode or overall training.
 +
 
 +
|-
 +
| {{text_anchor|EGG}} || The sprite for a clutch of eggs.
 +
 
 +
|-
 +
| {{text_anchor|SKELETON}} || The sprite for a rotten corpse.
 +
 
 +
|-
 +
| {{text_anchor|SKELETON_WITH_SKULL}} || The sprite for a rotten corpse that can have a [[totem]] made from it.
 +
 
 +
|}
 +
 
 +
=== Layered Conditions ===
 +
Layers aren't very useful on their own, so they come with a set of conditions to define how when they are displayed and how they interact.
 +
 
 +
{| {{prettytable}}
 +
|- bgcolor="#dddddd"
 +
! Token
 +
! Arguments
 +
! Type
 +
! Description
 +
 
 +
|-
 +
| {{text_anchor|LAYER_SET}} ||
 +
* condition
 +
| Creature<br>Graphics
 +
| Begins defining a layer set for a creature's graphics.  Valid values of ''condition'' are DEFAULT, PORTRAIT{{version|50.13}}, or CORPSE. Valid values for basic conditions may not work.{{verify}}
 +
 
 +
|-
 +
| {{text_anchor|LS_PALETTE}}{{version|50.13}} ||
 +
*  name
 +
|| Layer<br>Set
 +
|| Begins defining a palette for the layer set. Its name can be referenced by {{token|USE_PALETTE|g}}. Unlike the palettes used to render all [[descriptor color token]]s, it can be of arbitrary length.
 +
 
 +
|-
 +
| {{text_anchor|LS_PALETTE_FILE}}{{version|50.13}} ||
 +
* file name
 +
| Palette
 +
| The file name of the 8bit RGBA (sometimes called 32bit) in the <tt>/graphics/images</tt> folder of the mod, such as <tt>images/portraits/dwarf_portrait_body_palette.png</tt>.
 +
 
 +
|-
 +
| {{text_anchor|LS_PALETTE_DEFAULT}}{{version|50.13}} ||
 +
* integer
 +
| Palette
 +
| Defines the default row of a layer set palette, conventionally 0. The exact color values on this row will be replaced on layer images with the colors in the same column, based on what row is passed as an argument to {{token|USE_PALETTE|g}}.
 +
 
 +
|-
 +
| {{text_anchor|LG_CONDITION_BP}}{{version|50.13}} ||
 +
*  selection criteria BY_TYPE, BY_CATEGORY, BY_TOKEN
 +
*  category, type, or token
 +
|| Layer<br>Group
 +
|| Allows the entire layer group (rather than an individual layer) to be switched on and off depending on the conditions of a body part. Should accept the same tokens {{token|CONDITION_BP|g}} does. {{verify}}
 +
 
 +
|-
 +
| {{text_anchor|END_LAYER_GROUP}} ||  || Layer<br>Group
 +
| Explicitly marks the end of a layer group, which allows layers after to not belong to any layer group.
 +
 
 +
|-
 +
| {{text_anchor|CONDITION_ITEM_WORN}} ||
 +
* BY_CATEGORY / BY_TOKEN
 +
* [[Body_token#CATEGORY|category]] / [[Body_token#BP|body part token]]
 +
* Armor type (ARMOR, GLOVES, Etc.)
 +
* Item ID(s)
 +
|| 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:
 +
<code>[CONDITION_ITEM_WORN:BY_TOKEN:RH:GLOVES:ITEM_GLOVES_MITTENS]</code>
 +
Also accepts the input <code>ANY_HELD</code> or <code>WIELD</code> (e.g. <code>WIELD:WEAPON:ANY</code>).
 +
 
 +
|-
 +
| {{text_anchor|SHUT_OFF_IF_ITEM_PRESENT}} ||
 +
* BY_CATEGORY / BY_TOKEN
 +
* [[Body_token#CATEGORY|category]] / [[Body_token#BP|body part token]]
 +
* Armor type
 +
* 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>).
 +
 
 +
|-
 +
| {{text_anchor|CONDITION_CASTE}} ||
 +
* caste name(s)
 +
|| General
 +
|| Displays this layer if the creature is this caste. Only one caste is accepted for each condition, but multiple caste conditions can be used in one layer and the layer will be displayed if any of them match.
 +
 
 +
|-
 +
| {{text_anchor|CONDITION_DYE}} ||
 +
* dye color
 +
|| Armor
 +
|| Should represent which color the clothing is dyed. Currently nonfunctional.{{version|50.05}}
 +
 
 +
|-
 +
| {{text_anchor|CONDITION_NOT_DYED}} ||  || Armor
 +
|| Should check if the clothing is dyed. Currently nonfunctional.{{version|50.05}}
 +
 
 +
|-
 +
| {{text_anchor|CONDITION_MATERIAL_FLAG}} ||
 +
* material flag
 +
|| Material || Changes graphics based on the material an equipped item is made of. Valid material flags are similar to [[Reaction#Full_token_list|reactant conditions]] including:
 +
* WOVEN_ITEM
 +
* ANY_X_MATERIAL
 +
:with X being:
 +
:* PLANT, SILK, YARN, LEATHER, WOOD, SHELL, BONE, STONE, GEM, TOOTH, HORN, PEARL
 +
* IS_DIVINE_MATERIAL
 +
* NOT_ARTIFACT
 +
* IS_CRAFTED_ARTIFACT
 +
* METAL_ITEM_MATERIAL
 +
* GLASS_MATERIAL
 +
* FIRE_BUILD_SAFE
 +
* MAGMA_BUILD_SAFE
 +
[http://www.bay12forums.com/smf/index.php?topic=169696.msg8442543#msg8442543 among other, less useful ones.]
 +
 
 +
|-
 +
| {{text_anchor|CONDITION_MATERIAL_TYPE}} ||
 +
* 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. General [[material token]]s are '''not''' functional. {{token|CONDITION_MATERIAL_FLAG|g}} is a better option for any material condition other than metal.
 +
 
 +
|-
 +
| {{text_anchor|CONDITION_PROFESSION_CATEGORY}} ||
 +
* [[Unit type token#Profession Categories|profession category token(s)]]
 +
|| General
 +
|| Checks the profession category of the creature to act as a condition. Multiple profession category tokens can be chained together. You can also use multiple of these tokens instead of listing them all in a single one, but this is functionally identical. Valid Profession tokens which are not categories will be ignored; values that do not match any existing Profession will be treated as <code>NONE</code> and thus apply to doctors, military, etc..
 +
 
 +
|-
 +
| {{text_anchor|CONDITION_RANDOM_PART_INDEX}} ||
 +
* identifier
 +
* integer index
 +
* integer range
 +
|| General
 +
|| Chooses a random layer among layers with a CONDITION_RANDOM_PART_INDEX with the same identifier. Index is which option this condition is, out of Range number of options. Ex:
 +
<code>[CONDITION_RANDOM_PART_INDEX:HEAD:3:4]</code>
 +
is the third possible random head out of four total options. One of these random conditions each will be put into a set of four different sprites to add some random variation in the appearance of the creature's head.
 +
 
 +
|-
 +
| {{text_anchor|CONDITION_HAUL_COUNT_MIN}} ||
 +
* integer
 +
|| General
 +
|| Counts how many items the creature is hauling. Used for {{token|PACK_ANIMAL}}s in vanilla.
 +
 
 +
|-
 +
| {{text_anchor|CONDITION_HAUL_COUNT_MAX}} ||
 +
* integer
 +
|| General
 +
|| Counts how many items the creature is hauling. Used for {{token|PACK_ANIMAL}}s in vanilla.
 +
 
 +
|-
 +
| {{text_anchor|CONDITION_CHILD}} || || General
 +
|| Checks if the creature is a child or baby.
 +
 
 +
|-
 +
| {{text_anchor|CONDITION_NOT_CHILD}} || || General
 +
|| Checks if the creature is an adult.
 +
 
 +
|-
 +
| {{text_anchor|CONDITION_GHOST}} || || General
 +
|| Checks if the creature is a ghost.
 +
 
 +
|-
 +
| {{text_anchor|CONDITION_SYN_CLASS}} ||
 +
* [[Syndrome#SYN_CLASS|SYN_CLASS]]
 +
|| Syndrome || Changes graphics based on any syndromes the creature is affected by. Vanilla values include:
 +
* ZOMBIE
 +
* NECROMANCER
 +
* VAMPCURSE
 +
* RAISED_UNDEAD
 +
* DISTURBED_DEAD
 +
* GHOUL
 +
 
 +
|-
 +
| {{text_anchor|CONDITION_TISSUE_LAYER}} ||
 +
* BY_CATEGORY
 +
* [[Body_token#CATEGORY|body part category]] or ALL
 +
* [[Body_detail_plan_token#BP_LAYERS|tissue layer]] or ALL
 +
|| Tissue
 +
|| Selects a tissue layer to use for checking other conditions. Ex:
 +
<code>[CONDITION_TISSUE_LAYER:BY_CATEGORY:ALL:SKIN]</code>
 +
 
 +
|-
 +
| {{text_anchor|TISSUE_MIN_LENGTH}} ||
 +
* integer
 +
|| Tissue
 +
|| Checks the current {{token|CONDITION_TISSUE_LAYER|g}}'s LENGTH [[Creature_token#TISSUE_LAYER_APPEARANCE_MODIFIER|appearance modifier]]. Is true if the LENGTH is greater than the integer input.
 +
 
 +
|-
 +
| {{text_anchor|TISSUE_MAX_LENGTH}} ||
 +
* integer
 +
|| Tissue
 +
|| Checks the current {{token|CONDITION_TISSUE_LAYER|g}}'s LENGTH [[Creature_token#TISSUE_LAYER_APPEARANCE_MODIFIER|appearance modifier]]. Is true if the LENGTH is less than the integer input.
 +
 
 +
|-
 +
| {{text_anchor|TISSUE_MAY_HAVE_COLOR}} ||
 +
* [[Color#Color_tokens|color token(s)]]
 +
|| Tissue
 +
|| Checks the selected tissue's color. Accepts multiple color tokens, and is true if the any of the colors is present in the selected tissues.
 +
 
 +
|-
 +
| {{text_anchor|TISSUE_MAY_HAVE_SHAPING}} ||
 +
* styling token
 +
|| Tissue
 +
|| Checks the current {{token|CONDITION_TISSUE_LAYER|g}}'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
 +
|| Checks the current {{token|CONDITION_TISSUE_LAYER|g}}'s color. Accepts multiple color tokens, and is true if the any of the colors is present in the selected tissues.
 +
 
 +
|-
 +
| {{text_anchor|TISSUE_SWAP}} ||
 +
* IF_MIN_CURLY
 +
* integer
 +
* tile page id
 +
* x position
 +
* y position
 +
| Tissue
 +
| Checks if a tissue is sufficiently curly, and if so swaps to display a different image. The new image is defined by the tile page ID, x position, and y position.
 +
 
 +
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|g}} group must also include a {{token|TISSUE_MIN_LENGTH|g}}.
 +
 
 +
|-
 +
| {{text_anchor|ITEM_QUALITY}}{{version|50.13}} ||
 +
* integer
 +
| Armor<br>Wieldables{{verify}}
 +
|| Checks the current {{token|CONDITION_ITEM_WORN|g}}'s [[quality]]. 0 is base quality, 5 is masterwork.  See [CONDITION_MATERIAL_FLAG:IS_CRAFTED_ARTIFACT] for [[artifact]]-quality items.
 +
 
 +
|-
 +
| {{text_anchor|USE_PALETTE}}{{version|50.13}} ||
 +
* layer set palette
 +
* row
 +
| General
 +
|| Colors the layer using that row of the layer-set-specific {{token|LS_PALETTE|g}}.
 +
 
 +
|-
 +
| {{text_anchor|USE_STANDARD_PALETTE_FROM_ITEM}}{{version|50.13}} || || Armor<br>Wieldables{{verify}}
 +
|| Uses the default palette to render the layer based on the [[Material definition token#STATE_COLOR|color]] of the current {{token|CONDITION_ITEM_WORN|g}}.
 +
 
 +
|-
 +
| {{text_anchor|CONDITION_BP}}{{version|50.13}} ||
 +
*  selection criteria BY_TYPE, BY_CATEGORY, BY_TOKEN
 +
*  category, type, or token
 +
| Body
 +
|| Defines a body part graphic using standard [[body token]] selection criteria.
 +
 
 +
|-
 +
| {{text_anchor|BP_APPEARANCE_MODIFIER_RANGE}}{{version|50.13}} ||
 +
*  QUALITY
 +
*  minimum
 +
*  maximum
 +
| Body
 +
|| Checks if current {{token|CONDITION_BP|g}}'s {{token|BP_APPEARANCE_MODIFIER|c}} falls within the chosen range.
 +
 
 +
|-
 +
| {{text_anchor|BP_PRESENT}}{{version|50.13}} || || Body
 +
|| Checks if the current {{token|CONDITION_BP|g}} is present and not destroyed, pulped, or severed. Can also be applied to {{token|LG_CONDITION_BP|g}}.
 +
 
 +
|-
 +
| {{text_anchor|BP_SCARRED}}{{version|50.13}} || || Body
 +
|| Checks if the current {{token|CONDITION_BP|g}} is scarred. Seems to also require {{token|BP_PRESENT|g}} to avoid illogical results. {{verify}}
 +
 
 +
|}
 +
 
 +
=== Vermin Conditions ===
 +
Special Conditions for {{token|VERMIN|c}} creature graphics:
  
−
==C==
 
 
{| {{prettytable}}
 
{| {{prettytable}}
−
|- bgcolor="#ddd"
+
|- bgcolor="#dddddd"
−
! width="20%" | Token
+
! Condition
−
! width="10%" | Type
+
! Description
−
! width="20%" | Arguments
+
|-
−
! width="50%" | Description
+
| {{text anchor|VERMIN}} || The default graphic for this vermin.
 +
 
 +
|-
 +
| {{text anchor|VERMIN_ALT}} || Image cycles every 1 second.
 +
 
 +
|-
 +
| {{text anchor|SWARM_SMALL}} || For swarming vermin like [[fly|flies]] and [[fairy|fairies]] in small groups.
 +
 
 +
|-
 +
| {{text anchor|SWARM_MEDIUM}} || For swarming vermin like [[fly|flies]] and [[fairy|fairies]] in medium-sized groups.
 +
 
 +
|-
 +
| {{text anchor|SWARM_LARGE}} || For swarming vermin like [[fly|flies]] and [[fairy|fairies]] in large groups.
 +
 
 +
|-
 +
| {{text anchor|LIGHT_VERMIN}} || For [[firefly|fireflies]] etc. Does not replace {{token|VERMIN|g}}.
  
 
|-
 
|-
−
| {{text anchor|CREATURE_GRAPHICS}}
+
| {{text anchor|LIGHT_VERMIN_ALT}} || Like {{token|VERMIN_ALT|g}} for [[firefly|fireflies]] etc.
−
| Creature Reference
+
 
 +
|-
 +
| {{text anchor|LIGHT_SWARM_SMALL}} || Like {{token|SWARM_SMALL|g}} for [[firefly|fireflies]] etc. in small groups.
 +
 
 +
|-
 +
| {{text anchor|LIGHT_SWARM_MEDIUM}} || Like {{token|SWARM_LARGE|g}} for [[firefly|fireflies]] etc. in large groups.
 +
 
 +
|-
 +
| {{text anchor|LIGHT_SWARM_LARGE}} || Like {{token|SWARM_LARGE|g}} for [[firefly|fireflies]] etc.
 +
 
 +
|-
 +
| {{text anchor|REMAINS}} || Vermin corpses.
 +
 
 +
|-
 +
| {{text anchor|HIVE}} || Vermin hives.
 +
|}
 +
 
 +
== 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 currently do not support LARGE_IMAGE.
 +
 
 +
{| {{prettytable}}
 +
|- bgcolor="#dddddd"
 +
! Token
 +
! Arguments
 +
! Description
 +
 
 +
|-
 +
| {{text_anchor|TILE_GRAPHICS}}
 +
|
 +
* Tile page ID
 +
* x index
 +
* y index
 +
* Item ID
 +
| Begins defining tile graphics for an item. Sets default tile graphic.{{verify}}
 +
 
 +
|-
 +
| {{text_anchor|BOULDER_GRAPHICS}}
 +
|
 +
* Tile page ID
 +
* x index
 +
* y index
 +
* Material ID
 +
| Defines tile graphics variants to use for BOULDER items by material; currently all boulders use material palette instead.
 +
 
 +
|-
 +
| {{text_anchor|ROUGH_GEM_GRAPHICS}}
 +
|
 +
* Tile page ID
 +
* x index
 +
* y index
 +
* Material ID
 +
| Defines tile graphics variants to use for ROUGH (gem) items by material; currently all rough gems use material palette instead.
 +
 
 +
|-
 +
| {{text_anchor|BARS_GRAPHICS}}
 +
|
 +
* Tile page ID
 +
* x index
 +
* y index
 +
* Material ID or item ID
 +
| Defines tile graphics variants to use for BAR items by material.
 +
 
 +
|-
 +
| {{text_anchor|FOOD_GRAPHICS}}
 +
|
 +
* Tile page ID
 +
* x index
 +
* y index
 +
* Item ID
 +
| Defines tile graphics for FOOD items.
 +
 
 +
|-
 +
| {{text_anchor|CHEESE_GRAPHICS}}
 +
|
 +
* Tile page ID
 +
* x index
 +
* y index
 +
* Material ID
 +
| Defines tile graphics variants to use for CHEESE items by material. Unused in vanilla raws.
 +
 
 +
|-
 +
| {{text_anchor|ARMOR_GRAPHICS}}
 +
|
 +
* Tile page ID
 +
* x index
 +
* y index
 +
* Item ID
 +
| Defines tile graphics for ARMOR items; this is for items not being worn by a creature.
 +
 
 +
|-
 +
| {{text_anchor|GLOVES_GRAPHICS}}
 +
|
 +
* Tile page ID
 +
* x index
 +
* y index
 +
* Item ID
 +
| Defines tile graphics for GLOVES items; this is for items not being worn by a creature.
 +
 
 +
|-
 +
| {{text_anchor|HELM_GRAPHICS}}
 +
|
 +
* Tile page ID
 +
* x index
 +
* y index
 +
* Item ID
 +
| Defines tile graphics for HELM items; this is for items not being worn by a creature.
 +
 
 +
|-
 +
| {{text_anchor|PANTS_GRAPHICS}}
 +
|
 +
* Tile page ID
 +
* x index
 +
* y index
 +
* Item ID
 +
| Defines tile graphics for PANTS items; this is for items not being worn by a creature.
 +
 
 +
|-
 +
| {{text_anchor|SHOES_GRAPHICS}}
 +
|
 +
* Tile page ID
 +
* x index
 +
* y index
 +
* Item ID
 +
| Defines tile graphics for SHOES items; this is for items not being worn by a creature.
 +
 
 +
|-
 +
| {{text_anchor|SHOES_GRAPHICS_METAL}}
 +
|
 +
* Tile page ID
 +
* x index
 +
* y index
 +
* Item ID
 +
| Defines metal material tile graphics variants for SHOES items; this is for items not being worn by a creature.
 +
 
 +
|-
 +
| {{text_anchor|SHIELD_GRAPHICS}}
 +
|
 +
* Tile page ID
 +
* x index
 +
* y index
 +
* Item ID
 +
| Defines tile graphics for SHIELD items; this is for items not being worn by a creature.
 +
 
 +
|-
 +
| {{text_anchor|SHIELD_GRAPHICS_WOODEN}}
 +
|
 +
* Tile page ID
 +
* x index
 +
* y index
 +
* Item ID
 +
| Defines wood material tile graphics variants for SHIELD items; this is for items not being worn by a creature.
 +
 
 +
|-
 +
| {{text_anchor|TOY_GRAPHICS}}
 +
|
 +
* Tile page ID
 +
* x index
 +
* y index
 +
* Item ID
 +
* Material ID
 +
| Defines tile graphics for TOY items.  Material ID in this case is one of STONE, WOOD, METAL, or GLASS.
 +
 
 +
|-
 +
| {{text_anchor|TRAPCOMP_GRAPHICS}}
 +
|
 +
* Tile page ID
 +
* x index
 +
* y index
 +
* Item ID
 +
| Defines tile graphics for TRAPCOMP items.
 +
 
 +
|-
 +
| {{text_anchor|TRAPCOMP_GRAPHICS_WEAPON_TRAP}}
 +
|
 +
* Tile page ID
 +
* x index
 +
* y index
 +
| Defines tile graphics for TRAPCOMP items when built into a weapon trap; must follow TRAPCOMP_GRAPHICS.
 +
 
 +
|-
 +
| {{text_anchor|TRAPCOMP_GRAPHICS_UPRIGHT_#X}}
 +
|
 +
* Tile page ID
 +
* x index
 +
* y index
 +
| Defines tile graphics for installed upright spike traps. These comprise two-tile graphics: # is replaced with the number of spikes, 1-10; X is replaced with T (for top graphic tile) or B (bottom graphic tile). This follows the tile graphics definition of either MENACINGSPIKE or SPEAR.
 +
 
 +
|-
 +
| {{text_anchor|SIEGEAMMO_GRAPHICS}}
 +
|
 +
* Item ID
 +
| Begins defining graphics for SIEGEAMMO items.
 +
 
 +
|-
 +
| {{text_anchor|SIEGEAMMO_GRAPHICS_STRAIGHT_DEFAULT}}
 +
|
 +
* Tile page ID
 +
* x index
 +
* y index
 +
| Defines graphics for ballista arrows aligned orthogonally on the map; follows SEIGEAMMO_GRAPHICS.
 +
 
 +
|-
 +
| {{text_anchor|SIEGEAMMO_GRAPHICS_STRAIGHT_WOOD}}
 +
|
 +
* Tile page ID
 +
* x index
 +
* y index
 +
| Wooden variant of above.
 +
 
 +
|-
 +
| {{text_anchor|SIEGEAMMO_GRAPHICS_DIAGONAL_DEFAULT}}
 +
|
 +
* Tile page ID
 +
* x index
 +
* y index
 +
| Defines graphics for ballista arrows aligned diagonally on the map; follows SEIGEAMMO_GRAPHICS.
 +
 
 +
|-
 +
| {{text_anchor|SIEGEAMMO_GRAPHICS_DIAGONAL_WOOD}}
 +
|
 +
* Tile page ID
 +
* x index
 +
* y index
 +
| Wood variant of above.
 +
 
 +
|-
 +
| {{text_anchor|AMMO_GRAPHICS}}
 +
|
 +
* Item ID
 +
| Begins defining graphics for AMMO items.
 +
 
 +
|-
 +
| {{text_anchor|AMMO_GRAPHICS_STRAIGHT_DEFAULT}}
 +
|
 +
* Tile page ID
 +
* x index
 +
* y index
 +
| Defines graphics for AMMO items aligned orthogonally on the map; follows AMMO_GRAPHICS.
 +
 
 +
|-
 +
| {{text_anchor|AMMO_GRAPHICS_STRAIGHT_WOOD}}
 +
|
 +
* Tile page ID
 +
* x index
 +
* y index
 +
| Wooden variant of above.
 +
 
 +
|-
 +
| {{text_anchor|AMMO_GRAPHICS_DIAGONAL_DEFAULT}}
 +
|
 +
* Tile page ID
 +
* x index
 +
* y index
 +
| Defines graphics for AMMO aligned diagonally on the map; follows AMMO_GRAPHICS.
 +
 
 +
|-
 +
| {{text_anchor|AMMO_GRAPHICS_DIAGONAL_WOOD}}
 +
|
 +
* Tile page ID
 +
* x index
 +
* y index
 +
| Wood variant of above.
 +
 
 +
|-
 +
| {{text_anchor|WEAPON_GRAPHICS}}
 +
|
 +
* Item ID
 +
| Begins defining graphics for WEAPON items.
 +
 
 +
|-
 +
| {{text_anchor|WEAPON_GRAPHICS_DEFAULT}}
 +
|
 +
* Tile page ID
 +
* x index
 +
* y index
 +
| Defines default graphics for WEAPON item defined by WEAPON_GRAPHICS not being worn by creatures; follows WEAPON_GRAPHICS.
 +
 
 +
|-
 +
| {{text_anchor|WEAPON_GRAPHICS_MATERIAL}}
 +
|
 +
* Tile page ID
 +
* x index
 +
* y index
 +
| Defines material palette{{verify}} graphics for WEAPON item defined by WEAPON_GRAPHICS not being worn by creatures; follows WEAPON_GRAPHICS.
 +
 
 +
|-
 +
| {{text_anchor|WEAPON_GRAPHICS_WOOD_GROWN}}
 +
|
 +
* Tile page ID
 +
* x index
 +
* y index
 +
| Defines graphics for grown-wood WEAPON item defined by WEAPON_GRAPHICS not being worn by creatures; follows WEAPON_GRAPHICS.
 +
 
 +
|-
 +
| {{text_anchor|WEAPON_GRAPHICS_WOOD}}
 +
|
 +
* Tile page ID
 +
* x index
 +
* y index
 +
| Defines graphics for wooden WEAPON item defined by WEAPON_GRAPHICS not being worn by creatures; follows WEAPON_GRAPHICS.
 +
 
 +
|-
 +
| {{text_anchor|WEAPON_GRAPHICS_WEAPON_TRAP}}
 +
|
 +
* Tile page ID
 +
* x index
 +
* y index
 +
| Defines graphics for WEAPON item defined by WEAPON_GRAPHICS as it appears installed in a weapon trap; follows WEAPON_GRAPHICS.
 +
 
 +
|-
 +
| {{text_anchor|TOOL_GRAPHICS}}
 +
|
 +
* Tile page ID
 +
* x index
 +
* y index
 +
* Item ID
 +
| Defines default graphics for TOOL items; also begins defining variant graphics for material or container conditions when followed by tokens below.
 +
 
 +
|-
 +
| {{text_anchor|ADD_TOOL_GRAPHICS}}
 +
|
 +
* Item ID
 +
| Adds graphics to an existing tool defined with TOOL_GRAPHICS, followed by the tool graphics material or container condition tokens below.
 +
 
 +
|-
 +
| {{text_anchor|TOOL_GRAPHICS_WOOD}}
 +
|
 +
* Variant index
 +
* Tile page ID
 +
* x index
 +
* y index
 +
| Defines additonal variant graphics for wooden TOOL items defined by TOOL_GRAPHICS; follows TOOL_GRAPHICS or ADD_TOOL_GRAPHICS. Requires seven variants; the resulting tool graphic is selected randomly from these (they can all point to the same tile index if desired).
 +
 
 +
|-
 +
| {{text_anchor|TOOL_GRAPHICS_STONE}}
 +
|
 +
* Variant index
 +
* Tile page ID
 +
* x index
 +
* y index
 +
| Defines additonal variant graphics for stone TOOL items defined by TOOL_GRAPHICS; follows TOOL_GRAPHICS or ADD_TOOL_GRAPHICS. Requires seven variants; the resulting tool graphic is selected randomly from these (they can all point to the same tile index if desired).
 +
 
 +
|-
 +
| {{text_anchor|TOOL_GRAPHICS_METAL}}
 +
|
 +
* Variant index
 +
* Tile page ID
 +
* x index
 +
* y index
 +
| Defines additonal variant graphics for metal TOOL items defined by TOOL_GRAPHICS; follows TOOL_GRAPHICS or ADD_TOOL_GRAPHICS. Requires seven variants; the resulting tool graphic is selected randomly from these (they can all point to the same tile index if desired).
 +
 
 +
|-
 +
| {{text_anchor|TOOL_GRAPHICS_GLASS}}
 +
|
 +
* Variant index
 +
* Tile page ID
 +
* x index
 +
* y index
 +
| Defines additonal variant graphics for glass TOOL items defined by TOOL_GRAPHICS; follows TOOL_GRAPHICS or ADD_TOOL_GRAPHICS. Requires seven variants; the resulting tool graphic is selected randomly from these (they can all point to the same tile index if desired).
 +
 
 +
|-
 +
| {{text_anchor|TOOL_GRAPHICS_CONTAINER_WOOD_LIQUID}}
 +
|
 +
* Tile page ID
 +
* x index
 +
* y index
 +
| Defines graphics for wooden liquid-containing containers (empty); follows ADD_TOOL_GRAPHICS definition for container.
 +
 
 +
|-
 +
| {{text_anchor|TOOL_GRAPHICS_CONTAINER_STONE_LIQUID}}
 +
|
 +
* Tile page ID
 +
* x index
 +
* y index
 +
| Defines graphics for stone liquid-containing containers (empty); follows ADD_TOOL_GRAPHICS definition for container.
 +
 
 +
|-
 +
| {{text_anchor|TOOL_GRAPHICS_CONTAINER_METAL_LIQUID}}
 +
|
 +
* Tile page ID
 +
* x index
 +
* y index
 +
| Defines graphics for metal (and glass?) liquid-containing containers (empty); follows ADD_TOOL_GRAPHICS definition for container.
 +
 
 +
|-
 +
| {{text_anchor|TOOL_GRAPHICS_CONTAINER_LIQUID}}
 +
|
 +
* Tile page ID
 +
* x index
 +
* y index
 +
| Defines graphics for the liquid filling a liquid-containing container; follows TOOL_GRAPHICS_CONTAINER_*_LIQUID.
 +
 
 +
|-
 +
| {{text_anchor|TOOL_GRAPHICS_CONTAINER_WOOD_ITEM}}
 +
|
 +
* Tile page ID
 +
* x index
 +
* y index
 +
| Defines graphics for wooden containers holding items; follows ADD_TOOL_GRAPHICS definition for container.
 +
 
 +
|-
 +
| {{text_anchor|TOOL_GRAPHICS_CONTAINER_STONE_ITEM}}
 +
|
 +
* Tile page ID
 +
* x index
 +
* y index
 +
| Defines graphics for stone containers holding items; follows ADD_TOOL_GRAPHICS definition for container.
 +
 
 +
|-
 +
| {{text_anchor|TOOL_GRAPHICS_CONTAINER_METAL_ITEM}}
 +
|  
 +
* Tile page ID
 +
* x index
 +
* y index
 +
| Defines graphics for metal (and glass?) containers holding items; follows ADD_TOOL_GRAPHICS definition for container.
 +
|-
 +
| {{text_anchor|TOOL_GRAPHICS_HIVE_BLD}}
 +
|
 +
* Tile page ID
 +
* x index
 +
* y index
 +
| Defines the built item graphics for HIVE items.
 +
 
 +
|-
 +
| {{text_anchor|TOOL_GRAPHICS_HIVE_BLD_IN_USE}}
 +
|
 +
* Tile page ID
 +
* x index
 +
* y index
 +
| Defines the built item graphics for HIVE items that have hives installed.
 +
 
 +
|-
 +
| {{text_anchor|TOOL_GRAPHICS_HIVE_PRODUCTS}}
 
|  
 
|  
−
*creature <code>[[Creature token#NAME|NAME]]</code> token
+
* Tile page ID
−
| References the creature that will utilize the following graphics raws according to the <code>NAME</code> token defined in it's associated [[Raw file|object file]].
+
* x index
 +
* y index
 +
| Defines the built item graphics for HIVE items that are ready to be harvested.
  
 
|-
 
|-
−
| {{text anchor|CREATURE_CASTE_GRAPHICS}}
+
| {{text_anchor|TOOL_GRAPHICS_SHAPE}}
−
| Caste Reference
 
 
|  
 
|  
−
*creature <code>[[Creature token#NAME|NAME]]</code> token
+
* Shape ID
−
*creature <code>[[Creature token#CASTE|CASTE]]</code> token
+
* Tile page ID
−
| References the caste of a creature to be defined according to its referenced <code>[CASTE]</code> token assigned in it's associated [[Raw file|object file]], i.e. <code> [CREATURE_CASTE_GRAPHICS:BIRD_PEAFOWL_BLUE:MALE]</code> will start the definition for the <code>[MALE]</code> caste of the creature with the <code>[[Blue peafowl|BIRD_PEAFOWL_BLUE]]</code> <code>[NAME]</code>token.
+
* x index
 +
* y index
 +
| Defines graphics for shaped items; currently used for dice.
  
 
|}
 
|}
 +
<