UgLib.Notify

Client Through ug-lib.

UgLib.Notify.Show(options) -> id
UgLib.Notify.Update(id, options) -> boolean
UgLib.Notify.Dismiss(id) -> boolean
UgLib.Notify.DismissAll() -> integer

string

required

1 to 1024 characters. Takes the markup.

string

Up to 128 characters.

UgNotifyType

default:"Info"

UgNotifyStyle

default:"Toast"

Compact is one line, Banner is wide and defaults to the top of the screen.

UgPosition

Defaults to settings.notifyPosition.

integer

ms, 0 to 600000. 0 stays until dismissed. Defaults to settings.notifyDuration.

UgIcon

Replaces the type icon.

string

1 to 32 letters, digits or _ - . :, not starting with #. Showing an id that is on screen updates it and restarts its timer.

Without id, the returned id is generated, such as #3. Use it with Update and Dismiss.
Update changes fields of a notification on screen and restarts its timer. It returns false when it is gone.
DismissAll closes the notifications of your resource only.
At most settings.notifyMax (default 5) per anchor. The oldest leave first.
Notifications are client only. To notify from the server, see Using ug-lib with UgCore.

Markup

**bold**, *italic*, and ~token~ colors the rest of the text until ~reset~. Tokens: primary, success, warning, destructive, muted. HTML is shown as text.

Example

client.lua

UgLib.Notify.Show({
    title = 'Bank',
    message = 'Received ~success~**$500**~reset~ from Bob.',
    type = UgLib.Enums.NotifyType.Success,
})

UgLib.Notify.Show({ id = 'fuel', message = 'Fuel low: 9%', style = UgLib.Enums.NotifyStyle.Compact })

Getting started

UI

Client utilities

Shared utilities

Markup

Example

​Markup

​Example

Markup

Example