Event Triggers

Most menu items have triggers set on them. Triggers are like instructions that tell the plugin what to do when someone clicks on an item. Some triggers also work as conditions that decide if an item should be shown or not.

It's usually okay to change triggers that aren't conditional. But be careful when changing conditional triggers. If you do this incorrectly, it might stop some menus from working the right way. For example, an item to unlock or select something might not show up.

How to set Triggers

  1. Choose a menu file and open it.

  2. Find an item in the file and look for the trigger setting. If it's not there, you can add it.

  3. Set a trigger using this format: trigger: [TRIGGER ID]

Replace [TRIGGER ID] with the actual ID of the trigger you want to use for that item.

Trigger Example

item-builder:
  test-item:
    item-settings:
      slot: 22
      trigger: OPEN_ALERTS

Trigger List

Trigger ID
Type
Action

OPEN_[MENU ID]

Free to use

Opens a menu.

CLOSE_MENU

Free to use

Closes a menu.

GO_BACK

Free to use

Opens a previous menu.

PREVIOUS_PAGE

Conditional

Goes to the next page.

NEXT_PAGE

Conditional

Goes to the previous page.

FILTER_ALL

Conditional

Sets the filter to ALL.

FILTER_OWNED

Conditional

Sets the filter to OWNED.

FILTER_UNOWNED

Conditional

Sets the filter to UNOWNED.

Last updated