Class CommandContext

java.lang.Object
org.kingdoms.locale.SimpleMessenger
org.kingdoms.commands.CommandContext
All Implemented Interfaces:
org.kingdoms.locale.ContextualMessenger
Direct Known Subclasses:
CommandTabContext

public class CommandContext extends SimpleMessenger
  • Field Details

    • plugin

      public final Kingdoms plugin
    • args

      public final String[] args
  • Constructor Details

  • Method Details

    • arg

      public String arg(@org.checkerframework.common.value.qual.IntRange(from=0L, to=5L) int index)
    • argIsAny

      public boolean argIsAny(@org.checkerframework.common.value.qual.IntRange(from=0L, to=5L) int index, String... options)
    • joinArgs

      public String joinArgs()
    • joinArgs

      public String joinArgs(String delimiter)
    • joinArgs

      public String joinArgs(String delimiter, @org.checkerframework.common.value.qual.IntRange(from=0L, to=5L) int index)
    • getCommand

      public KingdomsCommand getCommand()
    • parseInt

      public Integer parseInt(int index, Messenger argName, boolean allowNegative)
    • parseBool

      public Boolean parseBool(@org.checkerframework.common.value.qual.IntRange(from=0L, to=5L) int index)
    • arg

      public String arg(@org.checkerframework.common.value.qual.IntRange(from=0L, to=5L) int index, String def)
    • debug

      public CommandContext debug(String msg)
    • nextArg

      public int nextArg()
    • generalSelector

      public <T extends Group> T generalSelector(boolean targetNation)
      This function checks for seleectors for the sender's language and the english since all commands executed from configs must use the English format for consistency.
    • fail

      public CommandResult fail(Messenger lang, Object... edits)
    • wrongUsage

      public void wrongUsage()
    • assertPlayer

      public boolean assertPlayer()
    • getPlugin

      public Kingdoms getPlugin()
    • getArgs

      public String[] getArgs()
    • senderAsPlayer

      public org.bukkit.entity.Player senderAsPlayer()
    • assertArgs

      public boolean assertArgs(@org.checkerframework.common.value.qual.IntRange(from=1L, to=5L) int len)
      Checks if this command has the provided number of arguments.
      Parameters:
      len - the amount of command arguments.
    • requireArgs

      public boolean requireArgs(@org.checkerframework.common.value.qual.IntRange(from=1L, to=5L) int len)
    • mapArguments

      public CommandContext.MappedArguments mapArguments()
    • assertHasKingdom

      public boolean assertHasKingdom()
    • assertHasNation

      public boolean assertHasNation()
    • lang

      public Messenger lang(String... entries)
    • argsLengthEquals

      public boolean argsLengthEquals(int len)
    • isAtArg

      public boolean isAtArg(@org.checkerframework.common.value.qual.IntRange(from=0L, to=5L) int index)
    • intArg

      public int intArg(@org.checkerframework.common.value.qual.IntRange(from=0L, to=5L) int index)
    • isNumber

      public boolean isNumber(int index)
    • getDouble

      public Double getDouble(int index)
    • getInt

      public Integer getInt(int index)
    • getNumber

      public Number getNumber(int index, boolean integerOnly, boolean positiveOnly, Messenger argName)
    • getKingdomPlayer

      public KingdomPlayer getKingdomPlayer()
    • getKingdom

      public Kingdom getKingdom()
    • getKingdom

      public Kingdom getKingdom(int index)
    • getNation

      public Nation getNation(int index)
    • argEquals

      public boolean argEquals(int index, KingdomsLang lang)
    • argEquals

      public boolean argEquals(int index, String str)
    • getSender

      public org.bukkit.command.CommandSender getSender()
      Specified by:
      getSender in interface org.kingdoms.locale.ContextualMessenger
      Overrides:
      getSender in class SimpleMessenger
    • hasPermission

      public boolean hasPermission(KingdomsDefaultPluginPermission permission)
    • hasPermission

      public boolean hasPermission(KingdomsDefaultPluginPermission permission, boolean checkAdmin)
    • isAdmin

      public boolean isAdmin()
    • getPlayer

      public @Nullable org.bukkit.entity.Player getPlayer(int index)
    • getPlayer

      public @Nullable org.bukkit.entity.Player getPlayer(int index, boolean exact)
    • getOfflinePlayer

      public @Nullable org.bukkit.OfflinePlayer getOfflinePlayer(int index)