forked from public-mirrors/HuskSync
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
12 lines
1.7 KiB
Markdown
12 lines
1.7 KiB
Markdown
2 years ago
|
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](API) 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 class | Cancellable | Description |
|
||
|
|
|---------------------------|:-----------:|---------------------------------------------------------------------------------------------|
|
||
|
|
| `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.
|