Colosseum/me.spartacus04.colosseum.commandHandling.command/ColosseumCommand

ColosseumCommand

abstract class ColosseumCommand(plugin: ColosseumPlugin) : CommandExecutor, TabCompleter

Abstract base class for Colosseum commands.

Parameters

plugin

The ColosseumPlugin instance.

Inheritors

ColosseumNestedCommand

Constructors

ColosseumCommand

constructor(plugin: ColosseumPlugin)

Types

CommandContext

class CommandContext<T : CommandSender>(val sender: T, val args: Array<out Any>)

Context class for command execution.

CommandData

data class CommandData(val name: String, val aliases: Set<String>, val description: String, val subCommandName: String?, val permissions: Set<String>, val arguments: List<ParsableArgument<*>>, val optionalArguments: List<ParsableArgument<*>>, val mcCommand: Command?)

Data class representing command metadata.

Properties

commandData

abstract val commandData: ColosseumCommand.CommandData

The command metadata for this Colosseum command.

Functions

execute

open fun execute(ctx: ColosseumCommand.CommandContext<CommandSender>): Unit?

Executes the command.

executeCommandBlock

open fun executeCommandBlock(ctx: ColosseumCommand.CommandContext<BlockCommandSender>)

Executes the command for a command block sender.

executeConsole

open fun executeConsole(ctx: ColosseumCommand.CommandContext<ConsoleCommandSender>)

Executes the command for a console sender.

executePlayer

open fun executePlayer(ctx: ColosseumCommand.CommandContext<Player>)

Executes the command for a player sender.

getCommandFormat

fun getCommandFormat(label: String): String

Generates the command format string for display.

onCommand

open override fun onCommand(sender: CommandSender, command: Command, label: String, args: Array<out String>): Boolean

Handles command execution. If the command throws an exception during parsing or execution, an appropriate error message is sent to the sender, along with the correct command format.

onTabComplete

open override fun onTabComplete(sender: CommandSender, command: Command, label: String, args: Array<out String>): List<String>?

Handles tab completion for the command.