Package dev.cwhead.GravesX.module.command

Interface GravesXModuleCommand

All Superinterfaces:
org.bukkit.command.CommandExecutor
public interface GravesXModuleCommand extends org.bukkit.command.CommandExecutor
Command executor with optional metadata used by the module registrar to auto-fill name, description, usage, permission, and aliases.

  • Method Summary

    Modifier and Type
    Method
    Description
    default List<String>
    getAliases()
    Additional names that run the same command.
    default String
    getDescription()
    Short help text shown in command lists.
    default String
    getName()
    Command name override.
    default String
    getPermission()
    Permission node required to run the command.
    default String
    getUsage()
    Usage string shown on errors or help.

    Methods inherited from interface org.bukkit.command.CommandExecutor

    onCommand

  • Method Details

    • getName

      default String getName()
      Command name override. If different from the YAML key, it may be added as an alias.
      Returns:
      Command name or null to keep the YAML/default.

    • getDescription

      default String getDescription()
      Short help text shown in command lists.
      Returns:
      Description string, empty if none.

    • getUsage

      default String getUsage()
      Usage string shown on errors or help.
      Returns:
      Usage text (e.g. "/cmd <arg>"), or null for default.

    • getPermission

      default String getPermission()
      Permission node required to run the command.
      Returns:
      Permission node or null for default.

    • getAliases

      default List<String> getAliases()
      Additional names that run the same command.
      Returns:
      List of aliases, possibly empty.