cMenu - Notifications

cMenu - Notifications is a notification list that appears on the right side of the screen.

Installation

  • Install the cMenu - Notifications package
  • Place the template either on the user or the player
    • If you’re using other cMenu packages, playing this next to the other ones on the player makes the most sense

Usage

To add a notification to the list, call cMenuNotificationsScript:AddNotification(options)
Options:

  • title - Text displayed on the top of the notification
  • subtitle - text displayed just below the title, slightly faded out
  • imageUrl - If you want to display an image with along with the message, include the URL here
  • quantity - Quantity is placed on the bottom right of the image.

cMenu - Notifications can display multiple notifications at once. The number of notifications displayed is dependent on the height of the container. If you want to display more or less notifications, simply use the handles on the widget to make it taller or shorter.

There is 1 property on cMenuNotificationsWidget - fullNotificationsDelay. When the notification list is full, this controls how long the notifications will persist before being removed and allowing another notification be displayed.
If notifications aren’t coming in quickly, it also controls how long a single notification takes to disappear.

Example

This is how cMenu - Inventory calls this script:

self.notificationsScript:AddNotification({
  imageUrl = self:GetIcon(template),
  quantity = count - (self.lastInventory[template] or 0),
  title = "Item Received",
  subtitle = self:GetName(template)
})

Media

1 Like
  • added an “accent” option that will display a color on the left side of the notification if specified
  • added backwards compatibility for the Notification package, if AddNotification is called with a string or string, values properties, the notification will properly handle the input and display the notification on the right side of the screen
  • Fixed a problem where if you add >1 notification within 500ms of each other, the last notification will repeatedly slide in