Skip to main content

Menu, Message, Sound

Actions for controlling menu navigation, communicating with players, and playing audio or visual feedback.

Opening Menus (type: open-menu)​

Transitions the player to another menu screen:

actions:
  - type: open-menu
    menu: "shop" # Opens sub/shop.yml

:::info Rendering Wait Guarantee open-menu pauses pipeline execution until the target menu is completely rendered on the client. Messages or actions configured immediately afterwards will execute only after the player is viewing the new screen. :::

Closing Menus (type: close-menu)​

Safely closes the current menu UI:

actions:
  - type: close-menu

:::note Safe Session Targeting close-menu and close-menu: true close the UI session from which the interaction originated. If you open a new menu beforehand via open-menu, the new menu will not be closed accidentally. :::

Sending Messages (type: message)​

Sends a formatted chat message to the player. Color codes and placeholders are supported.

actions:
  - type: message
    message: "&aPurchase successful! &7(Balance: %vault_eco_balance%)"

Playing Sounds (type: sound)​

Plays a Minecraft sound effect directly to the player.

actions:
  - type: sound
    sound: "ENTITY_PLAYER_LEVELUP" # Sound name
    volume: 1.0                    # Volume (default: 1.0)
    pitch: 1.2                     # Pitch (default: 1.0)

Displaying Titles (type: title)​

Displays large on-screen title text and subtitle banners.

actions:
  - type: title
    title: "&6&lMISSION COMPLETE"   # Main title
    subtitle: "&eReward received!"  # Subtitle
    fade-in: 10                     # Fade-in time in ticks (20 ticks = 1s)
    stay: 70                        # Stay time in ticks
    fade-out: 20                    # Fade-out time in ticks