Event Reference

This is a comprehensive index of all events in the Hytale server, organized by package.

How to Read This Reference

Column	Description
Event	Event class name
Async	Whether the event implements IAsyncEvent (handlers use CompletableFuture)
Cancellable	Whether the event implements ICancellable
Key	The KeyType parameter - Void for global, String for named keys, etc.
Description	Brief description of when the event fires

Registration Tips:

• Void key: Use register(Event.class, handler)
• String key: Use registerGlobal() for all, or register(Event.class, "key", handler) for specific
• See Listening to Events for details

---

Core Server Events

Package: com.hypixel.hytale.server.core.event.events

Event	Async	Cancellable	Key	Description
BootEvent	No	No	Void	Server finished booting
ShutdownEvent	No	No	Void	Server shutting down
PrepareUniverseEvent	No	No	Void	Universe preparation phase

---

Player Events

Package: com.hypixel.hytale.server.core.event.events.player + server.core.entity.entities.player.windows

Event	Async	Cancellable	Key	Description
PlayerConnectEvent	No	No	Void	Player connects to server
PlayerDisconnectEvent	No	No	Void	Player disconnects from server
PlayerSetupConnectEvent	No	Yes	Void	Connection setup (can reject)
PlayerSetupDisconnectEvent	No	No	Void	Disconnect during setup
PlayerReadyEvent	No	No	String	Player fully ready in world
PlayerChatEvent	Yes	Yes	String	Player sends chat message
PlayerInteractEvent	No	Yes	Void	Player interaction (deprecated)
PlayerCraftEvent	No	No	Void	Player crafts (deprecated)
PlayerMouseButtonEvent	No	Yes	Void	Mouse button input
PlayerMouseMotionEvent	No	Yes	Void	Mouse movement input
AddPlayerToWorldEvent	No	No	String	Player added to a world
DrainPlayerFromWorldEvent	No	No	String	Player removed from a world
WindowCloseEvent	No	No	Void	Player window (UI) closed

---

Entity Events

Package: com.hypixel.hytale.server.core.event.events.entity + server.core.inventory.container

Event	Async	Cancellable	Key	Description
EntityRemoveEvent	No	No	String	Entity being removed
LivingEntityUseBlockEvent	No	No	String	Living entity uses block (deprecated)
LivingEntityInventoryChangeEvent	No	No	String	Entity inventory changed
ItemContainerChangeEvent	No	No	Void	Item container contents changed

---

ECS Events (Block/Item/Combat Interactions)

Package: com.hypixel.hytale.server.core.event.events.ecs + modules.entity.damage

Event	Async	Cancellable	Key	Description
Damage	No	Yes	-	Entity takes damage (combat)
BreakBlockEvent	No	Yes	-	Player breaks a block
PlaceBlockEvent	No	Yes	-	Player places a block
DamageBlockEvent	No	Yes	-	Block takes damage
UseBlockEvent.Pre	No	Yes	-	Before block interaction
UseBlockEvent.Post	No	No	-	After block interaction
DropItemEvent	No	Yes	-	Item dropped
InteractivelyPickupItemEvent	No	Yes	-	Player picks up item
SwitchActiveSlotEvent	No	Yes	-	Hotbar slot changed
CraftRecipeEvent.Pre	No	Yes	-	Before crafting
CraftRecipeEvent.Post	No	Yes	-	After crafting
DiscoverZoneEvent	No	No	-	Zone discovered (base)
DiscoverZoneEvent.Display	No	Yes	-	Zone discovery notification
ChangeGameModeEvent	No	Yes	-	Game mode changed

Note: ECS events extend EcsEvent or CancellableEcsEvent base classes.

---

Permission Events

Package: com.hypixel.hytale.server.core.event.events.permissions

Event	Async	Cancellable	Key	Description
PlayerGroupEvent	No	No	Void	Player’s group changed (abstract)
PlayerGroupEvent.Added	No	No	Void	Player added to group
PlayerGroupEvent.Removed	No	No	Void	Player removed from group
GroupPermissionChangeEvent	No	No	Void	Group permissions modified (abstract)
GroupPermissionChangeEvent.Added	No	No	Void	Permission added to group
GroupPermissionChangeEvent.Removed	No	No	Void	Permission removed from group
PlayerPermissionChangeEvent	No	No	Void	Player permissions modified (abstract)
PlayerPermissionChangeEvent.PermissionsAdded	No	No	Void	Permissions granted to player
PlayerPermissionChangeEvent.PermissionsRemoved	No	No	Void	Permissions revoked from player
PlayerPermissionChangeEvent.GroupAdded	No	No	Void	Player gained perms via group
PlayerPermissionChangeEvent.GroupRemoved	No	No	Void	Player lost perms via group

---

World Events

Package: com.hypixel.hytale.server.core.universe.world.events

Event	Async	Cancellable	Key	Description
AddWorldEvent	No	Yes	String	World added to universe
RemoveWorldEvent	No	Yes	String	World removed from universe
StartWorldEvent	No	No	String	World starting
AllWorldsLoadedEvent	No	No	Void	All worlds finished loading
ChunkPreLoadProcessEvent	No	No	String	Chunk pre-load processing
WorldPathChangedEvent	No	No	Void	World file path changed
ChunkUnloadEvent	No	Yes	-	Chunk being unloaded (ECS)
ChunkSaveEvent	No	Yes	-	Chunk being saved (ECS)
MoonPhaseChangeEvent	No	No	-	Moon phase changed (ECS)

---

NPC Events

Packages: com.hypixel.hytale.server.npc + server.spawning

Event	Async	Cancellable	Key	Description
AllNPCsLoadedEvent	No	No	Void	All NPCs finished loading
LoadedNPCEvent	No	No	Void	Specific NPC loaded

---

Adventure Events

Packages: com.hypixel.hytale.builtin.adventure + builtin.instances

Event	Async	Cancellable	Key	Description
TreasureChestOpeningEvent	No	No	String	Player opens treasure chest
DiscoverInstanceEvent	No	No	-	Instance discovered (ECS, abstract)
DiscoverInstanceEvent.Display	No	Yes	-	Instance discovery notification (ECS)

---

Asset Events

Package: com.hypixel.hytale.assetstore.event + com.hypixel.hytale.server.core.asset

Event	Async	Cancellable	Key	Description
LoadAssetEvent	No	No	Void	Asset loading phase
LoadedAssetsEvent	No	No	Class<?>	Assets of a type loaded
RemovedAssetsEvent	No	No	Class<?>	Assets of a type removed
AssetPackRegisterEvent	No	No	Void	Asset pack registered
AssetPackUnregisterEvent	No	No	Void	Asset pack unregistered
GenerateSchemaEvent	No	No	Void	Schema generation
GenerateAssetsEvent	No	No	Class<?>	Asset generation
RegisterAssetStoreEvent	No	No	Void	Asset store registered
RemoveAssetStoreEvent	No	No	Void	Asset store removed
AssetStoreMonitorEvent	No	No	Void	Asset file changes detected
CommonAssetMonitorEvent	No	No	Void	Common asset file changes
SendCommonAssetsEvent	Yes	No	Void	Sending assets to client

---

Asset Editor Events

Package: com.hypixel.hytale.builtin.asseteditor.event

Event	Async	Cancellable	Key	Description
AssetEditorClientDisconnectEvent	No	No	Void	Editor client disconnected
AssetEditorAssetCreatedEvent	No	No	String	Asset created in editor
AssetEditorSelectAssetEvent	No	No	Void	Asset selected in editor
AssetEditorActivateButtonEvent	No	No	String	Button activated in editor
AssetEditorRequestDataSetEvent	Yes	No	String	Data set requested
AssetEditorFetchAutoCompleteDataEvent	Yes	No	String	Autocomplete data requested
AssetEditorUpdateWeatherPreviewLockEvent	No	No	Void	Weather preview lock changed

Note: Asset editor events are primarily for development tools.

---

Plugin Events

Package: com.hypixel.hytale.server.core.plugin.event

Event	Async	Cancellable	Key	Description
PluginSetupEvent	No	No	Class<?>	Plugin entering setup phase

---

Prefab Events

Package: com.hypixel.hytale.server.core.prefab.event

Event	Async	Cancellable	Key	Description
PrefabPasteEvent	No	Yes	-	Prefab being pasted (ECS)
PrefabPlaceEntityEvent	No	No	-	Entity placed from prefab (ECS)

---

Module Events

Package: Various module packages

Event	Async	Cancellable	Key	Description
KillFeedEvent	No	No	-	Kill feed notification (ECS, base)
KillFeedEvent.KillerMessage	No	Yes	-	Message shown to killer (ECS)
KillFeedEvent.DecedentMessage	No	Yes	-	Message shown to deceased (ECS)
KillFeedEvent.Display	No	Yes	-	Kill feed display (ECS)
GenerateDefaultLanguageEvent	No	No	Void	Default language generation
MessagesUpdated	No	No	Void	i18n messages updated
SingleplayerRequestAccessEvent	No	No	Void	Singleplayer access requested

---

Legend

• - = ECS event (handled differently via ECS systems, not IEvent)
• Void = Global event, use register()
• String = String-keyed, use registerGlobal() for all or register(..., key, ...) for specific
• Class<?> = Type-keyed, use register(..., AssetClass.class, ...) for specific type