silk-commands/net.silkmc.silk.commands

Package-level declarations

Types

class ArgumentCommandBuilder<Source : SharedSuggestionProvider, PermissionSource, T>(name: String, typeProvider: (CommandBuildContext) -> ArgumentType<T>) : CommandBuilder<Source, RequiredArgumentBuilder<Source, T>, ArgumentCommandNode<Source, T>>

ArgumentResolver

typealias ArgumentResolver<S, T> = CommandContext<S>.() -> T

An argument resolver extracts the argument value out of the current CommandContext.

BrigadierBuilder

typealias BrigadierBuilder<Builder> = Builder.(context: CommandBuildContext) -> Unit

ClientCommandSourceStack

typealias ClientCommandSourceStack = ClientSuggestionProvider

CommandBuilder

abstract class CommandBuilder<Source : SharedSuggestionProvider, PermissionSource, Builder : ArgumentBuilder<Source, Builder>, Node : CommandNode<Source>>

LiteralCommandBuilder

class LiteralCommandBuilder<Source : SharedSuggestionProvider, PermissionSource>(name: String) : CommandBuilder<Source, LiteralArgumentBuilder<Source>, LiteralCommandNode<Source>>

PermissionLevel

enum PermissionLevel : Enum<PermissionLevel>

An enum containing known permission levels. Information taken from the Minecraft wiki

RegistrableCommand

class RegistrableCommand<Source : SharedSuggestionProvider, PermissionSource>(val commandBuilder: LiteralCommandBuilder<Source>)

A wrapper around mutable command builders, which makes sure they don't get mutated anymore and can be registered.

SimpleArgumentBuilder

typealias SimpleArgumentBuilder<Source, T> = ArgumentCommandBuilder<Source, T>.(argument: ArgumentResolver<Source, T>) -> Unit

The simple argument builder is a variant of an ArgumentCommandBuilder lambda function that supports ArgumentResolver (passed as it).

Properties

connection

val ClientCommandSourceStack.connection: ClientPacketListener

level

val ClientCommandSourceStack.level: ClientLevel

minecraft

val ClientCommandSourceStack.minecraft: Minecraft

player

val ClientCommandSourceStack.player: LocalPlayer

Functions

clientCommand

@Environment(value = EnvType.CLIENT)

inline fun clientCommand(name: String, register: Boolean = true, builder: LiteralCommandBuilder<ClientCommandSourceStack>.() -> Unit = {}): RegistrableCommand<ClientCommandSourceStack>

Creates a new client command. Opens a LiteralCommandBuilder. This command will work on the client, even if the player is connected to a third party server.

command

inline fun command(name: String, register: Boolean = true, builder: LiteralCommandBuilder<CommandSourceStack>.() -> Unit = {}): RegistrableCommand<CommandSourceStack>

Creates a new command. Opens a LiteralCommandBuilder.

sendFailure

fun ClientCommandSourceStack.sendFailure(message: Component)

sendSuccess

fun ClientCommandSourceStack.sendSuccess(message: Component)