diff --git a/docs/Data-Snapshot-API.md b/docs/Data-Snapshot-API.md index 5e57e4ee..0cf1ace1 100644 --- a/docs/Data-Snapshot-API.md +++ b/docs/Data-Snapshot-API.md @@ -164,8 +164,10 @@ huskSyncAPI.getCurrentData(user).thenAccept(optionalSnapshot -> { | `husksync:statistics` | User statistics | `#getStatistics` | `#setStatistics` | | `husksync:health` | User health | `#getHealth` | `#setHealth` | | `husksync:hunger` | User hunger, saturation & exhaustion | `#getHunger` | `#setHunger` | +| `husksync:attributes` | User attributes | `#getAttributes` | `#setAttributes` | | `husksync:experience` | User level, experience, and score | `#getExperience` | `#setExperience` | -| `husksync:game_mode` | User game mode and flight status | `#getGameMode` | `#setGameMode` | +| `husksync:game_mode` | User game mode | `#getGameMode` | `#setGameMode` | +| `husksync:flight_status` | User ability to fly/if flying now | `#getFlightStatus` | `#setFlightStatus` | | `husksync:persistent_data` | User persistent data container | `#getPersistentData` | `#setPersistentData` | | Custom types; `plugin:foo` | Any custom data | `#getData(Identifer)` | `#setData(Identifier)` | @@ -173,8 +175,8 @@ huskSyncAPI.getCurrentData(user).thenAccept(optionalSnapshot -> { * You can only get data from snapshots where a serializer has been registered for it on this server and, in the case of the built-in data types, where the sync feature has been enabled in the [[Config File]]. If you try to get data from a snapshot where the data type is not supported, you will get an empty `Optional`. ### 4.2 Editing Health, Hunger, Experience, and GameMode data -* `DataSnapshot.Unpacked#getHealth()` returns an `Optional`, which you can then use to get the player's current and max health. -* `DataSnapshot.Unpacked#setHealth(Data.Health)` sets the player's current and max health. You can create a `Health` instance to pass on the Bukkit platform through `BukkitData.Health.from(double, double, double)`. +* `DataSnapshot.Unpacked#getHealth()` returns an `Optional`, which you can then use to get the player's current health. +* `DataSnapshot.Unpacked#setHealth(Data.Health)` sets the player's current health. You can create a `Health` instance to pass on the Bukkit platform through `BukkitData.Health.from(double, double)`. * Similar methods exist for Hunger, Experience, and GameMode data types * Once you've updated the data in the snapshot, you can save it to the database using `HuskSyncAPI#setCurrentData(user, userData)`. @@ -254,11 +256,8 @@ huskSyncAPI.editCurrentData(user, snapshot -> { // Get the player's current health double currentHealth = health.getCurrentHealth(); - // Get the player's max health - double maxHealth = health.getMaxHealth(); - - // Set the player's health - snapshot.setHealth(BukkitData.Health.from(20, 20, 20)); + // Set the player's health / health scale + snapshot.setHealth(BukkitData.Health.from(20, 20)); }); ```