HytaleDocs
Item

Reticles

Asset path: Server/Item/Reticles/*.json

Parent

When set this asset will inherit properties from the named asset.

When inheriting from another ItemReticleConfig most properties will simply be copied from the parent asset to this asset. In the case where both child and parent provide a field the child field will simply replace the value provided by the parent, in the case of nested structures this will apply to the fields within the structure. In some cases the field may decide to act differently, for example: by merging the parent and child fields together.

Type information: String

Tags

Tags are a general way to describe an asset that can be interpreted by other systems in a way they see fit.

For example you could tag something with a Material tag with the values Solid and Stone, And another single tag Ore.

Tags will be expanded into a single list of tags automatically. Using the above example with Material and Ore the end result would be the following list of tags: Ore, Material, Solid, Stone, Material=Solid and Material=Stone.

Type information:

(Nullable) Map of the following:

KeyType
any StringArray of String

Base

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

Type information: Array of String

Reference to a common asset in the folder:

  • Common/UI/Reticles/

with the extension: *.png

ServerEvents

A map of reticle configurations for server-side events.

Type information:

(Nullable) Map of the following:

KeyType
any String
ItemReticleWithDuration

ItemReticleWithDuration with the following properties:

KeyTypeDescription
HideBaseBoolean defaults to: false

Specifies whether the base reticle should be hidden while the configured parts are shown.

PartsArray of String

Reference to a common asset in the folder:

  • Common/UI/Reticles/
with the extension: *.png

A list of reticle parts that should be displayed for this configuration.

Duration(Nullable) Either Number defaults to: 0.25 or String that matches the pattern: ^(-?Infinity|NaN)$

The duration (in seconds) this reticle configuration should be displayed for.

ClientEvents

A map of reticle configurations for client-side events.

Type information:

(Nullable) Map of the following:

KeyTypeDescription
OnHitItemReticle
WieldingItemReticle
OnMovementLeftItemReticle
OnMovementRightItemReticle
OnMovementBackItemReticle

On this page