Command Properties

@Command Reference

@Command is placed on a method to register it as a command.

Properties

Property	Type	Default	Description
names	String[]	—	One or more aliases. Supports subcommands via spaces, e.g. "f create".
permission	String	""	Required permission node. Leave empty to allow everyone.
description	String	""	Short description shown in help messages.
playerOnly	boolean	false	Restricts the command to players only.
consoleOnly	boolean	false	Restricts the command to console only.
async	boolean	false	Runs the command off the main thread. On Folia, routes through AsyncScheduler automatically.
allowComplete	boolean	true	Whether tab completion is enabled for this command.
hidden	boolean	false	Sends an unknown command message to non-op players instead of the permission error.

Notes

• playerOnly and consoleOnly are mutually exclusive.
• When using @Subcommand, the root aliases are prepended to names automatically — see Subcommand Groups.