Skip to main content

Notifying Users

Creation Snippet​

local Notifications = Starlight:Notification({
    Title = "Notification",
    Icon = NebulaIcons:GetIcon('sparkle', 'Material'),
    Content = "This is the same as a paragraph, where it auto sizes.",
}, "INDEX")

This is just a snippet, not all parameters are included
Replace INDEX with a unique identifier of the instance that is not repeated.

Parameters​

Title : string
The Header of the Notification.

Content : string
A Description that shows up as additional info about the notification or the main content of it.

Icon : number NOT REQUIRED
The Icon that shows up next to the title.

Duration : number NOT REQUIRED
How long the notification is visible for.
If not set, then the notification will be visible for how long our Smart Read-times Technology sets it too based of the length of the content and title.