Notify
Exports
All client- & serversided exports included within this script. Exports provide callable functions that allow other resources to interact with this script's functionality.
If additional exports are required for your implementation, please submit a formal request through our ticketing system on the official Discord server.
Client Exports
Notify
Displays a notification to the player with customizable options.
exports['RxNotify']:Notify(title, text, type, length, options)
title
string
Title of the notification. If nil, the default title from config will be used based on the type.
text
string
Message text to display in the notification.
type
'success' | 'error' | 'info' | 'warn'
Type of notification. Determines the color and icon. Defaults to 'info'.
length
number
Duration in milliseconds to display the notification. Defaults to Config.DefaultDisplayTime (3000ms).
options
table
Optional table with additional settings:
confetti(boolean): Trigger confetti effect when notification appearsposition('tl' | 'tc' | 'tr' | 'lc' | 'rc' | 'bl' | 'bc' | 'br'): Override default position for this notification
Examples
client.lua
// Basic notification
exports['RxNotify']:Notify("Success", "Action completed successfully!", "success")
// Notification with custom duration
exports['RxNotify']:Notify("Warning", "Be careful!", "warn", 5000)
// Notification with confetti
exports['RxNotify']:Notify("Achievement!", "You did it!", "success", 5000, { confetti = true })
// Notification with custom position
exports['RxNotify']:Notify("Alert", "Check top right!", "info", 4000, { position = 'tr' })
// Notification with confetti and custom position
exports['RxNotify']:Notify("Party!", "Top center celebration!", "success", 6000, {
confetti = true,
position = 'tc'
})
// Using default title
exports['RxNotify']:Notify(nil, "This will use the default 'Error' title", "error")
Server Exports
No server-sided exports available at this time.