Adventure Events

Packages:

Events related to adventure gameplay, objectives, and instances.

TreasureChestOpeningEvent

Fired when a player opens a treasure chest.

Class: com.hypixel.hytale.builtin.adventure.objectives.events.TreasureChestOpeningEvent

Field	Type	Nullable	Description
`objectiveUUID`	`UUID`	No	UUID of the objective
`chestUUID`	`UUID`	No	UUID of the treasure chest
`playerRef`	`Ref<EntityStore>`	No	Reference to the player entity
`store`	`Store<EntityStore>`	No	Entity store

Method	Return Type	Description
`getObjectiveUUID()`	`UUID`	Returns the objective UUID
`getChestUUID()`	`UUID`	Returns the chest UUID
`getPlayerRef()`	`Ref<EntityStore>`	Returns the player entity reference
`getStore()`	`Store<EntityStore>`	Returns the entity store

Fired when a player interacts with and opens a treasure chest.

Fired when an instance is discovered. Abstract base with concrete subclasses.

Class: com.hypixel.hytale.builtin.instances.event.DiscoverInstanceEvent

Field	Type	Nullable	Description
`instanceWorldUuid`	`UUID`	No	UUID of the instance world
`discoveryConfig`	`InstanceDiscoveryConfig`	No	Configuration for the instance discovery

Method	Return Type	Description
`getInstanceWorldUuid()`	`UUID`	Returns the instance world UUID
`getDiscoveryConfig()`	`InstanceDiscoveryConfig`	Returns the discovery configuration

Fired when an instance discovery should be displayed to the player.

This event is cancellable.

Field	Type	Nullable	Description
`cancelled`	`boolean`	No	Whether the event is cancelled
`display`	`boolean`	No	Whether the discovery should be displayed

Method	Return Type	Description
`shouldDisplay()`	`boolean`	Returns whether the discovery should be displayed
`setDisplay(boolean)`	`void`	Sets whether to display the discovery

Fired when a player discovers an instance (dungeon, special area, etc.).