API

These are all the exports/events you can use in your other resources.

Client Export

exports.r_notify:notify(data)

Client Event

TriggerEvent('r_notify:notify', data)

Server Event

TriggerClientEvent('r_notify:notify', src, data)

  • src?: number

    • Server ID of the player you want to send the notification to.

Data

  • title?: string

    • Header contents of the notification. Will display the type if not defined.

  • content?: string

    • Message contents of the notification. This is a required field.

  • type?: 'info' or 'success' or 'warning' or 'error' or 'system'

    • Default: 'info'

  • icon?: string

    • Font Awesome Icon Name (ex. 'fas fa-check')

  • iconColor?: string

    • CSS Legal Color Values

  • duration?: number

    • Duration the notification is visible for.

  • position?: 'left' or 'right' or 'top' or 'top-left' or 'top-right'

    • Position the notification is displayed on the screen.

  • sound?: boolean

    • Enable or Disable the notification sound.

Last updated