Click Actions

The click-actions setting inside an item is always a list of action groups, as shown below.

# click actions example config
click-actions:
  # action group 1
  - actions:
      - "%action0%"
  # action group 2
  - click-type: LEFT
    requirement: ...
    requirements-expression: ...
    actions:
      - '%action1%'
      - '%action2%'
    

Actions

An action is defined with the following syntax: [ACTION_NAME] <arguments>

Depending on the menu, custom actions exist, such as the deposit menu (in the RoyaleBanks plugin) which implements [deposit] percentage and [deposit] custom actions.

Besides those, standard actions are defined:

• [message] <string> - Sends a message to the player, that can be colored or contain PlaceholderAPI placeholders. (Example: [message] &1Hello, %player_displayname%!)

• [menu_close] - Closes the current active menu.

• [command] <string> - Forces the player to execute the command given as parameter.

• [console_command] <string> - Execute a command as the console.

More standarc click actions can be added over time.

Click Type

The click type is taken directly from Bukkit and could have the following values:

LEFT,
SHIFT_LEFT,
RIGHT,
SHIFT_RIGHT,
WINDOW_BORDER_LEFT,
WINDOW_BORDER_RIGHT,
MIDDLE,
NUMBER_KEY,
DOUBLE_CLICK,
DROP,
CONTROL_DROP,
CREATIVE,
SWAP_OFFHAND,
UNKNOWN;