Configuration location#
There is no shared configuration file. Pass duration, color and animation choices to the client exports. ShowNotification defaults to 5000 milliseconds, #4a90e2, and animations enabled. A duration of 0 persists until removed. The developer-only testNotis toggle in client/main.lua defaults to false.
ShowNotification and AddBoxToNotification return notificationId, boxId. Notifications with the same main title are grouped. Keep both IDs to update or remove a box.
Exports#
The following exports are available for use in your scripts:
ShowNotification
Displays a notification with a title, message, and optional customizations.
exports['glitch-notifications']:ShowNotification(title, message, duration, color, noAnimation)
- Parameters:
title(string): The title of the notification.message(string): The main text of the notification.duration(number): Duration in milliseconds (0 for persistent).color(string): Hex color code for the title (e.g.,#ff4500).noAnimation(boolean): Iftrue, disables animations.
AddBoxToNotification
Adds a new text box to an existing notification.
exports['glitch-notifications']:AddBoxToNotification(notificationId, title, message, color, noAnimation)
- Parameters:
notificationId(number): The ID of the notification to update.title(string): The title of the notification (used for grouping).message(string): The text to add as a new box.color(string): Hex color code for the title (optional).noAnimation(boolean): Iftrue, disables animations.
RemoveBoxFromNotification
Removes a specific text box from a notification.
exports['glitch-notifications']:RemoveBoxFromNotification(notificationId, boxId)
- Parameters:
notificationId(number): The ID of the notification.boxId(number): The ID of the text box to remove.
RemoveNotification
Removes an entire notification, including all its text boxes.
exports['glitch-notifications']:RemoveNotification(notificationId)
- Parameters:
notificationId(number): The ID of the notification to remove.
UpdateBoxContent
Updates the content of a specific text box without animations.
exports['glitch-notifications']:UpdateBoxContent(notificationId, boxId, newMessage, newTitle, newColor)
- Parameters:
notificationId(number): The ID of the notification.boxId(number): The ID of the text box to update.newMessage(string): The updated text for the box.newTitle(string): The updated title for the notification (optional).newColor(string): The updated color for the title (optional).
ToggleNotification
Toggles a notification on or off.
exports['glitch-notifications']:ToggleNotification(id, title, message, color)
- Parameters:
id(number): A unique ID for the notification.title(string): The title of the notification.message(string): The main text of the notification.color(string): Hex color code for the title.