Buttons

Buttons are the basic foundation of the plugin, they are very important to be able to manage your configuration. Here you have all available button types and an example of their use.
Button types:
NONE
NONE_SLOT
BACK
HOME
PREVIOUS
NEXT
INVENTORY
PERFORM_COMMAND
AUCTION_ITEM
BUY_INVENTORY
SHOW_ITEM
REMOVE_ITEM
BUY_ITEM
CHANGE_SORT
CATEGORIES
REMOVE_ALL
SELL_INVENTORY_SLOT
SELL_INVENTORY_ACCEPT
SELL_INVENTORY_CANCEL
CLAIM
​
Default
Here is the information that is valid for all button types.
type Sets the type of the button.
slot Sets the button slot.
isPermanent Allows you to set a button as permanent, so the paging system will not take this button into account (you must set the value to true).
item Allows you to define the item to be displayed (Add an item)
permission Allows you to give permission to the.
elseMessage Allows you to send a message to the user when they do not have permission to click a button.
else Displays another button if the user does not have permission.
action Allows you to choose the formula for the verification with place holder, you have SUPERIOR, LOWER, SUPERIOR_OR_EQUAL, LOWER_OR_EQUAL, EQUALS_STRING and EQUALSIGNORECASE_STRING
placeHolder Allows to check an API placeholder variable
value Allows you to set the value for placeholder verification
sound Allows you to have a sound when the player clicks on the button. You have the list of sounds available here: XSound
volume Changing the sound volume
pitchChanging the sound pitch
Example:
1
block: 
2
  item:
3
    material: GRASS_BLOCK
4
    name: "&aBlocks"
5
    lore:
6
      - "&7Click to access the blocks"
7
  type: INVENTORY
8
  inventory: "blocks"
9
  slot: 20
10
  sound: BLOCK_NOTE_BLOCK_PLING
11
  volume: 1.3f
12
  pitch: 0.8f
Copied!
NONE
Description:
This type allows you to display a single item, no interaction is possible.
Example:
1
example:
2
  item:
3
    material: GRASS_BLOCK
4
    name: "&cRandom name"
5
  type: NONE
6
  slot: 0
Copied!
NONE_SLOT
Description:
The type with the same works as the NONE type but allows to display the same item on several slots. Example:
1
slots:
2
  type: NONE_SLOT
3
  item:
4
    material: GRAY_STAINED_GLASS_PANE
5
    name: "&e"
6
  slots:
7
    - 0
8
    - 1
9
    - 2
10
    - 3
11
    - 4
12
    - 5
13
    - 6
14
    - 7
15
    - 8
Copied!
slots Set button slots.
BACK
Description:
Returns to the previous inventory.
Example:
1
back:
2
  item:
3
    material: BARRIER
4
    name: "&cBack"
5
  type: BACK
6
  slot: 49
Copied!
HOME
Description:
Returns to the main inventory.
Example:
1
home:
2
  item:
3
    material: BARRIER
4
    name: "&eHome"
5
  type: HOME
6
  slot: 49
Copied!
PREVIOUS
Description:
Returns to the previous page
Example:
1
previous:
2
  type: PREVIOUS
3
  isPermanent: true
4
  slot: 48
5
  item:
6
    material: ARROW
7
    name: "&fPrevious"
8
  else: #Displays another button if there is no previous page.
9
    slot: 48
10
    type: PREVIOUS
11
    isPermanent: true
12
    item:
13
      material: AIR
Copied!
NEXT
Description:
Go to the next page
Example:
1
next:
2
  type: NEXT
3
  isPermanent: true
4
  slot: 50
5
  item:
6
    material: ARROW
7
    name: "&fNext"
8
  else: #Displays another button if there is no next page.
9
    slot: 50
10
    type: NEXT
11
    isPermanent: true
12
    item:
13
      material: AIR
Copied!
INVENTORY
Description:
Allows you to move between inventories. Please note that you can only move between inventories with a default type, otherwise you may get errors.
Example:
1
block:
2
  item:
3
    material: GRASS_BLOCK
4
    name: "&aBlocks"
5
    lore:
6
      - "&7Click to access the blocks"
7
  type: INVENTORY
8
  inventory: "blocks"
9
  slot: 20
Copied!
Value:
inventory Allows you to define the name of the inventory to which you want to go.
​
PERFORM_COMMAND
Description:
Allows the player to execute commands. And thus to navigate in the inventories of other plugin for example
Example:
1
commands:
2
  type: PERFORM_COMMAND
3
  item:
4
    material: EMERALD
5
    name: "&eClick for execute command"
6
  slot: 30
7
  commands:
8
    - "bc %player% est vraiment trop beau"
9
  closeInventory: true
Copied!
Value:
commands List of commands that will be executed by player.
consoleCommands List of commands that will be executed by console.
closeInventory Allows you to close the inventory before the commands are executed.
consolePermissionCommands Allows commands to be executed at the console only if the player has permission.
consolePermission Permission for the list above
AUCTION_ITEM
Description:
Allows you to display the list of items in an inventory.
Example:
1
slots:
2
  type: NONE_SLOT
3
  item:
4
    material: GRAY_STAINED_GLASS_PANE
5
    name: "&e"
6
  slots:
7
    - 0
8
    - 1
9
    - 2
10
    - 3
11
    - 4
12
    - 5
13
    - 6
14
    - 7
15
    - 8
Copied!
CLAIM
Description:
Allows to display the list of intems according to the inventory.
Example:
1
claim:
2
  type: CLAIM
3
  isPermanent: true
4
  slot: 51
5
  else:
6
    type: NONE
7
    item:
8
      material: MINECART
9
      name: "&fClaims money"
10
      lore:
11
        - "&f» &7You have no money on hold"
12
  item:
13
    material: HOPPER_MINECART
14
    name: "&aClaims money"
15
    lore:
16
      - "&f» &7You have &d%zauctionhouse_claim_vault%amp;7 to claim"
Copied!
slots Set button slots.
SELL_INVENTORY_SLOT
Description:
Allows the list of items contained in an AuctionItem of inventory type. Can only be used in the SELL_SHOW and SELL inventory type.
Example:
1
items:
2
  type: SELL_INVENTORY_SLOT
3
  slots:
4
    - 10
5
    - 11
6
    - 12
7
    - 13
8
    - 14
9
    - 15
10
    - 16
11
    - 19
12
    - 20
13
    - 21
14
    - 22
15
    - 23
Copied!
slots Set button slots.
SELL_INVENTORY_ACCEPT
Description:
Allows you to accept the sale of an inventory. Can only be used in the SELL inventory type.
Example:
1
accept:   
2
  type: SELL_INVENTORY_ACCEPT
3
  slot: 50
4
  item:
5
    material: GREEN_STAINED_GLASS_PANE
6
    name: "&fSell content"
Copied!
SELL_INVENTORY_CANCEL
Description:
Allows you to cancel the sale of an inventory. Can only be used in the SELL inventory type.
Example:
1
cancel:
2
  type: SELL_INVENTORY_CANCEL
3
  slot: 48
4
  item:
5
    material: RED_STAINED_GLASS_PANE
6
​
7
    name: "&fCancel"
Copied!
SELL_INVENTORY_BUY
Description:
Allows you to purchase inventory directly from the SELL_SHOW inventory. Can only be used in the SELL_SHOW inventory type.
Example:
1
buy:
2
  type: SELL_INVENTORY_BUY
3
  slot: 48
4
  item:
5
    material: GREEN_STAINED_GLASS_PANE
6
    name: "&fBuy for &b%zauctionhouse_price% %zauctionhouse_currency%"
Copied!
CHANGE_SORT
Description:
Allows you to change the sort type for items, usable only in the AUCTION inventory type.
Example:
1
informations:
2
  type: CHANGE_SORT
3
  slot: 49
4
  isPermanent: true
5
  item:
6
    material: NETHER_STAR
7
    name: "&fInformations"
8
    lore:
9
      - "&7&m-------------------------------------"
10
      - "&f&l» &7Welcome to the auction house"
11
      - "&f&l» &7it's a market where all the players"
12
      - "&f&l» &7can sell or buy items."
13
      - ""
14
      - "&f&l» &7To be able to sell items you must do"
15
      - "&f&l» &a/ah sell &7<&aprice&7> &8[&7<&fnumber of items&7>&8]"
16
      - ""
17
      - "&f&l» &7Number of items available&7: &b%zauctionhouse_counts%"
18
      - "&f&l» &7Sort type&7: &b%zauctionhouse_sorting%"
19
      - "&f&l» &7Click to &bchange &7the sort type"
20
      - "&7&m-------------------------------------" 
Copied!
REMOVE_ALL
Description:
Allows you to remove all items that are in the ITEMS, EXPIRE and BUYING inventory.
Example:
1
removeall:
2
  type: REMOVE_ALL
3
  isPermanent: true
4
  item:
5
    material: BLUE_STAINED_GLASS_PANE
6
    name: "&cRemove all"
7
  slot: 45
Copied!
CATEGORIES
Description:
Displays a button to access a category. Can only be used in the CATEGORIES inventory.
Example:
1
block:
2
  type: CATEGORIES
3
  category: "blocks"
4
  item:
5
    material: GRASS_BLOCK
6
    name: "&fCategory: Block"
7
    lore:
8
      - "&f» &7There are &b%zauctionhouse_category_item_blocks% &7items in the blocks category."
9
  slot: 20
10
weapons:
11
  type: CATEGORIES
12
  category: "weapons"
13
  slot: 21  
14
  item:
15
    material: DIAMOND_SWORD
16
    name: "&fCategory: Weapons"
17
    lore:
18
      - "&f» &7There are &b%zauctionhouse_category_item_weapons% &7items in the blocks weapons."
Copied!
category Allows you to give the name of the category to be opened.
BUY_ITEM
Description:
Allows to confirm the purchase of an item, usable only in the inventory BUY_CONFIRM.
Example:
1
buy1:
2
  type: BUY_ITEM
3
  item:
4
    material: GREEN_STAINED_GLASS_PANE
5
    name: "&aBuy"
6
  slot: 1
Copied!
REMOVE_ITEM
Description:
Allows you to confirm the cancellation of the sale of the item, usable only in the inventory REMOVE_CONFIRM.
Example:
1
remove1:
2
  type: REMOVE_ITEM
3
  item:
4
    material: GREEN_STAINED_GLASS_PANE
5
    name: "&aRemove"
6
  slot: 1  
Copied!
SHOW_ITEM
Description:
Displays the item to be purchased or remove, usable only in the inventory REMOVE_CONFIRM and BUY_CONFIRM.
Example:
1
show:
2
  type: SHOW_ITEM
3
  slot: 13
Copied!
Inventories - Previous
Inventories
Next - Inventories
Items
Last modified 1yr ago