kraftlin-command-paper/io.github.kraftlin.command.paper

Package-level declarations

Paper integration layer for the core DSL.

This package provides:

Registration helpers like io.github.kraftlin.command.paper.registerKraftlinCommands for Paper commands.
Optional alias override support by setting overrideAliases = true when building commands (uses Paper's alias override when available).
Extensions for io.github.kraftlin.command.paper.PaperLiteralNode such as io.github.kraftlin.command.paper.executesPlayer and io.github.kraftlin.command.paper.requiresPermission.
Access to the underlying Paper CommandSourceStack via io.github.kraftlin.command.paper.PaperSource.

Types

data class KraftlinPaperCommand(val node: LiteralCommandNode<PaperSource>, val description: String?, val aliases: List<String>, val overrideAliases: Boolean)

A built command ready for registration via registerKraftlinCommands.

PaperArgumentNode

typealias PaperArgumentNode<T> = ArgumentNode<PaperSource, T>

ArgumentNode specialized to Paper's CommandSourceStack.

PaperContext

typealias PaperContext = KContext<PaperSource>

KContext specialized to Paper's CommandSourceStack.

PaperExecuteScope

typealias PaperExecuteScope = ExecuteScope<PaperSource>

ExecuteScope specialized to Paper's CommandSourceStack.

PaperLiteralNode

typealias PaperLiteralNode = LiteralNode<PaperSource>

LiteralNode specialized to Paper's CommandSourceStack.

PaperPlatform

object PaperPlatform : PlatformAdapter<PaperSource, CommandSender>

Paper platform adapter for cross-platform command definitions.

PaperSource

typealias PaperSource = CommandSourceStack

Paper's Brigadier command source type.

Properties

sender

val PaperContext.sender: CommandSender

The CommandSender who executed the command.

Functions

executes

fun PaperLiteralNode.executes(block: PaperExecuteScope.(CommandSender, PaperContext) -> Unit)

Execution handler that extracts the CommandSender before invoking block.

executesPlayer

fun PaperLiteralNode.executesPlayer(block: PaperExecuteScope.(Player, PaperContext) -> Unit)

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

executesPlayerResult

fun PaperLiteralNode.executesPlayerResult(block: PaperExecuteScope.(Player, PaperContext) -> Int)

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

executesResult

fun PaperLiteralNode.executesResult(block: PaperExecuteScope.(CommandSender, PaperContext) -> Int)

Execution handler with custom result code that extracts the CommandSender.

kraftlinCommand

fun kraftlinCommand(name: String, description: String? = null, aliases: List<String> = emptyList(), overrideAliases: Boolean = false, block: PaperLiteralNode.() -> Unit): KraftlinPaperCommand

Declares a new Kraftlin command for Paper.

registerKraftlinCommands

fun Plugin.registerKraftlinCommands(vararg commands: KraftlinPaperCommand)

Registers one or more Kraftlin commands for this plugin.

requirePlayer

fun PaperContext.requirePlayer(): Player

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

requiresPermission

fun PaperLiteralNode.requiresPermission(permission: String)

Requires the sender to have the given permission.

requiresPlayer

fun PaperLiteralNode.requiresPlayer()

Requires the sender to be a Player.

requiresSender

fun PaperLiteralNode.requiresSender(predicate: (CommandSender) -> Boolean)

Requires the sender to match a predicate.