UltimateUIDocs
Archived upstream docs · Features depend on the installed plugin version; not all features have been verified.

UltimateUI guide

Opening UIs

Open Cursor UIs or HUD overlays for players.

Control the player's visual experience by launching either full-screen interactive menus or non-intrusive overlays, supporting both single and bulk player operations.

MethodReturnsDescription
openGui(Player, String)booleanOpens a full-screen menu with a cursor.
openGui(Player, String, boolean autoClose)booleanOpens a menu that closes after its animation ends.
openGuiHud(Player, String)booleanOpens a HUD overlay (player can still move).
openGuiHud(Player, String, boolean autoClose)booleanOpens a HUD that closes after its animation ends.
openGui(Player, String, boolean hud, boolean auto)booleanGeneric method to specify both HUD and AutoClose flags.
openGui(Iterable, String, ...)intBulk variants of the above. Returns the count of successful opens.