Package com.minigameworld.api

Class MiniGameAccessor

java.lang.Object
com.minigameworld.api.MiniGameAccessor
public class MiniGameAccessor extends Object
MiniGameWorld plugin "MiniGame" wrapper api

  • Constructor Details

    • MiniGameAccessor

      public MiniGameAccessor​(MiniGame minigame)
      MiniGame wrapper constructor
      Parameters:
      minigame -

  • Method Details

    • isEmpty

      public boolean isEmpty()
      Checks minigame has no players
      Returns:
      True if no players in the minigame

    • isFull

      public boolean isFull()
      Checks minigame has full players
      Returns:
      True if "current players" = "max player count"

    • isStarted

      public boolean isStarted()
      Check minigame has started or not
      Returns:
      True if already started, false if waiting players

    • containsPlayer

      public boolean containsPlayer​(org.bukkit.entity.Player p)
      Checks player is playing minigame
      Parameters:
      p - Checking player
      Returns:
      True if player is playing this minigame

    • players

      public List<org.bukkit.entity.Player> players()
      Gets playing players list
      Returns:
      Playing players list

    • score

      public int score​(org.bukkit.entity.Player p)
      Gets player's score
      Parameters:
      p - Target player
      Returns:
      Player's score

    • gamePlayers

      public List<MiniGamePlayer> gamePlayers()
      Gets copied PlayerData list in minigame (Data change will not be applied)
      Returns:
      PlayerData list

    • settings

      public MiniGameSetting settings()
      Gets setting data
      Returns:
      MiniGameSetting setting data

    • settingsData

      public Map<String,​Object> settingsData()
      Gets settings data with Map
      Returns:
      Map setting data

    • customOption

      public Object customOption​(MiniGameCustomOption.Option option)
      Gets custom option
      Parameters:
      option - Option to get data
      Returns:
      Option data

    • className

      public String className()
      Gets minigame class name
      Returns:

    • leftWaitTime

      public int leftWaitTime()
      Gets minigame left waiting time (sec)
      Returns:
      Left waiting time

    • leftPlayTime

      public int leftPlayTime()
      Gets left play time (sec)
      Returns:
      Left play time

    • rank

      public List<? extends MiniGameRank> rank()
      Gets rank list by score
      Will be return clone object in the future
      Returns:
      Rank list

    • classType

      public Class<?> classType()
      Get class
      Returns:
      Class

    • frameType

      public String frameType()
      Get minigame frame type
      Returns:
      Minigame frame type
      See Also:
      MiniGame.frameType()

    • viewers

      public Set<org.bukkit.entity.Player> viewers()
      Get viewers
      Returns:
      Viewers

    • scoreboard

      public org.bukkit.scoreboard.Scoreboard scoreboard()
      Get scoreboard
      Returns:
      Scoreboard

    • minigame

      public MiniGame minigame()
      Return minigame instance
      Returns:
      Minigame instance

    • isSameTemplate

      public boolean isSameTemplate​(MiniGameAccessor game)
      Check two games drived from the same template game or not
      Parameters:
      game - Checking game
      Returns:
      True if two games are derived from the same template game

    • equals

      public boolean equals​(Object obj)
      Compare with MiniGame.isSameTemplate(MiniGame) and MiniGameSetting.getId()
      Overrides:
      equals in class Object