UltimateUI guide

Skript API

Description of the Skript API functionality

UltimateUI provides full support for Skript. Below you will find detailed descriptions and examples of how to use it.

Opening UIs#

Open full-screen menus or HUD overlays for single players or groups.

ini

command /menu:
	trigger:
		open ui "menu" for player

command /openhud [<text>]:
	trigger:
		open ui arg-1 with hud for player

command /animation:
	trigger:
		open ui "teleport_anim" with autoclose and hud for player

Closing UIs#

Close all active interfaces or specific pages for players.

ini

command /closeall:
	trigger:
		close ui for player

command /closeui [<text>]:
	trigger:
		close ui arg-1 for player

Checking Current UI#

Check whether the player currently has any UI open.

ini

command /check:
    trigger:
        if player has ui open:
            send "&aSuccess!"

command /checkui [<text>]:
    trigger:
        if player has ui arg-1 open:
            send "&aYes"
        else:
            send "&cNo"

Interaction Handling (Events)#

Handle player clicks on UI elements via the Java Event API.

ini

on ultimateui block click:
    set {_page} to ultimateui event page name
    set {_id} to ultimateui event block id
    set {_layer} to ultimateui event block layer

    set {_x} to ultimateui event cursor x
    set {_y} to ultimateui event cursor y
    set {_type} to ultimateui event interaction type

    send "&6&lUI Click &8| &f%{_page}%"
    send "&7ID: &e%{_id}% &8| &7Layer: &e%{_layer}%"
    send "&7Type: &b%{_type}% &8| &7Pos: &b%{_x}%, %{_y}%"

Modifying UI Elements#

These effects allow you to dynamically change element properties in real-time while a player has a UI menu or HUD overlay open. Changes are rendered instantly.

Properties#

This option allows you to change the general settings of the element on the page.

ini

# Change text
set ultimate ui element id "example_text" text to "Hello world!" for player

# Change color
set ultimate ui element id "example_text" color to "#00ff88" for player

# Change position
set ultimate ui element id "block1" position to 120, 48 for player

# Change size
set ultimate ui element id "block1" scale to 250, 250 for player

# Change item
set ultimate ui element id "example_item" item to "DIAMOND" for player

Design#

This option modifies the element, for example its visibility, border radius, item, or alignment.

ini

# Change visibility
set ultimate ui element id "example_icon" path "visibility.visible" to false for player

# Change rotation
set ultimate ui element id "block2" path "rotation" to 45 for player

# Change rounding
set ultimate ui element id "block3" path "rounding" to "large" for player

# Change HUD alignment anchor
set ultimate ui element id "scoreboard" path "anchor" to "top_right" for player

Category	Property Paths	ValueType
Transform	`x`, `y`, `width`, `height`, `rotation`, `layer`, `depth`	`Number`
Visuals	`text`, `unicode`, `color`, `opacity`, `text-wrap`	`String/Number`
Visibility	`visibility.visible`, `visibility.placeholder`	`Boolean`
Alignment	`align`, `anchor`, `hud.aligned`	`String/Boolean`
Items	`item.material`, `custom_model_data`, `enchants`, `glowing`	`String/Number/Boolean`
Pivot	`pivot.x`, `pivot.y`, `pivot.normalized`, `pivot.mode`	`Number/Boolean`
Rounding	`rounding` (small, regular, etc.), `rounding.unicode`, `rounding.unicode.[corner]`, `rounding.[corner].[x/y]`	`String`