api/org.kryptonmc.api.command

Package-level declarations

Types

Link copied to clipboard
interface BrigadierCommand : Command

A command that is backed by a Brigadier LiteralCommandNode.

Link copied to clipboard
interface Command

A command that can be sent by a Sender, such as a player or the ConsoleSender.

Link copied to clipboard
interface CommandExecutionContext

The context of a command execution.

Link copied to clipboard
interface CommandManager

The command manager is responsible for registering, unregistering, and keeping track of commands.

Link copied to clipboard
interface CommandMeta

Holds metadata for a Command.

Link copied to clipboard
interface ConsoleSender : Sender

The sender for the org.kryptonmc.api.Server. This is the sender that is used by the console.

Link copied to clipboard
interface InvocableCommand<A> : Command

A command that may be invoked with arbitrary arguments.

Link copied to clipboard
fun interface RawCommand : InvocableCommand<String>

A command that passes its arguments as a single string, without processing the input.

Link copied to clipboard
interface Sender : Audience, Subject

A sender is an interface representing the sender of a command.

Link copied to clipboard
fun interface SimpleCommand : InvocableCommand<Array<String>>

A command styled after the convention popularised by Bukkit and BungeeCord.

Functions

Link copied to clipboard
@Contract(value = "_, _, _ -> this", mutates = "this")
inline fun <S, T> LiteralArgumentBuilder<S>.argument(name: String, type: ArgumentType<T>, builder: RequiredArgumentBuilder<S, T>.() -> Unit): LiteralArgumentBuilder<S>

Adds a new argument command node with the given name and type to this literal, applying the given builder to the node and returning this builder as the result.

@Contract(value = "_, _, _ -> this", mutates = "this")
inline fun <S, T, T1> RequiredArgumentBuilder<S, T>.argument(name: String, type: ArgumentType<T1>, builder: RequiredArgumentBuilder<S, T1>.() -> Unit): RequiredArgumentBuilder<S, T>

Adds a new argument command node with the given name and type to this argument, applying the given builder to the node and returning this builder as the result.

Link copied to clipboard
@Contract(value = "_, _ -> this", mutates = "this")
inline fun <S> LiteralArgumentBuilder<S>.literal(name: String, builder: LiteralArgumentBuilder<S>.() -> Unit): LiteralArgumentBuilder<S>

Adds a new literal command node with the given name to this literal, applying the given builder to the node and returning this builder as the result.

Link copied to clipboard
@Contract(value = "_, _ -> new", pure = true)
inline fun <S> literalCommand(name: String, builder: LiteralArgumentBuilder<S>.() -> Unit): LiteralArgumentBuilder<S>

Creates a new Brigadier literal argument builder with the given name, applying the given builder to it and returning the result.