SpigotEconomy

From Peirleitner.at Development

This resource adds an EconomSystem to your server. Economy can be used by Plugin Developers to create resources, by Server Admins to manage transactions and by players to purchase and sell items on your server.

Commands & Permissions

# Name Syntax Aliases Description Permissions Since Notes
001 /spigoteconomy /spigoteconomy None Version output None 1.0.0 None
002 /economy /economy <Argument> /eco Main command None 1.0.0 None
003 /money /money [Player] /balance Displays the money of a player SpigotEconomy.command.money.self

SpigotEconomy.command.money.others

1.0.0 None
004 /transactions /transactions None Displays last transactions of a player SpigotEconomy.command.transactions 1.0.0 None
005 /pay /pay <Player> <Amount> None Transfer money to another player SpigotEconomy.command.pay 1.0.0 None

Sub-Commands

These are the arguments available after typing /economy:

# Name Additional Arguments Aliases Description Permissions Since Notes
001 help None None Displays the help page None 1.0.0 None
002 version None v Version output None 1.0.0 None
003 get <Player> None Displays the economy of a player SpigotEconomy.command.economy.get 1.0.0 None
004 add <Player> <Amount> give, grant Adds currency to the user SpigotEconomy.command.economy.add 1.0.0 None
005 remove <Player> <Amount> None Removes currency from the user SpigotEconomy.command.economy.remove 1.0.0 None
006 set <Player> <Amount> None Set the currency from a user to given value SpigotEconomy.command.economy.set 1.0.0 None

For Developers

EconomyPlayer

Object for each individual player. Class: at.peirleitner.spigoteconomy.util.EconomyPlayer.java

# Method Description Type Return Since Notes
001 getUUID(); Get the UUID of the player UUID UUID 1.0.0 None
002 getEconomy(); Get the money of a player double double 1.0.0 None
003 addEconomy(double amount); Add money for a player void None 1.0.0 None
004 removeEconomy(double amount); Remove money from a player void None 1.0.0 None
005 setEconomy(double amount); Set the money for a player void None 1.0.0 None
006 addTransaction(String message); Add a transaction towards the history. void None 1.0.0 None
007 getTransactions(); Get the last transactions by the player List<String> Transaction history 1.0.0 None
008 sendTransactions(); Send the player's transaction history towards themself. void None 1.0.0 None

EconomyManager

Manages EconomyUsers. Class: at.peirleitner.spigoteconomy.manager.EconomyManager.java

# Method Description Type Return Since Notes
001 getPlayers(); Get all EconomyPlayer objects Collection<EconomyPlayer> Collection of all EconomyPlayers 1.0.0 None
002 getByUUID(UUID uuid); Get an EconomyPlayer object by the player's UUID EconomyPlayer EconomyPlayer or null 1.0.0 None
003 register(UUID uuid); Register a new EconomyPlayer object void None 1.0.0 Won't register an already existing User
004 getDefaultMoney(); Get the amount of default money set in config double Default Money set in config 1.0.0 None
005 getMaxTransactionsLogged(); Get the maximum amount of transactions to be logged for a player int Maximum transaction size 1.0.0 Older transactions will be deleted
006 createTransaction(Player sender, String targetName, double amount); Send money between two players. void None 1.0.0 Cancellable via Events, see below

API

Events

# Name Description Cancellable Since Notes
001 PaymentReceiveEvent Called when receiving money from a transaction between players Yes 1.0.0 None
002 PaymentSendEvent Called when sending money in a transaction between players Yes 1.0.0 None

Configuration

# Key Default Value Description Since Type Notes
001 prefix &7[&aSpigotEconomy&7] &f The prefix used on sending messages 1.0.0 String None
002 send-prefix-with-messages true If the prefix should be attached to every message sent 1.0.0 boolean None
003 economy.default 1000.0 The amount of economy a player receives when registered 1.0.0 double None
004 economy.max-transactions-logged 30 Maximum amount of transactions that will be logged for that player 1.0.0 int Older transactions will be deleted
005 help <Too long..> Help message that is displayed on /economy command 1.0.0 List<String> Supports ColorCodes (&)