Package com.minigameworld.api

Class MwUtil

java.lang.Object
com.minigameworld.api.MwUtil
public class MwUtil extends Object
MiniGameWorld Utility API

  • Constructor Details

    • MwUtil

      public MwUtil()

  • Method Details

    • setMiniGameManager

      public static void setMiniGameManager​(MiniGameManager minigameManager)
      Do not use

    • isPlayingGame

      public static boolean isPlayingGame​(org.bukkit.entity.Player p)
      Checks a player is playing any minigames
      Parameters:
      p - Player to check
      Returns:
      True if player is playing any minigames

    • isViewingGame

      public static boolean isViewingGame​(org.bukkit.entity.Player p)
      Check a player is viewing any minigames
      Parameters:
      p - Player to check
      Returns:
      True if a player is viewing any minigames

    • isInGame

      public static boolean isInGame​(org.bukkit.entity.Player p)
      Check a player is playing or viewing any minigame
      Parameters:
      p - Player to check
      Returns:
      True if the player is playing or viewing any minigame

    • getPlayingGame

      public static MiniGameAccessor getPlayingGame​(org.bukkit.entity.Player p)
      Gets player's playing minigame
      Parameters:
      p - Player to check
      Returns:
      Null if a player is not playing any minigames

    • getViewingGame

      public static MiniGameAccessor getViewingGame​(org.bukkit.entity.Player p)
      Get player's viewing minigame
      Parameters:
      p - Player to check
      Returns:
      Null if a player is not viewing any minigames

    • getInGame

      public static MiniGameAccessor getInGame​(org.bukkit.entity.Player p)
      Get minigame player is in(playing or viewing) any minigame
      Parameters:
      p - Player to check
      Returns:
      Null if a player is not in(playing or viewing) any minigames

    • getPlayingGamePlayers

      public static List<org.bukkit.entity.Player> getPlayingGamePlayers​(List<org.bukkit.entity.Player> players)
      Get players who are playing a minigame
      Parameters:
      players - Players to check
      Returns:
      Players who are playing a minigame

    • getPlayingGamePlayers

      public static List<org.bukkit.entity.Player> getPlayingGamePlayers​(List<org.bukkit.entity.Player> players, boolean reverse)
      Get players who are playing a minigame (reverse option)
      Parameters:
      players - Players to check
      reverse - If true, get not playing game players
      Returns:
      Players who are playing a minigame

    • getViewingGamePlayers

      public static List<org.bukkit.entity.Player> getViewingGamePlayers​(List<org.bukkit.entity.Player> players)
      Get players who are viewing a minigame
      Parameters:
      players - Players to check
      Returns:
      Players who are not viewing a minigame

    • getViewingGamePlayers

      public static List<org.bukkit.entity.Player> getViewingGamePlayers​(List<org.bukkit.entity.Player> players, boolean reverse)
      Get players who are viewing a minigame (reverse option)
      Parameters:
      players - Players to check
      reverse - If true, get not viewing game players
      Returns:
      Players who are not viewing a minigame

    • getInGamePlayers

      public static List<org.bukkit.entity.Player> getInGamePlayers​(List<org.bukkit.entity.Player> players)
      Get players who are in(playing or viewing) a minigame
      Parameters:
      players - Players to check
      Returns:
      Players who are in(playing or viewing) a minigame

    • getInGamePlayers

      public static List<org.bukkit.entity.Player> getInGamePlayers​(List<org.bukkit.entity.Player> players, boolean reverse)
      Get players who are in(playing or viewing) a minigame (reverse option)
      Parameters:
      players - Players to check
      reverse - If true, get not viewing game players
      Returns:
      Players who are NOT in(playing or viewing) a minigame

    • getTemplateGame

      public static MiniGameAccessor getTemplateGame​(String title)
      Get MiniGameAccessor with title
      Parameters:
      title - Minigame title
      Returns:
      Null if title minigmae is not exist

    • getTemplateGame

      public static MiniGameAccessor getTemplateGame​(Class<?> c)
      Gets MiniGameAccessor with class name
      Parameters:
      c - Minigame class name
      Returns:
      Null if class name minigame not exist

    • getInstanceGame

      public static MiniGameAccessor getInstanceGame​(String title, String id)
      Get instance game with title and minigame id
      Parameters:
      title - Minigame title
      id - Minigame instance id
      Returns:
      Null if there is no minigame matched

    • getInstanceGame

      public static MiniGameAccessor getInstanceGame​(Class<?> c, String id)
      Get instance game with class simple name and minigame id
      Parameters:
      c - Minigame class name
      id - Minigame instance id
      Returns:
      Null if there is no minigame matched

    • getMiniGamesDir

      public static File getMiniGamesDir()
      Get "plugins/MiniGameWorld/minigames" directory
      Returns:
      Directory which has minigame configs

    • getMessagesDir

      public static File getMessagesDir()
      Get "plugins/MiniGameWorld/messages" directory
      Returns:
      Directory which has language messages

    • checkPermission

      public static boolean checkPermission​(org.bukkit.command.CommandSender sender, String permission)
      Check MiniGameWorld permission without "minigameworld."
      Example
      If want to check a player has "minigameworld.play.join" permission or not
      if (!MwUtil.checkPermission(p, "play.join")) { return; }
      Parameters:
      sender - CommandSender to check
      permission - Permission to check
      Returns:
      True if sender has the permission