For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt, and this page is available as Markdown at /server/interfaces/CustomCommand.md.

Interface: CustomCommand

Beta

定义自定义命令,包括名称、权限和参数。

Define the custom command, including name, permissions, and parameters.

Properties

cheatsRequired?

optional cheatsRequired?: boolean

Beta

Remarks

运行此命令需要开启作弊。默认为 true

Cheats must be enabled to run this command. Defaults to true.


description

description: string

Beta

Remarks

在命令行上显示的命令描述。

Command description as seen on the command line.


mandatoryParameters?

optional mandatoryParameters?: CustomCommandParameter[]

Beta

Remarks

必填命令参数列表。

List of mandatory command parameters.


name

name: string

Beta

Remarks

命令的名称。需要命名空间。

The name of the command. A namespace is required.


optionalParameters?

optional optionalParameters?: CustomCommandParameter[]

Beta

Remarks

可选命令参数列表。

List of optional command parameters.


permissionLevel

permissionLevel: CommandPermissionLevel

Beta

Remarks

执行命令所需的权限等级。

The permission level required to execute the command.