Item

← Back to Asset Types

Documentation for the Item asset type.

Location

Item/Items

Use in Your Files

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

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

Schema

Tree

Icon stringnull

Categories arraynull

A list of categories this item will be shown in on the creative library menu.

Array items: string

IconProperties unknown

Any of

AssetIconProperties

null

TranslationProperties unknown

The translation properties for this item asset.

Any of

ItemTranslationProperties

null

ItemLevel integer

Default:0

Reticle unknown

Any of

stringReference to ItemReticleConfig

ItemReticleConfig

null

MaxStack integer

The maximum amount this item can be stacked in the inventory

Default:-1

Min (exclusive): 0

Quality stringnull

ItemEntity ItemEntityConfig

SoundEventId stringnull

ItemSoundSetId string

Default:"ISS_Default"

Set stringnull

Model stringnull

The model used for rendering this item. If this is a block, BlockType.Model should be used instead.

Scale number

Default:1

Texture stringnull

The texture used for rendering this item. If this is a block, block specific properties should be used instead.

Default:"Items/Unknown.png"

Animation stringnull

The animation used for rendering this item. If this is a block, block specific properties should be used instead.

UsePlayerAnimations boolean

Default:false

PlayerAnimationsId unknown

Any of

stringReference to ItemPlayerAnimations

ItemPlayerAnimations

DroppedItemAnimation stringnull

Particles arraynull

The particles played for this item. If this is a block, block specific properties should be used instead.

Array items: ModelParticle

FirstPersonParticles arraynull

The particles played for this item when in first person. If this is a block, block specific properties should be used instead.

Array items: ModelParticle

Trails arraynull

The trail attached to this item

Array items: ModelTrail

Light unknown

The light this item is emitting when being held or dropped. For block light, see Block properties

Any of

ColorLight

null

Recipe unknown

Any of

CraftingRecipe

null

ResourceTypes arraynull

Array items: ItemResourceType

Tool unknown

Any of

ItemTool

null

BlockSelectorTool unknown

Any of

BlockSelectorToolData

null

BuilderTool unknown

Any of

BuilderToolData

null

Weapon unknown

Any of

ItemWeapon

null

Armor unknown

Any of

ItemArmor

null

Glider unknown

Any of

ItemGlider

null

Utility ItemUtility

Default:{"Usable":false,"Compatible":false}

PortalKey unknown

Any of

PortalKey

null

Container ItemStackContainerConfig

Default:{"Capacity":0,"GlobalFilter":"AllowAll"}

Consumable boolean

Default:false

Variant boolean

Whether this item is a variant of another. Typically this is only the case for connected blocks. If this item is marked as a variant, then we filter it out of the item library menu by default, unless the player chooses to display variants.

Default:false

MaxDurability number

Default:0

FuelQuality number

Default:1

DurabilityLossOnHit number

Default:0

BlockType unknown

Any of

stringReference to BlockType

BlockType

null

Interactions objectnull

Primary unknown

Any of

stringReference to RootInteraction

RootInteraction

Secondary unknown

Any of

stringReference to RootInteraction

RootInteraction

Ability1 unknown

Any of

stringReference to RootInteraction

RootInteraction

Ability2 unknown

Any of

stringReference to RootInteraction

RootInteraction

Ability3 unknown

Any of

stringReference to RootInteraction

RootInteraction

Use unknown

Any of

stringReference to RootInteraction

RootInteraction

Pick unknown

Any of

stringReference to RootInteraction

RootInteraction

Pickup unknown

Any of

stringReference to RootInteraction

RootInteraction

CollisionEnter unknown

Any of

stringReference to RootInteraction

RootInteraction

CollisionLeave unknown

Any of

stringReference to RootInteraction

RootInteraction

Collision unknown

Any of

stringReference to RootInteraction

RootInteraction

EntityStatEffect unknown

Any of

stringReference to RootInteraction

RootInteraction

SwapTo unknown

Any of

stringReference to RootInteraction

RootInteraction

SwapFrom unknown

Any of

stringReference to RootInteraction

RootInteraction

Death unknown

Any of

stringReference to RootInteraction

RootInteraction

Wielding unknown

Any of

stringReference to RootInteraction

RootInteraction

ProjectileSpawn unknown

Any of

stringReference to RootInteraction

RootInteraction

ProjectileHit unknown

Any of

stringReference to RootInteraction

RootInteraction

ProjectileMiss unknown

Any of

stringReference to RootInteraction

RootInteraction

ProjectileBounce unknown

Any of

stringReference to RootInteraction

RootInteraction

Held unknown

Any of

stringReference to RootInteraction

RootInteraction

HeldOffhand unknown

Any of

stringReference to RootInteraction

RootInteraction

Equipped unknown

Any of

stringReference to RootInteraction

RootInteraction

Dodge unknown

Any of

stringReference to RootInteraction

RootInteraction

GameModeSwap unknown

Any of

stringReference to RootInteraction

RootInteraction

Additional properties

Any of

stringReference to RootInteraction

RootInteraction

InteractionConfig InteractionConfiguration

InteractionVars objectnull

Additional properties

Any of

stringReference to RootInteraction

RootInteraction

ItemAppearanceConditions objectnull

Define per EntityStat an array of ItemAppearanceCondition. Only a single condition will be applied to the item at the same time.

Additional properties: array

DisplayEntityStatsHUD arraynull

Used to indicate to the client whether an EntityStat HUD UI needs to be displayed

Array items: string

PullbackConfig unknown

Overrides the offset of first person arms when close to obstacles

Any of

ItemPullbackConfig

null

ClipsGeometry boolean

Default:false

RenderDeployablePreview boolean

Default:false

DropOnDeath boolean

Default:false

State objectnull

Additional properties

Any of

stringReference to Item

Item

All of

base

Raw JSON

Copy

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "Item.json",
  "title": "Item",
  "description": "Item asset type",
  "type": "object",
  "allOf": [
    {
      "$ref": "base.schema.json"
    }
  ],
  "properties": {
    "Icon": {
      "type": [
        "string",
        "null"
      ]
    },
    "Categories": {
      "type": [
        "array",
        "null"
      ],
      "description": "A list of categories this item will be shown in on the creative library menu.",
      "items": {
        "type": "string"
      }
    },
    "IconProperties": {
      "anyOf": [
        {
          "$ref": "common.schema.json#/$defs/AssetIconProperties"
        },
        {
          "type": "null"
        }
      ]
    },
    "TranslationProperties": {
      "description": "The translation properties for this item asset.",
      "anyOf": [
        {
          "$ref": "common.schema.json#/$defs/ItemTranslationProperties"
        },
        {
          "type": "null"
        }
      ]
    },
    "ItemLevel": {
      "type": "integer",
      "default": 0
    },
    "Reticle": {
      "anyOf": [
        {
          "type": "string",
          "title": "Reference to ItemReticleConfig"
        },
        {
          "$ref": "ItemReticleConfig.json#"
        },
        {
          "type": "null"
        }
      ]
    },
    "MaxStack": {
      "type": "integer",
      "description": "The maximum amount this item can be stacked in the inventory",
      "exclusiveMinimum": 0,
      "default": -1
    },
    "Quality": {
      "type": [
        "string",
        "null"
      ]
    },
    "ItemEntity": {
      "$ref": "common.schema.json#/$defs/ItemEntityConfig"
    },
    "SoundEventId": {
      "type": [
        "string",
        "null"
      ]
    },
    "ItemSoundSetId": {
      "type": "string",
      "default": "ISS_Default"
    },
    "Set": {
      "type": [
        "string",
        "null"
      ]
    },
    "Model": {
      "type": [
        "string",
        "null"
      ],
      "description": "The model used for rendering this item. If this is a block, BlockType.Model should be used instead."
    },
    "Scale": {
      "type": "number",
      "default": 1
    },
    "Texture": {
      "type": [
        "string",
        "null"
      ],
      "description": "The texture used for rendering this item. If this is a block, block specific properties should be used instead.",
      "default": "Items/Unknown.png"
    },
    "Animation": {
      "type": [
        "string",
        "null"
      ],
      "description": "The animation used for rendering this item. If this is a block, block specific properties should be used instead."
    },
    "UsePlayerAnimations": {
      "type": "boolean",
      "default": false
    },
    "PlayerAnimationsId": {
      "anyOf": [
        {
          "type": "string",
          "title": "Reference to ItemPlayerAnimations"
        },
        {
          "$ref": "ItemPlayerAnimations.json#"
        }
      ]
    },
    "DroppedItemAnimation": {
      "type": [
        "string",
        "null"
      ]
    },
    "Particles": {
      "type": [
        "array",
        "null"
      ],
      "description": "The particles played for this item. If this is a block, block specific properties should be used instead.",
      "items": {
        "$ref": "common.schema.json#/$defs/ModelParticle"
      }
    },
    "FirstPersonParticles": {
      "type": [
        "array",
        "null"
      ],
      "description": "The particles played for this item when in first person. If this is a block, block specific properties should be used instead.",
      "items": {
        "$ref": "common.schema.json#/$defs/ModelParticle"
      }
    },
    "Trails": {
      "type": [
        "array",
        "null"
      ],
      "description": "The trail attached to this item",
      "items": {
        "$ref": "common.schema.json#/$defs/ModelTrail"
      }
    },
    "Light": {
      "description": "The light this item is emitting when being held or dropped. For block light, see Block properties",
      "anyOf": [
        {
          "$ref": "common.schema.json#/$defs/ColorLight"
        },
        {
          "type": "null"
        }
      ]
    },
    "Recipe": {
      "anyOf": [
        {
          "$ref": "CraftingRecipe.json#"
        },
        {
          "type": "null"
        }
      ]
    },
    "ResourceTypes": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "common.schema.json#/$defs/ItemResourceType"
      }
    },
    "Tool": {
      "anyOf": [
        {
          "$ref": "common.schema.json#/$defs/ItemTool"
        },
        {
          "type": "null"
        }
      ]
    },
    "BlockSelectorTool": {
      "anyOf": [
        {
          "$ref": "common.schema.json#/$defs/BlockSelectorToolData"
        },
        {
          "type": "null"
        }
      ]
    },
    "BuilderTool": {
      "anyOf": [
        {
          "$ref": "common.schema.json#/$defs/BuilderToolData"
        },
        {
          "type": "null"
        }
      ]
    },
    "Weapon": {
      "anyOf": [
        {
          "$ref": "common.schema.json#/$defs/ItemWeapon"
        },
        {
          "type": "null"
        }
      ]
    },
    "Armor": {
      "anyOf": [
        {
          "$ref": "common.schema.json#/$defs/ItemArmor"
        },
        {
          "type": "null"
        }
      ]
    },
    "Glider": {
      "anyOf": [
        {
          "$ref": "common.schema.json#/$defs/ItemGlider"
        },
        {
          "type": "null"
        }
      ]
    },
    "Utility": {
      "default": {
        "Usable": false,
        "Compatible": false
      },
      "$ref": "common.schema.json#/$defs/ItemUtility"
    },
    "PortalKey": {
      "anyOf": [
        {
          "$ref": "common.schema.json#/$defs/PortalKey"
        },
        {
          "type": "null"
        }
      ]
    },
    "Container": {
      "default": {
        "Capacity": 0,
        "GlobalFilter": "AllowAll"
      },
      "$ref": "common.schema.json#/$defs/ItemStackContainerConfig"
    },
    "Consumable": {
      "type": "boolean",
      "default": false
    },
    "Variant": {
      "type": "boolean",
      "description": "Whether this item is a variant of another. Typically this is only the case for connected blocks. If this item is marked as a variant, then we filter it out of the item library menu by default, unless the player chooses to display variants.",
      "default": false
    },
    "MaxDurability": {
      "type": "number",
      "default": 0
    },
    "FuelQuality": {
      "type": "number",
      "default": 1
    },
    "DurabilityLossOnHit": {
      "type": "number",
      "default": 0
    },
    "BlockType": {
      "anyOf": [
        {
          "type": "string",
          "title": "Reference to BlockType"
        },
        {
          "$ref": "BlockType.json#"
        },
        {
          "type": "null"
        }
      ]
    },
    "Interactions": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "Primary": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "Secondary": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "Ability1": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "Ability2": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "Ability3": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "Use": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "Pick": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "Pickup": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "CollisionEnter": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "CollisionLeave": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "Collision": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "EntityStatEffect": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "SwapTo": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "SwapFrom": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "Death": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "Wielding": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "ProjectileSpawn": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "ProjectileHit": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "ProjectileMiss": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "ProjectileBounce": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "Held": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "HeldOffhand": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "Equipped": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "Dodge": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        },
        "GameModeSwap": {
          "anyOf": [
            {
              "type": "string",
              "title": "Reference to RootInteraction"
            },
            {
              "$ref": "RootInteraction.json#"
            }
          ]
        }
      },
      "additionalProperties": {
        "anyOf": [
          {
            "type": "string",
            "title": "Reference to RootInteraction"
          },
          {
            "$ref": "RootInteraction.json#"
          }
        ]
      },
      "propertyNames": {
        "enum": [
          "Primary",
          "Secondary",
          "Ability1",
          "Ability2",
          "Ability3",
          "Use",
          "Pick",
          "Pickup",
          "CollisionEnter",
          "CollisionLeave",
          "Collision",
          "EntityStatEffect",
          "SwapTo",
          "SwapFrom",
          "Death",
          "Wielding",
          "ProjectileSpawn",
          "ProjectileHit",
          "ProjectileMiss",
          "ProjectileBounce",
          "Held",
          "HeldOffhand",
          "Equipped",
          "Dodge",
          "GameModeSwap"
        ]
      }
    },
    "InteractionConfig": {
      "$ref": "common.schema.json#/$defs/InteractionConfiguration"
    },
    "InteractionVars": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "anyOf": [
          {
            "type": "string",
            "title": "Reference to RootInteraction"
          },
          {
            "$ref": "RootInteraction.json#"
          }
        ]
      }
    },
    "ItemAppearanceConditions": {
      "type": [
        "object",
        "null"
      ],
      "description": "Define per EntityStat an array of ItemAppearanceCondition. Only a single condition will be applied to the item at the same time.",
      "additionalProperties": {
        "type": "array",
        "items": {
          "$ref": "common.schema.json#/$defs/ItemAppearanceCondition"
        }
      }
    },
    "DisplayEntityStatsHUD": {
      "type": [
        "array",
        "null"
      ],
      "description": "Used to indicate to the client whether an EntityStat HUD UI needs to be displayed",
      "items": {
        "type": "string"
      }
    },
    "PullbackConfig": {
      "description": "Overrides the offset of first person arms when close to obstacles",
      "anyOf": [
        {
          "$ref": "common.schema.json#/$defs/ItemPullbackConfig"
        },
        {
          "type": "null"
        }
      ]
    },
    "ClipsGeometry": {
      "type": "boolean",
      "default": false
    },
    "RenderDeployablePreview": {
      "type": "boolean",
      "default": false
    },
    "DropOnDeath": {
      "type": "boolean",
      "default": false
    },
    "State": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "anyOf": [
          {
            "type": "string",
            "title": "Reference to Item"
          },
          {
            "$ref": "Item.json#"
          }
        ]
      }
    }
  }
}