Notifications

notification

Use Library:Notify() for quick, non-blocking feedback. Notifications support:

Choose between positional arguments for quick calls or a configuration table for full control.

Library:Notify("Hello world!", 4)

Arg Idx	Argument Description	Type	Default
1	Description of the notification	string	"nil"
2	Amount of time to show the notification for	number \| instance	4
3	SoundId to play when the notification is shown	number	nil

Pick an example that matches your use case:

Library:Notify({
    Title = "mspaint",
    Description = "Hello world!",
    Time = 4,
})

Prop

Type

Update the notification title without recreating it.

Notification:ChangeTitle("New Title")

Arg Idx	Argument Description	Type	Default
1	New title of the notification	string	nil

Refresh the supporting text while keeping the notification open.

Notification:ChangeDescription("New Description")

Arg Idx	Argument Description	Type	Default
1	New description of the notification	string	nil

Advance or rewind the progress bar when using step-based notifications.

Notification:ChangeStep(5)

Arg Idx	Argument Description	Type	Default
1	New step of the progress notification	number	nil

Immediately dismiss the notification and free its resources.

Notification:Destroy()