Buttons
All available button types for zAuctionHouse inventories
This page lists all button types available in zAuctionHouse. Each button type has specific functionality and configuration options.
All inventories in zAuctionHouse are powered by zMenu. For general zMenu button configuration (items, slots, lore, etc.), refer to the zMenu documentation.
Item Display Buttons
These buttons display and handle auction items.
| Type | Description | Used In |
|---|---|---|
ZAUCTIONHOUSE_LISTED_ITEMS | Displays all listed auction items with pagination | Auction |
ZAUCTIONHOUSE_EXPIRED_ITEMS | Displays player's expired items | Expired Items |
ZAUCTIONHOUSE_PURCHASED_ITEMS | Displays player's purchased items | Purchased Items |
ZAUCTIONHOUSE_SELLING_ITEMS | Displays player's items on sale | Selling Items |
ZAUCTIONHOUSE_COMBINED_ITEMS | Combines selling, expired, and purchased items in one view | Combined Items |
ZAUCTIONHOUSE_HISTORY_ITEMS | Displays player's sales history | History |
ZAUCTIONHOUSE_LISTED_ITEMS
Displays all items currently listed for sale in the auction house. Supports pagination, category filtering, and sorting.
Configuration:
| Property | Type | Description |
|---|---|---|
slots | List | Slots where items are displayed (e.g., 9-17, 18-26) |
empty-slot | Number | Slot for the "no items" placeholder |
item | Item | Placeholder shown when no items exist |
Example:
displayItems:
type: ZAUCTIONHOUSE_LISTED_ITEMS
empty-slot: 22
slots:
- 9-17
- 18-26
- 27-35
- 36-44
item:
material: BARRIER
name: '#ff0000&nNo items found'Click actions:
| Click | Action |
|---|---|
Q (drop) or middle click on a listing, with the zauctionhouse.admin.remove.inventory permission | Opens the admin removal confirmation. Checked before the container preview and before the purchase / removal actions |
Right click (action.container-preview.click) on a listing that contains a container | Opens the container preview without checking the balance |
| Any click on another player's listing | Opens the purchase confirmation (if the player has enough money) |
| Any click on your own listing | Removes the listing (through a confirmation with remove-listed-item.open-confirm-inventory) |
See Container Preview to change or disable the preview click.
ZAUCTIONHOUSE_EXPIRED_ITEMS
Displays expired items that the player can retrieve. Click an item to claim it back.
Configuration:
| Property | Type | Description |
|---|---|---|
slots | List | Slots where items are displayed |
empty-slot | Number | Slot for the "no items" placeholder |
item | Item | Placeholder shown when no items exist |
Example:
items:
type: ZAUCTIONHOUSE_EXPIRED_ITEMS
empty-slot: 22
slots:
- 9-17
- 18-26
- 27-35
- 36-44
item:
material: BARRIER
name: '#ff0000&nNo items found'ZAUCTIONHOUSE_PURCHASED_ITEMS
Displays items the player has purchased but not yet claimed.
Configuration:
| Property | Type | Description |
|---|---|---|
slots | List | Slots where items are displayed |
empty-slot | Number | Slot for the "no items" placeholder |
item | Item | Placeholder shown when no items exist |
Example:
items:
type: ZAUCTIONHOUSE_PURCHASED_ITEMS
empty-slot: 22
slots:
- 9-17
- 18-26
- 27-35
- 36-44
item:
material: BARRIER
name: '#ff0000&nNo items found'ZAUCTIONHOUSE_SELLING_ITEMS
Displays items the player currently has listed for sale. Click to remove an item from sale.
Configuration:
| Property | Type | Description |
|---|---|---|
slots | List | Slots where items are displayed |
empty-slot | Number | Slot for the "no items" placeholder |
item | Item | Placeholder shown when no items exist |
Example:
items:
type: ZAUCTIONHOUSE_SELLING_ITEMS
empty-slot: 22
slots:
- 9-17
- 18-26
- 27-35
- 36-44
item:
material: BARRIER
name: '#ff0000&nNo items found'ZAUCTIONHOUSE_COMBINED_ITEMS
Combines selling, expired, and purchased items into a single paginated view. Click action automatically adapts to the item's storage type.
Configuration:
| Property | Type | Description |
|---|---|---|
slots | List | Slots where items are displayed (e.g., 9-17, 18-26) |
empty-slot | Number | Slot for the "no items" placeholder (-1 to disable) |
include-selling | Boolean | Include items currently listed for sale (default: true) |
include-expired | Boolean | Include expired items (default: true) |
include-purchased | Boolean | Include purchased items (default: true) |
item | Item | Placeholder shown when no items exist |
Example:
items:
type: ZAUCTIONHOUSE_COMBINED_ITEMS
empty-slot: 22
include-selling: true
include-expired: true
include-purchased: true
slots:
- 9-17
- 18-26
- 27-35
- 36-44
item:
material: BARRIER
name: '#ff0000&nNo items found'Click behavior:
- Selling items (status
AVAILABLE): Removes/cancels the listing - Expired items (status
REMOVED): Claims the item back - Purchased items (status
PURCHASED): Claims the purchased item
Each item type automatically uses its corresponding lore from config.yml (selling-item, expired-item, purchased-item, being-purchased-item).
ZAUCTIONHOUSE_HISTORY_ITEMS
Displays the player's sales history (items they have sold).
Configuration:
| Property | Type | Description |
|---|---|---|
slots | List | Slots where items are displayed |
loading-slot | Number | Slot for the loading indicator |
item | Item | Loading placeholder |
else | Object | Configuration when no history exists |
Example:
items:
type: ZAUCTIONHOUSE_HISTORY_ITEMS
loading-slot: 22
slots:
- 9-17
- 18-26
- 27-35
- 36-44
item:
material: BARRIER
name: "#ff0000Loading..."
else:
slots:
- 22
item:
material: BARRIER
name: '#ff0000&nNo Sales Found'Navigation Buttons
These buttons open other inventories.
| Type | Description | Used In |
|---|---|---|
ZAUCTIONHOUSE_EXPIRED_INVENTORY | Opens expired items inventory | Auction |
ZAUCTIONHOUSE_PURCHASED_INVENTORY | Opens purchased items inventory | Auction |
ZAUCTIONHOUSE_SELLING_INVENTORY | Opens selling items inventory | Auction |
ZAUCTIONHOUSE_HISTORY_INVENTORY | Opens sales history inventory | Auction |
ZAUCTIONHOUSE_CATEGORY | Opens auction filtered by category | Categories |
ZAUCTIONHOUSE_CATEGORY_SWITCHER | Cycles through categories with left/right click | Auction |
ZAUCTIONHOUSE_SEARCH | Opens search input (chat or dialog) | Auction |
ZAUCTIONHOUSE_CLEAR_SEARCH | Clears active search filter | Auction |
ZAUCTIONHOUSE_EXPIRED_INVENTORY
Opens the expired items inventory. Displays different items based on whether the player has expired items.
Configuration:
| Property | Type | Description |
|---|---|---|
slot | Number | Button position |
item | Item | Shown when player HAS expired items |
else.item | Item | Shown when player has NO expired items |
open-when-empty | Boolean | Open the inventory even when the list is empty (default: false). Set it on the else button, with the same type, so the "no items" button can still be clicked |
Placeholders:
%expired-items%- Number of expired items%s%- Pluralization suffix ("" for 1, "s" for 2+)
Example:
expired-items:
type: ZAUCTIONHOUSE_EXPIRED_INVENTORY
slot: 45
item:
url: "eyJ0ZXh0dXJlcy..."
name: "#2CCED2<bold>ᴇxᴘɪʀᴇᴅ ɪᴛᴇᴍs"
lore:
- "#92ffffYou have #2CCED2%expired-items% #92ffffexpired item%s%."
- ""
- "#8c8c8c• #2CCED2Click #92ffffto open"
else:
type: ZAUCTIONHOUSE_EXPIRED_INVENTORY
open-when-empty: true
item:
url: "eyJ0ZXh0dXJlcy..."
name: "#2CCED2<bold>ᴇxᴘɪʀᴇᴅ ɪᴛᴇᴍs"
lore:
- "#ff3535You have no expired items."ZAUCTIONHOUSE_PURCHASED_INVENTORY
Opens the purchased items inventory.
Configuration:
| Property | Type | Description |
|---|---|---|
slot | Number | Button position |
item | Item | Shown when player HAS purchased items |
else.item | Item | Shown when player has NO purchased items |
open-when-empty | Boolean | Open the inventory even when the list is empty (default: false). Set it on the else button, with the same type, so the "no items" button can still be clicked |
Placeholders:
%purchased-items%- Number of purchased items%s%- Pluralization suffix
Example:
purchased-items:
type: ZAUCTIONHOUSE_PURCHASED_INVENTORY
slot: 46
item:
url: "eyJ0ZXh0dXJlcy..."
name: "#2CCED2<bold>ᴘᴜʀᴄʜᴀsᴇᴅ ɪᴛᴇᴍs"
lore:
- "#92ffffYou have #2CCED2%purchased-items% #92ffffbought item%s%."
- ""
- "#8c8c8c• #2CCED2Click #92ffffto open"
else:
type: ZAUCTIONHOUSE_PURCHASED_INVENTORY
open-when-empty: true
item:
url: "eyJ0ZXh0dXJlcy..."
name: "#2CCED2<bold>ᴘᴜʀᴄʜᴀsᴇᴅ ɪᴛᴇᴍs"
lore:
- "#ff3535You have no purchased items."ZAUCTIONHOUSE_SELLING_INVENTORY
Opens the inventory showing items the player currently has on sale.
Configuration:
| Property | Type | Description |
|---|---|---|
slot | Number | Button position |
item | Item | Shown when player HAS items on sale |
else.item | Item | Shown when player has NO items on sale |
open-when-empty | Boolean | Open the inventory even when the list is empty (default: false). Set it on the else button, with the same type, so the "no items" button can still be clicked |
Placeholders:
%selling-items%- Number of items on sale%s%- Pluralization suffix
Example:
selling-items:
type: ZAUCTIONHOUSE_SELLING_INVENTORY
slot: 53
item:
url: "eyJ0ZXh0dXJlcy..."
name: "#2CCED2<bold>ʏᴏᴜʀ ɪᴛᴇᴍs"
lore:
- "#92ffffYou have #2CCED2%selling-items% #92ffffitem%s% on sale."
- ""
- "#8c8c8c• #2CCED2Click #92ffffto open"
else:
type: ZAUCTIONHOUSE_SELLING_INVENTORY
open-when-empty: true
item:
url: "eyJ0ZXh0dXJlcy..."
name: "#2CCED2<bold>ʏᴏᴜʀ ɪᴛᴇᴍs"
lore:
- "#ff3535You have no items for sale."ZAUCTIONHOUSE_HISTORY_INVENTORY
Opens the sales history inventory.
Configuration:
| Property | Type | Description |
|---|---|---|
slot | Number | Button position |
item | Item | Button appearance |
Example:
history:
type: ZAUCTIONHOUSE_HISTORY_INVENTORY
slot: 47
item:
material: BOOK
name: "#2CCED2<bold>sᴀʟᴇs ʜɪsᴛᴏʀʏ"
lore:
- "#92ffffView your sales history."
- ""
- "#8c8c8c• #2CCED2Click #92ffffto open"ZAUCTIONHOUSE_CATEGORY
Opens the auction house filtered by a specific category.
Configuration:
| Property | Type | Description |
|---|---|---|
slot | Number | Button position |
category | String | Category name (must match categories.yml) |
item | Item | Button appearance |
Special Categories:
all- Shows all items (no filtering)
Placeholders:
%zauctionhouse_category_count_<name>%- Number of items in category
Example:
weapons:
type: ZAUCTIONHOUSE_CATEGORY
category: weapons
slot: 20
item:
material: DIAMOND_SWORD
name: "#ff5555<bold>ᴡᴇᴀᴘᴏɴs"
lore:
- "#92ffffCombat equipment"
- ""
- "#92ffffItems#8c8c8c: #2CCED2%zauctionhouse_category_count_weapons%"
- ""
- "#8c8c8c• #2CCED2Click #92ffffto browse"ZAUCTIONHOUSE_CATEGORY_SWITCHER
Cycles through categories using left/right click. Displays a dynamic lore showing the enable/disable state for each category.
Configuration:
| Property | Type | Description |
|---|---|---|
slot | Number | Button position |
enable-text | String | Format for the currently selected category |
disable-text | String | Format for unselected categories |
categories | List | List of category IDs to cycle through |
item | Item | Button appearance |
Placeholders:
%category%- Current category display name%<category-id>%- Replaced byenable-textordisable-textfor each category
Example:
category-switcher:
type: ZAUCTIONHOUSE_CATEGORY_SWITCHER
slot: 49
enable-text: "&a● %category%"
disable-text: "&7○ %category%"
categories:
- "main"
- "weapons"
- "armor"
- "tools"
- "blocks"
- "consumables"
- "resources"
- "enchanted-books"
- "misc"
item:
material: COMPASS
name: "&6Categories &7(&f%category%&7)"
lore:
- ""
- "%main%"
- "%weapons%"
- "%armor%"
- "%tools%"
- "%blocks%"
- "%consumables%"
- "%resources%"
- "%enchanted-books%"
- "%misc%"
- ""
- "&7Left-click &8» &fNext"
- "&7Right-click &8» &fPrevious"Use "main" as a category ID to represent "All Items" (no filtering).
Search Buttons
| Type | Description | Used In |
|---|---|---|
ZAUCTIONHOUSE_SEARCH | Opens search input (chat or dialog) | Auction |
ZAUCTIONHOUSE_CLEAR_SEARCH | Clears active search filter | Auction |
ZAUCTIONHOUSE_SEARCH
Opens a chat-based search input. When clicked, the player's inventory closes and they can type a search query in chat. Supports advanced filter operators for targeted searches.
Configuration:
| Property | Type | Description |
|---|---|---|
slot | Number | Button position |
none-value | String | Text shown in %search_query% when no search is active. Defaults to None; ships localized per language (FR Aucune, ES Ninguna, IT Nessuna, TH ไม่มี). |
active-value | String | Text shown in %search_active% when a search is active. Defaults to true. |
inactive-value | String | Text shown in %search_active% when no search is active. Defaults to false. |
dialog.enabled | Boolean | Open a search dialog instead of the chat input (default: false). See Search dialog |
item | Item | Button appearance |
Placeholders:
%search_query%- Current search query (or the configurablenone-value, defaultNone/ localized, when no search is active)%search_active%- Whether a search is active (the configurableactive-value/inactive-value, defaulttrue/false)
Search Operators:
| Operator | Description |
|---|---|
~ | Contains (case-sensitive) |
= | Exact match (case-sensitive) |
~= | Contains (ignore case) |
== | Exact match (ignore case) |
Searchable Fields: name, material, lore, seller
Example:
search:
type: ZAUCTIONHOUSE_SEARCH
slot: 47
is-permanent: true
# Value shown in %search_query% when no search is active.
none-value: "None"
# Value shown in %search_active% when a search is active.
active-value: "true"
# Value shown in %search_active% when no search is active.
inactive-value: "false"
item:
material: COMPASS
name: "#2CCED2<bold>sᴇᴀʀᴄʜ"
lore:
- ""
- "#92ffffCurrent search#8c8c8c: #2CCED2%search_query%"
- ""
- "#92ffffFilters#8c8c8c:"
- "#8c8c8c name #76CDCD~ #8c8c8cvalue #555555(contains)"
- "#8c8c8c name #76CDCD= #8c8c8cvalue #555555(exact)"
- "#8c8c8c name #76CDCD~= #8c8c8cvalue #555555(contains, ignore case)"
- "#8c8c8c name #76CDCD== #8c8c8cvalue #555555(exact, ignore case)"
- ""
- "#92ffffFields#8c8c8c: #76CDCDname#8c8c8c, #76CDCDmaterial#8c8c8c, #76CDCDlore#8c8c8c, #76CDCDseller"
- ""
- "#92ffffExamples#8c8c8c:"
- "#8c8c8c seller #76CDCD= #8c8c8cNotch"
- "#8c8c8c name #76CDCD~ #8c8c8cDiamond"
- ""
- "#8c8c8c• #2CCED2Click #92ffffto search"Without an operator, the search performs a case-insensitive substring match on item name, material, lore, and seller name simultaneously.
Search dialog
With dialog.enabled: true, clicking the button opens a native Paper dialog (provided by zMenu) instead of asking in chat. The text field is pre-filled with the current search (256 characters max) and the dialog has three buttons: Search, Clear (removes the active search) and Cancel (returns to the auction house). If the dialog cannot be loaded, the chat input is used instead.
search:
type: ZAUCTIONHOUSE_SEARCH
dialog:
enabled: trueThe dialog is configured in dialogs/search.yml, shipped in every language:
name: Auction Search
type: multi_action
can-close-with-escape: true
pause: false
after-action: CLOSE
number-of-columns: 3
body:
description:
type: plain_message
messages:
- <gray>Enter an item name or a filter, such as seller = Notch.
width: 350
query-label: Search query
search-label: <aqua>Search
clear-label: <yellow>Clear
cancel-label: <red>Cancel
multi-actions:
search:
label: <aqua>Search
clear:
label: <yellow>Clear
cancel:
label: <red>CancelZAUCTIONHOUSE_CLEAR_SEARCH
Clears the active search filter. This button is only visible when the player has an active search query.
Configuration:
| Property | Type | Description |
|---|---|---|
slot | Number | Button position |
item | Item | Button appearance |
Placeholders:
%search_query%- Current search query
Example:
clear-search:
type: ZAUCTIONHOUSE_CLEAR_SEARCH
slot: 48
is-permanent: true
item:
material: BARRIER
name: "#ff6b6b<bold>ᴄʟᴇᴀʀ sᴇᴀʀᴄʜ"
lore:
- ""
- "#92ffffSearching for#8c8c8c: #2CCED2%search_query%"
- ""
- "#8c8c8c• #2CCED2Click #92ffffto clear search"Claim Button
| Type | Description | Used In |
|---|---|---|
ZAUCTIONHOUSE_CLAIM | Displays pending money and allows claiming | Auction |
ZAUCTIONHOUSE_CLAIM
Displays the player's pending money from sales and allows them to claim it with a single click. Shows per-economy amounts using dynamic placeholders and supports a loading state while data is being fetched.
Configuration:
| Property | Type | Description |
|---|---|---|
slot | Number | Button position |
loading-item | Item | Shown while pending money data is loading |
item | Item | Normal button appearance with pending money placeholders |
Placeholders:
| Placeholder | Description |
|---|---|
%pending_total% | Total pending money across all economies (formatted) |
%pending_<economy_name>% | Pending money for a specific economy (e.g., %pending_vault%) |
%has_pending% | true or false |
The economy name corresponds to the name field defined in your economies.yml configuration. For example, if you have an economy with name: vault, use %pending_vault%.
Example:
claim-money:
type: ZAUCTIONHOUSE_CLAIM
slot: 48
loading-item:
material: CLOCK
name: "#2CCED2<bold>ᴄʟᴀɪᴍ ᴍᴏɴᴇʏ"
lore:
- "#8c8c8c• #ff3535Loading, please wait..."
item:
material: GOLD_INGOT
name: "#2CCED2<bold>ᴄʟᴀɪᴍ ᴍᴏɴᴇʏ"
lore:
- ""
- "#92ffffPending money#8c8c8c: #2CCED2%pending_total%"
- ""
- "#8c8c8c• #2CCED2Click #92ffffto claim your money"Multi-economy example:
claim-money:
type: ZAUCTIONHOUSE_CLAIM
slot: 48
loading-item:
material: CLOCK
name: "#2CCED2<bold>ᴄʟᴀɪᴍ ᴍᴏɴᴇʏ"
lore:
- "#8c8c8c• #ff3535Loading, please wait..."
item:
material: GOLD_INGOT
name: "#2CCED2<bold>ᴄʟᴀɪᴍ ᴍᴏɴᴇʏ"
lore:
- ""
- "#92ffffVault#8c8c8c: #2CCED2%pending_vault%"
- "#92ffffTokens#8c8c8c: #2CCED2%pending_tokens%"
- "#92ffffTotal#8c8c8c: #2CCED2%pending_total%"
- ""
- "#8c8c8c• #2CCED2Click #92ffffto claim your money"Sort Buttons
| Type | Description | Used In |
|---|---|---|
ZAUCTIONHOUSE_CHANGE_SORT | Changes auction item sort order | Auction |
ZAUCTIONHOUSE_HISTORY_SORT | Changes history sort order | History |
ZAUCTIONHOUSE_CHANGE_SORT
Cycles through available sort options for the auction house.
Configuration:
| Property | Type | Description |
|---|---|---|
slot | Number | Button position |
sorts | List | Available sort options |
enable-text | String | Format for selected sort option |
disable-text | String | Format for unselected sort options |
loading-item | Item | Shown while sorting |
item | Item | Button appearance |
Sort Options:
DECREASING_DATE- Newest firstINCREASING_DATE- Oldest firstDECREASING_PRICE- Most expensive firstINCREASING_PRICE- Cheapest first
Example:
change-sort:
type: ZAUCTIONHOUSE_CHANGE_SORT
slot: 52
sorts:
- DECREASING_DATE
- DECREASING_PRICE
- ASCENDING_DATE
- ASCENDING_PRICE
enable-text: ' #F27438➜ %sorting%'
disable-text: ' #76CDCD➜ %sorting%'
loading-item:
material: HOPPER
name: "#2CCED2<bold>sᴏʀᴛ ᴛʏᴘᴇ"
lore:
- "#8c8c8c• #ff3535Loading, please wait"
item:
material: HOPPER
name: "#2CCED2<bold>sᴏʀᴛ ᴛʏᴘᴇ"
lore:
- "#92ffffAvailable sort types:"
- "%DECREASING_DATE%"
- "%DECREASING_PRICE%"
- "%ASCENDING_DATE%"
- "%ASCENDING_PRICE%"
- ""
- "#8c8c8c• #2CCED2Click #92ffffto change the sort type"ZAUCTIONHOUSE_HISTORY_SORT
Cycles through sort options for sales history.
Configuration:
| Property | Type | Description |
|---|---|---|
slot | Number | Button position |
sorts | List | Available sort options |
sort-names | Map | Display names for sort options |
enable-text | String | Format for selected sort option |
disable-text | String | Format for unselected sort options |
item | Item | Button appearance |
Sort Options:
DATE_DESC- Newest firstDATE_ASC- Oldest firstPRICE_DESC- Highest price firstPRICE_ASC- Lowest price firstBUYER_ASC- Buyer name A-ZBUYER_DESC- Buyer name Z-A
Example:
sort:
type: ZAUCTIONHOUSE_HISTORY_SORT
slot: 51
enable-text: ' #F27438➜ %sorting%'
disable-text: ' #76CDCD➜ %sorting%'
sorts:
- DATE_DESC
- DATE_ASC
- PRICE_DESC
- PRICE_ASC
sort-names:
DATE_DESC: "Newest First"
DATE_ASC: "Oldest First"
PRICE_DESC: "Highest Price"
PRICE_ASC: "Lowest Price"
item:
material: HOPPER
name: "#2CCED2<bold>sᴏʀᴛ"
lore:
- "#92ffffAvailable sort types:"
- "%DATE_DESC%"
- "%DATE_ASC%"
- "%PRICE_DESC%"
- "%PRICE_ASC%"
- ""
- "#8c8c8c• #2CCED2Click #92ffffto change the sort type"Sell Inventory Buttons
These buttons are used in the sell inventory.
| Type | Description | Used In |
|---|---|---|
ZAUCTIONHOUSE_SELL_SHOW_ITEM | Displays selected items | Sell |
ZAUCTIONHOUSE_SELL_PRICE | Adjusts listing price | Sell |
ZAUCTIONHOUSE_SELL_ECONOMY | Selects economy type | Sell |
ZAUCTIONHOUSE_SELL_CONFIRM | Confirms the sale | Sell |
ZAUCTIONHOUSE_SELL_CANCEL | Cancels the sale | Sell |
ZAUCTIONHOUSE_SELL_SHOW_ITEM
Displays items selected for sale.
Configuration:
| Property | Type | Description |
|---|---|---|
slots | List | Slots for displaying items |
empty-slot | Number | Slot for "no item" placeholder |
item | Item | Placeholder when no item selected |
Example:
show-item:
type: ZAUCTIONHOUSE_SELL_SHOW_ITEM
slots:
- 9-44
empty-slot: 22
item:
material: BARRIER
name: "#ff0000<bold>No Item Selected"
lore:
- ""
- "#8c8c8cHold an item in your hand"
- "#8c8c8cor select items from your inventory"ZAUCTIONHOUSE_SELL_PRICE
Adjusts the listing price with different amounts per click type.
Configuration:
| Property | Type | Description |
|---|---|---|
slot | Number | Button position |
amounts | Map | Price changes per click type |
item | Item | Button appearance |
Click Types:
left-click- Regular left clickright-click- Regular right clickshift-left-click- Shift + left clickshift-right-click- Shift + right click
Placeholders:
%price%- Current listing price
Example (Decrease):
price-decrease:
type: ZAUCTIONHOUSE_SELL_PRICE
slot: 48
amounts:
left-click: -500
right-click: -100
shift-left-click: -1000
shift-right-click: -2500
item:
url: eyJ0ZXh0dXJlcy...
name: "#ff3333-1,000"
lore:
- ""
- "<white>Current price#8c8c8c: #2CCED2%price%"
- ""
- "#8c8c8c• #92ffffLeft click#8c8c8c: -500"
- "#8c8c8c• #92ffffRight click#8c8c8c: -100"
- "#8c8c8c• #92ffffShift+Left#8c8c8c: -1,000"
- "#8c8c8c• #92ffffShift+Right#8c8c8c: -2,500"Example (Increase):
price-increase:
type: ZAUCTIONHOUSE_SELL_PRICE
slot: 50
amounts:
left-click: 500
right-click: 100
shift-left-click: 1000
shift-right-click: 2500
item:
url: eyJ0ZXh0dXJlcy...
name: '#00cc00+1,000'
lore:
- '<white>Current price#8c8c8c: #2CCED2%price%'
- ''
- '#8c8c8c• #92ffffLeft click#8c8c8c: +500'
- '#8c8c8c• #92ffffRight click#8c8c8c: +100'
- '#8c8c8c• #92ffffShift+Left#8c8c8c: +1,000'
- '#8c8c8c• #92ffffShift+Right#8c8c8c: +2,500'ZAUCTIONHOUSE_SELL_ECONOMY
Cycles through available economies.
With the economy option the button no longer cycles: clicking it selects that economy. Add one button per economy to let the player pick directly.
Configuration:
| Property | Type | Description |
|---|---|---|
slot | Number | Button position |
item | Item | Button appearance |
economy | String | Optional. Economy selected on click instead of cycling (name from economies.yml) |
Placeholders:
%economy%- Display name of the economy (the button's economy witheconomy, otherwise the selected one)%economy_name%- Internal name of that economy%price%- Listing price formatted in that economy%selected%-truewhen this economy is the selected one
Example:
select-economy:
type: ZAUCTIONHOUSE_SELL_ECONOMY
slot: 49
item:
url: eyJ0ZXh0dXJlcy...
name: "#ffd700<bold>Economy"
lore:
- ""
- "<white>Current#8c8c8c: #2CCED2%economy%"
- ""
- "#8c8c8c• #92ffffLeft click#8c8c8c: Next economy"
- "#8c8c8c• #92ffffRight click#8c8c8c: Previous economy"One button per economy:
select-money:
type: ZAUCTIONHOUSE_SELL_ECONOMY
economy: vault
slot: 48
item:
material: GOLD_INGOT
name: "#ffd700<bold>Money"
lore:
- "<white>Price#8c8c8c: #2CCED2%price%"
- "<white>Selected#8c8c8c: #2CCED2%selected%"
select-levels:
type: ZAUCTIONHOUSE_SELL_ECONOMY
economy: level
slot: 50
item:
material: EXPERIENCE_BOTTLE
name: "#7cfc00<bold>Levels"
lore:
- "<white>Price#8c8c8c: #2CCED2%price%"
- "<white>Selected#8c8c8c: #2CCED2%selected%"ZAUCTIONHOUSE_SELL_CONFIRM
Confirms the sale and lists the items.
With the economy option the button always sells with that economy, whatever economy is selected: one confirm button per economy lists the item in a single click. The price limits of that economy still apply: a price outside them is refused. If the economy does not exist, a warning is logged when the inventory loads and the click sends sell-error-economy.
Configuration:
| Property | Type | Description |
|---|---|---|
slot | Number | Button position |
item | Item | Button appearance |
economy | String | Optional. Always sell with this economy (name from economies.yml) |
Placeholders:
%economy%- Economy of the sale (the button's economy witheconomy, otherwise the selected one)%economy_name%- Internal name of that economy%price%- Listing price%item_count%- Number of items
Example:
confirm:
type: ZAUCTIONHOUSE_SELL_CONFIRM
slot: 53
item:
material: LIME_STAINED_GLASS_PANE
name: "#00ff00<bold>CONFIRM SALE"
lore:
- ""
- "<white>Economy#8c8c8c: #2CCED2%economy%"
- "<white>Price#8c8c8c: #2CCED2%price%"
- "<white>Items#8c8c8c: #2CCED2%item_count%"
- ""
- "#8c8c8c• #2CCED2Click #92ffffto confirm the sale"One confirm button per economy:
sell-for-money:
type: ZAUCTIONHOUSE_SELL_CONFIRM
economy: vault
slot: 52
item:
material: GOLD_INGOT
name: "#00ff00<bold>Sell for %price%"
sell-for-levels:
type: ZAUCTIONHOUSE_SELL_CONFIRM
economy: level
slot: 53
item:
material: EXPERIENCE_BOTTLE
name: "#00ff00<bold>Sell for %price%"ZAUCTIONHOUSE_SELL_CANCEL
Cancels the sale and returns items to the player.
Configuration:
| Property | Type | Description |
|---|---|---|
slot | Number | Button position |
item | Item | Button appearance |
Example:
cancel:
type: ZAUCTIONHOUSE_SELL_CANCEL
slot: 45
item:
material: RED_STAINED_GLASS_PANE
name: "#ff0000<bold>CANCEL"
lore:
- ""
- "#8c8c8c• #2CCED2Click #92ffffto cancel and return items"Confirmation Buttons
| Type | Description | Used In |
|---|---|---|
ZAUCTIONHOUSE_CONFIRM_PURCHASE | Confirms a purchase | Purchase Confirm |
ZAUCTIONHOUSE_CONFIRM_REMOVE_LISTED | Confirms removing a listing | Remove Confirm |
ZAUCTIONHOUSE_SHOW | Displays the auction item | Confirmations |
ZAUCTIONHOUSE_CONFIRM_PURCHASE
Confirms the purchase of an item.
Configuration:
| Property | Type | Description |
|---|---|---|
slots | List | Button slots (larger click area) |
item | Item | Button appearance |
Example:
confirm:
type: ZAUCTIONHOUSE_CONFIRM_PURCHASE
slots:
- 0-2
- 9-11
- 18-20
item:
material: GREEN_STAINED_GLASS_PANE
name: "#2CCED2<bold>ᴘᴜʀᴄʜᴀsᴇ"
lore:
- "#92ffffPurchase this item."
- ""
- "#8c8c8c• #2CCED2Click #92ffffto purchase"ZAUCTIONHOUSE_CONFIRM_REMOVE_LISTED
Confirms removing an item from sale.
Configuration:
| Property | Type | Description |
|---|---|---|
slots | List | Button slots |
item | Item | Button appearance |
Example:
remove:
type: ZAUCTIONHOUSE_CONFIRM_REMOVE_LISTED
slots:
- 0-2
- 9-11
- 18-20
item:
material: GREEN_STAINED_GLASS_PANE
name: "#2CCED2<bold>ʀᴇᴍᴏᴠᴇ"
lore:
- "#92ffffRemove this item."
- ""
- "#8c8c8c• #2CCED2Click #92ffffto remove"ZAUCTIONHOUSE_SHOW
Displays the auction item being confirmed.
Configuration:
| Property | Type | Description |
|---|---|---|
slot | Number | Display position |
Example:
show:
type: ZAUCTIONHOUSE_SHOW
slot: 13Container Content Buttons
These buttons display the contents of container items (shulker boxes, AxShulkers, etc.). The system is extensible via the ItemContentProvider API, allowing plugins to register custom container types.
| Type | Description | Used In |
|---|---|---|
ZAUCTIONHOUSE_SHULKER_OPEN | Opens container content viewer | Confirmations |
ZAUCTIONHOUSE_SHULKER_CONTENT | Displays container contents | Shulker Content |
ZAUCTIONHOUSE_SHULKER_INFO | Shows container information | Shulker Content |
ZAUCTIONHOUSE_SHULKER_NAVIGATION | Navigates between containers | Shulker Content |
Supported container types:
- Vanilla shulker boxes - built-in, no extra plugin required
- AxShulkers - requires AxShulkers plugin
External plugins can register additional container types via the API:
AuctionPlugin api = getServer().getServicesManager().load(AuctionPlugin.class);
api.getItemContentManager().registerProvider(new MyCustomContentProvider());ZAUCTIONHOUSE_SHULKER_OPEN
Opens the container content preview. Only visible when the item contains recognized container items (shulker boxes, AxShulkers, etc.).
The same preview can also be opened straight from the auction house by right-clicking the listing, without the purchase confirmation: see Container Preview.
Configuration:
| Property | Type | Description |
|---|---|---|
slot | Number | Button position |
item | Item | Button appearance |
Example:
shulker:
type: ZAUCTIONHOUSE_SHULKER_OPEN
slot: 4
item:
material: SHULKER_BOX
name: "#2CCED2<bold>ᴠɪᴇᴡ sʜᴜʟᴋᴇʀ ᴄᴏɴᴛᴇɴᴛ"
lore:
- "#92ffffView the content of shulker boxes."
- ""
- "#8c8c8c• #2CCED2Click #92ffffto view content"ZAUCTIONHOUSE_SHULKER_CONTENT
Displays the contents of the current shulker box.
Configuration:
| Property | Type | Description |
|---|---|---|
slots | List | Slots for displaying contents |
Example:
content:
type: ZAUCTIONHOUSE_SHULKER_CONTENT
slots:
- 9-17
- 18-26
- 27-35
- 36-44ZAUCTIONHOUSE_SHULKER_INFO
Displays information about the current shulker.
Configuration:
| Property | Type | Description |
|---|---|---|
slot | Number | Button position |
item | Item | Button appearance |
Placeholders:
%shulker_current%- Current shulker number%shulker_total%- Total shulkers
Example:
shulker-info:
type: ZAUCTIONHOUSE_SHULKER_INFO
slot: 4
item:
material: SHULKER_BOX
name: "#2CCED2<bold>sʜᴜʟᴋᴇʀ ʙᴏx"
lore:
- "#92ffffViewing shulker #2CCED2%shulker_current% #92ffffof #2CCED2%shulker_total%"ZAUCTIONHOUSE_SHULKER_NAVIGATION
Navigates between shulkers in bulk sales.
Configuration:
| Property | Type | Description |
|---|---|---|
slot | Number | Button position |
direction | String | previous or next |
item | Item | Button appearance |
Example:
previous:
type: ZAUCTIONHOUSE_SHULKER_NAVIGATION
direction: previous
slot: 48
item:
material: ARROW
name: "#2CCED2<bold>ᴘʀᴇᴠɪᴏᴜs sʜᴜʟᴋᴇʀ"
lore:
- "#92ffffView the previous shulker box."
next:
type: ZAUCTIONHOUSE_SHULKER_NAVIGATION
direction: next
slot: 50
item:
material: ARROW
name: "#2CCED2<bold>ɴᴇxᴛ sʜᴜʟᴋᴇʀ"
lore:
- "#92ffffView the next shulker box."Bulk Item Buttons
| Type | Description | Used In |
|---|---|---|
ZAUCTIONHOUSE_ITEM_CONTENT | Displays all items in a bulk sale | Purchase Inventory Confirm, Remove Inventory Confirm |
ZAUCTIONHOUSE_ITEM_CONTENT
Displays all items in a bulk sale. Used in confirmation inventories for bulk purchases and removals.
Configuration:
| Property | Type | Description |
|---|---|---|
slots | List | Slots for displaying items |
Example:
item-content:
type: ZAUCTIONHOUSE_ITEM_CONTENT
slots:
- 9-44Remove All Buttons
| Type | Description | Used In |
|---|---|---|
ZAUCTIONHOUSE_REMOVE_ALL_EXPIRED | Retrieves all expired items at once | Expired Items |
ZAUCTIONHOUSE_REMOVE_ALL_SELLING | Retrieves all selling items at once | Selling Items |
ZAUCTIONHOUSE_REMOVE_ALL_PURCHASED | Retrieves all purchased items at once | Purchased Items |
ZAUCTIONHOUSE_REMOVE_ALL_EXPIRED
Retrieves all expired items at once. Items are given one by one and the process stops when the player's inventory is full (if player-inventory-must-have-free-space is enabled under remove-expired-item in config.yml).
Example:
remove-all:
type: ZAUCTIONHOUSE_REMOVE_ALL_EXPIRED
is-permanent: true
slot: 47
item:
material: CHEST
name: "#2CCED2<bold>Retrieve All"
lore:
- "#92ffffRetrieve all expired items."
- ""
- "#8c8c8c• #2CCED2Click #92ffffto retrieve all"ZAUCTIONHOUSE_REMOVE_ALL_SELLING
Retrieves all selling items at once. Cancels listings and returns items to the player. Items currently being purchased by another player are skipped.
Example:
remove-all:
type: ZAUCTIONHOUSE_REMOVE_ALL_SELLING
is-permanent: true
slot: 47
item:
material: CHEST
name: "#2CCED2<bold>Retrieve All"
lore:
- "#92ffffRetrieve all selling items."
- ""
- "#8c8c8c• #2CCED2Click #92ffffto retrieve all"ZAUCTIONHOUSE_REMOVE_ALL_PURCHASED
Retrieves all purchased items at once. Items are given one by one and the process stops when the player's inventory is full (if player-inventory-must-have-free-space is enabled under purchased-item in config.yml).
Example:
remove-all:
type: ZAUCTIONHOUSE_REMOVE_ALL_PURCHASED
is-permanent: true
slot: 47
item:
material: CHEST
name: "#2CCED2<bold>Retrieve All"
lore:
- "#92ffffRetrieve all purchased items."
- ""
- "#8c8c8c• #2CCED2Click #92ffffto retrieve all"Admin Buttons
Navigation Buttons
| Type | Description | Used In |
|---|---|---|
ZAUCTIONHOUSE_ADMIN_HISTORY_MAIN | Displays target player info | Admin History |
ZAUCTIONHOUSE_ADMIN_HISTORY_EXPIRED | Opens target's expired items | Admin History |
ZAUCTIONHOUSE_ADMIN_HISTORY_PURCHASED | Opens target's purchased items | Admin History |
ZAUCTIONHOUSE_ADMIN_HISTORY_SELLING | Opens target's selling items | Admin History |
ZAUCTIONHOUSE_ADMIN_HISTORY_LOGS | Opens target's action logs | Admin History |
ZAUCTIONHOUSE_ADMIN_HISTORY_TRANSACTIONS | Opens target's transactions | Admin History |
ZAUCTIONHOUSE_ADMIN_MAIN | Opens (and refreshes) the admin player directory | Admin Player Directory, Admin History |
Player Directory Buttons
| Type | Description | Used In |
|---|---|---|
ZAUCTIONHOUSE_ADMIN_PLAYERS | Paginated list of players with auction activity | Admin Player Directory |
ZAUCTIONHOUSE_ADMIN_PLAYERS_SORT | Changes the player list sort | Admin Player Directory |
Admin Removal Buttons
| Type | Description | Used In |
|---|---|---|
ZAUCTIONHOUSE_ADMIN_REMOVE_CONFIRM | Confirms the removal of a listing | Admin Remove Confirm |
ZAUCTIONHOUSE_ADMIN_REMOVE_NOTIFY | Toggles the seller notification | Admin Remove Confirm |
ZAUCTIONHOUSE_ADMIN_REMOVE_EXPIRE | Toggles sending the item to the seller's expired items | Admin Remove Confirm |
ZAUCTIONHOUSE_ADMIN_REMOVE_COPY | Toggles giving the item to the admin | Admin Remove Confirm |
Item Display Buttons
| Type | Description | Used In |
|---|---|---|
ZAUCTIONHOUSE_ADMIN_SELLING_ITEMS | Displays target's selling items | Admin Selling Items |
ZAUCTIONHOUSE_ADMIN_EXPIRED_ITEMS | Displays target's expired items | Admin Expired Items |
ZAUCTIONHOUSE_ADMIN_PURCHASED_ITEMS | Displays target's purchased items | Admin Purchased Items |
ZAUCTIONHOUSE_ADMIN_LOGS | Displays action logs | Admin Logs |
ZAUCTIONHOUSE_ADMIN_TRANSACTIONS | Displays transactions | Admin Transactions |
Filter Buttons
| Type | Description | Used In |
|---|---|---|
ZAUCTIONHOUSE_ADMIN_LOGS_FILTER_TYPE | Filters logs by action type | Admin Logs |
ZAUCTIONHOUSE_ADMIN_LOGS_FILTER_DATE | Filters logs by date range | Admin Logs |
ZAUCTIONHOUSE_ADMIN_TRANSACTIONS_FILTER_STATUS | Filters transactions by status | Admin Transactions |
ZAUCTIONHOUSE_ADMIN_TRANSACTIONS_FILTER_DATE | Filters transactions by date | Admin Transactions |
ZAUCTIONHOUSE_ADMIN_HISTORY_MAIN
Displays target player information (player head).
Configuration:
| Property | Type | Description |
|---|---|---|
slot | Number | Button position |
item | Item | Button appearance |
Example:
target:
type: ZAUCTIONHOUSE_ADMIN_HISTORY_MAIN
slot: 13
item:
player-head: '%target%'
name: '#2CCED2<bold>%target%'ZAUCTIONHOUSE_ADMIN_HISTORY_EXPIRED
Opens the admin expired items inventory for the target player.
Placeholders:
%target%- Target player name%expired-items%- Number of expired items%s%- Pluralization suffix
ZAUCTIONHOUSE_ADMIN_HISTORY_PURCHASED
Opens the admin purchased items inventory for the target player.
Placeholders:
%target%- Target player name%purchased-items%- Number of purchased items%s%- Pluralization suffix
ZAUCTIONHOUSE_ADMIN_HISTORY_SELLING
Opens the admin selling items inventory for the target player.
Placeholders:
%target%- Target player name%selling-items%- Number of selling items%s%- Pluralization suffix
ZAUCTIONHOUSE_ADMIN_HISTORY_LOGS
Opens the admin logs inventory for the target player.
ZAUCTIONHOUSE_ADMIN_HISTORY_TRANSACTIONS
Opens the admin transactions inventory for the target player.
ZAUCTIONHOUSE_ADMIN_LOGS_FILTER_TYPE
Cycles through log type filters.
Configuration:
| Property | Type | Description |
|---|---|---|
slot | Number | Button position |
types | List | Available log types to filter |
type-names | Map | Display names for each type |
enable-text | String | Format for selected type |
disable-text | String | Format for unselected types |
all-types-name | String | Display name for "all" option |
Log Types:
SALE- Item was listed for salePURCHASE- Item was purchasedREMOVE_LISTED- Item removed from active listingREMOVE_SELLING- Item retrieved from selling inventoryREMOVE_EXPIRED- Item retrieved from expired inventoryREMOVE_PURCHASED- Item retrieved from purchased inventoryADMIN_REMOVE- Listing removed by an administrator from the admin removal confirmation
If types is empty or missing, every log type is available. The default admin-logs.yml does not list ADMIN_REMOVE: add it to types (and %ADMIN_REMOVE% to the lore) to filter on it.
ZAUCTIONHOUSE_ADMIN_LOGS_FILTER_DATE
Cycles through date range filters.
Configuration:
| Property | Type | Description |
|---|---|---|
slot | Number | Button position |
filters | List | Available date filters |
filter-names | Map | Display names for each filter |
enable-text | String | Format for selected filter |
disable-text | String | Format for unselected filters |
Date Filters:
ALL- All timeTODAY- Today onlyTHIS_WEEK- Last 7 daysTHIS_MONTH- Last 30 daysTHIS_YEAR- Last 365 days
ZAUCTIONHOUSE_ADMIN_TRANSACTIONS_FILTER_STATUS
Cycles through transaction status filters.
Configuration:
| Property | Type | Description |
|---|---|---|
slot | Number | Button position |
statuses | List | Available statuses |
status-names | Map | Display names for each status |
enable-text | String | Format for selected status |
disable-text | String | Format for unselected statuses |
all-statuses-name | String | Display name for "all" option |
Statuses:
PENDING- Money not yet claimedRETRIEVED- Money has been claimed
ZAUCTIONHOUSE_ADMIN_TRANSACTIONS_FILTER_DATE
Cycles through date range filters for transactions.
Configuration:
Same as ZAUCTIONHOUSE_ADMIN_LOGS_FILTER_DATE.
ZAUCTIONHOUSE_ADMIN_MAIN
Opens the admin player directory (admin-main.yml). The player data is always reloaded when the button is clicked, so the same button is used as the Refresh button inside the directory and as the All players button in Admin History.
Requires the zauctionhouse.admin.items permission.
Configuration:
| Property | Type | Description |
|---|---|---|
slot | Number | Button position |
item | Item | Button appearance |
Example:
refresh:
type: ZAUCTIONHOUSE_ADMIN_MAIN
slot: 45
item:
material: SUNFLOWER
name: "#2CCED2Refresh"ZAUCTIONHOUSE_ADMIN_PLAYERS
Paginated list of every player who has auction activity (listings, purchases, logs or transactions). Each entry is built from the button item, with the placeholders below. Clicking an entry opens Admin History for that player.
The data is loaded asynchronously with a single SQL query (no item content is loaded), then the inventory refreshes by itself.
Requires the zauctionhouse.admin.items permission.
Configuration:
| Property | Type | Description |
|---|---|---|
slots | List | Slots where player entries are displayed |
item | Item | Appearance of each player entry |
else | Button | Button shown when no player has auction activity |
Placeholders:
%target%- Player name%listed%- Number of the player's listings currently on sale (not expired)%sold%- Number ofPURCHASElogs where the player is the seller%purchased%- Number ofPURCHASElogs where the player is the buyer (includes historical purchases)
Example:
players:
type: ZAUCTIONHOUSE_ADMIN_PLAYERS
slots:
- 0-44
item:
material: PLAYER_HEAD
player-head: "%target%"
name: "#2CCED2%target%"
lore:
- "#92ffffListed: #2CCED2%listed%"
- "#92ffffSold: #2CCED2%sold%"
- "#92ffffPurchased: #2CCED2%purchased%"
- ""
- "#92ffffClick to view player history"
else:
item:
material: BARRIER
name: "#ff5555No player history"
slot: 22ZAUCTIONHOUSE_ADMIN_PLAYERS_SORT
Changes the sort order of ZAUCTIONHOUSE_ADMIN_PLAYERS. Left click selects the next sort, right click the previous one.
| Order | Sort |
|---|---|
| 1 | Name (A-Z) |
| 2 | Listed (descending) |
| 3 | Sold (descending) |
| 4 | Purchased (descending) |
Placeholders:
%name-color%,%listed-color%,%sold-color%,%purchased-color%-#2CCED2for the active sort,#8c8c8cotherwise
Example:
sort:
type: ZAUCTIONHOUSE_ADMIN_PLAYERS_SORT
slot: 49
item:
material: HOPPER
name: "#2CCED2Sort players"
lore:
- "%name-color%• Name"
- "%listed-color%• Listed (descending)"
- "%sold-color%• Sold (descending)"
- "%purchased-color%• Purchased (descending)"
- "#8c8c8cLeft / right click to cycle"ZAUCTIONHOUSE_ADMIN_REMOVE_CONFIRM
Confirms the removal of the listing in the admin removal confirmation inventory, using the options chosen with the three toggle buttons below.
The removal is cluster-safe (availability check, lock, then revalidation). If the item was sold or removed in the meantime, the admin receives the admin-item-not-available message. Otherwise the admin receives admin-item-removed, an ADMIN_REMOVE log is written (visible in Admin Logs) and the main auction inventory reopens.
Requires the zauctionhouse.admin.remove.inventory permission.
Example:
confirm:
type: ZAUCTIONHOUSE_ADMIN_REMOVE_CONFIRM
slot: 21
item:
material: LIME_CONCRETE
name: "#2CCED2Confirm removal"ZAUCTIONHOUSE_ADMIN_REMOVE_NOTIFY
ZAUCTIONHOUSE_ADMIN_REMOVE_EXPIRE
ZAUCTIONHOUSE_ADMIN_REMOVE_COPY
Toggle buttons of the admin removal confirmation inventory. Each click switches the option on or off. The options are reset every time the inventory opens.
| Type | Default | When enabled |
|---|---|---|
ZAUCTIONHOUSE_ADMIN_REMOVE_NOTIFY | On | The seller receives the admin-listing-removed message. If the seller is offline, the message is delivered on their next join |
ZAUCTIONHOUSE_ADMIN_REMOVE_EXPIRE | On | The item is moved to the seller's expired items (with the normal expire-expiration duration) so they can claim it. When disabled, the listing is deleted |
ZAUCTIONHOUSE_ADMIN_REMOVE_COPY | Off | The admin receives the item: a copy when expire is on (the seller keeps theirs), the item itself when expire is off. If the item cannot be delivered, it goes back to the seller's claimable items instead of being lost |
Configuration:
| Property | Type | Description |
|---|---|---|
slot | Number | Button position |
enable-material | Material | Material used when the option is enabled (default: PAPER) |
disable-material | Material | Material used when the option is disabled (default: BARRIER) |
item | Item | Button appearance |
Placeholders:
%material%-enable-materialordisable-materialdepending on the state (use it asmaterial: '%material%')%state-color%-#55ff55when enabled,#ff5555when disabled%enabled%-trueorfalse
Example:
notify:
type: ZAUCTIONHOUSE_ADMIN_REMOVE_NOTIFY
enable-material: BELL
disable-material: BARRIER
slot: 11
item:
material: '%material%'
name: "%state-color%Notify player"
lore:
- "#8c8c8cClick to toggle"zMenu Built-in Buttons
These buttons are provided by zMenu and work in all inventories.
| Type | Description |
|---|---|
PREVIOUS | Goes to the previous page |
NEXT | Goes to the next page |
BACK | Returns to the previous inventory |
inventory | Opens another inventory |
See zMenu documentation for more details.