kraftlin-command-velocity/io.github.kraftlin.command.velocity

Package-level declarations

Velocity integration layer for the core DSL.

io.github.kraftlin.command.velocity.kraftlinCommand: Entry point for defining Velocity commands.
io.github.kraftlin.command.velocity.registerKraftlinCommands: Registration helper.

Types

data class KraftlinVelocityCommand(val node: LiteralCommandNode<VelocitySource>, val description: String?, val aliases: List<String>)

A built command ready for registration via registerKraftlinCommands.

VelocityArgumentNode

typealias VelocityArgumentNode<T> = ArgumentNode<VelocitySource, T>

ArgumentNode specialized to Velocity's CommandSource.

VelocityContext

typealias VelocityContext = KContext<VelocitySource>

KContext specialized to Velocity's CommandSource.

VelocityExecuteScope

typealias VelocityExecuteScope = ExecuteScope<VelocitySource>

ExecuteScope specialized to Velocity's CommandSource.

VelocityLiteralNode

typealias VelocityLiteralNode = LiteralNode<VelocitySource>

LiteralNode specialized to Velocity's CommandSource.

VelocityPlatform

object VelocityPlatform : PlatformAdapter<VelocitySource, CommandSource>

Velocity platform adapter for cross-platform command definitions.

VelocitySource

typealias VelocitySource = CommandSource

Velocity's Brigadier command source type.

Properties

sender

val VelocityContext.sender: CommandSource

The CommandSource who executed the command.

Functions

executes

fun VelocityLiteralNode.executes(block: VelocityExecuteScope.(CommandSource, VelocityContext) -> Unit)

Execution handler that extracts the CommandSource before invoking block.

executesPlayer

fun VelocityLiteralNode.executesPlayer(block: VelocityExecuteScope.(Player, VelocityContext) -> Unit)

Execution handler restricted to Player senders. Throws a command error if the sender is not a player.

executesPlayerResult

fun VelocityLiteralNode.executesPlayerResult(block: VelocityExecuteScope.(Player, VelocityContext) -> Int)

Execution handler with custom result code, restricted to Player senders.

executesResult

fun VelocityLiteralNode.executesResult(block: VelocityExecuteScope.(CommandSource, VelocityContext) -> Int)

Execution handler with custom result code that extracts the CommandSource.

kraftlinCommand

fun kraftlinCommand(name: String, description: String? = null, aliases: List<String> = emptyList(), block: VelocityLiteralNode.() -> Unit): KraftlinVelocityCommand

Declares a new Kraftlin command for Velocity.

registerKraftlinCommands

fun CommandManager.registerKraftlinCommands(vararg commands: KraftlinVelocityCommand)

Registers one or more Kraftlin commands with this command manager.

requirePlayer

fun VelocityContext.requirePlayer(): Player

Returns the sender as a Player, or throws a command error if the sender is not a player.

requiresPermission

fun VelocityLiteralNode.requiresPermission(permission: String)

Requires the sender to have the given permission.

requiresPlayer

fun VelocityLiteralNode.requiresPlayer()

Requires the sender to be a Player.

requiresSender

fun VelocityLiteralNode.requiresSender(predicate: (CommandSource) -> Boolean)

Requires the sender to match a predicate.