ItemQuality

← Back to Asset Types

Documentation for the ItemQuality asset type.

Location

Item/Qualities

Use in Your Files

Add this to your JSON files for IDE autocompletion and validation:

"$schema": "https://hytaledb.ginco.gg/schemas/ItemQuality.schema.json" Copy

Schema

Tree

QualityValue integer

Define the value of the quality to order them, 0 being the lowest quality.

Default:0

ItemTooltipTexture string

The path to the texture of the item tooltip. It has to be located in Common/Items/Qualities.

Pattern:[^\s]

ItemTooltipArrowTexture string

The path to the texture of the item tooltip arrow. It has to be located in Common/Items/Qualities.

Pattern:[^\s]

SlotTexture string

The path to the texture of the item slot. It has to be located in Common/Items/Qualities.

Pattern:[^\s]

BlockSlotTexture string

The path to the texture of the item slot, if it has an associated block type. It has to be located in Common/Items/Qualities.

Pattern:[^\s]

SpecialSlotTexture string

The path to the texture of the item slot used when RenderSpecialSlot is true and the item is consumable or usable. It has to be located in Common/Items/Qualities.

Pattern:[^\s]

TextColor ColorRGB

LocalizationKey string

The localization key for the item quality name.

Pattern:[^\s]

VisibleQualityLabel boolean

To specify the quality label should be displayed in the tooltip.

Default:false

RenderSpecialSlot boolean

To specify if we display a special slot texture if the item is a consumable or usable.

Default:false

ItemEntityConfig unknown

Provides an ItemEntityConfig used for all items with their item quality set to this asset unless overridden by an ItemEntityConfig defined on the item itself.

Any of

ItemEntityConfig

null

HideFromSearch boolean

Whether this item is hidden from typical public search, like the creative library

Default:false

All of

base

Raw JSON

Copy

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "ItemQuality.json",
  "title": "ItemQuality",
  "description": "ItemQuality asset type",
  "type": "object",
  "allOf": [
    {
      "$ref": "base.schema.json"
    }
  ],
  "properties": {
    "QualityValue": {
      "type": "integer",
      "description": "Define the value of the quality to order them, 0 being the lowest quality.",
      "default": 0
    },
    "ItemTooltipTexture": {
      "type": "string",
      "description": "The path to the texture of the item tooltip. It has to be located in Common/Items/Qualities.",
      "pattern": "[^\\s]",
      "minLength": 1
    },
    "ItemTooltipArrowTexture": {
      "type": "string",
      "description": "The path to the texture of the item tooltip arrow. It has to be located in Common/Items/Qualities.",
      "pattern": "[^\\s]",
      "minLength": 1
    },
    "SlotTexture": {
      "type": "string",
      "description": "The path to the texture of the item slot. It has to be located in Common/Items/Qualities.",
      "pattern": "[^\\s]",
      "minLength": 1
    },
    "BlockSlotTexture": {
      "type": "string",
      "description": "The path to the texture of the item slot, if it has an associated block type. It has to be located in Common/Items/Qualities.",
      "pattern": "[^\\s]",
      "minLength": 1
    },
    "SpecialSlotTexture": {
      "type": "string",
      "description": "The path to the texture of the item slot used when RenderSpecialSlot is true and the item is consumable or usable. It has to be located in Common/Items/Qualities.",
      "pattern": "[^\\s]",
      "minLength": 1
    },
    "TextColor": {
      "$ref": "base.schema.json#/$defs/ColorRGB"
    },
    "LocalizationKey": {
      "type": "string",
      "description": "The localization key for the item quality name.",
      "pattern": "[^\\s]",
      "minLength": 1
    },
    "VisibleQualityLabel": {
      "type": "boolean",
      "description": "To specify the quality label should be displayed in the tooltip.",
      "default": false
    },
    "RenderSpecialSlot": {
      "type": "boolean",
      "description": "To specify if we display a special slot texture if the item is a consumable or usable.",
      "default": false
    },
    "ItemEntityConfig": {
      "description": "Provides an ItemEntityConfig used for all items with their item quality set to this asset unless overridden by an ItemEntityConfig defined on the item itself.",
      "anyOf": [
        {
          "$ref": "common.schema.json#/$defs/ItemEntityConfig"
        },
        {
          "type": "null"
        }
      ]
    },
    "HideFromSearch": {
      "type": "boolean",
      "description": "Whether this item is hidden from typical public search, like the creative library",
      "default": false
    }
  }
}