Event System

Hook into game events with @EventHandler. Player connections, chat, combat, and more.

All 58 Player 8 World 8 Block 2 Entity 3 Crafting 3 Combat 4 Permission 6

Block Events

2
BreakBlockEvent
Cancellable

Fired when a block is broken. ECS event - runs on world thread.
PlaceBlockEvent
Cancellable

Fired when a block is placed. ECS event - runs on world thread.

Combat Events

4
DamageBlockEvent
Cancellable

Fired when a block takes damage (mining). ECS event.
KillFeedEvent.DecedentMessage

Death message for victim
KillFeedEvent.Display

Kill feed display
KillFeedEvent.KillerMessage

Kill message for killer

Crafting Events

3
CraftRecipeEvent.Post

After crafting
CraftRecipeEvent.Pre
Cancellable

Before crafting
PlayerCraftEvent

Fired when player crafts an item.

Discovery Events

4
DiscoverInstanceEvent

Instance discovered
DiscoverInstanceEvent.Display
Cancellable

Instance discovery display
DiscoverZoneEvent.Display
Cancellable

Zone discovery display
TreasureChestOpeningEvent

Treasure chest opened

Entity Events

3
EntityRemoveEvent

Fired when an entity is removed from the world.
LivingEntityInventoryChangeEvent

Fired when a living entity inventory changes.
PrefabPlaceEntityEvent

Entity placed from prefab

Interaction Events

6
InteractivelyPickupItemEvent
Cancellable

Item pickup interaction
LivingEntityUseBlockEvent

Entity used a block
PlayerInteractEvent
Cancellable

Fired when player interacts with world. Has actionType (InteractionType), itemInHand (ItemStack), targetBlock (Vector3i), targetEntity (Entity). Cancellable.
UseBlockEvent

Fired when a block is used/activated. Has Pre and Post variants. ECS event.
UseBlockEvent.Post

After block use
UseBlockEvent.Pre
Cancellable

Before block use

Item Events

5
DropItemEvent
Cancellable

ECS event fired when item is dropped. Cancellable.
DropItemEvent.Drop
Cancellable

Item being dropped
DropItemEvent.PlayerRequest
Cancellable

Player requests item drop
ItemContainerChangeEvent

Fired when an item container changes.
SwitchActiveSlotEvent
Cancellable

Hotbar slot changed

Other Events

4
ChangeGameModeEvent
Cancellable

Game mode changed
MouseExited

Fired when mouse exits a UI element. Useful for canceling confirmation dialogs.
PrefabPasteEvent
Cancellable

Prefab being pasted
ValueChanged

Fired when a UI element value changes (text input, checkbox, dropdown)

Permission Events

6
GroupPermissionChangeEvent.Added

Permission added to group
GroupPermissionChangeEvent.Removed

Permission removed from group
PlayerPermissionChangeEvent.GroupAdded

Player added to permission group
PlayerPermissionChangeEvent.GroupRemoved

Player removed from permission group
PlayerPermissionChangeEvent.PermissionsAdded

Permissions added to player
PlayerPermissionChangeEvent.PermissionsRemoved

Permissions removed from player

Player Events

8
PlayerChatEvent
Cancellable

Fired when a player sends a chat message. Use getSender() to get PlayerRef (NOT Player!). Cast to Player via store.getComponent() if needed.
PlayerConnectEvent

Fired when a player connects to the server. Use to handle initial setup.
PlayerDisconnectEvent

Fired when a player disconnects from the server.
PlayerMouseButtonEvent
Cancellable

Fired when player presses or releases a mouse button.
PlayerMouseMotionEvent
Cancellable

Fired when player moves their mouse/camera.
PlayerReadyEvent

Fired when a player is fully loaded and ready in the world. Use for welcome messages, loading player data, etc.
PlayerSetupConnectEvent
Cancellable

Pre-connection authentication. Cancel to reject connection.
PlayerSetupDisconnectEvent

Pre-disconnection

System Events

5
BootEvent

Server initialization event
MessagesUpdated

Language messages updated
MoonPhaseChangeEvent

Moon phase changed
PluginSetupEvent

Fired during plugin setup phase.
ShutdownEvent

Server shutdown event. Special priorities: DISCONNECT_PLAYERS(-48), UNBIND_LISTENERS(-40), SHUTDOWN_WORLDS(-32)

World Events

8
AddPlayerToWorldEvent

Player added to world
AddWorldEvent

Fired when a new world is added.
AllWorldsLoadedEvent

Fired when all worlds are loaded.
DrainPlayerFromWorldEvent

Player removed from world
PrepareUniverseEvent

Universe preparation (deprecated)
RemovePlayerFromWorldEvent

Fired when player is removed from a world.
RemoveWorldEvent

Fired when a world is removed.
StartWorldEvent

Fired when a world starts.