HytaleDocs
Misc

InstanceDiscoveryConfig

Configuration for displaying an event title when a player discovers an instance.

TitleKey

The translation key for the primary title (e.g., "server.instances.gaia_temple.title").

Type information: String

SubtitleKey

The translation key for the subtitle (e.g., "server.instances.gaia_temple.subtitle").

Type information: (Nullable) String

Display

Whether to display the discovery title and play the discovery sound.

Type information: Boolean defaults to: true

AlwaysDisplay

Whether to always display the discovery title, even if already discovered.

Type information: Boolean defaults to: false

DiscoverySoundEventId

The sound event ID to play when discovering this instance.

Type information: (Nullable) String

Icon

The icon to display with the event title.

Type information: (Nullable) String

Style

The style the client uses to present the event title.

Type information:

(Nullable) Any one of the following String (defaults to Default):

NameDescription
"Default"

The standard event title presentation.

"Major"

A major event title presentation.

"GoblinBreach"

The presentation for a goblin breach.

"VoidEviction"

The presentation for a void-presence eviction.

Major

Deprecated field for whether this is a major discovery.

Type information: Boolean

Duration

The duration to display the event title for, in seconds.

Type information:

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

FadeInDuration

The fade-in duration for the event title, in seconds.

Type information:

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

FadeOutDuration

The fade-out duration for the event title, in seconds.

Type information:

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

On this page