CommandContext

class CommandContext<T>(flyLib: FlyLib<T>, config: T?, command: Command<T>, sender: CommandSender, world: World?, server: Server, message: String, depth: Int, typedArgs: List<Any?>)

The context when the command is executed. It is passed as an argument or receiver when executing a command or completing a tab. This class holds information when executing a command or completing a tab, which can be retrieved by the plug-in that registered the command, the command itself, the sender of the command, etc. It can also send a message to the executor of the command, display usage instructions, etc.

Constructors

CommandContext

fun <T> CommandContext(flyLib: FlyLib<T>, config: T?, command: Command<T>, sender: CommandSender, world: World?, server: Server, message: String, depth: Int, typedArgs: List<Any?> = emptyList())

Functions

fail

fun fail(text: String)

send red string

message

fun message(builder: ComponentBuilderAction)

send component via builder

fun message(text: String)

send string message

fun message(component: Component)

send component

fun message(text: String, color: Color)

send string colored message

pluginMessage

fun pluginMessage(builder: ComponentBuilderAction)

send component via builder with plugin name

fun pluginMessage(text: String)

send string with plugin name

fun pluginMessage(component: Component)

send component with plugin name

fun pluginMessage(text: String, color: Color)

send colored string with plugin name

pluginMessageFail

fun pluginMessageFail(text: String)

send red string with plugin name

pluginMessageSuccess

fun pluginMessageSuccess(text: String)

send green string with plugin name

pluginMessageWarn

fun pluginMessageWarn(text: String)

send yellow string with plugin name

sendHelp

fun sendHelp()

Display the information of the command in this context in the sender of this context. (It will also include usages and examples.)

success

fun success(text: String)

send green string

updateConfig

fun updateConfig(action: T.() -> Unit)

warn

fun warn(text: String)

send yellow string

Properties

args

val args: List<String>

Command arguments. The remaining arguments except the beginning of the command are assigned. These are all returned as strings. If you need parsed values, see typedArgs.

command

val command: Command<T>

The command that has been executed or is about to be executed.

config

val config: T?

flyLib

val flyLib: FlyLib<T>

message

val message: String

Command input message. (includes slash)

player

val player: Player?