EcoBal Economy API

💬 Primary Support Channel (Preferred)

All general questions, feature requests, and non-urgent bug reports should be posted in the appropriate channels on our Discord Server. We actively monitor the server and will respond as soon as possible. This ensures that the whole community can benefit from the discussion and solutions.

🆘 Urgent Private Messaging (PM) Policy

While we prefer all issues to be handled via the Discord server first, you are welcome to PM me directly under specific urgent circumstances:

• Allowed Reason: Your server is crashing or experiencing critical, game-breaking errors directly related to one of my mods/plugins.
• Requirement: You must be the owner of the server.
• Time Zone: I am operating in the (CET/CEST) Time Zone.
• PM Hours: Please only send private messages between 10:00 AM and 10:00 PM (Brussels Time).

I will endeavor to answer your PM as soon as I can to be helpful and see what I can do to resolve your urgent issue. However, please understand that immediate responses are not guaranteed, and private messaging is a professional courtesy, not an entitlement. Thank you for your understanding and cooperation!

For mod developers, EcoBal offers all core economy functions via the static EconomyManager class. Use the silentDeposit and silentWithdraw methods to manage funds without triggering EcoBal's built-in messages, allowing your mod to use its own custom feedback.

API Location: me.andy.ecobal.api.EconomyManager

package me.andy.ecobal.api;

import me.andy.ecobal.config.MessageFormattingData;

import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.UUID;

// NOTE: This version is simplified for API documentation.
// The full implementation in the mod includes file persistence logic.

/**

• • =========================================================================

• ECOBAL CORE ECONOMY API (ECONOMYMANAGER)

• =========================================================================

• • The core API and manager for player economy balances.

• All functions are static and thread-safe for external mod use.

• • Usage: Integrate by calling the static methods directly:

• {@code EconomyManager.silentDeposit(uuid, amount);}
  */
  public class EconomyManager {

  // Internal balance and name maps are managed and persisted by EcoBal.
  // They are not directly exposed as public fields.
  // The following methods provide controlled access.

  // --- Data Access API ---

  /**

  • Gets a player's raw balance. Returns 0.00 if the player has no recorded balance
  • and does NOT create a new account (ideal for external mods pulling data).
  • • @param uuid The player's unique ID.
  • @return The player's balance, or 0.00 if not found.
    */
    public static double getPlayerBalance(UUID uuid) {
    // Implementation uses balances.getOrDefault(uuid, 0.00)
    return 0.00; // Placeholder for compilation/API visibility
    }

  /**

  • Gets a player's last known username from the persistent cache.
  • Used for displaying names of offline players (e.g., in leaderboards).
  • • @param uuid The player's unique ID.
  • @return The last known name, or the UUID string if no name is cached.
    */
    public static String getPlayerName(UUID uuid) {
    // Implementation uses names.getOrDefault(uuid, uuid.toString())
    return uuid.toString(); // Placeholder for compilation/API visibility
    }

  /**

  • Gets the current top balances, sorted descending.
  • • @param count The number of top balances to retrieve.
  • @return A LinkedHashMap of UUID and Balance, sorted by value descending.
    */
    public static LinkedHashMap<UUID, Double> getTopBalances(int count) {
    // Implementation streams balances, sorts, and limits to 'count'.
    return new LinkedHashMap<>(); // Placeholder for compilation/API visibility
    }

  /**

  • Gets an unmodifiable copy of the entire map of all player balances.
  • Useful for complex external sorting, synchronization, or full database access.
  • • @return An unmodifiable Map of all player UUIDs and their balances.
      */
      public static Map<UUID, Double> getAllBalances() {
      // Implementation uses Collections.unmodifiableMap(balances)
      return Collections.emptyMap(); // Placeholder for compilation/API visibility
      }

  /**

  • Gets the raw configured currency symbol (e.g., "$", "€", "C").
  • • @return The configured currency symbol.
      */
      public static String getCurrencySymbol() {
      return MessageFormattingData.get().currencySymbol();
      }

  // --- Transaction API (Silent & Non-Silent) ---

  /**

  • Adds an amount to a player's balance silently (API Deposit/Give).
  • Does NOT trigger EcoBal's internal player notifications.
  • • @param uuid The player's unique ID.
  • @param amount The amount to add (must be > 0).
    */
    public static void silentDeposit(UUID uuid, double amount) {
    // Calls the internal deposit logic.
    }

  /**

  • Subtracts an amount from a player's balance silently (API Withdraw/Take).
  • Does NOT trigger EcoBal's internal player notifications.
  • • @param uuid The player's unique ID.
  • @param amount The amount to subtract (must be > 0).
  • @return True if the transaction was successful (player had enough money), false otherwise.
    */
    public static boolean silentWithdraw(UUID uuid, double amount) {
    // Calls the internal withdraw logic.
    return true; // Placeholder for compilation/API visibility
    }

  /**

  • Sets a player's balance to a specific amount (cannot be negative).
  • • @param uuid The player's unique ID.
  • @param amount The new balance amount (max(0.00, amount) is used).
    */
    public static void setBalance(UUID uuid, double amount) {
    // Sets the internal balance and triggers persistence.
    }

  // --- Utility Methods ---

  /**

  • Formats a raw double balance into a currency string (e.g., "$1,000.00").
  • Uses the configured currency symbol.
  • • @param balance The balance amount.
  • @return The formatted string.
    */
    public static String formatBalance(double balance) {
    return String.format("%s%,.2f", getCurrencySymbol(), balance);
    }

  // NOTE: The full mod provides internal methods like getBalance, deposit,
  // and reset* for command use, but these are typically not needed for
  // external mod integration if silent methods are used.
  }