Interface EconomyService

public interface EconomyService

YouNeedMe's internal economy. This is also exposed to the rest of the server through a net.milkbowl.vault.economy.Economy provider (see core's Vault integration), so any other plugin can transact against it without knowing YouNeedMe exists - use this interface directly only when you need YouNeedMe-specific features Vault's API doesn't have, such as multi-currency support or transferAtomic(UUID, UUID, String, double).

Every mutating call is serialized per-player internally (a spam of /pay cannot cause a double-spend), and every method is safe to call from any thread.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	EconomyService.BalanceEntry

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_CURRENCY

Method Summary

Modifier and Type	Method	Description
default CompletableFuture<Double>	balance(UUID player)
CompletableFuture<Double>	balance(UUID player, String currencyId)
List<Currency>	currencies()
Currency	currency(String currencyId)
default CompletableFuture<EconomyResult>	deposit(UUID player, double amount)
CompletableFuture<EconomyResult>	deposit(UUID player, String currencyId, double amount)
CompletableFuture<Boolean>	has(UUID player, String currencyId, double amount)
default CompletableFuture<EconomyResult>	setBalance(UUID player, double amount)
CompletableFuture<EconomyResult>	setBalance(UUID player, String currencyId, double amount)
CompletableFuture<List<EconomyService.BalanceEntry>>	top(String currencyId, int page, int pageSize)	Top balances for /baltop, richest first.
default CompletableFuture<EconomyResult>	transferAtomic(UUID from, UUID to, double amount)
CompletableFuture<EconomyResult>	transferAtomic(UUID from, UUID to, String currencyId, double amount)	Withdraws from from and deposits to to as a single atomic unit: on insufficient funds neither balance changes.
default CompletableFuture<EconomyResult>	withdraw(UUID player, double amount)
CompletableFuture<EconomyResult>	withdraw(UUID player, String currencyId, double amount)

Field Details

DEFAULT_CURRENCY

static final String DEFAULT_CURRENCY

See Also:

• Constant Field Values

Method Details

currencies

List<Currency> currencies()

currency

Currency currency(String currencyId)

balance

CompletableFuture<Double> balance(UUID player,
 String currencyId)

balance

default CompletableFuture<Double> balance(UUID player)

has

CompletableFuture<Boolean> has(UUID player,
 String currencyId,
 double amount)

deposit

CompletableFuture<EconomyResult> deposit(UUID player,
 String currencyId,
 double amount)

withdraw

CompletableFuture<EconomyResult> withdraw(UUID player,
 String currencyId,
 double amount)

setBalance

CompletableFuture<EconomyResult> setBalance(UUID player,
 String currencyId,
 double amount)

deposit

default CompletableFuture<EconomyResult> deposit(UUID player,
 double amount)

withdraw

default CompletableFuture<EconomyResult> withdraw(UUID player,
 double amount)

setBalance

default CompletableFuture<EconomyResult> setBalance(UUID player,
 double amount)

transferAtomic

CompletableFuture<EconomyResult> transferAtomic(UUID from,
 UUID to,
 String currencyId,
 double amount)

Withdraws from from and deposits to to as a single atomic unit: on insufficient funds neither balance changes. This is what /pay uses, and is the right primitive for any plugin-to-plugin transfer.

transferAtomic

default CompletableFuture<EconomyResult> transferAtomic(UUID from,
 UUID to,
 double amount)

top

CompletableFuture<List<EconomyService.BalanceEntry>> top(String currencyId,
 int page,
 int pageSize)

Top balances for /baltop, richest first.