VVOUCHER API
Methods
This page collects the public API methods for both vouchers and external event tables, plus the related usage event.
Available Methods
| Method | Returns | Description |
|---|---|---|
getAllVouchers() | List<VoucherDefinition> | Returns every loaded voucher, including disabled ones. |
getEnabledVouchers() | List<VoucherDefinition> | Returns only vouchers that are currently enabled. |
getAllEvents() | List<EventDefinition> | Returns every loaded event from events/*.yml. |
isVoucher(ItemStack itemStack) | boolean | Checks the persistent voucher marker on the item. |
getVoucher(ItemStack itemStack) | VoucherDefinition | Resolves voucher data from a tagged item instance. |
getVoucher(String configKey) | VoucherDefinition | Looks up a voucher directly by config id. |
getEvent(String eventId) | EventDefinition | Resolves a reusable external event by id. |
executeEvent(String eventId, Player player) | VoucherDefinition.RandomCommandEntry | Executes the selected event for a player and returns the chosen reward entry. |
Related Events
The API also exposes a cancellable VVoucherUsage Bukkit event.
@EventHandler
public void onVoucherUsage(VVoucherUsage event) {
if (event.getVoucher().getId().equalsIgnoreCase("fly-permission")) {
event.setCancelled(true);
}
}Behavior Notes
getAllVouchers()includes disabled vouchers too.getEnabledVouchers()filters only active ones.getAllEvents()returns the loaded reusable event reward tables.getVoucher(item)works from persistent metadata, not display name.getVoucher(configKey)can still resolve disabled vouchers.getEvent(eventId)returns an event definition by id.executeEvent(eventId, player)runs an event for the target player and returns the selected reward entry.