Package net.tnemc.plugincore.core.compatibility

Interface PlayerProvider

All Superinterfaces:
net.tnemc.menu.core.compatibility.MenuPlayer
All Known Implementing Classes:
BukkitPlayerProvider, PaperPlayerProvider, SpongePlayerProvider
public interface PlayerProvider extends net.tnemc.menu.core.compatibility.MenuPlayer
A class that acts as a bridge between various player objects on different server software providers.
Since:
0.1.2.0
Author:
creatorfromhell

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    biome()
    Used to get the name of the biome this player is currently in.
    List<String>
    getEffectivePermissions()
    Method for retrieving player permissions.
    int
    getExp()
    Used to get the amount of experience this player has.
    int
    getExpLevel()
    Used to get the amount of experience levels this player has.
    Optional<Location>
    getLocation()
    Used to get the location of this player.
    String
    getName()
    Used to get the name of this player.
    boolean
    hasPermission(String permission)
    Used to determine if this player has the specified permission node.
    InventoryProvider<?>
    inventory()
     
    void
    message(MessageData messageData)
    Used to send a message to this command source.
    void
    setExp(int exp)
    Used to set the amount of experience this player has.
    void
    setExpLevel(int level)
    Used to set the amount of experience levels this player has.
    String
    world()
    Used to get the name of the world this player is currently in.

    Methods inherited from interface net.tnemc.menu.core.compatibility.MenuPlayer

    identifier, message, status, viewer

  • Method Details

    • getName

      String getName()
      Used to get the name of this player.
      Returns:
      The name of this player.

    • getLocation

      Optional<Location> getLocation()
      Used to get the location of this player.
      Returns:
      The location of this player.

    • world

      String world()
      Used to get the name of the world this player is currently in.
      Returns:
      The name of the world.

    • biome

      String biome()
      Used to get the name of the biome this player is currently in.
      Returns:
      The name of the biome.

    • getExp

      int getExp()
      Used to get the amount of experience this player has.
      Returns:
      The amount of levels this player has.

    • setExp

      void setExp(int exp)
      Used to set the amount of experience this player has.
      Parameters:
      exp - The amount of experience to set for this player.

    • getExpLevel

      int getExpLevel()
      Used to get the amount of experience levels this player has.
      Returns:
      The amount of experience levels this player has.

    • setExpLevel

      void setExpLevel(int level)
      Used to set the amount of experience levels this player has.
      Parameters:
      level - The amount of experience levels to set for this player.

    • inventory

      InventoryProvider<?> inventory()
      Specified by:
      inventory in interface net.tnemc.menu.core.compatibility.MenuPlayer

    • getEffectivePermissions

      List<String> getEffectivePermissions()
      Method for retrieving player permissions.
      Returns:
      A list of permission strings.

    • hasPermission

      boolean hasPermission(String permission)
      Used to determine if this player has the specified permission node.
      Specified by:
      hasPermission in interface net.tnemc.menu.core.compatibility.MenuPlayer
      Parameters:
      permission - The node to check for.
      Returns:
      True if the player has the permission, otherwise false.

    • message

      void message(MessageData messageData)
      Used to send a message to this command source.
      Parameters:
      messageData - The message data to utilize for this translation.