EffectiveSpigot/ru.hukm.effectiveSpigot.minecraft.commands/EffectiveCommand

EffectiveCommand

abstract class EffectiveCommand : BasicCommand

Base class for a Brigadier-backed command.

A subclass declares identity (getNamespacedData), getDescription, a required getPermission (empty string = no permission) and a commandTree built with CommandNode. The command registers itself with the owning plugin's lifecycle on construction; execution walks the tree by argument and runs the deepest matching executor, and tab-completion is driven by the same tree.

Instantiate it from onLoad (not onEnable) — Brigadier commands register during the server's load phase, so a command touched only in onEnable won't be registered.

Constructors

EffectiveCommand

constructor()

Types

object Companion

Functions

open override fun canUse(sender: CommandSender): Boolean

abstract fun commandTree(): CommandNode?

The argument tree (choices, dynamic completions, executors), or null for no arguments.

open override fun execute(commandSourceStack: CommandSourceStack, args: Array<out String>)

abstract fun getDescription(): String

Short command description shown in help.

getNamespacedData

abstract fun getNamespacedData(): Pair<JavaPlugin, String>

Owning plugin and the command's literal name (its second element).

getNamespacedName

fun getNamespacedName(): String

Unique identity as "<plugin-name>/<command>", both lowercased.

abstract fun getPermission(): String

Permission node required to run the command; empty string means no permission check.

@ApiStatus.OverrideOnly

open fun permission(): @Nullable String?

open override fun suggest(commandSourceStack: CommandSourceStack, args: Array<out String>): Collection<String>