Interface IUser

All Known Subinterfaces:
IUser
All Known Implementing Classes:
User

@Deprecated public interface IUser
Deprecated.
External plugins should use IUser instead of this interface, in case future APIs are added.
Provides access to the user abstraction and stored data. Maintainers should add methods to this interface.
  • Method Details

    • isAuthorized

      boolean isAuthorized(String node)
      Deprecated.
    • isAuthorized

      boolean isAuthorized(IEssentialsCommand cmd)
      Deprecated.
    • isAuthorized

      boolean isAuthorized(IEssentialsCommand cmd, String permissionPrefix)
      Deprecated.
    • isPermissionSet

      boolean isPermissionSet(String node)
      Deprecated.
    • healCooldown

      void healCooldown() throws Exception
      Deprecated.
      Throws:
      Exception
    • giveMoney

      void giveMoney(BigDecimal value) throws MaxMoneyException
      Deprecated.
      Throws:
      MaxMoneyException
    • giveMoney

      void giveMoney(BigDecimal value, CommandSource initiator) throws MaxMoneyException
      Deprecated.
      Throws:
      MaxMoneyException
    • payUser

      void payUser(User reciever, BigDecimal value) throws Exception
      Deprecated.
      Throws:
      Exception
    • takeMoney

      void takeMoney(BigDecimal value)
      Deprecated.
    • takeMoney

      void takeMoney(BigDecimal value, CommandSource initiator)
      Deprecated.
    • canAfford

      boolean canAfford(BigDecimal value)
      Deprecated.
    • canSpawnItem

      Boolean canSpawnItem(Material material)
      Deprecated.
    • setLastLocation

      void setLastLocation()
      Deprecated.
    • setLogoutLocation

      void setLogoutLocation()
      Deprecated.
    • requestTeleport

      void requestTeleport(User player, boolean here)
      Deprecated.
    • hasOutstandingTeleportRequest

      @Deprecated boolean hasOutstandingTeleportRequest()
      Deprecated.
      The teleport request system has been moved into a multi-user teleport request queue.
      Returns whether this user has an outstanding teleport request to deal with.
      Returns:
      whether there is a teleport request
      See Also:
    • getTeleport

      @Deprecated ITeleport getTeleport()
      Deprecated.
      This API is not asynchronous. Use IAsyncTeleport with getAsyncTeleport()
    • getAsyncTeleport

      IAsyncTeleport getAsyncTeleport()
      Deprecated.
    • getMoney

      BigDecimal getMoney()
      Deprecated.
    • setMoney

      void setMoney(BigDecimal value) throws MaxMoneyException
      Deprecated.
      Throws:
      MaxMoneyException
    • setAfk

      void setAfk(boolean set, AfkStatusChangeEvent.Cause cause)
      Deprecated.
    • isHidden

      boolean isHidden()
      Deprecated.
      'Hidden' Represents when a player is hidden from others. This status includes when the player is hidden via other supported plugins. Use isVanished() if you want to check if a user is vanished by Essentials.
      Returns:
      If the user is hidden or not
      See Also:
    • setHidden

      void setHidden(boolean vanish)
      Deprecated.
    • isGodModeEnabled

      boolean isGodModeEnabled()
      Deprecated.
    • getGroup

      String getGroup()
      Deprecated.
    • inGroup

      boolean inGroup(String group)
      Deprecated.
    • canBuild

      boolean canBuild()
      Deprecated.
    • getTeleportRequestTime

      @Deprecated long getTeleportRequestTime()
      Deprecated.
      The teleport request system has been moved into a multi-user teleport request queue.
      See Also:
    • enableInvulnerabilityAfterTeleport

      void enableInvulnerabilityAfterTeleport()
      Deprecated.
    • resetInvulnerabilityAfterTeleport

      void resetInvulnerabilityAfterTeleport()
      Deprecated.
    • hasInvulnerabilityAfterTeleport

      boolean hasInvulnerabilityAfterTeleport()
      Deprecated.
    • isVanished

      boolean isVanished()
      Deprecated.
      'Vanished' Represents when a player is hidden from others by Essentials. This status does NOT include when the player is hidden via other plugins. Use isHidden() if you want to check if a user is vanished by any supported plugin.
      Returns:
      If the user is vanished or not
      See Also:
    • setVanished

      void setVanished(boolean vanish)
      Deprecated.
    • isIgnoreExempt

      boolean isIgnoreExempt()
      Deprecated.
    • sendMessage

      void sendMessage(String message)
      Deprecated.
    • getHome

      Location getHome(String name) throws Exception
      Deprecated.
      Throws:
      Exception
    • getHome

      Location getHome(Location loc) throws Exception
      Deprecated.
      Throws:
      Exception
    • getHomes

      List<String> getHomes()
      Deprecated.
    • setHome

      void setHome(String name, Location loc)
      Deprecated.
    • delHome

      void delHome(String name) throws Exception
      Deprecated.
      Throws:
      Exception
    • hasHome

      boolean hasHome()
      Deprecated.
    • getLastLocation

      Location getLastLocation()
      Deprecated.
    • getLogoutLocation

      Location getLogoutLocation()
      Deprecated.
    • getLastTeleportTimestamp

      long getLastTeleportTimestamp()
      Deprecated.
    • setLastTeleportTimestamp

      void setLastTeleportTimestamp(long time)
      Deprecated.
    • getJail

      String getJail()
      Deprecated.
    • setJail

      void setJail(String jail)
      Deprecated.
    • getFormattedJailTime

      String getFormattedJailTime()
      Deprecated.
    • getMails

      @Deprecated List<String> getMails()
      Deprecated.
    • addMail

      @Deprecated void addMail(String mail)
      Deprecated.
    • sendMail

      void sendMail(MailSender sender, String message)
      Deprecated.
    • sendMail

      void sendMail(MailSender sender, String message, long expireAt)
      Deprecated.
    • getMailMessages

      ArrayList<MailMessage> getMailMessages()
      Deprecated.
    • setMailList

      void setMailList(ArrayList<MailMessage> messages)
      Deprecated.
    • getMailAmount

      int getMailAmount()
      Deprecated.
    • isAfk

      boolean isAfk()
      Deprecated.
    • setAfk

      @Deprecated void setAfk(boolean set)
      Deprecated.
    • isIgnoreMsg

      boolean isIgnoreMsg()
      Deprecated.
    • setIgnoreMsg

      void setIgnoreMsg(boolean ignoreMsg)
      Deprecated.
    • setConfigProperty

      @Deprecated void setConfigProperty(String node, Object object)
      Deprecated.
    • getConfigKeys

      Set<String> getConfigKeys()
      Deprecated.
    • getConfigMap

      Map<String,Object> getConfigMap()
      Deprecated.
    • getConfigMap

      Map<String,Object> getConfigMap(String node)
      Deprecated.
    • getCommandCooldowns

      @Deprecated Map<Pattern,Long> getCommandCooldowns()
      Deprecated.
    • getCooldownsList

      List<CommandCooldown> getCooldownsList()
      Deprecated.
    • getCommandCooldownExpiry

      Date getCommandCooldownExpiry(String label)
      Deprecated.
    • addCommandCooldown

      void addCommandCooldown(Pattern pattern, Date expiresAt, boolean save)
      Deprecated.
    • clearCommandCooldown

      boolean clearCommandCooldown(Pattern pattern)
      Deprecated.
    • getBase

      Player getBase()
      Deprecated.
    • getSource

      CommandSource getSource()
      Deprecated.
    • getName

      String getName()
      Deprecated.
    • getUUID

      UUID getUUID()
      Deprecated.
    • getDisplayName

      String getDisplayName()
      Deprecated.
    • getFormattedNickname

      String getFormattedNickname()
      Deprecated.
    • getAfkMessage

      String getAfkMessage()
      Deprecated.
    • setAfkMessage

      void setAfkMessage(String message)
      Deprecated.
    • getAfkSince

      long getAfkSince()
      Deprecated.
    • isAcceptingPay

      boolean isAcceptingPay()
      Deprecated.
    • setAcceptingPay

      void setAcceptingPay(boolean acceptingPay)
      Deprecated.
    • isPromptingPayConfirm

      boolean isPromptingPayConfirm()
      Deprecated.
    • setPromptingPayConfirm

      void setPromptingPayConfirm(boolean prompt)
      Deprecated.
    • isPromptingClearConfirm

      boolean isPromptingClearConfirm()
      Deprecated.
    • setPromptingClearConfirm

      void setPromptingClearConfirm(boolean prompt)
      Deprecated.
    • isLastMessageReplyRecipient

      boolean isLastMessageReplyRecipient()
      Deprecated.
    • setLastMessageReplyRecipient

      void setLastMessageReplyRecipient(boolean enabled)
      Deprecated.
    • getConfirmingPayments

      Map<User,BigDecimal> getConfirmingPayments()
      Deprecated.
    • getTargetBlock

      Block getTargetBlock(int maxDistance)
      Deprecated.
    • setToggleShout

      void setToggleShout(boolean toggleShout)
      Deprecated.
    • isToggleShout

      boolean isToggleShout()
      Deprecated.
    • getNextTpaRequest

      @Nullable IUser.TpaRequest getNextTpaRequest(boolean inform, boolean performExpirations, boolean excludeHere)
      Deprecated.
      Gets information about the most-recently-made, non-expired TPA request in the tpa queue of this IUser.

      The TPA Queue is Last-In-First-Out queue which stores all the active pending teleport requests of this IUser. Timeout calculations are also done during the iteration process of this method, ensuring that teleport requests made past the timeout period are removed from queue and therefore not returned here. The maximum size of this queue is determined by ISettings.getTpaMaxRequests().

      Parameters:
      inform - true if the underlying IUser should be informed if a request expires during iteration.
      performExpirations - true if this method should not spend time validating time for all items in the queue and just return the first item in the queue.
      excludeHere - true if /tphere requests should be ignored in fetching the next tpa request.
      Returns:
      A IUser.TpaRequest corresponding to the next available request or null if no valid request is present.
    • hasPendingTpaRequests

      boolean hasPendingTpaRequests(boolean inform, boolean excludeHere)
      Deprecated.
      Whether or not this IUser has any valid TPA requests in queue.
      Parameters:
      inform - true if the user should be informed if a request expires during iteration.
      excludeHere - true if /tpahere requests should be ignored in checking if a tpa request is available.
      Returns:
      true if the user has an available pending request in queue.