Notifications

Every ai-* script shows notifications through ai-lib (notify in the lib, aiLib.notify in Lua). ai-lib draws its own cards, unless the server owner picked another notification UI in ai-core's panel (tgiann-lumihud, okokNotify, ox_lib, mythic_notify, brutal_notify). Then ai-lib hands each card to ai-core, and ai-core translates it into that UI's call.

You do not call this yourself. To show a notification, use the lib's notify(text, kind, duration) or aiLib.notify(text, kind, duration): they pick the right UI. This page exists so you know what the export does when you see it.

ExternalNotifyCopy Anchor Link

Shows one ai-lib notification card in the notification UI the panel picked. ai-lib calls it for every card while a third-party UI is picked.

Side: Client · Waits: no

ExternalNotify(notification: Notification): boolean

local shown = exports['ai-core']:ExternalNotify({ text = 'Saved', kind = 'success' }) -- boolean

ParametersCopy Anchor Link

NotificationCopy Anchor Link

ReturnsCopy Anchor Link

boolean: true when a third-party UI was picked, runs, and got the card. false when the card has no text, or when no third-party UI is picked or running: then ai-lib draws the card itself.

ExampleCopy Anchor Link

import { notify } from "@aicore-fivem/lib/client";
import { Locale } from "common";

// The right way to notify: ai-lib calls ExternalNotify for you when a third-party UI is picked.
RegisterCommand("saved", () => notify(Locale("SAVED"), "success", 3000), false);