HytaleDocs
WorldEvent

Event

Asset path: Server/WorldEvent/Event/*.json

Represents a timeline of stages that progress from one to the other depending on the condition and action definitions at each stage.

Parent

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

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

Root

The starting stage for the event.

Type information:

(Nullable) Either String or StageAsset

Reference to a StageAsset asset

Persistent

The event should be persisted with the world and resumed after server restarts.

Type information: Boolean defaults to: true

IterationCount

The number of times this event will repeat. Set to -1 to repeat indefinitely.

Type information: Integer defaults to: -1

PlayerCountMin

The minimum number of players in the world required for the event to run.

Type information: Integer defaults to: 1

InstanceCountMax

The maximum number of instances of the event that can be running at once.

Type information: Integer defaults to: -1

Name

Translation key of the player-facing event name. Shown on the map while the event waits at an interval marked ShowOnMap.

Type information: (Nullable) String

Icon

Common asset path of the event icon. Shown next to the name on the map.

Type information: (Nullable) String

On this page