Interface User

All Superinterfaces:
ArmorEquipable, Carrier, Contextual, DataHolder, DataHolder.Mutable, Equipable, Identifiable, Nameable, Subject, Tamer, ValueContainer
@DoNotStore public interface User extends DataHolder.Mutable, ArmorEquipable, Tamer, Subject, Carrier
A User is the data usually associated with a Player that is persisted across server restarts. This is in contrast to Player which represents the in-game entity associated with an online User.

  • Method Details

    • profile

      GameProfile profile()
      Gets the associated GameProfile of this player.
      Returns:
      The user's profile

    • name

      String name()
      Gets the player's last known username.
      Specified by:
      name in interface Nameable
      Returns:
      The player's last known username

    • isOnline

      boolean isOnline()
      Checks if this user is online or not.
      Returns:
      True if the corresponding player is online

    • player

      Optional<ServerPlayer> player()
      Gets the related online player if the player is in fact online.
      Returns:
      The associated online player, if available

    • position

      Vector3d position()
      Gets the position of this User
      Returns:
      The position of this User

    • worldKey

      ResourceKey worldKey()
      Gets the world key of this User.
      Returns:
      The key, if found

    • setLocation

      boolean setLocation(ResourceKey world, Vector3d position)
      Sets the world and position of this User.

      The key must belong to an existing world.

      When the User isOnline() this redirects to Entity.setLocation(ServerLocation)

      Parameters:
      world - The world key
      position - The position to set
      Returns:
      True if the location was accepted

    • setRotation

      void setRotation(Vector3d rotation)
      Sets the rotation of this entity.

      The format of the rotation is represented by:

      x -> pitch, y -> yaw, z -> roll

      Parameters:
      rotation - The rotation to set the entity to

    • rotation

      Vector3d rotation()
      Gets the rotation.

      The format of the rotation is represented by:

      x -> pitch, y -> yaw, z -> roll

      Returns:
      The rotation

    • inventory

      CarriedInventory<? extends Carrier> inventory()
      Returns the inventory that this Carrier is holding. Note that this may be either a PlayerInventory or UserInventory, depending on whether the user is online or not.
      Specified by:
      inventory in interface Carrier
      Returns:
      The inventory this Carrier is holding

    • enderChestInventory

      Inventory enderChestInventory()
      Gets the Inventory available for this Player's shared EnderChest contents.
      Returns:
      The ender chest inventory

    • respawnLocations

      default MapValue.Mutable<ResourceKey, RespawnLocation> respawnLocations()
      Keys.RESPAWN_LOCATIONS
      Returns:
      The spawn locations of the user may have for various worlds

    • firstJoined

      default Optional<Value.Mutable<Instant>> firstJoined()
      Keys.FIRST_DATE_JOINED
      Returns:
      The timestamp value when this user first joined

    • lastJoined

      default Optional<Value.Mutable<Instant>> lastJoined()
      Keys.LAST_DATE_JOINED
      Returns:
      The last timestamp value when this user has joined

    • invulnerable

      default Value.Mutable<Boolean> invulnerable()
      Keys.INVULNERABLE
      Returns:
      Whether the user is invulnerable

    • invisible

      default Value.Mutable<Boolean> invisible()
      Keys.IS_INVISIBLE
      Returns:
      Whether the user is invisible

    • vanishState

      default Value.Mutable<VanishState> vanishState()

    • hasPlayedBefore

      default boolean hasPlayedBefore()
      Gets if the User has played on the Server before. Added as a utility.
      Returns:
      True if played before, false otherwise