CommandsModule/xyz.theprogramsrc.commandsmodule.bungee/Command

Command

class Command(name: String, onExecute: (CommandExecutor) -> Unit)

Representation of a command

Parameters

name

The name of the command

onExecute

The function to execute when the command is executed.

Constructors

Command

fun Command(name: String, onExecute: (CommandExecutor) -> Unit = {})

Functions

consoleOnly

fun consoleOnly(): Command

Makes this command to be executable only through console

playersOnly

fun playersOnly(): Command

Makes this command to be executable only by players

require

fun require(message: String, check: (CommandSender) -> Boolean): Command

Adds a new requirement to the command

subCommand

fun subCommand(signature: String, tabCompletions: (CommandSender) -> Map<String, Collection<String>> = { emptyMap() }, executor: (CommandExecutor) -> Unit): Command

Registers an argument to this command

withAlias

fun withAlias(vararg aliases: String): Command

Adds the given aliases to the command

withPermission

fun withPermission(permission: String): Command

Sets the command permission to the given permission

withTabCompleter

fun withTabCompleter(tabCompleter: (CommandSender, Array<String>) -> Collection<String>): Command

Replaces the default tab completer for this command

Properties

aliases

val aliases: MutableList<String>

commandType

var commandType: CommandType

name

val name: String

onExecute

val onExecute: (CommandExecutor) -> Unit

permission

var permission: String? = null

requirements

val requirements: MutableList<CommandRequirement<CommandSender>>

subCommands

val subCommands: MutableList<SubCommand>

tabCompleter

var tabCompleter: (CommandSender, Array<String>) -> Collection<String>