Skip to content

Param Reference

mario edited this page Mar 29, 2026 · 1 revision

@Param Reference

@Param is placed on a method parameter to declare it as a command argument.

Properties

Property Type Default Description
name String Display name used in the auto-generated usage message.
required boolean true Whether the argument is mandatory. Optional arguments appear as [name] in the usage message.
concated boolean false Joins all remaining arguments into a single String. Shown as <name..> in the usage message.
defaultValue String "" Raw value passed through the processor when the argument is omitted. Requires required = false.

Notes

  • Only one concated = true parameter is allowed per command, and it must be the last one.
  • defaultValue is a raw string — it goes through the same processor chain as a normally supplied argument.
  • A parameter with no @Param annotation is treated as the CommandSender — there can only be one per method.

Clone this wiki locally