Creating a GUI

Creating a new GUI

Creates a new GUI and puts it in the result of the expression last created GUI

create [a] [new] gui with %inventory% [(and|with) ([re]move[e]able|stealable) items] [(and|with) shape %strings%]

Example

create a gui with chest inventory with 3 rows named "My GUI":
  #do some stuff
open last created gui to player

empty gui

The last argument allows you to use prepared templates for the arrangement of interactive elements. For example, if we open the funnel inventory, we can specify the template “xxixx”, and then, when creating the element “x”, the first, second, fourth and fifth slots will be with this element.

Example

create a gui with chest inventory with 3 rows named "My GUI" with shape "xxxxxxxxx","x-------x","xxxxxxxxx":
  make gui slot "x" with dirt
open last created gui to player

gui shape

Edit an already created GUI

Allows you to redefine interactive elements inside an already created GUI

(change|edit) [gui] %gui%

Create an interactive element

When you click on this element, the code inside the section will be executed. The expression below creates an interactive element on the next empty inventory slot.

(make|format) [the] next gui [slot] (with|to) [([re]mov[e]able|stealable)] %itemtype%

The following expression allows you to specify the value from the template or the slot number to create the element.

(make|format) gui [slot[s]] %strings/numbers% (with|to) [([re]mov[e]able|stealable)] %itemtype%

create a gui with chest inventory with 3 rows named "My GUI":
  make gui slot 1 with stone named "Click for hello world!":
    broadcast "Hello world!"

Delete an interactive element

(un(make|format)|remove) [the] next gui [slot]

(un(make|format)|remove) gui [slot[s]] %strings/numbers%

(un(make|format)|remove) all [[of] the] gui [slots]

When opening the GUI

The code inside this section will be executed after opening the GUI to the player.

run (when|while) open[ing] [[the] gui]

run (when|while) [the] gui opens

run on gui open[ing]

When closing the GUI

The code inside this section will be executed after the GUI is closed by the player.

run (when|while) clos(e|ing) [[the] gui]

run (when|while) [the] gui closes

run on gui clos(e|ing)

Last created GUI

Returns the last GUI created/modified

[the] last[ly] [(created|edited)] gui

PROCESSING THE RESULTS

The player’s open GUI

Returns the currently open GUI of the player

%players%'s gui

gui of %player%'s

Check whether any GUI is open or not for the player

%players% (has|have) a gui [open]

%players% do[es](n't| not) have a gui [open]

The next GUI slot

Returns the number or letter of the template of the next GUI slot

%guis%'[s] next gui slot[s]

[the] next gui slot[s] of %guis%

[the] next gui slot

The name GUI inventory

%gui%'s gui(-| )name

gui(-| )name of %gui%

GUI Inventory Size

%gui%'s gui(-| )size

gui(-| )size of %gui%

GUI Template

%gui%'s gui(-| )shape

gui(-| )shape of %gui%

The ability to take items in the GUI

%gui%'s gui(-| )lock(-| )status

gui(-| )lock(-| )status of %gui%

Current, editable GUI

[the] gui

Clicked Slot

[the] gui(-| )raw(-| )slot

The hotkey of the clicked slot

[the] gui(-| )hotbar(-| )slot

GUI inventory that is being edited

[the] gui(-| )inventory

Action inside the GUI

For example, a player made a double click, which caused things to gather in the cursor slot.

[the] gui(-| )inventory(-| )action

Type of click

For example, a player made a click with the Shift key held down.

[the] gui(-| )click(-| )(type|action)

Cursor slot

[the] gui(-| )cursor[(-| )item]

The type of clicked slot

[the] gui(-| )slot(-| )type

The clicked item

[the] gui[(-| )(clicked|current)](-| )item

The expression used instead of the player inside the GUI section

[the] gui(-| )player

Players who have a GUI open

[the] gui(-| )(viewer|player)s

ID of the clicked slot

[the] gui(-| )slot(-| )id

Cancel the closure

Prohibits the player from closing the GUI by reopening it while preserving the GUI parameters

cancel [the] gui clos(e|ing)

Allow closure

Allows the player to close the GUI

uncancel [the] gui close(e|ing)