HytaleDocs
Misc

VoidEventConfig

InvasionPortalCount

The base number of void invasion portals that can be active during the void event. Stages may add capacity for extra portals via their 'ExtraInvasionPortalCount' property.

Type information: Integer defaults to: 24

InvasionPortalSpacing

The minimum distance in blocks to maintain between invasion portals.

Type information: Integer defaults to: 62

Stages

Stages of the void event. Each stage triggers at 'SecondsInto' seconds of the world's lifetime. Only one stage is active at a time. Weather, music, and invasion portals inherit from the previous stage when omitted. SpawnBeacons accumulate: each stage adds its beacons to the previous stages' beacons.

Type information:

(Nullable) Array of the type:

VoidEventStage with the following properties:

KeyTypeDescription
SecondsIntoInteger defaults to: 0

How many seconds into the portal world's lifetime this stage becomes the active stage.

ForcedWeather(Nullable) String

Reference to a Weather asset

What weather to force during this stage. If omitted, the previous stage's weather stays active.

ExtraInvasionPortalCountInteger defaults to: 0

The number of additional invasion portals that may be created at this stage. The total is accumulated over all active stages up to a maximum of 64 portals.

InvasionPortals(Nullable)
InvasionPortalConfig

InvasionPortalConfig with the following properties:

KeyTypeDescription
BlockKey(Nullable) Either String or BlockType

Reference to a BlockType asset

The block used for evil portals that spawn around the world during the event. Can be omitted.

SpawnBeacons(Nullable) Array of String

Reference to a BeaconNPCSpawn asset

An array of SpawnBeacon IDs, which will make mobs spawn around the evil portals.

OnSpawnParticles(Nullable) String

A particle system ID to spawn when the portal spawns, should be a temporary one.

The invasion portals that spawn around players while this stage is active. These remain for the remaining lifetime of the world.

MusicContainer(Nullable) Either String or MusicContainer

Reference to a MusicContainer asset

The ID of a MusicContainer to force during this stage. If omitted, the previous stage's music stays active.

SoundEvent(Nullable) String

Reference to a SoundEvent asset

The sound event to play to every player in the world at the start of this stage. May be omitted.

EventTitle(Nullable)
VoidEventTitle

VoidEventTitle with the following properties:

KeyTypeDescription
PrimaryFormattedMessage

The primary title message.

SecondaryFormattedMessage (1)

The secondary title message.

StyleEventTitleStyle

The title style to use.

Icon(Nullable) String

The icon to use. May be omitted

DurationEither Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$

The number of seconds the title should be displayed for.

FadeInEither Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$

The number of seconds the title should fade-in for.

FadeOutEither Number defaults to: 0.0 or String that matches the pattern: ^(-?Infinity|NaN)$

The number of seconds the title should fade-out for.

The title to show to players at the start of this stage. May be omitted. Is not sent to players that joined the world after the stage started.

Notes:

Types referenced by this type

FormattedMessage

The primary title message.

FormattedMessage with the following properties:

KeyTypeDescription
RawText(Nullable) String
MessageId(Nullable) String
Params(Nullable) Map of the following:
Map
KeyType
any StringType 0
MessageParams(Nullable) Map of the following:
Map
KeyType
any StringFormattedMessage
Children(Nullable) Array of the type: FormattedMessage
Bold(Nullable) (Nullable) Boolean
Italic(Nullable) (Nullable) Boolean
Monospace(Nullable) (Nullable) Boolean
Underline(Nullable) (Nullable) Boolean
Strikethrough(Nullable) (Nullable) Boolean
Color(Nullable) String
Link(Nullable) String

Type 0

Any of these:

Type
Boolean
Number
Integer
String

FormattedMessage (1)

The secondary title message.

FormattedMessage with the following properties:

KeyTypeDescription
RawText(Nullable) String
MessageId(Nullable) String
Params(Nullable) Map of the following:
Map
KeyType
any StringType 0
MessageParams(Nullable) Map of the following:
Map
KeyType
any StringFormattedMessage
Children(Nullable) Array of the type: FormattedMessage
Bold(Nullable) (Nullable) Boolean
Italic(Nullable) (Nullable) Boolean
Monospace(Nullable) (Nullable) Boolean
Underline(Nullable) (Nullable) Boolean
Strikethrough(Nullable) (Nullable) Boolean
Color(Nullable) String
Link(Nullable) String

EventTitleStyle

Any one of the following String:

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.

On this page