Enter at least two characters

Settings

Docs version: v2.0.7

Container menus use selected shared Settings entries plus inventory-specific click throttling. Dialog-only can_escape, after_action, and lifetime do not apply to Containers; use actions and Events.Close for closing and transitions.

Field Overview#

Key Type Default Purpose
need_placeholder String list No checks Require PAPI expansions before opening
min_click_delay Non-negative integer 0, in milliseconds Prevent rapid repeated button clicks
pass_arguments.enable Boolean Disabled Enable argument defaults and requirements
pass_arguments.default List Empty Fill missing arguments by index
pass_arguments.must Non-negative integer No minimum Minimum count after defaults are applied

Settings applies to the menu session. It does not define slots or items: use Layout for placement and Buttons for display and actions.

need_placeholder#

Checks PlaceholderAPI and the listed expansions before the menu opens. A failed check blocks rendering so incomplete displays or conditions are not used.

Settings:
  need_placeholder:
    - player
    - vault

List expansion identifiers for variables such as %player_name% and %vault_eco_balance%. The setting does not scan placeholders automatically. See PlaceholderAPI prerequisites.

min_click_delay#

Settings:
  min_click_delay: 200

The value is an absolute interval in milliseconds, tracked per player and active Container session:

  • 0 or omitted disables the limit.
  • Only valid action-bearing button clicks are limited.
  • Empty slots, hidden buttons, and actionless buttons do not consume the cooldown.
  • Reopening, reset, or switching menus starts a new session interval.

150 to 300 milliseconds is a practical range for shops, rewards, economy, and points operations. See Global Settings for shared click-delay details.

pass_arguments#

Container and Dialog menus share argument passing:

Settings:
  pass_arguments:
    enable: true
    default: ['default', '%player_name%', '{meta:source}']
    must: 2

default fills missing positions by index and supports PAPI and KaMenu variables. must is the minimum argument count required after defaults are applied; the menu does not open when the count is still insufficient. The target menu resolves arguments when an opening action runs. See Actions and Events for lifecycle behaviour.

Example: Shop Throttle And Arguments#

Type: CHEST
Title: '&8Buy {arg:0}'
Settings:
  need_placeholder:
    - vault
  min_click_delay: 250
  pass_arguments:
    enable: true
    default: ['DIAMOND', '1']
    must: 1
Layout:
  - '         '
  - '    `buy`    '
  - '         '

Buttons:
  buy:
    display:
      material: DIAMOND
      name: '&bBuy {arg:1} x {arg:0}'
    actions:
      left:
        - 'actionbar: &aPurchase request submitted'

open: shop DIAMOND 16 supplies two arguments, while open: shop uses the defaults. min_click_delay throttles only buttons that actually execute actions, not empty slots.