ItemReticleConfig

← Back to Asset Types

Documentation for the ItemReticleConfig asset type.

Location

Item/Reticles

Use in Your Files

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

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

Schema

Tree

Base array

Paths to the parts that should be displayed for the base reticle.

Array items: string

ServerEvents objectnull

A map of reticle configurations for server-side events.

Additional properties: ItemReticleWithDuration

ClientEvents objectnull

A map of reticle configurations for client-side events.

OnHit ItemReticle

Wielding ItemReticle

OnMovementLeft ItemReticle

OnMovementRight ItemReticle

OnMovementBack ItemReticle

Additional properties: ItemReticle

All of

base

Raw JSON

Copy

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "ItemReticleConfig.json",
  "title": "ItemReticleConfig",
  "description": "ItemReticleConfig asset type",
  "type": "object",
  "allOf": [
    {
      "$ref": "base.schema.json"
    }
  ],
  "properties": {
    "Base": {
      "type": "array",
      "description": "Paths to the parts that should be displayed for the base reticle.",
      "items": {
        "type": "string"
      },
      "minItems": 1
    },
    "ServerEvents": {
      "type": [
        "object",
        "null"
      ],
      "description": "A map of reticle configurations for server-side events.",
      "additionalProperties": {
        "$ref": "common.schema.json#/$defs/ItemReticleWithDuration"
      }
    },
    "ClientEvents": {
      "type": [
        "object",
        "null"
      ],
      "title": "Map of ItemReticleClientEvent",
      "description": "A map of reticle configurations for client-side events.",
      "properties": {
        "OnHit": {
          "$ref": "common.schema.json#/$defs/ItemReticle"
        },
        "Wielding": {
          "$ref": "common.schema.json#/$defs/ItemReticle"
        },
        "OnMovementLeft": {
          "$ref": "common.schema.json#/$defs/ItemReticle"
        },
        "OnMovementRight": {
          "$ref": "common.schema.json#/$defs/ItemReticle"
        },
        "OnMovementBack": {
          "$ref": "common.schema.json#/$defs/ItemReticle"
        }
      },
      "additionalProperties": {
        "$ref": "common.schema.json#/$defs/ItemReticle"
      },
      "propertyNames": {
        "enum": [
          "OnHit",
          "Wielding",
          "OnMovementLeft",
          "OnMovementRight",
          "OnMovementBack"
        ]
      }
    }
  }
}