command/com.peco2282.devcore.command/CommandCreator

CommandCreator

class CommandCreator<T : ArgumentBuilder<CommandSourceStack, T>>(val plugin: Plugin?, var builder: T)

Creates and manages Minecraft commands using a DSL-style builder pattern.

This class wraps a Brigadier ArgumentBuilder and provides a Kotlin-friendly DSL for defining command structures, including literals, arguments, requirements, and execution logic.

Type Parameters

the type of Brigadier ArgumentBuilder being wrapped

Constructors

CommandCreator

constructor(plugin: Plugin?, builder: T)

Properties

builder

var builder: T

the underlying Brigadier ArgumentBuilder

plugin

val plugin: Plugin?

the plugin instance for launching coroutines

Functions

aliases

fun aliases(vararg aliases: String, creator: CommandCreator<LiteralArgumentBuilder<CommandSourceStack>>.() -> Unit = {}): CommandCreator<T>

Adds multiple literal aliases to the command that all execute the same block.

angle

fun angle(name: String, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

Adds an angle argument to the command.

argument

fun <V> argument(name: String, type: ArgumentType<V>, creator: CommandCreator<RequiredArgumentBuilder<CommandSourceStack, V>>.() -> Unit = {}): CommandCreator<T>

Adds a required argument to the command.

axes

fun axes(name: String, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

Adds an axes argument (set of X/Y/Z axes) to the command.

blockInWorldPredicate

fun blockInWorldPredicate(name: String, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

Adds a block-in-world predicate argument to the command.

blockPos

fun blockPos(name: String, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

Adds a block position argument to the command.

blockState

fun blockState(name: String, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

Adds a block state argument to the command.

boolean

fun boolean(name: String, creator: CommandCreator<RequiredArgumentBuilder<CommandSourceStack, Boolean>>.() -> Unit = {}): CommandCreator<T>

Adds a boolean argument to the command.

columnBlockPos

fun columnBlockPos(name: String, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

columnFinePos

fun columnFinePos(name: String, centerIntegers: Boolean = false, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

Adds a column fine position argument (2D decimal coordinates) to the command.

component

fun component(name: String, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

custom

fun <V> CommandCreator<*>.custom(name: String, type: ArgumentType<V>, creator: CommandCreator<RequiredArgumentBuilder<CommandSourceStack, V>>.() -> Unit = {}): CommandCreator<*>

Registers a custom argument type to the DSL.

double

fun double(name: String, min: Double = Double.MIN_VALUE, max: Double = Double.MAX_VALUE, creator: CommandCreator<RequiredArgumentBuilder<CommandSourceStack, Double>>.() -> Unit = {}): CommandCreator<T>

Adds a double argument to the command.

doubleRange

fun doubleRange(name: String, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

Adds a double range argument to the command.

entities

fun entities(name: String, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

Adds an entities argument to the command.

entity

fun entity(name: String, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

Adds an entity argument to the command.

entityAnchor

fun entityAnchor(name: String, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

Adds an entity anchor argument to the command.

executes

infix fun executes(block: (CommandContext<CommandSourceStack>) -> Int): CommandCreator<T>

Sets the execution handler for this command.

executesConsole

fun executesConsole(block: (ConsoleCommandSender, CommandContext<CommandSourceStack>) -> Int): CommandCreator<T>

Sets the execution handler for this command, limited to console only.

executesConsoleSuspend

infix fun executesConsoleSuspend(block: suspend (ConsoleCommandSender, CommandContext<CommandSourceStack>) -> Int): CommandCreator<T>

executesPlayer

fun executesPlayer(block: (Player, CommandContext<CommandSourceStack>) -> Int): CommandCreator<T>

Sets the execution handler for this command, limited to players only.

executesPlayerSuspend

infix fun executesPlayerSuspend(block: suspend (Player, CommandContext<CommandSourceStack>) -> Int): CommandCreator<T>

executesSuspend

infix fun executesSuspend(block: suspend (CommandContext<CommandSourceStack>) -> Int): CommandCreator<T>

finePos

fun finePos(name: String, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

Adds a fine position argument (with decimals) to the command. Equivalent to finePos with centerIntegers = false.

fun finePos(name: String, centerIntegers: Boolean, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

Adds a fine position argument with centerIntegers option to the command.

float

fun float(name: String, min: Float = Float.MIN_VALUE, max: Float = Float.MAX_VALUE, creator: CommandCreator<RequiredArgumentBuilder<CommandSourceStack, Float>>.() -> Unit = {}): CommandCreator<T>

Adds a float argument to the command.

gameMode

fun gameMode(name: String, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

greedyString

fun greedyString(name: String, creator: CommandCreator<RequiredArgumentBuilder<CommandSourceStack, String>>.() -> Unit = {}): CommandCreator<T>

Adds a greedy string argument to the command.

guard

fun CommandContext<CommandSourceStack>.guard(condition: Boolean, errorMessage: ComponentBuilder.() -> Unit, block: () -> Int): Int

Guards the command execution with a condition. If the condition is false, sends an error message and returns 0.

heightMap

fun heightMap(name: String, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

Adds a height map argument to the command.

hexColor

fun hexColor(name: String, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

Adds a hex color argument to the command.

integer

fun integer(name: String, min: Int = Int.MIN_VALUE, max: Int = Int.MAX_VALUE, creator: CommandCreator<RequiredArgumentBuilder<CommandSourceStack, Int>>.() -> Unit = {}): CommandCreator<T>

Adds an integer argument to the command.

integerRange

fun integerRange(name: String, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

Adds an integer range argument to the command.

invoke

infix inline operator fun String.invoke(creator: CommandCreator<LiteralArgumentBuilder<CommandSourceStack>>.() -> Unit): String

DSL operator to add a literal subcommand to the command.

itemStack

fun itemStack(name: String, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

itemStackPredicate

fun itemStackPredicate(name: String, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

Adds an item stack predicate argument to the command.

key

fun key(name: String, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

Adds a key argument to the command.

literal

infix fun literal(literal: String): CommandCreator<T>

fun literal(literal: String, creator: CommandCreator<LiteralArgumentBuilder<CommandSourceStack>>.() -> Unit = {}): CommandCreator<T>

Adds a literal argument to the command.

long

fun long(name: String, min: Long = Long.MIN_VALUE, max: Long = Long.MAX_VALUE, creator: CommandCreator<RequiredArgumentBuilder<CommandSourceStack, Long>>.() -> Unit = {}): CommandCreator<T>

Adds a long argument to the command.

namedColor

fun namedColor(name: String, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

Adds a named color argument to the command.

namespacedKey

fun namespacedKey(name: String, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

objective

fun objective(name: String, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

objectiveCriteria

fun objectiveCriteria(name: String, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

Adds an objective criteria argument to the command.

permission

infix fun permission(permission: String): CommandCreator<T>

Sets a permission requirement for this command.

permissionAnd

fun permissionAnd(permission: String, predicate: (CommandSourceStack) -> Boolean): CommandCreator<T>

Sets a permission requirement combined with an additional condition for this command.

player

fun player(name: String, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

Adds a player argument to the command.

playerProfiles

fun playerProfiles(name: String, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

Adds a player profiles argument to the command.

players

fun players(name: String, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

Adds a players argument to the command.

fun register(description: String?, aliases: Collection<String>)

Registers this command with the given plugin.

requireOp

fun requireOp(): CommandCreator<T>

Sets a requirement that the command sender must be an operator.

requireOpAnd

fun requireOpAnd(predicate: (CommandSourceStack) -> Boolean): CommandCreator<T>

Sets a requirement that the command sender must be an operator and satisfy an additional condition.

requirePermissionOrOp

fun requirePermissionOrOp(permission: String): CommandCreator<T>

requires

infix fun requires(predicate: (CommandSourceStack) -> Boolean): CommandCreator<T>

Sets a requirement predicate for this command.

resource

fun <T> resource(name: String, registryKey: RegistryKey<T>, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

Adds a resource argument to the command.

resourceKey

fun <T> resourceKey(name: String, registryKey: RegistryKey<T>, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

Adds a resource key argument to the command.

rotation

fun rotation(name: String, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

Adds a rotation argument (yaw and pitch) to the command.

scoreboardDisplaySlot

fun scoreboardDisplaySlot(name: String, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

Adds a scoreboard display slot argument to the command.

sendError

fun CommandContext<CommandSourceStack>.sendError(consumer: ComponentBuilder.() -> Unit)

Sends an error message to the command sender.

sendMessage

fun CommandContext<CommandSourceStack>.sendMessage(consumer: ComponentBuilder.() -> Unit)

Sends a message to the command sender using Adventure component DSL.

fun CommandContext<CommandSourceStack>.sendMessage(component: Component)

Sends a message to the command sender.

sendSuccess

fun CommandContext<CommandSourceStack>.sendSuccess(consumer: ComponentBuilder.() -> Unit)

Sends a success message to the command sender.

signedMessage

fun signedMessage(name: String, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

Adds a signed message argument to the command.

slot

fun slot(name: String, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

slots

fun slots(name: String, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

Adds a slots argument (multiple inventory slots) to the command.

string

fun string(name: String, creator: CommandCreator<RequiredArgumentBuilder<CommandSourceStack, String>>.() -> Unit = {}): CommandCreator<T>

Adds a string argument to the command.

style

fun style(name: String, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

Adds a style argument to the command.

suggestion

inline fun <E : Enum<E>> suggestion(): CommandCreator<T>

Adds static suggestions for this command argument from an Enum.

fun suggestion(provider: SuggestionProvider<CommandSourceStack>): CommandCreator<T>

Adds dynamic suggestions for this command argument.

fun suggestion(suggestions: List<String>): CommandCreator<T>

Adds static suggestions for this command argument.

suggestionAsync

fun suggestionAsync(provider: (CommandContext<CommandSourceStack>) -> List<String>): CommandCreator<T>

Adds asynchronous suggestions for this command argument.

team

fun team(name: String, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

templateMirror

fun templateMirror(name: String, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

Adds a template mirror argument to the command.

templateRotation

fun templateRotation(name: String, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

Adds a template rotation argument to the command.

time

fun time(name: String, minTicks: Int = 0, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

Adds a time argument to the command.

uuid

fun uuid(name: String, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

word

fun word(name: String, creator: CommandCreator<RequiredArgumentBuilder<CommandSourceStack, String>>.() -> Unit = {}): CommandCreator<T>

Adds a word argument to the command.

world

fun world(name: String, creator: CommandCreator<out ArgumentBuilder<CommandSourceStack, *>>.() -> Unit = {}): CommandCreator<T>

Adds a world argument to the command.