GUI Values

skript-gui provides many additional values that can be used within some or all GUI sections. Each available value is described below.

Note

Many of these values are available through vanilla Skript.
However, they have remained in skript-gui over the years for compatibility.

Slot

Available In: GUI Make
Pattern: [the] gui slot

This is the index of the slot that was clicked. This index is relative to the inventory that was clicked.

Raw Slot

Available In: GUI Make
Pattern: [the] gui raw slot

This is the raw index of the slot that was clicked. This index is relative to the entire inventory view (both the top and bottom inventories).

Hotbar Slot

Available In: GUI Make
Pattern: [the] gui hotbar slot

This value is available when the click type is number key. It returns the index of the pressed key (between 0 and 8).

Inventory

Available In: GUI Make, GUI Open/Close
Pattern: [the] gui inventory

This is the inventory that was clicked in, opened, or closed.

Inventory Action

Available In: GUI Make
Pattern: [the] gui inventory action

This is the action that triggered the click. See the SkriptLang documentation for more information: https://docs.skriptlang.org/docs.html?search=#inventoryaction

Click Type

Available In: GUI Make
Pattern: [the] gui click (type|action)

This is the type of click that was performed. See the SkriptLang documentation for more information: https://docs.skriptlang.org/docs.html?search=#clicktype

Cursor Item

Available In: GUI Make
Pattern: [the] gui cursor [item]

This is the item the player has on their cursor at the time of the click.

Clicked Item

Available In: GUI Make
Pattern: [the] gui [clicked|current] item

This is the item in the slot that was clicked. This value may be changed (set).

Slot Type

Available In: GUI Make
Pattern: [the] gui slot type

This is the type of slot that was clicked. These values are defined by skript-gui:

armor, armour, container, crafting, fuel, outside, quickbar, quick bar, hotbar, hot bar, bottom row, result, crafting result, smelting result

Player

Available In: GUI Make, GUI Open/Close
Pattern: [the] gui player

This is the player that clicked, opened the inventory, or closed the inventory.

Viewers

Available In: GUI Make, GUI Open/Close
Pattern: [the] gui (player|viewer)s

These are the viewers of the inventory involved.

Slot ID

Available In: GUI Make
Pattern: [the] gui slot id

This is the ID (single character text) in the gui's layout that was interacted with.

GUI

Available In: GUI Creation, GUI Make, GUI Open/Close
Pattern: [the] gui

This is the GUI being interacted with.