kraftlin-command-core/io.github.kraftlin.command/KContext

KContext

class KContext<S>(val rawContext: CommandContext<S>)

Typed accessor for retrieving parsed argument values from a Brigadier CommandContext.

Passed to executes and executesResult blocks. Use the accessor methods (e.g. string, integer) to retrieve arguments by the name used when defining them.

Constructors

KContext

constructor(rawContext: CommandContext<S>)

Properties

rawContext

val rawContext: CommandContext<S>

source

val source: S

The raw command source provided by the platform.

Functions

boolean

fun boolean(name: String): Boolean

Returns the parsed Boolean for the argument registered as name.

double

fun double(name: String): Double

Returns the parsed Double for the argument registered as name.

float

fun float(name: String): Float

Returns the parsed Float for the argument registered as name.

greedyString

fun <S> KContext<S>.greedyString(name: String): String

Returns the string value. Alias for string. @see LiteralNode.greedyString

integer

fun integer(name: String): Int

Returns the parsed Int for the argument registered as name.

long

fun long(name: String): Long

Returns the parsed Long for the argument registered as name.

string

fun string(name: String): String

Returns the parsed String for the argument registered as name.

word

fun <S> KContext<S>.word(name: String): String

Returns the string value. Alias for string. @see LiteralNode.word