Api Events

HuskSync provides three API events your plugin can listen to when certain parts of the data synchronisation process are performed. These events deal in HuskSync class types, so you may want to familiarize yourself with the API basics first. Two of the events can be cancelled (thus aborting the synchronisation process at certain stages) and some of the events expose methods letting you affect their outcome (such as modifying the data that is saved during the process).

Consult the Javadocs for more information -- and don't forget to register your listener when listening for these event calls. Please note that carrying out expensive blocking operations during these events is strongly discouraged as this may affect plugin performance.

List of API Events

Bukkit Event classCancellableDescription
BukkitDataSaveEventβœ…Called when player data snapshot is created, saved and cached due to a DataSaveCause
BukkitPreSyncβœ…Called before a player has their data updated from the cache or database, just after login
BukkitSyncCompleteEvent❌Called once a player has completed their data synchronisation on login successfully†

†This can also fire when a user's data is updated while the player is logged in; i.e. when an admin rolls back the user, updates their inventory or Ender Chest through the respective commands, or when an API call is made forcing the user to have their data updated.