Package com.mclds.plugins.customplugin.registry.registrable

Class RegistrableCommand

java.lang.Object
com.mclds.plugins.customplugin.registry.registrable.RegistrableCommand
public class RegistrableCommand extends Object

  • Constructor Details

    • RegistrableCommand

      public RegistrableCommand()

  • Method Details

    • create

      public static RegistrableCommand create()

    • name

      public RegistrableCommand name(String name)
      设置命令名， 真正执行的命令行为 /插件名:命令名
      Parameters:
      name - 名字

    • desc

      public RegistrableCommand desc(String desc)
      描述

    • usage

      public RegistrableCommand usage(String usage)
      使用方法

    • permissions

      public RegistrableCommand permissions(String... permission)
      指定此指令的权限

    • permissions

      public RegistrableCommand permissions(Permissions... permission)
      指定此指令的权限
      Parameters:
      permission - 权限，false 代表无需权限

    • defineParam

      public RegistrableCommand defineParam(String key, List<String> values)
      定义 TabComplete 提示参数名字， Key 为参数名，Value 为参数的提示列表 最终所提示的 TabComplete 为 Key=Value

    • defineParam

      public RegistrableCommand defineParam(String key, String... values)
      定义 TabComplete 提示参数名字， Key 为参数名，Value 为参数的提示列表 最终所提示的 TabComplete 为 Key=Value

    • comment

      public RegistrableCommand comment(String comment)
      添加参数注释，调用顺序必须在 defineParam 之后 , addParam 不支持注释
      Parameters:
      comment - 注释

    • addParam

      public RegistrableCommand addParam(List<String> values)
      定义 TabComplete 提示的参数列表，每次调用都会添加一个参数列表，参数列表中的参数按照顺序排列
      第一个调用的param函数，代表第一个参数所对应的提示列表
      注意 addParam 和 defineParam 不能同时使用

    • addParam

      public RegistrableCommand addParam(String... values)
      定义 TabComplete 提示的参数列表，每次调用都会添加一个参数列表，参数列表中的参数按照顺序排列
      第一个调用的param函数，代表第一个参数所对应的提示列表
      注意 addParam 和 defineParam 不能同时使用

    • restParam

      public RegistrableCommand restParam(String value)
      指定剩余参数的 TabComplete 提示 只有在全部参数都填写完毕后才会提示

    • executor

      public RegistrableCommand executor(RegistrableCommand.CommandExecutor executor)
      设置执行器

    • tabComplete

      public RegistrableCommand tabComplete(RegistrableCommand.TabCompleteProvider tabCompleteProvider)
      设置命令行自动补全器，尽量避免使用动态的补全器，因为会增加服务器的负担 可以使用 setParam 或者 addParam 设置静态参数 如果需要更新补全则 调用 /reload-plugin xxx 重载插件

    • getName

      public String getName()

    • getDescription

      public String getDescription()

    • getUsage

      public String getUsage()

    • getPermissions

      public List<String> getPermissions()

    • getExecutor

      public RegistrableCommand.CommandExecutor getExecutor()

    • getTabCompleteProvider

      @Nullable public @Nullable RegistrableCommand.TabCompleteProvider getTabCompleteProvider()

    • getParamKeyMap

      public Map<String,String[]> getParamKeyMap()

    • getParamsList

      public List<String[]> getParamsList()

    • getRestParam

      public String getRestParam()