模块 linlang.api

程序包 api.linlang.command

接口 LinCommand

public interface LinCommand

Linlang 命令服务。

命令由规范字符串、执行器和 CommandOptions 组成。开发者既可以 使用完整规范逐条注册，也可以通过 root(String) 创建可合并的嵌套命令组。

嵌套类概要

嵌套类

修饰符和类型	接口	说明
static interface	LinCommand.CommandExecutor	命令执行器。
static interface	LinCommand.Ctx	单次命令执行上下文。
static enum	LinCommand.ExecTarget	命令允许的发送者类型。
static interface	LinCommand.I18nSupplier	延迟 i18n 提供者：在渲染 usage/help 时根据当前语言动态取值。
static interface	LinCommand.ParseCtx	参数解析上下文。
static final record	LinCommand.Permission	命令权限要求。
static interface	LinCommand.TypeResolver	自定义命令参数类型解析器。

方法概要

修饰符和类型	方法	说明
default void	addResolver(LinCommand.TypeResolver resolver)	注册自定义命令参数类型解析器。
default LinCommand	register(String spec, LinCommand.CommandExecutor exec)	使用默认选项注册命令。
LinCommand	register(String spec, LinCommand.CommandExecutor exec, CommandOptions options)	使用统一选项注册命令。
api.linlang.command.group.CommandRoot	root(String namespace)	获取或创建根命令。

方法详细资料

addResolver

default void addResolver(LinCommand.TypeResolver resolver)

注册自定义命令参数类型解析器。

解析器既负责把参数文本转换为业务对象，也可以按当前输入动态提供 Tab 补全候选。 实现若不支持扩展参数类型，可以保留默认行为。

参数:

resolver - 参数类型解析器

抛出:

UnsupportedOperationException - 当前实现不支持自定义解析器时

root

api.linlang.command.group.CommandRoot root(String namespace)

获取或创建根命令。

同一命令服务中名称相同的根命令会合并。通过根命令注册的相对规范与 register(String, CommandExecutor, CommandOptions) 注册的完整规范 最终进入同一套路由。

参数:

namespace - 根命令命名空间

返回:

根命令

register

default LinCommand register(String spec,
 LinCommand.CommandExecutor exec)

使用默认选项注册命令。

命令默认不要求权限，并允许玩家和控制台执行。

参数:

spec - 命令规范字符串

exec - 命令执行器

返回:

当前命令服务

register

LinCommand register(String spec,
 LinCommand.CommandExecutor exec,
 CommandOptions options)

使用统一选项注册命令。

参数:

spec - 命令规范字符串

exec - 命令执行器

options - 命令选项

返回:

当前命令服务