Package dev.esophose.playerparticles.command

Class HelpCommandModule

java.lang.Object
dev.esophose.playerparticles.command.HelpCommandModule
All Implemented Interfaces:
CommandModule
public class HelpCommandModule
extends java.lang.Object
implements CommandModule

  • Constructor Summary

    Constructors 
    Constructor Description
    HelpCommandModule()  

  • Method Summary

    Modifier and Type Method Description
    boolean canConsoleExecute()  
    java.lang.String getArguments()
    Gets any arguments this command has
    java.lang.String getDescriptionKey()
    Gets the locale description key of this command
    java.lang.String getName()
    Gets the name of this command
    void onCommandExecute​(PPlayer pplayer, java.lang.String[] args)
    Called when this command gets executed
    java.util.List<java.lang.String> onTabComplete​(PPlayer pplayer, java.lang.String[] args)
    Called when a player tries to tab complete this command
    boolean requiresEffectsAndStyles()
    True if this command requires the player to have any effects and styles

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

  • Method Details

    • onCommandExecute

      public void onCommandExecute​(PPlayer pplayer, java.lang.String[] args)
      Description copied from interface: CommandModule
      Called when this command gets executed
      Specified by:
      onCommandExecute in interface CommandModule
      Parameters:
      pplayer - The PPlayer who executed this command
      args - The arguments to this command

    • onTabComplete

      public java.util.List<java.lang.String> onTabComplete​(PPlayer pplayer, java.lang.String[] args)
      Description copied from interface: CommandModule
      Called when a player tries to tab complete this command
      Specified by:
      onTabComplete in interface CommandModule
      Parameters:
      pplayer - The PPlayer who is tab completing this command
      args - Arguments typed so far
      Returns:
      A list of possible argument values

    • getName

      public java.lang.String getName()
      Description copied from interface: CommandModule
      Gets the name of this command
      Specified by:
      getName in interface CommandModule
      Returns:
      The name of this command

    • getDescriptionKey

      public java.lang.String getDescriptionKey()
      Description copied from interface: CommandModule
      Gets the locale description key of this command
      Specified by:
      getDescriptionKey in interface CommandModule
      Returns:
      The locale description key of this command

    • getArguments

      public java.lang.String getArguments()
      Description copied from interface: CommandModule
      Gets any arguments this command has
      Specified by:
      getArguments in interface CommandModule
      Returns:
      The arguments this command has

    • requiresEffectsAndStyles

      public boolean requiresEffectsAndStyles()
      Description copied from interface: CommandModule
      True if this command requires the player to have any effects and styles
      Specified by:
      requiresEffectsAndStyles in interface CommandModule
      Returns:
      If the player must have effects and styles to use this command

    • canConsoleExecute

      public boolean canConsoleExecute()
      Specified by:
      canConsoleExecute in interface CommandModule
      Returns:
      true if this command can be executed from console, otherwise false