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

UltimateUI guide

Session & State

Retrieve details about a player's active interface state.

Access real-time session information, including active GUI names and snapshots containing mode flags like HUD, AutoClose, and Edit mode.

MethodReturnsDescription
isGuiOpen(Player)booleanChecks if the player has any GUI or HUD active.
getOpenGuiName(Player)StringReturns the name of the active GUI or null if none.
getSession(Player)UiSessionReturns an immutable snapshot of the current session details.

UiSession Object Fields#

  • getGuiName(): Name of the GUI.
  • isHudMode(): true if it's an overlay.
  • isAutoClose(): true if it handles its own termination.
  • isEditMode(): true if the session is in editor mode.