Package net.okocraft.box.api.player

Interface BoxPlayerMap

public interface BoxPlayerMap
An interface to get the BoxPlayer from Player.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull BoxPlayer
    get(@NotNull Player player)
    Gets the BoxPlayer.
    boolean
    isLoaded(@NotNull Player player)
    Checks if the BoxPlayer of specified player is loaded.
    boolean
    isScheduledLoading(@NotNull Player player)
    Checks if loading of data for the specified player is scheduled.

  • Method Details

    • isLoaded

      boolean isLoaded(@NotNull @NotNull Player player)
      Checks if the BoxPlayer of specified player is loaded.
      Parameters:
      player - the Player to check
      Returns:
      true if loaded, false otherwise

    • isScheduledLoading

      boolean isScheduledLoading(@NotNull @NotNull Player player)
      Checks if loading of data for the specified player is scheduled.
      Parameters:
      player - the Player to check
      Returns:
      true indicates that it will be loaded a little later, false indicates that it has already been loaded or failed.

    • get

      @NotNull @NotNull BoxPlayer get(@NotNull @NotNull Player player) throws IllegalStateException
      Gets the BoxPlayer.
      Parameters:
      player - the Player
      Returns:
      the BoxPlayer
      Throws:
      IllegalStateException - if the player is not online or not loaded