ai-lib for developers

ai-lib carries @aicore-fivem/lib for resources that do not bundle the npm package. The functions themselves are documented once, in the lib reference:

• The lib: overview
• Lib: client functions
• Lib: server functions
• Lib: shared functions
• Lua (aiLib): the Lua twins and their argument order

Loading itCopy Anchor Link

fx_version 'cerulean'
game 'gta5'
lua54 'yes'

dependency 'ai-lib'
shared_script '@ai-lib/init.lua'
client_script 'client.lua'
server_script 'server.lua'

local L = aiLib.locale()
aiLib.notify(L('WELCOME'), 'success')

Client exportsCopy Anchor Link

The lib's notify, progress, showPrompt, menu, input, skillCheck and lockpick call these for you; use the lib functions. They are typed AiLibClientExports in @aicore-fivem/shared (resourceExport("ai-lib")). Prompts, menus and zones belong to the calling resource and go when it stops.

NotifyCopy Anchor Link

Shows a notification card on this player's screen.

Side: Client · Waits: no

Notify(notification: Notification): void

exports['ai-lib']:Notify({ text = 'Saved', kind = 'success' })
-- the same through the lib: aiLib.notify('Saved', 'success')

NotificationCopy Anchor Link

ReturnsCopy Anchor Link

Nothing. A notification without text is dropped. When the owner picked another notification script in the panel, the card goes there; if that script does not take it, ai-lib draws it.

ExampleCopy Anchor Link

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

notify("Your vehicle was stored", "success", 5000);

import { notify, onClientEvent } from "@aicore-fivem/lib/server";

// The same card on one player's screen, sent from the server.
onClientEvent("myscript:collectPay", (source) => {
  notify(source, "You were paid $500", "info");
});

ShowProgress and HideProgressCopy Anchor Link

Shows the progress bar for a time, or hides it. Only the bar: the calling script runs the action, its animation and the cancel logic. Use lib progress (client) or progressFor (server) instead, which do all of that.

Side: Client · Waits: no

ShowProgress(label: string, duration: number): void
HideProgress(): void

While the bar shows, the cancel key (Backspace) fires the local event ai-lib:client:cancelProgress.

ShowPrompt and HidePromptCopy Anchor Link

Shows or updates one of the calling resource's prompts, or hides it. Use lib showPrompt / hidePrompt, or better lib Points, which shows and hides prompts by distance for you.

Side: Client · Waits: no

ShowPrompt(id: string, text: string, at?: PromptAnchor): void
HidePrompt(id: string): void

When the player presses the interaction key while your prompt is on top, the local event ai-lib:client:promptPressed (resource, id) fires; lib onPromptPressed filters it for your resource.

CloseDialogCopy Anchor Link

Closes the calling resource's open menu or input dialog. The waiting menu.show / input call answers null, as if the player closed it. Side: Client · Waits: no.

CloseDialog(): void

Plumbing exportsCopy Anchor Link

These are used by the lib's own functions. You do not call them.

EventsCopy Anchor Link

// Server: a notification without the lib.
emitNet("ai-lib:client:notify", source, { text: "Welcome to the city", kind: "info", duration: 6000 });