HytaleDocs

Shops

Asset path: Server/Shops/*.json

Parent

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

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

Content

Type information:

(Nullable) Array of the type:

ShopElement with the following properties:

KeyTypeDescription
TypeConstant value: ShopElement

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

DisplayNameKey(Nullable) String that matches the pattern: [^\s] and is at least 1 characters long
DescriptionKey(Nullable) String that matches the pattern: [^\s] and is at least 1 characters long
InteractionsArray of the type: Either
GiveItemInteraction

GiveItemInteraction with the following properties:

KeyTypeDescription
TypeConstant value: GiveItem

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

ItemIdString

Reference to a Item asset

QuantityInteger defaults to: 1
or
StartObjectiveInteraction

StartObjectiveInteraction with the following properties:

KeyTypeDescription
TypeConstant value: StartObjective

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

ObjectiveId(Nullable) String

Reference to a ObjectiveAsset asset

Requirements(Nullable) Array of the type: Either
CanStartObjectiveRequirement

CanStartObjectiveRequirement with the following properties:

KeyTypeDescription
TypeConstant value: CanStartObjective

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

ObjectiveId(Nullable) String
or
ReputationRequirement

ReputationRequirement with the following properties:

KeyTypeDescription
TypeConstant value: Reputation

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

ReputationGroupId(Nullable) String

Reference to a ReputationGroup asset

MinRequiredRankId(Nullable) String

Reference to a ReputationRank asset

CostInteger defaults to: 0
Icon(Nullable) String

ScriptedBrushes

Previous Page

TagPatterns

Next Page

On this page

ParentTagsContent