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

Package-level declarations

Public DSL for defining and accessing command arguments in Paper commands.

This package contains extension functions for io.github.kraftlin.command.paper.PaperLiteralNode to add various argument types, for example:

Each builder has a matching accessor on io.github.kraftlin.command.paper.PaperContext to retrieve the parsed values.

Refer to the paper arguments documentation for a detailed description of available argument types and usage examples.

Functions

Link copied to clipboard
fun PaperContext.angle(name: String): Float

Returns the resolved angle in degrees. @see PaperLiteralNode.angle

fun PaperLiteralNode.angle(name: String, block: PaperArgumentNode<AngleResolver>.() -> Unit)

Adds an angle argument (single float rotation). @see PaperContext.angle

Link copied to clipboard
fun PaperContext.axes(name: String): AxisSet

Returns the parsed AxisSet. @see PaperLiteralNode.axes

fun PaperLiteralNode.axes(name: String, block: PaperArgumentNode<AxisSet>.() -> Unit)

Adds an AxisSet argument (combination of x, y, z axes). @see PaperContext.axes

Link copied to clipboard
fun PaperContext.blockInWorldPredicate(name: String): BlockInWorldPredicate

Returns the parsed BlockInWorldPredicate. @see PaperLiteralNode.blockInWorldPredicate

fun PaperLiteralNode.blockInWorldPredicate(name: String, block: PaperArgumentNode<BlockInWorldPredicate>.() -> Unit)

Adds a BlockInWorldPredicate argument for testing blocks in the world. @see PaperContext.blockInWorldPredicate

Link copied to clipboard
fun PaperContext.blockPosition(name: String): BlockPosition

Returns the resolved BlockPosition. @see PaperLiteralNode.blockPosition

fun PaperLiteralNode.blockPosition(name: String, block: PaperArgumentNode<BlockPositionResolver>.() -> Unit)

Adds a block position (x, y, z integers) argument. @see PaperContext.blockPosition

Link copied to clipboard
fun PaperContext.blockState(name: String): BlockState

Returns the parsed BlockState. @see PaperLiteralNode.blockState

fun PaperLiteralNode.blockState(name: String, block: PaperArgumentNode<BlockState>.() -> Unit)

Adds a BlockState argument. @see PaperContext.blockState

Link copied to clipboard
fun PaperContext.choice(name: String): String

Returns the parsed value of a choice argument.

fun PaperLiteralNode.choice(name: String, values: Iterable<String>, block: PaperArgumentNode<String>.() -> Unit)

Adds a string "choice" argument to this command.

Link copied to clipboard
fun PaperContext.columnBlockPosition(name: String): ColumnBlockPosition

Returns the resolved ColumnBlockPosition. @see PaperLiteralNode.columnBlockPosition

fun PaperLiteralNode.columnBlockPosition(name: String, block: PaperArgumentNode<ColumnBlockPositionResolver>.() -> Unit)

Adds a column block position (x, z integers) argument. @see PaperContext.columnBlockPosition

Link copied to clipboard
fun PaperContext.columnFinePosition(name: String): ColumnFinePosition

Returns the resolved ColumnFinePosition. @see PaperLiteralNode.columnFinePosition

fun PaperLiteralNode.columnFinePosition(name: String, block: PaperArgumentNode<ColumnFinePositionResolver>.() -> Unit)

Adds a column fine position (x, z doubles) argument. @see PaperContext.columnFinePosition

fun PaperLiteralNode.columnFinePosition(name: String, centerIntegers: Boolean, block: PaperArgumentNode<ColumnFinePositionResolver>.() -> Unit)

Adds a column fine position argument. When centerIntegers is true, integer inputs are centered (+0.5). @see PaperContext.columnFinePosition

Link copied to clipboard
fun PaperContext.component(name: String): Component

Retrieves the value of a Component argument from the command context.

fun PaperLiteralNode.component(name: String, block: PaperArgumentNode<Component>.() -> Unit)

Adds a formatted chat Component argument to this command.

Link copied to clipboard
fun PaperContext.doubleRange(name: String): Range<Double>

Returns the parsed double Range. @see PaperLiteralNode.doubleRange

fun PaperLiteralNode.doubleRange(name: String, block: PaperArgumentNode<DoubleRangeProvider>.() -> Unit)

Adds a double range argument (e.g. 0.5..1.0). @see PaperContext.doubleRange

Link copied to clipboard
fun PaperContext.entities(name: String): List<Entity>

Returns all entities matched by the entity selector (can be empty).

fun PaperLiteralNode.entities(name: String, block: PaperArgumentNode<EntitySelectorArgumentResolver>.() -> Unit)

Adds a selector argument that may resolve to zero or more entities.

Link copied to clipboard
fun PaperContext.entity(name: String): Entity

Returns exactly one selected entity. Safe to use with PaperLiteralNode.entity.

fun PaperLiteralNode.entity(name: String, block: PaperArgumentNode<EntitySelectorArgumentResolver>.() -> Unit)

Adds an entity selector argument that must resolve to exactly one entity.

Link copied to clipboard
fun PaperContext.entityAnchor(name: String): LookAnchor

Returns the parsed LookAnchor. @see PaperLiteralNode.entityAnchor

fun PaperLiteralNode.entityAnchor(name: String, block: PaperArgumentNode<LookAnchor>.() -> Unit)

Adds a LookAnchor (eyes or feet) argument. @see PaperContext.entityAnchor

Link copied to clipboard
inline fun <E : Enum<E>> PaperContext.enum(name: String): E

Returns the parsed enum value of an enum argument.

inline fun <E : Enum<E>> PaperLiteralNode.enum(name: String, values: Iterable<E> = enumValues<E>().asList(), noinline block: PaperArgumentNode<E>.() -> Unit)

Adds an enum-backed "choice" argument to this command.

Link copied to clipboard
fun PaperContext.finePosition(name: String): FinePosition

Returns the resolved FinePosition. @see PaperLiteralNode.finePosition

fun PaperLiteralNode.finePosition(name: String, block: PaperArgumentNode<FinePositionResolver>.() -> Unit)

Adds a fine position (x, y, z doubles) argument. @see PaperContext.finePosition

fun PaperLiteralNode.finePosition(name: String, centerIntegers: Boolean, block: PaperArgumentNode<FinePositionResolver>.() -> Unit)

Adds a fine position argument. When centerIntegers is true, integer inputs are centered (+0.5). @see PaperContext.finePosition

Link copied to clipboard
fun PaperContext.gameMode(name: String): GameMode

Returns the parsed GameMode. @see PaperLiteralNode.gameMode

fun PaperLiteralNode.gameMode(name: String, block: PaperArgumentNode<GameMode>.() -> Unit)

Adds a GameMode argument. @see PaperContext.gameMode

Link copied to clipboard
fun PaperContext.heightMap(name: String): HeightMap

Returns the parsed HeightMap. @see PaperLiteralNode.heightMap

fun PaperLiteralNode.heightMap(name: String, block: PaperArgumentNode<HeightMap>.() -> Unit)

Adds a HeightMap argument. @see PaperContext.heightMap

Link copied to clipboard
fun PaperContext.hexColor(name: String): TextColor

Returns the parsed hex TextColor. @see PaperLiteralNode.hexColor

fun PaperLiteralNode.hexColor(name: String, block: PaperArgumentNode<TextColor>.() -> Unit)

Adds a hex TextColor argument. @see PaperContext.hexColor

Link copied to clipboard
fun PaperContext.integerRange(name: String): Range<Int>

Returns the parsed integer Range. @see PaperLiteralNode.integerRange

fun PaperLiteralNode.integerRange(name: String, block: PaperArgumentNode<IntegerRangeProvider>.() -> Unit)

Adds an integer range argument (e.g. 1..5). @see PaperContext.integerRange

Link copied to clipboard
fun PaperContext.itemPredicate(name: String): ItemStackPredicate

Returns the parsed ItemStackPredicate. @see PaperLiteralNode.itemPredicate

fun PaperLiteralNode.itemPredicate(name: String, block: PaperArgumentNode<ItemStackPredicate>.() -> Unit)

Adds an ItemStackPredicate argument for testing item stacks. @see PaperContext.itemPredicate

Link copied to clipboard
fun PaperContext.itemStack(name: String): ItemStack

Returns the parsed ItemStack. @see PaperLiteralNode.itemStack

fun PaperLiteralNode.itemStack(name: String, block: PaperArgumentNode<ItemStack>.() -> Unit)

Adds an ItemStack argument. @see PaperContext.itemStack

Link copied to clipboard
fun PaperContext.key(name: String): Key

Returns the parsed Key. @see PaperLiteralNode.key

fun PaperLiteralNode.key(name: String, block: PaperArgumentNode<Key>.() -> Unit)

Adds an Adventure Key argument. @see PaperContext.key

Link copied to clipboard
fun PaperContext.namedColor(name: String): NamedTextColor

Returns the parsed NamedTextColor. @see PaperLiteralNode.namedColor

fun PaperLiteralNode.namedColor(name: String, block: PaperArgumentNode<NamedTextColor>.() -> Unit)

Adds a NamedTextColor argument. @see PaperContext.namedColor

Link copied to clipboard
fun PaperContext.namespacedKey(name: String): NamespacedKey

Returns the parsed NamespacedKey. @see PaperLiteralNode.namespacedKey

fun PaperLiteralNode.namespacedKey(name: String, block: PaperArgumentNode<NamespacedKey>.() -> Unit)

Adds a NamespacedKey argument. @see PaperContext.namespacedKey

Link copied to clipboard
fun PaperContext.objectiveCriteria(name: String): Criteria

Returns the parsed Criteria. @see PaperLiteralNode.objectiveCriteria

fun PaperLiteralNode.objectiveCriteria(name: String, block: PaperArgumentNode<Criteria>.() -> Unit)

Adds a scoreboard objective Criteria argument. @see PaperContext.objectiveCriteria

Link copied to clipboard
fun PaperContext.player(name: String): Player

Returns exactly one selected player. Safe to use with PaperLiteralNode.player.

fun PaperLiteralNode.player(name: String, block: PaperArgumentNode<PlayerSelectorArgumentResolver>.() -> Unit)

Adds an entity selector argument that must resolve to exactly one entity.

Link copied to clipboard
fun PaperContext.playerProfiles(name: String): Collection<PlayerProfile>

Returns the resolved collection of PlayerProfiles. @see PaperLiteralNode.playerProfiles

fun PaperLiteralNode.playerProfiles(name: String, block: PaperArgumentNode<PlayerProfileListResolver>.() -> Unit)

Adds a player profile list argument. @see PaperContext.playerProfiles

Link copied to clipboard
fun PaperContext.players(name: String): List<Player>

Returns all players matched by the player selector (can be empty).

fun PaperLiteralNode.players(name: String, block: PaperArgumentNode<PlayerSelectorArgumentResolver>.() -> Unit)

Adds a selector argument that may resolve to zero or more players.

Link copied to clipboard
inline fun <T : Any> PaperContext.resource(name: String): T

Returns the resolved registry entry of type T. @see PaperLiteralNode.resource

fun <T : Any> PaperLiteralNode.resource(name: String, registryKey: RegistryKey<T>, block: PaperArgumentNode<T>.() -> Unit)

Adds a registry resource argument that resolves to the actual registry entry of type T. @see PaperContext.resource

Link copied to clipboard
fun <T : Any> PaperContext.resourceKey(name: String): TypedKey<T>

Returns the parsed TypedKey for a resource.

fun <T : Any> PaperLiteralNode.resourceKey(name: String, registryKey: RegistryKey<T>, block: PaperArgumentNode<TypedKey<T>>.() -> Unit)

Adds a registry resource key argument that resolves to a TypedKey without loading the entry. @see PaperContext.resourceKey

Link copied to clipboard
fun PaperContext.rotation(name: String): Rotation

Returns the resolved Rotation. @see PaperLiteralNode.rotation

fun PaperLiteralNode.rotation(name: String, block: PaperArgumentNode<RotationResolver>.() -> Unit)

Adds a Rotation (yaw, pitch) argument. @see PaperContext.rotation

Link copied to clipboard
fun PaperContext.scoreboardDisplaySlot(name: String): DisplaySlot

Returns the parsed DisplaySlot. @see PaperLiteralNode.scoreboardDisplaySlot

fun PaperLiteralNode.scoreboardDisplaySlot(name: String, block: PaperArgumentNode<DisplaySlot>.() -> Unit)

Adds a scoreboard DisplaySlot argument. @see PaperContext.scoreboardDisplaySlot

Link copied to clipboard
fun PaperContext.signedMessage(name: String): CompletableFuture<SignedMessage>

Returns the parsed SignedMessage, preserving signatures if provided by the client.

fun PaperLiteralNode.signedMessage(name: String, block: PaperArgumentNode<SignedMessageResolver>.() -> Unit)

Adds a SignedMessage argument. This preserves signatures from the client, if supported. This argument type is useful for commands that accept chat components from players - such as chat or broadcast commands.

Link copied to clipboard
fun PaperContext.style(name: String): Style

Retrieves the value of a Style argument from the command context.

fun PaperLiteralNode.style(name: String, block: PaperArgumentNode<Style>.() -> Unit)

Adds a Style argument to this command, which can be applied using Component.style.

Link copied to clipboard
fun PaperContext.templateMirror(name: String): Mirror

Returns the parsed Mirror. @see PaperLiteralNode.templateMirror

fun PaperLiteralNode.templateMirror(name: String, block: PaperArgumentNode<Mirror>.() -> Unit)

Adds a structure Mirror argument. @see PaperContext.templateMirror

Link copied to clipboard
fun PaperContext.templateRotation(name: String): StructureRotation

Returns the parsed StructureRotation. @see PaperLiteralNode.templateRotation

fun PaperLiteralNode.templateRotation(name: String, block: PaperArgumentNode<StructureRotation>.() -> Unit)

Adds a StructureRotation argument. @see PaperContext.templateRotation

Link copied to clipboard
fun PaperContext.time(name: String): Int

Returns the parsed time value in ticks. @see PaperLiteralNode.time

fun PaperLiteralNode.time(name: String, block: PaperArgumentNode<Int>.() -> Unit)

Adds a time argument (in ticks). @see PaperContext.time

fun PaperLiteralNode.time(name: String, minTime: Int, block: PaperArgumentNode<Int>.() -> Unit)

Adds a time argument (in ticks) with minimum minTime. @see PaperContext.time

Link copied to clipboard
fun PaperContext.uuid(name: String): UUID

Returns the parsed UUID. @see PaperLiteralNode.uuid

fun PaperLiteralNode.uuid(name: String, block: PaperArgumentNode<UUID>.() -> Unit)

Adds a UUID argument. @see PaperContext.uuid

Link copied to clipboard
fun PaperContext.world(name: String): World

Returns the parsed World. @see PaperLiteralNode.world

fun PaperLiteralNode.world(name: String, block: PaperArgumentNode<World>.() -> Unit)

Adds a World argument. @see PaperContext.world

Generated by Dokka
© 2026 Copyright