mirai-console/net.mamoe.mirai.console.command.java/JRawCommand

JRawCommand

abstract class JRawCommand @JvmOverloads constructor( val owner: CommandOwner, val primaryName: String, val secondaryNames: String, parentPermission: Permission = owner.parentPermission) : Command

供 Java 用户继承

请在构造时设置相关属性.

public final class MyCommand extends JRawCommand {
    public static final MyCommand INSTANCE = new MyCommand();
    private MyCommand() {
        super(MyPluginMain.INSTANCE, "test")
        // 可选设置如下属性
        setUsage("/test")
        setDescription("这是一个测试指令")
        setPermission(CommandPermission.Operator.INSTANCE)
        setPrefixOptional(true)
    }

    @Override
    public void onCommand(@NotNull CommandSender sender, @NotNull args: Object[]) {
        // 处理指令
    }
}

See also

net.mamoe.mirai.console.command.java.JRawCommand

Constructors

fun JRawCommand( owner: CommandOwner, primaryName: String, vararg secondaryNames: String, parentPermission: Permission = owner.parentPermission)

Functions

open fun onCommand(sender: CommandSender, args: MessageChain)

在指令被执行时调用.

Properties

override val description: String

指令描述, 用于显示在 BuiltInCommands.HelpCommand

@ExperimentalCommandDescriptors

open override val overloads: List<@JvmWildcard CommandSignature>

指令可能的参数列表.

open override val owner: CommandOwner

指令拥有者.

override val permission: Permission

指令权限

@ExperimentalCommandDescriptors

override val prefixOptional: Boolean = false

为 true 时表示指令前缀可选

open override val primaryName: String

主指令名. 将会参与构成 Permission.id.

open override val secondaryNames: Array<out String>

次要指令名

open override val usage: String

用法说明, 用于发送给用户