minecraft/org.quiltmc.qkl.wrapper.minecraft.brigadier

Package org.quiltmc.qkl.wrapper.minecraft.brigadier

Types

typealias ArgumentAccessor<S, D> = CommandContext<S>.() -> ArgumentReader<S, D>

class ArgumentConstructor<S, B : ArgumentBuilder<S, *>, D : ArgumentDescriptor<*>>( val builder: B, val name: String, val descriptor: D)

Class containing all data necessary to construct an optional or required argument.

ArgumentDescriptor

interface ArgumentDescriptor<A : ArgumentType<*>>

A marker interface for any object or class that describes a subtype of the argument type A. The descriptor is used to find the ArgumentReader extensions applicable to the argument being described, and possibly to provide additional data for those extensions.

ArgumentReader

class ArgumentReader<S, out D : ArgumentDescriptor<*>>( val context: CommandContext<S>, val name: String, val argumentDescriptor: D)

Argument readers are a general access point for obtaining argument values from the command context.

BrigadierDsl

@DslMarker

annotation class BrigadierDsl

Marks functions as part of QKL's Brigadier DSL.

CommandAction

typealias CommandAction<S> = CommandContext<S>.() -> Unit

CommandActionWithResult

typealias CommandActionWithResult<S> = CommandContext<S>.() -> CommandResult

CommandArgument

sealed class CommandArgument<S, out B : ArgumentBuilder<S, *>, out D : ArgumentDescriptor<*>, out A>

An argument ready to be registered into a command. Can be either optional or required.

CommandResult

sealed class CommandResult

Representation of possible results of running a command.

DefaultArgumentConstructor

typealias DefaultArgumentConstructor<S, T> = RequiredArgumentConstructor<S, DefaultArgumentDescriptor<T>>

DefaultArgumentDescriptor

class DefaultArgumentDescriptor<T : ArgumentType<*>> : ArgumentDescriptor<T>

Default ArgumentDescriptor, used for argument types such as IntegerArgumentType and many others that do only provide a single argument type with no extra data needed to resolve it.

DefaultArgumentReader

typealias DefaultArgumentReader<T> = ArgumentReader<*, DefaultArgumentDescriptor<T>>

RequiredArgumentConstructor

typealias RequiredArgumentConstructor<S, D> = ArgumentConstructor<S, RequiredArgumentBuilder<S, *>, D>

Functions

argument

fun <S, AT, A : ArgumentType<AT>> argument(name: String, argumentType: A): RequiredArgumentConstructor<S, DefaultArgumentDescriptor<A>>

Creates an argument of the specified argumentType with the specified parameter name and a DefaultArgumentDescriptor for the argument type used.

fun <S, D : ArgumentDescriptor<A>, AT, A : ArgumentType<AT>> argument( name: String, argumentType: A, argumentDescriptor: D): RequiredArgumentConstructor<S, D>

Creates an argument of the specified argumentType with the specified parameter name and argumentDescriptor.

commandBuildContext

fun commandBuildContext(dynamicRegistryManager: DynamicRegistryManager, action: CommandBuildContext.() -> Unit): CommandBuildContext

Creates and returns a CommandBuildContext with the given dynamicRegistryManager and configured with action.

execute

fun <S> ArgumentBuilder<S, *>.execute(command: CommandAction<S>)

Sets the action the command will take when executed.

executeWithResult

fun <S> ArgumentBuilder<S, *>.executeWithResult(command: CommandActionWithResult<S>)

Sets the action the command will take when executed.

get

@JvmName(name = "getRequired")

operator fun <S, D : ArgumentDescriptor<*>> CommandContext<S>.get(accessor: ArgumentAccessor<S, D>): ArgumentReader<S, D>

@JvmName(name = "getOptional")

operator fun <S, D : ArgumentDescriptor<*>> CommandContext<S>.get(accessor: ArgumentAccessor<S, D>?): ArgumentReader<S, D>?

Applies the accessor to the receiver CommandContext.

optional

inline fun <S, D : ArgumentDescriptor<*>> ArgumentBuilder<S, *>.optional(constructor: ArgumentConstructor<S, *, D>, action: ArgumentBuilder<S, *>.(ArgumentAccessor<S, D>?) -> Unit)

Registers the argument specified by the constructor as an optional argument and further configures the resulting subcommands with the given action.

fun <S> CommandDispatcher<S>.register(command: String, action: LiteralArgumentBuilder<S>.() -> Unit)

Registers a command under command as the name.

required

inline fun <S, B : ArgumentBuilder<S, *>, D : ArgumentDescriptor<*>> ArgumentBuilder<S, *>.required(constructor: ArgumentConstructor<S, B, D>, action: B.(ArgumentAccessor<S, D>) -> Unit)

Registers the argument specified by the constructor as a required argument and further configures the resulting subcommand with the given action.