-
Notifications
You must be signed in to change notification settings - Fork 0
Param Reference
mario edited this page Mar 29, 2026
·
1 revision
@Param is placed on a method parameter to declare it as a command argument.
| 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. |
- Only one
concated = trueparameter is allowed per command, and it must be the last one. -
defaultValueis a raw string — it goes through the same processor chain as a normally supplied argument. - A parameter with no
@Paramannotation is treated as theCommandSender— there can only be one per method.