Accueil › Documentation › Exports · origen_notify

Exports · origen_notify

Tous les exports sont enregistrés sous le nom de ressource origen_notify.

Exports côté serveur

ShowNotification(pID, message, type, length)

Envoie une notification toast à un joueur précis depuis le serveur.

lua
exports["origen_notify"]:ShowNotification(source, "Your vehicle has been impounded", "warning")
Paramètre Type Description
pID number ID serveur du joueur. Ne doit pas être nil.
message string Texte affiché dans la notification.
type string | nil Style de la notification. Valeurs acceptées : "success", "warning", "error", "business". Laisse nil pour le style par défaut.
length number | nil Durée en millisecondes. 5000 par défaut si elle n’est pas indiquée.

Si pID vaut nil, l’export affiche une erreur dans la console du serveur et s’arrête immédiatement. Passe toujours un source de joueur valide.

Exports côté client

ShowNotification(message, type, timeout)

Affiche une notification toast sur l’écran du joueur local.

lua
exports["origen_notify"]:ShowNotification("You received $500", "success")
exports["origen_notify"]:ShowNotification("Low health", "warning", 8000)
Paramètre Type Description
message string Texte affiché dans la notification.
type string | nil Style de la notification : "success", "warning", "error", "business" ou nil pour le style par défaut.
timeout number | nil Durée en millisecondes. 5000 par défaut.

CreateHelp(key, text) → id

Affiche une notification d’aide avec une touche (style en bas à gauche). Renvoie un ID unique nécessaire pour la mettre à jour ou la supprimer plus tard.

lua
local id = exports["origen_notify"]:CreateHelp("E", "Press to open the shop")
Paramètre Type Description
key string Libellé de la touche affiché dans l’aide (par exemple "E", "F", "G"). Obligatoire : renvoie nil s’il est omis.
text string Texte descriptif affiché à côté de la touche.

Renvoie id (string) : identifiant unique de cette notification.

UpdateHelp(id, key, text)

Met à jour le libellé de la touche et le texte d’une notification d’aide existante.

lua
exports["origen_notify"]:UpdateHelp(id, "G", "Press to close")
Paramètre Type Description
id string ID renvoyé par CreateHelp.
key string Nouveau libellé de la touche.
text string Nouveau texte descriptif.

RemoveHelp(id)

Supprime une notification d’aide à partir de son ID.

lua
exports["origen_notify"]:RemoveHelp(id)
Paramètre Type Description
id string ID renvoyé par CreateHelp.

SetQueueMax(max)

Définit le nombre maximum de notifications toast pouvant être affichées en même temps dans la file.

lua
exports["origen_notify"]:SetQueueMax(5)
Paramètre Type Description
max number Nombre maximum de notifications simultanées dans la file.

StatusNotify(enabled)

Active ou désactive un mode de notification de statut qui met la file en pause jusqu’à sa désactivation. Utilisé en interne pour éviter que les notifications se chevauchent pendant les transitions.

lua
exports["origen_notify"]:StatusNotify(true)  -- pause queue
exports["origen_notify"]:StatusNotify(false) -- resume queue
Paramètre Type Description
enabled boolean true pour mettre la file de notifications en pause, false pour la reprendre.