Package net.lewmc.essence.core

Class UtilPlayer

java.lang.Object
net.lewmc.essence.core.UtilPlayer
public class UtilPlayer extends Object
Essence's player utility.

  • Constructor Details

    • UtilPlayer

      public UtilPlayer(Essence plugin)
      The Player utility.
      Parameters:
      plugin - Reference to the main Essence class.
      Since:
      1.11.0

  • Method Details

    • setPlayer

      public boolean setPlayer(UUID uuid, UtilPlayer.KEYS key, Object value)
      Sets a player's data value
      Parameters:
      uuid - UUID - The player's UUID
      key - KEYS - The item to change
      value - Object - The value
      Returns:
      Success?
      Since:
      1.11.0

    • getPlayer

      public Object getPlayer(UUID uuid, UtilPlayer.KEYS key)
      Gets a player's data value
      Parameters:
      uuid - UUID - The player's UUID
      key - KEYS - The item to change
      Returns:
      Object - Value or Null
      Since:
      1.11.0

    • loadPlayer

      public boolean loadPlayer(UUID uuid)
      Loads a player into memory.
      Parameters:
      uuid - UUID - The player's UUID.
      Returns:
      boolean - Success?
      Since:
      1.11.0

    • savePlayer

      public boolean savePlayer(UUID uuid)
      Saves a player's data, avoid using this unless required - it fires automatically when a player leaves the server.
      Parameters:
      uuid - UUID - The player's UUID
      Returns:
      boolean - Success?
      Since:
      1.11.0

    • unloadPlayer

      public void unloadPlayer(UUID uuid)
      Unloads a player's data from memory - WARNING: Does not save! Call savePlayer() first to persist changes.
      Parameters:
      uuid - UUID - The player's UUID
      Since:
      1.11.0

    • createPlayer

      public boolean createPlayer(UUID uuid)
      Creates a player's data file. Does not load any data into it - default data is loaded in by loadPlayer()
      Parameters:
      uuid - UUID - The player's UUID
      Returns:
      boolean - Success?
      Since:
      1.11.0

    • playerIsIgnoring

      public boolean playerIsIgnoring(UUID check, UUID target)
      Checks if a player is ignoring another player
      Parameters:
      check - UUID - The account to check
      target - UUID - The player who might be being ignored.
      Returns:
      boolean - is ignored?

    • setGamemode

      public boolean setGamemode(org.bukkit.command.CommandSender cs, org.bukkit.entity.Player p, org.bukkit.GameMode gamemode)
      Sets the player's gamemode.
      Parameters:
      cs - CommandSender - The executor of the command.
      p - Player - The target player (might be self).
      gamemode - GameMode - The gamemode to set the player to.
      Returns:
      boolean - Success

    • getPlayerPrefix

      public String getPlayerPrefix(org.bukkit.command.CommandSender cs)
      Fetches a player's prefix.
      Parameters:
      cs - CommandSender - The command sender.
      Returns:
      String - The player's prefix (might be blank).

    • getPlayerSuffix

      public String getPlayerSuffix(org.bukkit.command.CommandSender cs)
      Fetches a player's suffix.
      Parameters:
      cs - CommandSender - The command sender.
      Returns:
      String - The player's suffix (might be blank).

    • getDisplayname

      public String getDisplayname(org.bukkit.command.CommandSender cs)
      Gets a player's display name.
      Parameters:
      cs - CommandSender - The player to check.
      Returns:
      The display name.

    • setDisplayname

      public boolean setDisplayname(org.bukkit.command.CommandSender cs, String nickname)
      Sets a player's display name.
      Parameters:
      cs - CommandSender - The p.
      nickname - String - The nickname
      Returns:
      true/false success.

    • removeDisplayname

      public boolean removeDisplayname(org.bukkit.command.CommandSender cs)
      Sets a player's display name.
      Parameters:
      cs - CommandSender - The p.
      Returns:
      true/false success.

    • givePlayerItem

      public boolean givePlayerItem(org.bukkit.entity.Player p, String item, int amount)
      Gives a player X amount of an item.
      Parameters:
      p - Player - The player
      item - String - The item material name
      amount - int - The amount requested
      Returns:
      boolean - true/false success.
      Since:
      1.11.0