Api Events

HuskHomes provides a number of API events your plugin can listen to when certain actions are performed. Most of these events are cancellable, letting you stop them from executing if you wish.

List of API events

Bukkit Event classSinceCancellableDescription
HomeCreateEvent4.0βœ…Called when a player sets a home
HomeListEvent3.0βœ…Called when a player requests to view a list of homes / public homes
HomeEditEvent4.0βœ…Called when a player edits a home (privacy, relocate, description, name)
HomeDeleteEvent3.0βœ…Called when a player deletes a home†
DeleteAllHomesEvent3.2.1βœ…Called when a player uses /delhome all to delete all their homes
WarpCreateEvent4.0βœ…Called when a player sets a warp
WarpListEvent3.0βœ…Called when a player requests to view a list of warps
WarpEditEvent4.0βœ…Called when a player edits a warp (relocate, description, name)
WarpDeleteEvent3.0βœ…Called when a player deletes a warp†
DeleteAllWarpsEvent3.2.1βœ…Called when a player uses /delwarp all to delete all warps
TeleportWarmupEvent3.0βœ…Called when a player starts a teleport warmup countdown
TeleportEvent3.0βœ…Called when a player is teleported‑

† If the player uses /delhome all or /delwarp all to delete all their homes or all the warps, a single DeleteAllHomesEvent or DeleteAllWarpsEvent is fired instead. ‑ Called on the server the player is teleported from; not neccessarily where the executor of the teleport is.