API

ENEconomy API Documentation

Installation

Maven

<dependency>
    <groupId>dev.necmi</groupId>
    <artifactId>simpleeconomy</artifactId>
    <version>1.0.0</version>
    <scope>provided</scope>
</dependency>

Gradle

dependencies {
    compileOnly 'dev.necmi:simpleeconomy:1.0.0'
}

Quick Start

import dev.necmi.simpleeconomy.api.EconomyAPI;
import dev.necmi.simpleeconomy.api.EconomyAPIProvider;

public class YourPlugin {
    public void example() {
        EconomyAPI economy = EconomyAPIProvider.getAPI();

        if (EconomyAPIProvider.isAvailable()) {
            // Use API...
        }
    }
}

---

Economy API

Getting Balances

EconomyAPI economy = EconomyAPIProvider.getAPI();

BigDecimal balance = economy.getBalance(playerId);

boolean canAfford = economy.hasBalance(playerId, new BigDecimal("100.50"));

---

Modifying Balances

boolean success = economy.addBalance(playerId, new BigDecimal("50.00"));

boolean success = economy.removeBalance(playerId, new BigDecimal("25.00"));

boolean success = economy.setBalance(playerId, new BigDecimal("1000.00"));

boolean success = economy.resetBalance(playerId);

boolean success = economy.transferBalance(fromPlayerId, toPlayerId, new BigDecimal("75.00"));

---

Formatting

String formatted = economy.formatAmount(new BigDecimal("1234.5"));

String symbol = economy.getCurrencySymbol();
String name = economy.getCurrencyName();
int decimals = economy.getDecimalPlaces();

---

Event System

BalanceChangeEvent

import dev.necmi.simpleeconomy.events.BalanceChangeEvent;

eventBus.register(BalanceChangeEvent.class, event -> {
    UUID playerId = event.getPlayerId();
    BigDecimal oldBalance = event.getOldBalance();
    BigDecimal newBalance = event.getNewBalance();
    BigDecimal change = event.getAmountChanged();
    BalanceChangeEvent.ChangeType type = event.getChangeType();

    event.setCancelled(true);
});

ChangeType

Value	Description
INCREASE	Balance went up
DECREASE	Balance went down
ADMIN_SET	Admin set balance
RESET	Balance reset

---

EconomyTransactionEvent

import dev.necmi.simpleeconomy.events.EconomyTransactionEvent;

eventBus.register(EconomyTransactionEvent.class, "default, event -> {
    UUID playerId = event.getPlayerId();
    BigDecimal amount = event.getAmount();
    EconomyTransactionEvent.TransactionType type = event.getTransactionType();
    String source = event.getSource();
});

TransactionType

Value	Description
TRANSFER_SEND	Sent money
TRANSFER_RECEIVE	Received money
ADMIN_GIVE	Admin gave
ADMIN_SET	Admin set
ADMIN_RESET	Admin reset

---

Event Listeners

import dev.necmi.simpleeconomy.api.EconomyEventListener;

public class MyListener implements EconomyEventListener {

    @Override
    public void onBalanceChange(UUID playerId, BigDecimal oldBalance,
                               BigDecimal newBalance, BalanceChangeType type) {
        switch (type) {
            case INCREASE:
                break;
            case DECREASE:
                break;
            case ADMIN_SET:
                break;
            case RESET:
                break;
        }
    }

    @Override
    public void onPayment(UUID senderId, UUID receiverId, BigDecimal amount, boolean successful) {
        if (successful) {
            System.out.println("Payment success");
        }
    }

    @Override
    public void onAdminTransaction(UUID playerId, BigDecimal amount,
                                   AdminTransactionType type) {
        switch (type) {
            case GIVE:
                break;
            case TAKE:
                break;
            case SET:
                break;
            case RESET:
                break;
        }
    }
}

Register:

EconomyAPI economy = EconomyAPIProvider.getAPI();
economy.registerEventListener(new MyListener());

Unregister:

economy.unregisterEventListener(listener);

---

Important Notes

• Always check EconomyAPIProvider.isAvailable()

• All money uses BigDecimal

• Decimal places are configurable

• Events are cancellable

• Use UUID instead of player name

• Methods return true if successful

---

Configuration Values

Method	Description	Example
getCurrencySymbol()	Currency symbol	$, €, ₺
getCurrencyName()	Currency name	coins
getDecimalPlaces()	Decimal count	2
formatAmount()	Format value	1,234.50

---

API Reference

EconomyAPI

Method	Returns
getBalance(UUID)	BigDecimal
hasBalance(UUID, BigDecimal)	boolean
addBalance(UUID, BigDecimal)	boolean
removeBalance(UUID, BigDecimal)	boolean
setBalance(UUID, BigDecimal)	boolean
resetBalance(UUID)	boolean
transferBalance(UUID, UUID, BigDecimal)	boolean
formatAmount(BigDecimal)	String
getDecimalPlaces()	int
getCurrencySymbol()	String
getCurrencyName()	String
registerEventListener(EconomyEventListener)	void
unregisterEventListener(EconomyEventListener)	void

---

Error Handling

try {
    boolean success = economy.transferBalance(fromId, toId, amount);
    if (!success) {
        // handle failure
    }
} catch (IllegalStateException e) {
    System.out.println("API not ready");
}