pylon-core/io.github.pylonmc.pylon.core.command/CommandBuilder

CommandBuilder

class CommandBuilder(val command: ArgumentBuilder<CommandSourceStack, *>)(source)

If you are using Kotlin, you can use this class to create Brigadier commands Kotlin-style.

You should probably implement your own command system if you are making your own addon, rather than using anything from Pylon Core. We recommend checking out Aikar's commands, as it makes adding commands very easy and simple.

(Blame Kotlin for not allowing us to hide this class in any way from Java).

Constructors

CommandBuilder

constructor(command: ArgumentBuilder<CommandSourceStack, *>)

Properties

command

val command: ArgumentBuilder<CommandSourceStack, *>

requirement

var requirement: CommandContext<CommandSourceStack>.(CommandSender) -> Boolean

Functions

argument

inline fun argument(name: String, type: ArgumentType<*>, block: CommandBuilder.() -> Unit): CommandNode<CommandSourceStack>

build

fun build(): CommandNode<CommandSourceStack>

executes

inline fun executes(crossinline handler: CommandContext<CommandSourceStack>.(CommandSender) -> Unit)

executesWithPlayer

inline fun executesWithPlayer(crossinline handler: CommandContext<CommandSourceStack>.(Player) -> Unit)

literal

inline fun literal(name: String, block: CommandBuilder.() -> Unit): CommandNode<CommandSourceStack>

permission

fun permission(permission: String)

redirect

fun redirect(node: CommandNode<CommandSourceStack>)

requires

inline fun requires(errorMessage: Component, crossinline predicate: CommandContext<CommandSourceStack>.(CommandSender) -> Boolean)

then

fun then(node: CommandNode<CommandSourceStack>)