Skip to main content
Bridge.Notify shows a toast — a small, auto-dismissing card with an icon, title, and optional description. Use it for quick feedback: an action succeeded, a purchase went through, an inventory was full. It is the only UI component available on the server. From the server you target a specific player; from the client it shows on the local screen.

Availability

Both sides also expose four shorthands: Notify.Info, Notify.Success, Notify.Warn, Notify.Error.

Signature

Bridge.Notify accepts either a plain string (with an optional type) or a payload table.
string
The bold first line. Optional, but recommended — the shorthands put their first argument here.
string
The muted second line. Optional.
string
default:"info"
One of info, success, warning, error. Picks the accent color and default icon.
number
default:"4000"
How long the toast stays, in milliseconds.
string
default:"top-center"
One of top-left, top-center, top-right, bottom-left, bottom-center, bottom-right.
string
An icon name override. Defaults to a type-appropriate icon (circle-check for success, circle-exclamation for error, etc.).
Up to 5 toasts stack at a time, newest first. A default icon is chosen from type when you omit icon.

Shorthands

Each shorthand sets the type for you. The signature is (title, description?) on the client and (src, title, description?) on the server.

Examples

Notifications honor the player’s theme accent automatically — the info type and any accent fills tint to the live atlas:theme:color. Set atlas:ui "ox" to render the same calls through ox_lib instead.