HytaleDocs

Rewards

Asset path: Server/Rewards/*.json

This object has different properties depending on the value of the Type property.

All possible options are listed below:

Entitlement

EntitlementReward with the following properties:

KeyTypeDescription
TypeConstant value: Entitlement

This field controls the type, it must be set to the constant value "Entitlement" to function as this type.

ParentString

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

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

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

The id of the entitlement to give to the player.

Tags(Nullable) Map of the following:
Map
KeyType
any StringArray of String

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.

On this page