UI

class in OpalScript

Read and write in-game UI elements by element id.

Methods

Member	Description
UI.Has	Does the current scene UI contain this exact element id?
UI.IsVisible	Read an element's own visibility flag (a hidden parent can still hide it).
UI.GetText	Read a text element or button label by element id.
UI.GetValue	Read a bar or slider value by element id.
UI.SetVisible	Show or hide a UI element during Play.
UI.SetText	Set a text element or button label and refresh its layout. Bound fields must be changed through their GameState value.
UI.SetValue	Set a bar or slider value, clamped to its current range.
UI.SetRange	Set a slider's minimum and maximum, clamping its current value. Maximum must exceed minimum.
UI.SetBar	Set a bar's value and positive maximum together.

See also

• Typed HUD bindings
• Direct UI and touch actions
• Scripts
• Scripting API