HytaleDocs
Item

Qualities

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

Parent

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

When inheriting from another ItemQuality 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

QualityValue

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

Type information: Integer defaults to: 0

ItemTooltipTexture

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

Type information: String that matches the pattern: [^\s] and is at least 1 characters long

Reference to a common asset in the folder:

  • Common/UI/ItemQualities/

with the extension: *.png

ItemTooltipArrowTexture

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

Type information: String that matches the pattern: [^\s] and is at least 1 characters long

Reference to a common asset in the folder:

  • Common/UI/ItemQualities/

with the extension: *.png

SlotTexture

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

Type information: String that matches the pattern: [^\s] and is at least 1 characters long

Reference to a common asset in the folder:

  • Common/UI/ItemQualities/

with the extension: *.png

BlockSlotTexture

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.

Type information: String that matches the pattern: [^\s] and is at least 1 characters long

Reference to a common asset in the folder:

  • Common/UI/ItemQualities/

with the extension: *.png

SpecialSlotTexture

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.

Type information: String that matches the pattern: [^\s] and is at least 1 characters long

Reference to a common asset in the folder:

  • Common/UI/ItemQualities/

with the extension: *.png

TextColor

The color that'll be used to display the text of the item in the inventory.

Type information:

A color in the form:

  • #RRGGBB

  • rgb(rrr, ggg, bbb)

LocalizationKey

The localization key for the item quality name.

Type information: String that matches the pattern: [^\s] and is at least 1 characters long

VisibleQualityLabel

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

Type information: Boolean defaults to: false

RenderSpecialSlot

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

Type information: Boolean defaults to: false

ItemEntityConfig

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.

Type information:

(Nullable)

ItemEntityConfig with the following properties:

KeyTypeDescription
Physics(Nullable)
PhysicsValues

PhysicsValues with the following properties:

KeyTypeDescription
MassNumber defaults to: 1.0
DragCoefficientNumber defaults to: 0.5
InvertedGravityBoolean defaults to: false
PickupRadius(Nullable) Either Number defaults to: 1.75 or String that matches the pattern: ^(-?Infinity|NaN)$
MergeRadius(Nullable) Either Number defaults to: 2.0 or String that matches the pattern: ^(-?Infinity|NaN)$
Lifetime(Nullable) Either Number or String that matches the pattern: ^(-?Infinity|NaN)$
ParticleSystemId(Nullable) String defaults to: Item

Reference to a ParticleSystem asset

ParticleColor(Nullable) A color in the form:

  • #RRGGBB

  • rgb(rrr, ggg, bbb)

ShowItemParticlesBoolean defaults to: true

HideFromSearch

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

Type information: Boolean defaults to: false

On this page