Skip navigation links
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Index
  • Help

Deprecated API

Contents

  • Interfaces
  • Classes
  • Exceptions
  • Methods
  • Constructors
  • Deprecated Interfaces
    Interface
    Description
    com.earth2me.essentials.api.II18n
    External plugins should prefer to use either the player's client language (Player.getLocale() or II18n in case of future additions.
    com.earth2me.essentials.api.IItemDb
    External plugins should use IItemDb instead, which includes access to IItemDb.ItemResolver APIs.
    com.earth2me.essentials.api.IJails
    External plugins should use IJails instead of this interface in case future APIs are added.
    com.earth2me.essentials.api.ITeleport
    This API is not asynchronous and is no longer maintained. Use IAsyncTeleport.
    com.earth2me.essentials.api.IWarps
    External plugins should use IWarps instead of this interface, in case future APIs are added.
    com.earth2me.essentials.IUser
    External plugins should use IUser instead of this interface, in case future APIs are added.
    net.ess3.api.ITeleport
    This API is not asynchronous. Use IAsyncTeleport
  • Deprecated Classes
    Class
    Description
    com.earth2me.essentials.signs.SignProtection
    com.earth2me.essentials.Teleport
    This API is not asynchronous. Use AsyncTeleport
    com.earth2me.essentials.TimedTeleport
    com.earth2me.essentials.UserMap
    com.earth2me.essentials.UUIDMap
    net.ess3.api.Economy
  • Deprecated Exceptions
    Exceptions
    Description
    com.earth2me.essentials.api.InvalidNameException
    This exception relates to the abandoned 3.x storage refactor and is not implemented.
    com.earth2me.essentials.api.InvalidWorldException
    This exception is unused. Use InvalidWorldException instead.
    net.ess3.api.InvalidNameException
    This exception relates to the abandoned 3.x storage refactor and is not implemented.
    net.ess3.api.NoLoanPermittedException
    You should use NoLoanPermittedException instead of this class.
    net.ess3.api.UserDoesNotExistException
    This is unused - see UserDoesNotExistException.
  • Deprecated Methods
    Method
    Description
    com.earth2me.essentials.api.Economy.add(String, double)
    com.earth2me.essentials.api.Economy.add(String, BigDecimal)
    Usernames can change, use Economy.add(UUID, BigDecimal) or Economy.add(User, BigDecimal)
    com.earth2me.essentials.api.Economy.divide(String, double)
    Use Economy.divide(UUID, BigDecimal) or Economy.divide(User, BigDecimal)
    com.earth2me.essentials.api.Economy.divide(String, BigDecimal)
    Usernames can change, use Economy.divide(UUID, BigDecimal) or Economy.divide(User, BigDecimal)
    com.earth2me.essentials.api.Economy.format(double)
    Use Economy.format(BigDecimal) if your input is already a BigDecimal.
    com.earth2me.essentials.api.Economy.getMoney(String)
    Use Economy.getMoneyExact(UUID) or Economy.getMoneyExact(User)
    com.earth2me.essentials.api.Economy.getMoneyExact(String)
    Usernames can change, use Economy.getMoneyExact(UUID) or Economy.getMoneyExact(User)
    com.earth2me.essentials.api.Economy.hasEnough(String, double)
    Use Economy.hasEnough(UUID, BigDecimal) or Economy.hasEnough(User, BigDecimal)
    com.earth2me.essentials.api.Economy.hasEnough(String, BigDecimal)
    Usernames can change, use Economy.hasEnough(UUID, BigDecimal) or Economy.hasEnough(User, BigDecimal)
    com.earth2me.essentials.api.Economy.hasLess(String, double)
    Use Economy.hasLess(UUID, BigDecimal) or Economy.hasLess(User, BigDecimal)
    com.earth2me.essentials.api.Economy.hasLess(String, BigDecimal)
    Usernames can change, use Economy.hasLess(UUID, BigDecimal) or Economy.hasLess(User, BigDecimal)
    com.earth2me.essentials.api.Economy.hasMore(String, double)
    Use Economy.hasMore(UUID, BigDecimal) or Economy.hasMore(User, BigDecimal)
    com.earth2me.essentials.api.Economy.hasMore(String, BigDecimal)
    Usernames can change, use Economy.hasMore(UUID, BigDecimal) or Economy.hasMore(User, BigDecimal)
    com.earth2me.essentials.api.Economy.isNegative(String)
    Usernames can change, use Economy.isNegative(UUID) or Economy.isNegative(User)
    com.earth2me.essentials.api.Economy.multiply(String, double)
    Use Economy.multiply(UUID, BigDecimal) or Economy.multiply(User, BigDecimal)
    com.earth2me.essentials.api.Economy.multiply(String, BigDecimal)
    Usernames can change, use Economy.multiply(UUID, BigDecimal) or Economy.multiply(User, BigDecimal)
    com.earth2me.essentials.api.Economy.playerExists(String)
    Essentials is moving away from username based economy methods. This may be removed in the future.
    com.earth2me.essentials.api.Economy.resetBalance(String)
    Usernames can change, use Economy.resetBalance(UUID) or Economy.resetBalance(User)
    com.earth2me.essentials.api.Economy.setMoney(String, double)
    Use Economy.setMoney(UUID, BigDecimal) or Economy.setMoney(User, BigDecimal)
    com.earth2me.essentials.api.Economy.setMoney(String, BigDecimal)
    Usernames can change use Economy.setMoney(UUID, BigDecimal) or Economy.setMoney(User, BigDecimal)
    com.earth2me.essentials.api.Economy.substract(String, BigDecimal)
    Usernames can change, use Economy.subtract(UUID, BigDecimal) or Economy.subtract(User, BigDecimal)
    com.earth2me.essentials.api.Economy.subtract(String, double)
    Use Economy.subtract(UUID, BigDecimal) or Economy.subtract(User, BigDecimal)
    com.earth2me.essentials.api.IItemDb.getFromLegacyId(int)
    com.earth2me.essentials.api.IItemDb.getLegacyId(Material)
    Item IDs are no longer supported.
    com.earth2me.essentials.api.IJails.sendToJail(IUser, String)
    Use IJails.sendToJail(IUser, String, CompletableFuture)
    com.earth2me.essentials.api.ITeleport.back()
    com.earth2me.essentials.api.ITeleport.back(Trade)
    com.earth2me.essentials.api.ITeleport.back(IUser, Trade)
    com.earth2me.essentials.api.ITeleport.now(Player, boolean, PlayerTeleportEvent.TeleportCause)
    com.earth2me.essentials.api.ITeleport.now(Location, boolean, PlayerTeleportEvent.TeleportCause)
    com.earth2me.essentials.api.ITeleport.respawn(Trade, PlayerTeleportEvent.TeleportCause)
    com.earth2me.essentials.api.ITeleport.teleport(Player, Trade, PlayerTeleportEvent.TeleportCause)
    com.earth2me.essentials.api.ITeleport.teleport(Location, Trade)
    com.earth2me.essentials.api.ITeleport.teleport(Location, Trade, PlayerTeleportEvent.TeleportCause)
    com.earth2me.essentials.api.ITeleport.teleportPlayer(IUser, Player, Trade, PlayerTeleportEvent.TeleportCause)
    com.earth2me.essentials.api.ITeleport.teleportPlayer(IUser, Location, Trade, PlayerTeleportEvent.TeleportCause)
    com.earth2me.essentials.api.ITeleport.warp(IUser, String, Trade, PlayerTeleportEvent.TeleportCause)
    com.earth2me.essentials.api.IWarps.getWarpFile(String)
    This method relates to the abandoned 3.x storage refactor and is not implemented.
    com.earth2me.essentials.Console.getCommandSender(Server)
    Use Console.getCommandSender()
    com.earth2me.essentials.Essentials.getUser(Object)
    com.earth2me.essentials.Essentials.getUserMap()
    com.earth2me.essentials.IEssentials.getUser(Object)
    com.earth2me.essentials.IEssentials.getUserMap()
    com.earth2me.essentials.IEssentials.getVanishedPlayers()
    Use IEssentials.getVanishedPlayersNew() where possible.
    com.earth2me.essentials.ISettings.getKitSection()
    com.earth2me.essentials.ISettings.isTradeInStacks(int)
    com.earth2me.essentials.items.FlatItemDb.getLegacyId(Material)
    com.earth2me.essentials.IUser.addMail(String)
    com.earth2me.essentials.IUser.getCommandCooldowns()
    com.earth2me.essentials.IUser.getMails()
    com.earth2me.essentials.IUser.getTeleport()
    This API is not asynchronous. Use IAsyncTeleport with IUser.getAsyncTeleport()
    com.earth2me.essentials.IUser.getTeleportRequestTime()
    The teleport request system has been moved into a multi-user teleport request queue.
    com.earth2me.essentials.IUser.hasOutstandingTeleportRequest()
    The teleport request system has been moved into a multi-user teleport request queue.
    com.earth2me.essentials.IUser.setAfk(boolean)
    com.earth2me.essentials.IUser.setConfigProperty(String, Object)
    com.earth2me.essentials.Jails.sendToJail(IUser, String)
    This method does not use asynchronous teleportation. Use Jails.sendToJail(IUser, String, CompletableFuture)
    com.earth2me.essentials.Kit.getItems(User)
    com.earth2me.essentials.Settings.isTradeInStacks(int)
    com.earth2me.essentials.signs.EssentialsSign.isValidSign(EssentialsSign.ISign)
    use EssentialsSign.isValidSign(IEssentials, ISign) if possible
    com.earth2me.essentials.Teleport.back()
    com.earth2me.essentials.Teleport.back(Trade)
    com.earth2me.essentials.Teleport.back(IUser, Trade)
    com.earth2me.essentials.Teleport.cooldown(boolean)
    com.earth2me.essentials.Teleport.now(IUser, ITarget, PlayerTeleportEvent.TeleportCause)
    com.earth2me.essentials.Teleport.now(Player, boolean, PlayerTeleportEvent.TeleportCause)
    com.earth2me.essentials.Teleport.now(Location, boolean, PlayerTeleportEvent.TeleportCause)
    com.earth2me.essentials.Teleport.respawn(Trade, PlayerTeleportEvent.TeleportCause)
    com.earth2me.essentials.Teleport.setTpType(Teleport.TeleportType)
    com.earth2me.essentials.Teleport.teleport(Player, Trade, PlayerTeleportEvent.TeleportCause)
    com.earth2me.essentials.Teleport.teleport(Location, Trade)
    com.earth2me.essentials.Teleport.teleport(Location, Trade, PlayerTeleportEvent.TeleportCause)
    com.earth2me.essentials.Teleport.teleportPlayer(IUser, Player, Trade, PlayerTeleportEvent.TeleportCause)
    com.earth2me.essentials.Teleport.teleportPlayer(IUser, Location, Trade, PlayerTeleportEvent.TeleportCause)
    com.earth2me.essentials.Teleport.warp(IUser, String, Trade, PlayerTeleportEvent.TeleportCause)
    com.earth2me.essentials.User.addMail(String)
    com.earth2me.essentials.User.getTeleport()
    This API is not asynchronous. Use User.getAsyncTeleport()
    com.earth2me.essentials.User.getTeleportRequestTime()
    com.earth2me.essentials.User.hasOutstandingTeleportRequest()
    com.earth2me.essentials.User.toggleAfk()
    com.earth2me.essentials.User.updateActivity(boolean)
    com.earth2me.essentials.UserData.getMails()
    Mails are no longer just strings, this method is therefore misleading.
    com.earth2me.essentials.UserData.isIgnoredPlayer(String)
    com.earth2me.essentials.UserData.setIgnoredPlayers(List<String>)
    com.earth2me.essentials.UserData.setMails(List<String>)
    This method does not support the new mail system and will fail at runtime.
    com.earth2me.essentials.utils.LocationUtil.getSafeDestination(IUser, Location)
    Use LocationUtil.getSafeDestination(IEssentials, IUser, Location)
    com.earth2me.essentials.Warps.getWarpFile(String)
    This method relates to the abandoned 3.x storage refactor and is not implemented.
    net.ess3.api.IItemDb.serialize(ItemStack, boolean)
    This will soon be replaced with a new two-way API. It should not be relied upon by external plugins!
    net.essentialsx.api.v2.services.mail.MailService.sendLegacyMail(IUser, String)
    This is only for maintaining backwards compatibility with old API, please use the newer MailService.sendMail(IUser, MailSender, String) API.
  • Deprecated Constructors
    Constructor
    Description
    com.earth2me.essentials.Teleport(IUser, IEssentials)
    com.earth2me.essentials.Trade(double, IEssentials)
    net.ess3.api.events.AfkStatusChangeEvent(IUser, boolean)
    net.ess3.api.events.UserBalanceUpdateEvent(Player, BigDecimal, BigDecimal)