Package com.olziedev.playereconomy.api

Class PlayerEconomyAPI

java.lang.Object

com.olziedev.playereconomy.api.PlayerEconomyAPI

All Implemented Interfaces:

PluginAPI

public abstract class PlayerEconomyAPI
extends Object
implements PluginAPI

The main class for accessing and using the API.

Constructor Summary

Constructors

Constructor	Description
PlayerEconomyAPI()

Method Summary

Modifier and Type	Method	Description
abstract CommandRegistry	getCommandRegistry()
abstract EPlayer	getEcoPlayer(UUID uuid)	Retrieve the requested eco player.
abstract List<EPlayer>	getEcoPlayers()
static PlayerEconomyAPI	getInstance()
static void	getInstance(Consumer<PlayerEconomyAPI> api)	Waits for the instance of the API when it is ready.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.olziedev.playereconomy.api.PluginAPI

createConfigItem, getExpansionRegistry, getPlugin, sendMessage

Constructor Details

PlayerEconomyAPI

public PlayerEconomyAPI()

Method Details

getInstance

public static PlayerEconomyAPI getInstance()

Returns:

The instance of the API.

getInstance

public static void getInstance(Consumer<PlayerEconomyAPI> api)

Waits for the instance of the API when it is ready.

Parameters:

api - Callback with the instance of the API.

getEcoPlayer

public abstract EPlayer getEcoPlayer(UUID uuid)

Retrieve the requested eco player.

Parameters:

uuid - The uuid of a player to get.

Returns:

The requested player.

getEcoPlayers

public abstract List<EPlayer> getEcoPlayers()

Returns:

The currently loaded eco players.

getCommandRegistry

public abstract CommandRegistry getCommandRegistry()

Returns:

The command registry to manage the plugin sub-commands.