API Events

HuskTowns provides several API events your plugin can listen to when players do certain town-related things. These events deal in HuskTowns class types, so you may want to familiarize yourself with the API basics first. Note that on cross-server setups, events only fire on the server the event occurred on and will not fire as a result of API calls/updates.

Consult the Javadocs for more information—and don't forget to register your listener when listening for these event calls.

List of API Events

Bukkit Event classSinceCancellableDescription
TownCreateEvent1.8✅Called when a town is created
PostTownCreateEvent2.6❌Called after a town is created
TownDisbandEvent1.8✅Called when a town is deleted
ClaimEvent1.8✅Called when a player claims a chunk for a town
UnClaimEvent1.8✅Called when a player deletes a claim
UnClaimAllEvent2.1✅Called when a player deletes all of a town's claims
PlayerEnterTownEvent2.0✅Called when a player walks into a town claim from wilderness or another town
PlayerLeaveTownEvent2.0✅Called when a player walks out of a town claim into wilderness or another town
MemberJoinEvent2.0✅Called when a player joins a town
MemberLeaveEvent2.0✅Called when a player leaves or is evicted from a town
MemberRoleChangeEvent2.0✅Called when a player is promoted or demoted within a town
TownWarCreateEvent3.0.6❌Called when a town war starts
TownWarEndEvent3.0.6❌Called when a town war ends