UI shows on-screen toasts and HUD labels.
On Scripts, calls affect everyone in the place.
On LocalScripts, Notify and Hud affect only the local client. Clear is Script-only.
Available as the global UI.
Overview
Methods
- :Notify(text: string, seconds: number?)
- .notify(text: string, seconds: number?) deprecated
- :Hud(text: string, seconds: number?)
- .hud(text: string, seconds: number?) deprecated
- :Clear()
- .clear() deprecated
API
Methods
Notify
Notify(text: string, seconds: number?) : void
Shows a center toast.
Default duration is about 3 seconds.
For one player from a Script, prefer `Player:Notify`.
notify
notify(text: string, seconds: number?) : void deprecated
Identical to Notify.
No longer recommended for use.
Hud
Hud(text: string, seconds: number?) : void
Shows a top HUD label.
Default duration is about 8 seconds. Pass 0 to keep it until Clear or a replacement.
For one player from a Script, prefer `Player:Hud`.
hud
hud(text: string, seconds: number?) : void deprecated
Identical to Hud.
No longer recommended for use.
Clear
Clear() : void
Clears toast and HUD for everyone. Scripts only.
For one player, use `Player:ClearUI`.
clear
clear() : void deprecated
Identical to Clear.
No longer recommended for use.
