Index
All Classes and Interfaces|All Packages
A
- AboutCommandHandler - Class in dev.satyrn.xpeconomy.commands
-
Command which can be used to print information about the plugin, such as name, author, and version.
- AboutCommandHandler(Plugin, Permission) - Constructor for class dev.satyrn.xpeconomy.commands.AboutCommandHandler
-
Initializes a new command handler with the permission manager instance.
- Account - Interface in dev.satyrn.xpeconomy.api.economy
-
Represents an economy account.
- AccountCommandHandler - Class in dev.satyrn.xpeconomy.api.commands
-
Represents a command handler which manages accounts.
- AccountCommandHandler(Plugin, Permission, AccountManager, Configuration) - Constructor for class dev.satyrn.xpeconomy.api.commands.AccountCommandHandler
-
Represents a command which manages accounts or account balances.
- accountManager() - Method in record class dev.satyrn.xpeconomy.listeners.InventoryEventListener
-
Returns the value of the
accountManager
record component. - accountManager() - Method in record class dev.satyrn.xpeconomy.listeners.PlayerEventListener
-
Returns the value of the
accountManager
record component. - AccountManager - Interface in dev.satyrn.xpeconomy.api.economy
-
Manages, creates, saves, and loads player accounts.
- accounts - Variable in class dev.satyrn.xpeconomy.economy.PlayerAccountManagerBase
- AddCommandHandler - Class in dev.satyrn.xpeconomy.commands
-
Models a command which allows players to add a balance to another player's account.
- AddCommandHandler(Plugin, Permission, AccountManager, Configuration) - Constructor for class dev.satyrn.xpeconomy.commands.AddCommandHandler
-
Initializes a new command handler with the permission manager instance.
B
- BalanceCommandHandler - Class in dev.satyrn.xpeconomy.commands
-
Models a command which allows a player to check another player's balance.
- BalanceCommandHandler(Plugin, Permission, AccountManager, Configuration) - Constructor for class dev.satyrn.xpeconomy.commands.BalanceCommandHandler
-
Creates a new command executor.
- bankBalance(String) - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Returns the amount the bank has
- bankDeposit(String, double) - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Deposit an amount into a bank account - DO NOT USE NEGATIVE AMOUNTS
- bankHas(String, double) - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Returns true or false whether the bank has the amount specified - DO NOT USE NEGATIVE AMOUNTS
- bankWithdraw(String, double) - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Withdraw an amount from a bank account - DO NOT USE NEGATIVE AMOUNTS
- bottleOptions - Variable in class dev.satyrn.xpeconomy.configuration.Configuration
-
The Experience Bottle mechanics options.
C
- Commands - Class in dev.satyrn.xpeconomy.utils
-
Handles common Command tasks.
- configuration - Variable in class dev.satyrn.xpeconomy.economy.PlayerAccountManagerBase
- Configuration - Class in dev.satyrn.xpeconomy.configuration
-
Root configuration container for the Experience Economy mod.
- Configuration(Plugin) - Constructor for class dev.satyrn.xpeconomy.configuration.Configuration
-
Initializes a new root configuration container.
- Configuration.BottleOptionsContainer - Class in dev.satyrn.xpeconomy.configuration
-
Represents a bottle options configuration container.
- createAccount(OfflinePlayer) - Method in interface dev.satyrn.xpeconomy.api.economy.AccountManager
-
Creates an account for a player.
- createAccount(OfflinePlayer) - Method in class dev.satyrn.xpeconomy.economy.PlayerAccountManagerBase
-
Creates an account for a player.
- createBank(String, String) - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Deprecated.
- createBank(String, OfflinePlayer) - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Creates a bank account with the specified name and the player as the owner
- createPlayerAccount(String) - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Deprecated.As of VaultAPI 1.4 use {
ExperienceEconomy.createPlayerAccount(OfflinePlayer)
instead. - createPlayerAccount(String, String) - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Deprecated.As of VaultAPI 1.4 use {
ExperienceEconomy.createPlayerAccount(OfflinePlayer, String)
instead. - createPlayerAccount(OfflinePlayer) - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Attempts to create a player account for the given player
- createPlayerAccount(OfflinePlayer, String) - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Attempts to create a player account for the given player on the specified world IMPLEMENTATION SPECIFIC - if an economy plugin does not support this then false will always be returned.
- currencyNamePlural() - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Returns the name of the currency in plural form.
- currencyNameSingular() - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Returns the name of the currency in singular form.
D
- debug - Variable in class dev.satyrn.xpeconomy.configuration.Configuration
-
Whether to enable debug logging.
- DeductCommandHandler - Class in dev.satyrn.xpeconomy.commands
-
Implements a command which can be used to deduct a specific amount from a player's account.
- DeductCommandHandler(Plugin, Permission, AccountManager, Configuration) - Constructor for class dev.satyrn.xpeconomy.commands.DeductCommandHandler
-
Creates a new instance of the remove command handler.
- deleteBank(String) - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Deletes a bank account with the specified name.
- deposit(BigDecimal) - Method in interface dev.satyrn.xpeconomy.api.economy.Account
-
Deposits a given amount into the account.
- deposit(BigDecimal) - Method in class dev.satyrn.xpeconomy.economy.PlayerAccount
-
Deposits a given amount into the account.
- depositPlayer(String, double) - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Deprecated.As of VaultAPI 1.4 use
ExperienceEconomy.depositPlayer(OfflinePlayer, double)
instead. - depositPlayer(String, String, double) - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Deprecated.As of VaultAPI 1.4 use
ExperienceEconomy.depositPlayer(OfflinePlayer, String, double)
instead. - depositPlayer(OfflinePlayer, double) - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Deposit an amount to a player - DO NOT USE NEGATIVE AMOUNTS
- depositPlayer(OfflinePlayer, String, double) - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Deposit an amount to a player - DO NOT USE NEGATIVE AMOUNTS IMPLEMENTATION SPECIFIC - if an economy plugin does not support this the global balance will be returned.
- dev.satyrn.xpeconomy - package dev.satyrn.xpeconomy
- dev.satyrn.xpeconomy.api.commands - package dev.satyrn.xpeconomy.api.commands
- dev.satyrn.xpeconomy.api.economy - package dev.satyrn.xpeconomy.api.economy
- dev.satyrn.xpeconomy.commands - package dev.satyrn.xpeconomy.commands
- dev.satyrn.xpeconomy.configuration - package dev.satyrn.xpeconomy.configuration
- dev.satyrn.xpeconomy.economy - package dev.satyrn.xpeconomy.economy
- dev.satyrn.xpeconomy.listeners - package dev.satyrn.xpeconomy.listeners
- dev.satyrn.xpeconomy.tasks - package dev.satyrn.xpeconomy.tasks
- dev.satyrn.xpeconomy.utils - package dev.satyrn.xpeconomy.utils
E
- economyMethod - Variable in class dev.satyrn.xpeconomy.configuration.Configuration
-
The economy method to use.
- EconomyMethod - Enum Class in dev.satyrn.xpeconomy.utils
-
Economy processing method.
- enabled - Variable in class dev.satyrn.xpeconomy.configuration.Configuration.BottleOptionsContainer
-
Enable or disable experience bottle management functionality.
- equals(Object) - Method in record class dev.satyrn.xpeconomy.listeners.InventoryEventListener
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class dev.satyrn.xpeconomy.listeners.PlayerEventListener
-
Indicates whether some other object is "equal to" this one.
- ExperienceBottleEventListener - Class in dev.satyrn.xpeconomy.listeners
-
Handles experience bottle events.
- ExperienceBottleEventListener(Plugin, AccountManager, Permission, Configuration) - Constructor for class dev.satyrn.xpeconomy.listeners.ExperienceBottleEventListener
- ExperienceCommandHandler - Class in dev.satyrn.xpeconomy.commands
- ExperienceCommandHandler(Plugin, Permission) - Constructor for class dev.satyrn.xpeconomy.commands.ExperienceCommandHandler
-
Initializes a new command handler with the permission manager instance.
- ExperienceEconomy - Class in dev.satyrn.xpeconomy.economy
-
The XP Economy handler.
- ExperienceEconomy(Plugin, AccountManager, Configuration) - Constructor for class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Creates a new instance of the Economy class.
- ExperienceEconomyPlugin - Class in dev.satyrn.xpeconomy
-
The main plugin class for Experience Economy
- ExperienceEconomyPlugin() - Constructor for class dev.satyrn.xpeconomy.ExperienceEconomyPlugin
F
- fillInteractBlock - Variable in class dev.satyrn.xpeconomy.configuration.Configuration.BottleOptionsContainer
-
Material of the block to interact with to allow players to fill bottles.
- format(double) - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Format amount into a human-readable String This provides translation into economy specific formatting to improve consistency between plugins.
- fractionalDigits() - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Some economy plugins round off after a certain number of digits.
- fromRawBalance(BigInteger) - Method in enum class dev.satyrn.xpeconomy.utils.EconomyMethod
-
Converts raw XP values into economy values.
G
- getAccount(UUID) - Method in interface dev.satyrn.xpeconomy.api.economy.AccountManager
-
Gets an account with a specific player UUID.
- getAccount(UUID) - Method in class dev.satyrn.xpeconomy.economy.PlayerAccountManagerBase
-
Gets an account with a specific player UUID.
- getAccountManager() - Method in class dev.satyrn.xpeconomy.api.commands.AccountCommandHandler
-
Gets the account manager instance.
- getBalance() - Method in interface dev.satyrn.xpeconomy.api.economy.Account
-
Gets the balance on the account.
- getBalance() - Method in class dev.satyrn.xpeconomy.economy.PlayerAccount
-
Gets the balance on the account.
- getBalance(String) - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Deprecated.As of VaultAPI 1.4 use
ExperienceEconomy.getBalance(OfflinePlayer)
instead. - getBalance(String, String) - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Deprecated.As of VaultAPI 1.4 use
ExperienceEconomy.getBalance(OfflinePlayer, String)
instead. - getBalance(OfflinePlayer) - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Gets balance of a player
- getBalance(OfflinePlayer, String) - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Gets balance of a player on the specified world.
- getBalanceRaw() - Method in interface dev.satyrn.xpeconomy.api.economy.Account
-
Gets the raw experience point value on the account.
- getBalanceRaw() - Method in class dev.satyrn.xpeconomy.economy.PlayerAccount
- getBanks() - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Gets the list of banks
- getConfiguration() - Method in class dev.satyrn.xpeconomy.api.commands.AccountCommandHandler
-
Gets the configuration.
- getCurrencyName() - Method in enum class dev.satyrn.xpeconomy.utils.EconomyMethod
-
Gets the translated currency name.
- getCurrencyNamePlural() - Method in enum class dev.satyrn.xpeconomy.utils.EconomyMethod
-
Gets the translated plural currency name.
- getCurrentLevelProgress(BigInteger, BigDecimal) - Static method in class dev.satyrn.xpeconomy.utils.PlayerXPUtils
-
Gets the current XP amount for the player's current progress towards leveling.
- getDefault() - Static method in enum class dev.satyrn.xpeconomy.utils.EconomyMethod
-
Returns the default economy method value.
- getEconomyMethod() - Method in class dev.satyrn.xpeconomy.api.commands.AccountCommandHandler
-
Gets the economy method.
- getEconomyMethod() - Method in class dev.satyrn.xpeconomy.economy.PlayerAccountManagerBase
-
Gets the current economy method
- getName() - Method in interface dev.satyrn.xpeconomy.api.economy.Account
-
Gets the account owner's name
- getName() - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Gets name of economy method
- getName() - Method in class dev.satyrn.xpeconomy.economy.PlayerAccount
-
Gets the name of the account owner.
- getOnlinePlayer(String) - Static method in class dev.satyrn.xpeconomy.utils.Commands
-
Gets a target from all online players
- getPermission() - Method in class dev.satyrn.xpeconomy.api.commands.VaultCommandHandler
-
Gets the permission manager instance.
- getPlayer(String) - Static method in class dev.satyrn.xpeconomy.utils.Commands
-
Gets a target from all players.
- getPlayerNames() - Static method in class dev.satyrn.xpeconomy.utils.Commands
-
Gets all player names from the online player list.
- getPlayerXPTotal(Player) - Static method in class dev.satyrn.xpeconomy.utils.PlayerXPUtils
-
Gets the total amount of XP a player has.
- getPlayerXPTotal(UUID) - Static method in class dev.satyrn.xpeconomy.utils.PlayerXPUtils
-
Gets the total amount of XP a player has.
- getRoundingMode() - Method in enum class dev.satyrn.xpeconomy.utils.EconomyMethod
-
Returns the rounding mode to use when converting the economy method balance.
- getScale() - Method in enum class dev.satyrn.xpeconomy.utils.EconomyMethod
-
Returns the decimal scale of the economy method.
- getStartingBalance() - Method in class dev.satyrn.xpeconomy.economy.PlayerAccountManagerBase
-
Gets the starting balance for the account.
- getTotalXPValue(int, float) - Static method in class dev.satyrn.xpeconomy.utils.PlayerXPUtils
-
Gets the total amount of XP a player with the given level and level-up progress has.
- getUsage(CommandSender, Command) - Method in class dev.satyrn.xpeconomy.commands.AddCommandHandler
-
Gets the command usage.
- getUsage(CommandSender, Command) - Method in class dev.satyrn.xpeconomy.commands.BalanceCommandHandler
-
Gets the command usage.
- getUsage(CommandSender, Command) - Method in class dev.satyrn.xpeconomy.commands.DeductCommandHandler
-
Gets the command usage hint.
- getUsage(CommandSender, Command) - Method in class dev.satyrn.xpeconomy.commands.ExperienceCommandHandler
-
Gets the command usage.
- getUsage(CommandSender, Command) - Method in class dev.satyrn.xpeconomy.commands.PayCommandHandler
- getUsage(CommandSender, Command) - Method in class dev.satyrn.xpeconomy.commands.SetCommandHandler
-
Gets the command usage hint.
- getUsage(CommandSender, Command) - Method in class dev.satyrn.xpeconomy.commands.SyncCommandHandler
-
Gets the command usage hint.
- getUsage(CommandSender, Command) - Method in class dev.satyrn.xpeconomy.commands.TransferCommandHandler
-
Gets the command usage hint.
- getUUID() - Method in interface dev.satyrn.xpeconomy.api.economy.Account
-
Gets the account owner's player UUID.
- getUUID() - Method in class dev.satyrn.xpeconomy.economy.PlayerAccount
-
Gets the account owner's player UUID.
- getXPForLevel(BigInteger) - Static method in class dev.satyrn.xpeconomy.utils.PlayerXPUtils
-
Calculates the total XP value for a given level.
H
- has(BigDecimal) - Method in interface dev.satyrn.xpeconomy.api.economy.Account
-
Checks whether the account can withdraw a given amount.
- has(BigDecimal) - Method in class dev.satyrn.xpeconomy.economy.PlayerAccount
-
Checks whether the account can withdraw a given amount.
- has(String, double) - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Deprecated.As of VaultAPI 1.4 use
ExperienceEconomy.has(OfflinePlayer, double)
instead. - has(String, String, double) - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Deprecated.As of VaultAPI 1.4 use
ExperienceEconomy.has(OfflinePlayer, String, double)
instead. - has(OfflinePlayer, double) - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Checks if the player account has the amount - DO NOT USE NEGATIVE AMOUNTS
- has(OfflinePlayer, String, double) - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Checks if the player account has the amount in a given world - DO NOT USE NEGATIVE AMOUNTS IMPLEMENTATION SPECIFIC - if an economy plugin does not support this the global balance will be returned.
- hasAccount(UUID) - Method in interface dev.satyrn.xpeconomy.api.economy.AccountManager
-
Checks if an account exists for a given player UUID.
- hasAccount(UUID) - Method in class dev.satyrn.xpeconomy.economy.PlayerAccountManagerBase
-
Checks if an account exists for a given player UUID.
- hasAccount(String) - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Deprecated.As of VaultAPI 1.4 use
ExperienceEconomy.hasAccount(OfflinePlayer)
instead. - hasAccount(String, String) - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Deprecated.As of VaultAPI 1.4 use
ExperienceEconomy.hasAccount(OfflinePlayer, String)
instead. - hasAccount(OfflinePlayer) - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Checks if this player has an account on the server yet This will always return true if the player has joined the server at least once as all major economy plugins auto-generate a player account when the player joins the server
- hasAccount(OfflinePlayer, String) - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Checks if this player has an account on the server yet on the given world This will always return true if the player has joined the server at least once as all major economy plugins auto-generate a player account when the player joins the server
- hasBankSupport() - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Returns true if the given implementation supports banks.
- hashCode() - Method in record class dev.satyrn.xpeconomy.listeners.InventoryEventListener
-
Returns a hash code value for this object.
- hashCode() - Method in record class dev.satyrn.xpeconomy.listeners.PlayerEventListener
-
Returns a hash code value for this object.
- HelpCommandHandler - Class in dev.satyrn.xpeconomy.commands
- HelpCommandHandler(Plugin, Permission) - Constructor for class dev.satyrn.xpeconomy.commands.HelpCommandHandler
-
Creates a handler for the help subcommand.
I
- InventoryEventListener - Record Class in dev.satyrn.xpeconomy.listeners
- InventoryEventListener(Plugin, AccountManager) - Constructor for record class dev.satyrn.xpeconomy.listeners.InventoryEventListener
-
Initializes the player event listener.
- isBankMember(String, String) - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Deprecated.As of VaultAPI 1.4 use {
ExperienceEconomy.isBankMember(String, OfflinePlayer)
instead. - isBankMember(String, OfflinePlayer) - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Check if the player is a member of the bank account
- isBankOwner(String, String) - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Deprecated.As of VaultAPI 1.4 use {
ExperienceEconomy.isBankOwner(String, OfflinePlayer)
instead. - isBankOwner(String, OfflinePlayer) - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Check if a player is the owner of a bank account
- isEnabled() - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Checks if economy method is enabled.
L
- LEVELS - Enum constant in enum class dev.satyrn.xpeconomy.utils.EconomyMethod
-
Economy method for levels.
- load() - Method in interface dev.satyrn.xpeconomy.api.economy.AccountManager
-
Loads player account data from storage.
- load() - Method in class dev.satyrn.xpeconomy.economy.MySQLAccountManager
-
Loads account details from the database.
- load() - Method in class dev.satyrn.xpeconomy.economy.YamlAccountManager
-
Loads account data from a YAML file.
- locale - Variable in class dev.satyrn.xpeconomy.configuration.Configuration
-
The locale to use while translating chat messages.
M
- metrics - Variable in class dev.satyrn.xpeconomy.configuration.Configuration
-
Whether to enable plugin metrics.
- mysql - Variable in class dev.satyrn.xpeconomy.configuration.Configuration
-
The MySQL connection settings configuration container.
- MySQLAccountManager - Class in dev.satyrn.xpeconomy.economy
-
An account manager with a MySQL backend.
- MySQLAccountManager(Configuration, Plugin, ConnectionManager) - Constructor for class dev.satyrn.xpeconomy.economy.MySQLAccountManager
-
Creates a new account manager with a MySQL backend.
O
- onAnvilUsed(InventoryClickEvent) - Method in record class dev.satyrn.xpeconomy.listeners.InventoryEventListener
-
Handles the event that is called when a user takes or attempts to take an item from the anvil's third slot.
- onBottleUsed(PlayerInteractEvent) - Method in class dev.satyrn.xpeconomy.listeners.ExperienceBottleEventListener
- onCommand(CommandSender, Command, String, String[]) - Method in class dev.satyrn.xpeconomy.commands.AboutCommandHandler
-
Executes the given command, returning its success.
- onCommand(CommandSender, Command, String, String[]) - Method in class dev.satyrn.xpeconomy.commands.AddCommandHandler
-
Executes the given command, returning its success.
- onCommand(CommandSender, Command, String, String[]) - Method in class dev.satyrn.xpeconomy.commands.BalanceCommandHandler
-
Executes the given command, returning its success.
- onCommand(CommandSender, Command, String, String[]) - Method in class dev.satyrn.xpeconomy.commands.DeductCommandHandler
-
Executes the given command, returning its success.
- onCommand(CommandSender, Command, String, String[]) - Method in class dev.satyrn.xpeconomy.commands.ExperienceCommandHandler
-
Executes the given command, returning its success.
- onCommand(CommandSender, Command, String, String[]) - Method in class dev.satyrn.xpeconomy.commands.HelpCommandHandler
-
Executes the given command, returning its success.
- onCommand(CommandSender, Command, String, String[]) - Method in class dev.satyrn.xpeconomy.commands.PayCommandHandler
-
Executes the given command, returning its success.
- onCommand(CommandSender, Command, String, String[]) - Method in class dev.satyrn.xpeconomy.commands.ReloadCommandHandler
-
Executes the given command, returning its success.
- onCommand(CommandSender, Command, String, String[]) - Method in class dev.satyrn.xpeconomy.commands.SetCommandHandler
-
Executes the given command, returning its success.
- onCommand(CommandSender, Command, String, String[]) - Method in class dev.satyrn.xpeconomy.commands.SyncCommandHandler
-
Executes the given command, returning its success.
- onCommand(CommandSender, Command, String, String[]) - Method in class dev.satyrn.xpeconomy.commands.TransferCommandHandler
-
Executes the given command, returning its success.
- onCommand(CommandSender, Command, String, String[]) - Method in class dev.satyrn.xpeconomy.commands.XPEconomyCommandHandler
-
Executes the given command, returning its success.
- onDisable() - Method in class dev.satyrn.xpeconomy.ExperienceEconomyPlugin
-
Occurs when the plugin is disabled.
- onEnable() - Method in class dev.satyrn.xpeconomy.ExperienceEconomyPlugin
-
Occurs when the plugin is enabled.
- onEnchantItem(EnchantItemEvent) - Method in record class dev.satyrn.xpeconomy.listeners.InventoryEventListener
-
Handles the event that is called when a user enchants an item.
- onExpChange(PlayerExpChangeEvent) - Method in record class dev.satyrn.xpeconomy.listeners.PlayerEventListener
-
Handles player experience value changes.
- onExperienceBottleBreak(ExpBottleEvent) - Method in class dev.satyrn.xpeconomy.listeners.ExperienceBottleEventListener
- onExperienceBottleUsed(PlayerInteractEvent) - Method in class dev.satyrn.xpeconomy.listeners.ExperienceBottleEventListener
- onJoin(PlayerJoinEvent) - Method in record class dev.satyrn.xpeconomy.listeners.PlayerEventListener
-
Handles player join events.
- onTabComplete(CommandSender, Command, String, String[]) - Method in class dev.satyrn.xpeconomy.commands.AboutCommandHandler
-
Requests a list of possible completions for a command argument.
- onTabComplete(CommandSender, Command, String, String[]) - Method in class dev.satyrn.xpeconomy.commands.AddCommandHandler
-
Requests a list of possible completions for a command argument.
- onTabComplete(CommandSender, Command, String, String[]) - Method in class dev.satyrn.xpeconomy.commands.BalanceCommandHandler
-
Requests a list of possible completions for a command argument.
- onTabComplete(CommandSender, Command, String, String[]) - Method in class dev.satyrn.xpeconomy.commands.DeductCommandHandler
-
Requests a list of possible completions for a command argument.
- onTabComplete(CommandSender, Command, String, String[]) - Method in class dev.satyrn.xpeconomy.commands.ExperienceCommandHandler
-
Requests a list of possible completions for a command argument.
- onTabComplete(CommandSender, Command, String, String[]) - Method in class dev.satyrn.xpeconomy.commands.HelpCommandHandler
-
Requests a list of possible completions for a command argument.
- onTabComplete(CommandSender, Command, String, String[]) - Method in class dev.satyrn.xpeconomy.commands.PayCommandHandler
-
Requests a list of possible completions for a command argument.
- onTabComplete(CommandSender, Command, String, String[]) - Method in class dev.satyrn.xpeconomy.commands.ReloadCommandHandler
-
Requests a list of possible completions for a command argument.
- onTabComplete(CommandSender, Command, String, String[]) - Method in class dev.satyrn.xpeconomy.commands.SetCommandHandler
-
Requests a list of possible completions for a command argument.
- onTabComplete(CommandSender, Command, String, String[]) - Method in class dev.satyrn.xpeconomy.commands.SyncCommandHandler
-
Requests a list of possible completions for a command argument.
- onTabComplete(CommandSender, Command, String, String[]) - Method in class dev.satyrn.xpeconomy.commands.TransferCommandHandler
-
Requests a list of possible completions for a command argument.
- onTabComplete(CommandSender, Command, String, String[]) - Method in class dev.satyrn.xpeconomy.commands.XPEconomyCommandHandler
-
Requests a list of possible completions for a command argument.
- onWorldSave(WorldSaveEvent) - Method in class dev.satyrn.xpeconomy.listeners.WorldEventListener
-
Saves the account data on the manager each time the world is saved.
P
- PayCommandHandler - Class in dev.satyrn.xpeconomy.commands
-
Handles the Pay command and subcommand.
- PayCommandHandler(Plugin, Permission, AccountManager, Configuration) - Constructor for class dev.satyrn.xpeconomy.commands.PayCommandHandler
-
Creates a new pay command handler.
- PER_HUNDRED - Enum constant in enum class dev.satyrn.xpeconomy.utils.EconomyMethod
-
Economy method for per-hundred XP points.
- PlayerAccount - Class in dev.satyrn.xpeconomy.economy
-
Represents a player account.
- PlayerAccount(Configuration, UUID) - Constructor for class dev.satyrn.xpeconomy.economy.PlayerAccount
-
Creates an account with a name and UUID.
- PlayerAccountManagerBase - Class in dev.satyrn.xpeconomy.economy
-
Manages player accounts.
- PlayerAccountManagerBase(Configuration) - Constructor for class dev.satyrn.xpeconomy.economy.PlayerAccountManagerBase
-
Creates a new instance of an account manager.
- PlayerBalanceSynchronizationTask - Class in dev.satyrn.xpeconomy.tasks
- PlayerBalanceSynchronizationTask(Plugin, Player, Account) - Constructor for class dev.satyrn.xpeconomy.tasks.PlayerBalanceSynchronizationTask
- PlayerEventListener - Record Class in dev.satyrn.xpeconomy.listeners
-
Listener class for player events.
- PlayerEventListener(Plugin, AccountManager) - Constructor for record class dev.satyrn.xpeconomy.listeners.PlayerEventListener
-
Initializes the player event listener.
- PlayerExperienceSynchronizationTask - Class in dev.satyrn.xpeconomy.tasks
-
Task used to synchronize player experience with a value in an account.
- PlayerExperienceSynchronizationTask(Plugin, UUID, Account) - Constructor for class dev.satyrn.xpeconomy.tasks.PlayerExperienceSynchronizationTask
-
Creates a new player experience synchronization task.
- PlayerXPUtils - Class in dev.satyrn.xpeconomy.utils
-
Performs XP conversion, calculation, and updating.
- PlayerXPUtils() - Constructor for class dev.satyrn.xpeconomy.utils.PlayerXPUtils
- plugin() - Method in record class dev.satyrn.xpeconomy.listeners.InventoryEventListener
-
Returns the value of the
plugin
record component. - plugin() - Method in record class dev.satyrn.xpeconomy.listeners.PlayerEventListener
-
Returns the value of the
plugin
record component. - POINTS - Enum constant in enum class dev.satyrn.xpeconomy.utils.EconomyMethod
-
Economy method for individual points.
- pointsPerBottle - Variable in class dev.satyrn.xpeconomy.configuration.Configuration.BottleOptionsContainer
-
The number of experience points awarded or stored per bottle.
R
- refundThrownBottles - Variable in class dev.satyrn.xpeconomy.configuration.Configuration.BottleOptionsContainer
-
Whether thrown experience bottles will refund thrown bottles.
- registerSubcommand(String, CommandHandler, String...) - Method in class dev.satyrn.xpeconomy.commands.XPEconomyCommandHandler
-
Adds a new subcommand to the command handler.
- registerSubcommand(String, String, CommandHandler, boolean, boolean, String...) - Method in class dev.satyrn.xpeconomy.commands.XPEconomyCommandHandler
-
Adds a new subcommand to the command handler.
- registerSubcommand(String, String, CommandHandler, String...) - Method in class dev.satyrn.xpeconomy.commands.XPEconomyCommandHandler
-
Adds a new subcommand to the command handler.
- ReloadCommandHandler - Class in dev.satyrn.xpeconomy.commands
-
Models a command which allows a user to trigger a configuration reload.
- ReloadCommandHandler(Plugin, Permission, Configuration) - Constructor for class dev.satyrn.xpeconomy.commands.ReloadCommandHandler
-
Initializes a new command handler with the permission manager instance.
- reloadConfig() - Method in class dev.satyrn.xpeconomy.ExperienceEconomyPlugin
-
Occurs when the plugin configuration is reloaded.
- run() - Method in class dev.satyrn.xpeconomy.tasks.PlayerBalanceSynchronizationTask
-
When an object implementing interface
Runnable
is used to create a thread, starting the thread causes the object'srun
method to be called in that separately executing thread. - run() - Method in class dev.satyrn.xpeconomy.tasks.PlayerExperienceSynchronizationTask
-
When an object implementing interface
Runnable
is used to create a thread, starting the thread causes the object'srun
method to be called in that separately executing thread. - run() - Method in class dev.satyrn.xpeconomy.tasks.SaveAccountDataTask
-
When an object implementing interface
Runnable
is used to create a thread, starting the thread causes the object'srun
method to be called in that separately executing thread.
S
- save() - Method in interface dev.satyrn.xpeconomy.api.economy.AccountManager
-
Saves player account data to storage.
- save() - Method in class dev.satyrn.xpeconomy.economy.MySQLAccountManager
-
Saves the accounts to the database in a new thread.
- save() - Method in class dev.satyrn.xpeconomy.economy.YamlAccountManager
-
Saves account data to a YAML file.
- SaveAccountDataTask - Class in dev.satyrn.xpeconomy.tasks
- SaveAccountDataTask(Plugin, AccountManager) - Constructor for class dev.satyrn.xpeconomy.tasks.SaveAccountDataTask
- scale(BigDecimal) - Method in enum class dev.satyrn.xpeconomy.utils.EconomyMethod
-
Scales the value to the economy mode.
- setBalance(BigDecimal) - Method in interface dev.satyrn.xpeconomy.api.economy.Account
-
Sets the balance on the account.
- setBalance(BigDecimal) - Method in class dev.satyrn.xpeconomy.economy.PlayerAccount
-
Sets the balance on the account.
- setBalance(BigDecimal, boolean) - Method in interface dev.satyrn.xpeconomy.api.economy.Account
-
Sets the balance on the account and optionally updates the player's XP value.
- setBalance(BigDecimal, boolean) - Method in class dev.satyrn.xpeconomy.economy.PlayerAccount
-
Sets the balance on the account and optionally updates the player's XP value.
- setBalanceRaw(BigInteger, boolean) - Method in interface dev.satyrn.xpeconomy.api.economy.Account
-
Sets the raw balance value.
- setBalanceRaw(BigInteger, boolean) - Method in class dev.satyrn.xpeconomy.economy.PlayerAccount
-
Sets the raw balance value.
- SetCommandHandler - Class in dev.satyrn.xpeconomy.commands
-
Implements a command which allows a user to set another user's balance.
- SetCommandHandler(Plugin, Permission, AccountManager, Configuration) - Constructor for class dev.satyrn.xpeconomy.commands.SetCommandHandler
-
Creates a new command handler for the /set command.
- setName(String) - Method in interface dev.satyrn.xpeconomy.api.economy.Account
-
Sets the account owner's name.
- setName(String) - Method in class dev.satyrn.xpeconomy.economy.PlayerAccount
-
Sets the account owner's name.
- setPlayerXPTotal(UUID, BigInteger) - Static method in class dev.satyrn.xpeconomy.utils.PlayerXPUtils
-
Sets a player's experience values to a specific balance.
- setPlayerXPTotal(Player, BigInteger) - Static method in class dev.satyrn.xpeconomy.utils.PlayerXPUtils
-
Sets a player's experience values to a specific total.
- setUUID(UUID) - Method in interface dev.satyrn.xpeconomy.api.economy.Account
-
Sets the account owner's player UUID.
- setUUID(UUID) - Method in class dev.satyrn.xpeconomy.economy.PlayerAccount
-
Sets the account owner's player UUID.
- startingBalance - Variable in class dev.satyrn.xpeconomy.configuration.Configuration
-
The initial account balance for new player accounts.
- SyncCommandHandler - Class in dev.satyrn.xpeconomy.commands
-
Implements a command which can be used to sync a user's account balance to their current XP balance.
- SyncCommandHandler(Plugin, Permission, AccountManager, Configuration) - Constructor for class dev.satyrn.xpeconomy.commands.SyncCommandHandler
-
Creates a new instance of the remove command handler.
T
- throwBottles - Variable in class dev.satyrn.xpeconomy.configuration.Configuration.BottleOptionsContainer
-
Whether bottles should be thrown when the player is not crouching.
- toLevelProgress(BigInteger) - Static method in class dev.satyrn.xpeconomy.utils.PlayerXPUtils
-
Calculates the XP level and progress values from the total XP value.
- toRawBalance(BigDecimal, BigInteger) - Method in enum class dev.satyrn.xpeconomy.utils.EconomyMethod
-
Converts economy values into raw XP values.
- toString() - Method in record class dev.satyrn.xpeconomy.listeners.InventoryEventListener
-
Returns a string representation of this record class.
- toString() - Method in record class dev.satyrn.xpeconomy.listeners.PlayerEventListener
-
Returns a string representation of this record class.
- toString(BigDecimal) - Method in enum class dev.satyrn.xpeconomy.utils.EconomyMethod
-
Transforms a value into a string representation.
- toString(BigDecimal, boolean) - Method in enum class dev.satyrn.xpeconomy.utils.EconomyMethod
-
Transforms a value into a string representation.
- TransferCommandHandler - Class in dev.satyrn.xpeconomy.commands
-
Implements a command which can be used to transfer balance from one player to another.
- TransferCommandHandler(Plugin, Permission, AccountManager, Configuration) - Constructor for class dev.satyrn.xpeconomy.commands.TransferCommandHandler
-
Creates a new instance of the remove command handler.
V
- valueOf(String) - Static method in enum class dev.satyrn.xpeconomy.utils.EconomyMethod
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class dev.satyrn.xpeconomy.utils.EconomyMethod
-
Returns an array containing the constants of this enum class, in the order they are declared.
- VaultCommandHandler - Class in dev.satyrn.xpeconomy.api.commands
-
Handles commands that require access to the vault configuration instance.
- VaultCommandHandler(Plugin, Permission) - Constructor for class dev.satyrn.xpeconomy.api.commands.VaultCommandHandler
-
Initializes a new command handler with the permission manager instance.
W
- withdraw(BigDecimal) - Method in interface dev.satyrn.xpeconomy.api.economy.Account
-
Withdraws a given amount from the account.
- withdraw(BigDecimal) - Method in class dev.satyrn.xpeconomy.economy.PlayerAccount
-
Withdraws a given amount from the account.
- withdrawPlayer(String, double) - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Deprecated.As of VaultAPI 1.4 use
ExperienceEconomy.withdrawPlayer(OfflinePlayer, double)
instead. - withdrawPlayer(String, String, double) - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Deprecated.As of VaultAPI 1.4 use
ExperienceEconomy.withdrawPlayer(OfflinePlayer, String, double)
instead. - withdrawPlayer(OfflinePlayer, double) - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Withdraw an amount from a player - DO NOT USE NEGATIVE AMOUNTS
- withdrawPlayer(OfflinePlayer, String, double) - Method in class dev.satyrn.xpeconomy.economy.ExperienceEconomy
-
Withdraw an amount from a player on a given world - DO NOT USE NEGATIVE AMOUNTS IMPLEMENTATION SPECIFIC - if an economy plugin does not support this the global balance will be returned.
- WorldEventListener - Class in dev.satyrn.xpeconomy.listeners
-
Handles world events.
- WorldEventListener(Plugin, AccountManager) - Constructor for class dev.satyrn.xpeconomy.listeners.WorldEventListener
-
Creates a new world event listener.
X
- XPEconomyCommandHandler - Class in dev.satyrn.xpeconomy.commands
- XPEconomyCommandHandler(Plugin, Permission) - Constructor for class dev.satyrn.xpeconomy.commands.XPEconomyCommandHandler
-
Creates a new command executor.
Y
- YamlAccountManager - Class in dev.satyrn.xpeconomy.economy
-
An account manager with a YAML file backend.
- YamlAccountManager(Configuration, Plugin) - Constructor for class dev.satyrn.xpeconomy.economy.YamlAccountManager
-
Creates a new instance of an account manager with a YAML backend.
All Classes and Interfaces|All Packages
ExperienceEconomy.createBank(String, OfflinePlayer)
instead.