Menu Variables

Variables are the heart of the menu system, they enable dynamic content and data flow between menus

---

Built-in Variables

Some variables are automatically provided by the system:

Variable	Description	Example Value
{sword}	Current sword skin ID (when opening sword menus)	wooden-sword
{player}	Player's username	Notch

Note: Built-in variables depend on context. For example, {sword} only exists when the source is from the binded inventory when right-clicking a dungeon sword. But then you can allow other menus to inherit that data.

---

Custom Variables

You can define your own variables in three ways:

1

Default Values in Config

Set defaults that apply when the menu opens:

inventory:
  variables:
    sword_tier: '1'
    enchant_id: 'speed'
    player_balance: '0'

2

Pass When Opening Menu

Pass variables via the [menu] action:

any-click-actions:
  - '[menu] upgrade-menu sword_tier 5 enchant_id critical'

Format: [menu] menu-id [key1 value1 key2 value2...]

3

Set During Execution

Use the [set-variable] action (if implemented):

any-click-actions:
  - '[set-variable] current_page 2'
  - '[menu] next-page'

---

Using Variables

Reference variables with curly braces: {variable_name}

In Titles

title: '&8Sword Details - Tier {tier}'

In Item Names

In Lore

In Actions

---

Variable Inheritance

Variables follow a hierarchical inheritance model:

Parent Menu
├─ Variables: { tier: 1, type: sword }
│
└─→ Child Menu (inherits)
    ├─ tier: 1          (inherited)
    ├─ type: wooden-sword      (inherited)
    └─ enchant: speed   (new variable)

Example Flow:

# menu-1.yml
menu-items:
  'tier-selector':
    any-click-actions:
      - '[menu] sword-details tier 5 sword_type netherite-sword'

# sword-details.yml (child menu)
inventory:
  title: '&8{sword_type} - Tier {tier}'  # Shows: "netherite-sword - Tier 5"

menu-items:
  'info':
    name: '&e{sword_type}'
    lore:
      - '&7Tier: &f{tier}'  # Variables inherited from parent

---

PlaceholderAPI Integration

Yes! PlaceholderAPI placeholders work everywhere variables do.

You can mix variables and PlaceholderAPI:

title: '&8{menu_name} | Balance: %vault_eco_balance_formatted%'

lore:
  - '&7Player: &f%player_name%'
  - '&7Tier: &f{sword_tier}'
  - '&7Health: &c%player_health%/%player_max_health%'
  - '&7World: &e%player_world%'

Processing Order

1

Variables are replaced first: {variable} → value

2

PlaceholderAPI is processed next: %placeholder% → result

3

Color codes are applied last: &a → green color

---

Advanced Examples

Multi-Menu Workflow

Create a wizard-style flow by passing variables between menus:

# Step 1: Select sword type
any-click-actions:
  - '[menu] select-tier sword_type wooden-sword'

# Step 2: Select tier (receives sword_type)
any-click-actions:
  - '[menu] confirmation sword_type {sword_type} tier 3'

# Step 3: Confirm purchase (receives both)
any-click-actions:
  - '[buy-sword-tier] {sword_type} {tier}'
  - '[close]'

Troubleshooting

Variable Not Showing

Problem: {variable} appears as literal text

Solutions:

• Check spelling matches exactly

• Ensure variable was passed to the menu

• Verify variable exists in parent context

Variable is Empty

Problem: Variable resolves to empty string

Solutions:

• Set default value in menu config

• Check if parent menu passed the variable

• Use PlaceholderAPI if fetching player data

PlaceholderAPI Not Working

Problem: %placeholder% not resolving

Solutions:

• Ensure PlaceholderAPI is installed

• Check expansion is installed (/papi ecloud)

• Verify placeholder syntax is correct

---

Quick Reference

Concept	Syntax	Example
Reference Variable	{variable_name}	{tier}
Set Default	variables: key: 'value'	tier: '1'
Pass Variable	[menu] id key value	[menu] shop tier 5
PlaceholderAPI	%expansion_placeholder%	%player_level%
Combined Usage	{var} %papi%	{tier} %vault_eco_balance%