Package org.lazywizard.console

Class CommandStore.StoredCommand

  • All Implemented Interfaces:
    
public final class CommandStore.StoredCommand

    Contains detailed information on a loaded command.

    Since:

    2.0

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      Class<out BaseCommand> getCommandClass() Returns the class object for this command's implementation.
      String getName() Returns the name of this command (what the player would enter to use it).
      String getSyntax() Returns the syntax for this command.
      String getHelp() Returns the detailed usage instructions for this command.
      String getSource() Returns the complete file path of the CSV this command was loaded from (not the relative path).
      List<String> getTags() Returns all tags associated with this command.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

    • Method Detail

      • getName

         String getName()

        Returns the name of this command (what the player would enter to use it).

        Returns:

        The name of this command, taken from the 'name' column of the CSV.

        Since:

        2.0

      • getSyntax

         String getSyntax()

        Returns the syntax for this command.

        Returns:

        The syntax for this command, taken from the 'syntax' column of the CSV.

        Since:

        2.0

      • getHelp

         String getHelp()

        Returns the detailed usage instructions for this command.

        Returns:

        The detailed help for this command, taken from the 'help' column of the CSV.

        Since:

        2.0

      • getSource

         String getSource()

        Returns the complete file path of the CSV this command was loaded from (not the relative path). Useful for determining which mod added this command.

        Returns:

        The complete file path of the CSV this command was loaded from. There is no other way to retrieve this information in the current API.

        Since:

        2.0

      • getTags

         List<String> getTags()

        Returns all tags associated with this command.

        Returns:

        All tags associated with this command, taken from the 'tags' column of the CSV.

        Since:

        2.0