DocsNotify

Exports and events

Send notifications from client and server scripts.

Not released yet. These pages are written from the code of manniche_notify and can change before the release.

Client export

Call from a client script. A plain string is accepted and used as the description.

exports.manniche_notify:notify({
    title = 'Bank',
    description = 'Paid $250',
    type = 'success',
    duration = 4000,
    position = 'top-right',
    id = 'bank',
})
FieldDefaultWhat it does
titlenoneOptional heading.
descriptionnoneMessage text. message is accepted as an alias.
type'info'info, success, warning or error. Aliases: inform, primary, default map to info; warn to warning; danger to error. Unknown values become info.
durationConfig.durationMilliseconds, limited to 1000 to 30000. length is accepted as an alias.
positionConfig.positionOne of the eight positions. Unknown values use the config.
idnoneA new message with the same id replaces the old one.

Server export

Pass the player's server id, or -1 for everyone, then the same table.

exports.manniche_notify:notify(source, { description = 'Welcome', type = 'info' })

Client event

manniche_notify:notify takes the same table. The server export triggers it. A player who triggers it on their own client only shows themselves a message.

ESX hooks

When Config.replaceEsx is on and esx_notify is not started, the client also answers the esx_notify Notify export and the ESX:Notify event. ESX's position is ignored so all messages line up in one spot.