common / me.schlaubi.regnumutils.command.spi / SubCommand

SubCommand

abstract class SubCommand : AbstractCommand

Representation of a sub-command.

See Also

AbstractCommand

Command

Constructors

<init>

SubCommand(displayName: String, permissions: Permissions, alias: String, description: String, usage: String = "", exampleUsage: String = "")SubCommand(displayName: String, permissions: Permissions, aliases: Array<String>, description: String, usage: String = "", exampleUsage: String = "")

Representation of a sub-command.

Properties

parent

lateinit var parent: Command

The commands parent

Inherited Properties

aliases

open val aliases: Array<String>

the command's aliases

description

open val description: String

the command's description

displayName

open val displayName: String

name for command in help messages

exampleUsage

open val exampleUsage: String

the command's example usage

permissions

open val permissions: Permissions

the command's Permissions

subCommandAssociations

val subCommandAssociations: MutableMap<String, Command>

The commands sub-commands.

usage

open val usage: String

The usage of the command.

Inherited Functions

registerSubCommand

open fun registerSubCommand(subCommand: SubCommand): Unit

Registers the subCommand.