Client Exports
Notification
--- @param data {table}
--- @field title {string?} Title. (Optional)
--- @field description {string?} Description. (Optional)
--- @field time {number?} Display time in milliseconds. (Optional)
--- @field color {string?} Notification color in HEX format, such as "#34ebe8". (Optional)
--- @field icon {string?} An icon class from Font Awesome, such as “fa-solid fa-check”. (Optional)
--- @field image {string?} URL of the image displayed. (Optional)
--- @field progressBar {string?} Progress bar type: "linear", "rounded", "rounded-icon". (Optional)
--- @field preset {string?} Name of the predefined preset from Config.NotificationsPresets. (Optional)
--- @field soundFile {string?} The name of the audio file, such as "notification-1.mp3". (Optional)
--- @field soundVolume {number?} Sound volume (range: 0-100). (Optional)
--- @field soundNative {table?} An array of native sound data that takes priority over soundFile. (Optional)
--- @field customCSS {table?} CSS style board for custom notification design. (Optional)
--- @field customCSS.icon {table} Icon styling, such as color or scaling.
--- @field customCSS.title {table} Title styling, such as font or size.
--- @field customCSS.description {table} Stylization of the description, such as font thickness.
--- @field customCSS.background {table} Background styling, such as color and border.
--- @field customCSS.background_glow {table} Styling the background glow effect.
exports['vms_notifyv2']:Notification(data)
TopNotification
--- @param data {table}
--- @field title {string?} Title. (Optional)
--- @field description {string?} Description. (Optional)
--- @field time {number?} Display time in milliseconds. (Optional)
--- @field color {string?} Notification color in HEX format, such as "#34ebe8". (Optional)
--- @field icon {string?} An icon class from Font Awesome, such as “fa-solid fa-check”. (Optional)
--- @field image {string?} URL of the image displayed. (Optional)
--- @field progressBar {string?} Progress bar type: "linear" or nil. (Optional)
--- @field soundFile {string?} The name of the audio file, such as "notification-1.mp3". (Optional)
--- @field soundVolume {number?} Sound volume (range: 0-100). (Optional)
--- @field soundNative {table?} An array of native sound data that takes priority over soundFile. (Optional)
exports['vms_notifyv2']:TopNotification(data)
Question
--- @param data {table}
--- @field title {string?} Title. (Optional)
--- @field description {string?} Description. (Optional)
--- @field color {string?} Notification color in HEX format, such as "#34ebe8". (Optional)
--- @field icon {string?} An icon class from Font Awesome, such as “fa-solid fa-check”. (Optional)
--- @field image {string?} URL of the image displayed. (Optional)
--- @field preset {string?} Name of the predefined preset from Config.QuestionsPresets. (Optional)
--- @field soundFile {string?} The name of the audio file, such as "notification-1.mp3". (Optional)
--- @field soundVolume {number?} Sound volume (range: 0-100). (Optional)
--- @field soundNative {table?} An array of native sound data that takes priority over soundFile. (Optional)
--- @field customCSS {table?} CSS style board for custom notification design. (Optional)
--- @field customCSS.icon {table} Icon styling, such as color or scaling.
--- @field customCSS.title {table} Title styling, such as font or size.
--- @field customCSS.description {table} Stylization of the description, such as font thickness.
--- @field customCSS.background {table} Background styling, such as color and border.
--- @field customCSS.background_glow {table} Styling the background glow effect.
--- @param keys {table?}
local question = exports['vms_notifyv2']:Question(data, keys)
ShowTextUI
--- @param message {string} Message
--- @param data {table?}
--- @field preset {string?} Name of the predefined preset from Config.QuestionsPresets. (Optional)
--- @field soundFile {string?} The name of the audio file, such as "notification-1.mp3". (Optional)
--- @field soundVolume {number?} Sound volume (range: 0-100). (Optional)
--- @field soundNative {table?} An array of native sound data that takes priority over soundFile. (Optional)
--- @field customCSS {table?} CSS style board for custom notification design. (Optional)
--- @field customCSS.key {table} Key styling, such as font or size.
--- @field customCSS.message {table} Stylization of the message, such as font thickness.
--- @field customCSS.background {table} Background styling, such as color and border.
exports['vms_notifyv2']:ShowTextUI(message, data)
UpdateTextUI
--- @param message {string} Message
exports['vms_notifyv2']:UpdateTextUI(message)
HideTextUI
exports['vms_notifyv2']:HideTextUI()
Last updated
Was this helpful?