Ultra Economy

https://ultraeconomy.com/wiki
Admin
Ultra Economy is a Minecraft server economy management plugin that enables multi-currency creation,...
Tokens:8,439
Snippets:118
Trust Score:5.4
Update:1 month ago
Show doc for...
Tokens:
Raw
### Get UltraEconomyAPI instance

Source: https://ultraeconomy.com/wiki/api

Obtain the Ultra Economy API instance. This instance provides methods for managing economic features, detailed on other pages of the API documentation.

```java
UltraEconomyAPI api = UltraEconomy.getAPI();
```

--------------------------------

### Add UltraEconomyAPI Maven dependency

Source: https://ultraeconomy.com/wiki/api

Add the Techscode repository and the UltraEconomyAPI dependency to your Maven build file. Replace VERSION with the desired version; available versions can be browsed from the linked page.

```xml
<repositories>
    <repository>
        <id>techscode</id>
        <url>https://repo.techscode.com/repository/techscode-apis/</url>
    </repository>
</repositories>

<dependency>
    <groupId>me.TechsCode</groupId>
    <artifactId>UltraEconomyAPI</artifactId>
    <version>VERSION</version>
    <scope>provided</scope>
</dependency>
```

--------------------------------

### UltraEconomyAPI

Source: https://ultraeconomy.com/wiki/api/instance

The UltraEconomyAPI interface provides methods to access various registries and lists within Ultra Economy, including accounts, currencies, transactions, trades, bank accounts, and system settings.

```APIDOC
## UltraEconomyAPI

### Description
Provides access to the storage, actions, and events of Ultra Economy.

### Methods

#### getAccounts
- **Return Type**: `AccountList`
- **Description**: Retrieve all registered Player accounts.

#### getCurrencies
- **Return Type**: `CurrencyList`
- **Description**: Retrieve all currencies.

#### getTransactions
- **Return Type**: `TransactionList`
- **Description**: Retrieve all transactions made (Currency).

#### getLoggedTrades
- **Return Type**: `LoggedTradeList`
- **Description**: Retrieve all trades that have been made.

#### getBankAccounts
- **Return Type**: `BankAccountList`
- **Description**: Retrieve all registered bank accounts.

#### getDropMoneyOnDeathRegistry
- **Return Type**: `LoseMoneyOnDeathRegistry`
- **Description**: Retrieve the drop money on death system settings.

#### getBankFeatureRegistry
- **Return Type**: `BankFeatureRegistry`
- **Description**: Retrieve all the bank feature settings.

#### getLocalRegistry
- **Return Type**: `LocalRegistry`
- **Description**: Retrieve all the local settings (Database, Language, and appearance).

#### getMobDropsRegistry
- **Return Type**: `MobDropsRegistry`
- **Description**: Retrieve mob drop system settings.

#### getDisabledLoseMoneyOnDeathWorldsRegistry
- **Return Type**: `DisabledLoseMoneyOnDeathWorldsRegistry`
- **Description**: Retrieve disabled world for money on death system.

#### getTradeSystemRegistry
- **Return Type**: `TradeSystemRegistry`
- **Description**: Retrieve all trading system settings.

#### getVaultCurrency
- **Return Type**: `Optional<Currency>`
- **Description**: Retrieve the currency that is set to Vault.

#### getAvailableServers
- **Return Type**: `ServerList`
- **Description**: Get all available servers for Ultra Economy.
```

--------------------------------

### UltraEconomyAPI interface methods

Source: https://ultraeconomy.com/wiki/api/instance

Defines the public interface for the Ultra Economy API instance, exposing methods to access storage, actions, and events. Use it to retrieve accounts, currencies, transactions, logged trades, bank accounts, and various registries for settings like money-on-death, banks, local configuration, mob drops, disabled worlds, trading, Vault currency, and available servers.

```java
/**
 * The main instance of the UltraEconomyAPI
 */
public interface UltraEconomyAPI {

    /**
     * Retrieve all registered Player accounts
     */
    AccountList getAccounts();

    /**
     * Retrieve all currencies
     */
    CurrencyList getCurrencies();

    /**
     * Retrieve all transactions made (Currency)
     */
    TransactionList getTransactions();

    /**
     * Retrieve all trades that have been made
     */
    LoggedTradeList getLoggedTrades();

    /**
     * Retrieve all registered bank accounts
     */
    BankAccountList getBankAccounts();

    /**
     * Retrieve the drop money on death system settings
     */
    LoseMoneyOnDeathRegistry getDropMoneyOnDeathRegistry();

    /**
     * Retrieve all the bank feature settings
     */
    BankFeatureRegistry getBankFeatureRegistry();
    
    /**
     * Retrieve all the local settings (Database, Language, and appearance)
     */
    LocalRegistry getLocalRegistry();
    
    /**
     * Retrieve mob drop system settings
     */
    MobDropsRegistry getMobDropsRegistry();
    
    /**
     * Retrieve disabled world for money on death system
     */
    DisabledLoseMoneyOnDeathWorldsRegistry getDisabledLoseMoneyOnDeathWorldsRegistry();
    
    /**
     * Retrieve all trading system settings
     */
    TradeSystemRegistry getTradeSystemRegistry();
    
    /**
     * Rettrieve the currency that is set to Vault
     */
    Optional<Currency> getVaultCurrency();

    /**
     * Get all available servers for Ultra Economy
     */
    ServerList getAvailableServers();
}
```
Tokens:
Raw