VGRAVES API
Methods
This page collects the public API methods for managers, player data, grave lookup, tickets, reclaim flows, utility checks, saves, and cleanup.
Available Methods
| Method | Returns | Description |
|---|---|---|
getGraveManager() | GraveManager | Returns the runtime grave manager for deeper integrations. |
getCurrencyHandler() | CurrencyHandler | Returns the currency integration handler used by paid reclaim flows. |
getLangManager() | LangManager | Returns the language/message manager. |
getGraveLogger() | GraveLogger | Returns the grave audit/logger component. |
getPlayerData(UUID playerUuid) | PlayerData | Returns stored VGraves data for a player. |
getGraves(UUID playerUuid) | List<Grave> | Returns all active graves for a player. |
getGrave(UUID playerUuid, String graveId) | Grave | Looks up one grave by owner UUID and grave id. |
hasGrave(UUID playerUuid, String graveId) | boolean | Checks whether the player has a grave with the given id. |
getGraveCount(UUID playerUuid) | int | Returns the number of active graves owned by a player. |
getTickets(UUID playerUuid) | int | Returns the player's current ticket balance. |
getBuyUsage(UUID playerUuid) | int | Returns how many paid reclaim usages are tracked for the player. |
getTicketUsage(UUID playerUuid) | int | Returns how many ticket reclaim usages are tracked for the player. |
addTickets(UUID playerUuid, int amount) | void | Adds grave tickets and fires the ticket-change flow. |
removeTickets(UUID playerUuid, int amount) | void | Removes grave tickets and fires the ticket-change flow. |
setTickets(UUID playerUuid, int amount) | void | Sets the player's grave ticket balance. |
createGrave(Player player) | Grave | Creates a grave from the player's current death-related inventory state. |
createGraveFromSnapshot(Player player, ItemStack[] storageContents, ItemStack[] armorContents, ItemStack offhandItem, int xp, List<ItemStack> dropFallback) | Grave | Creates a grave from a custom snapshot for external death handling. |
claimWithTicket(UUID ownerUuid, String graveId, Player receiver) | TicketClaimResult | Attempts to reclaim a grave using a ticket. |
claimWithCurrency(UUID ownerUuid, String graveId, Player receiver) | PaidClaimResult | Attempts to reclaim a grave using the configured currency flow. |
precheckCurrencyClaim(UUID ownerUuid, String graveId, Player receiver) | PaidClaimResult | Checks whether a paid reclaim can proceed before claiming. |
forceClaim(UUID ownerUuid, String graveId, Player receiver, boolean consumeGrave) | boolean | Runs an admin restore flow and optionally consumes the grave. |
giveUp(UUID ownerUuid, String graveId, Player actor) | boolean | Runs the give-up flow for a grave. |
removeGrave(UUID ownerUuid, String graveId) | boolean | Deletes a grave from the player's stored grave data. |
isExceptionItem(ItemStack itemStack) | boolean | Checks whether an item is configured as an exception item. |
shouldConsumeAdminSelfClaim() | boolean | Returns whether admin self-claims should consume the grave. |
savePlayerData(UUID playerUuid) | void | Saves one player's grave data. |
saveAll() | void | Saves all loaded grave data. |
cleanupExpired() | void | Runs expired-grave cleanup. |
Related Events
GraveCreatedEventGraveClaimedEventGraveGivenUpEventGraveRemovedEventGraveExpiredEventGraveTicketsChangedEvent
Behavior Notes
- Ticket methods run through the plugin flow and trigger the ticket-change event.
- The snapshot grave creator is intended for plugins that handle custom death logic but still want VGraves storage.
- Claim methods return flow-specific result objects so integrations can react to success or failure states.