Référence de l’API
Vue d’ensemble de l’API
Comment appeler AI Core depuis un autre script - exports, événements et la lib, en TypeScript et en Lua.
Tout ce qu’un autre script peut appeler : les exports d’ai-core, les événements qu’il déclenche et les utilitaires de @aicore8/lib (les exports propres à chaque script ai-* se trouvent sur sa page, sous Scripts). Chaque signature de ces pages vient du code source (@aicore8/shared exports.ts, la JSDoc de la lib, les appels d’export de chaque script).
Choisir la bonne porte
| Vous écrivez | Utilisez |
|---|---|
| Un script ai-* ou n’importe quelle ressource TypeScript | @aicore8/lib : inventory, vehicleKeys, online, medical... La lib appelle ai-core pour vous. |
| Une ressource Lua | aiLib depuis ai-lib (shared_script '@ai-lib/init.lua'), ou directement les exports d’ai-core. |
| Un script ESX / QB / Qbox / vRP | Rien de nouveau : le pont répond à l’API propre du framework. Voir Couches et pont. |
Objets, clés de véhicule, alertes, téléphone, météo, prison, vêtements et morts passent toujours par ai-core, jamais par les exports d’un script précis : ai-core transmet au script que le serveur utilise pour cette tâche.
Appeler un export
import { resourceExport } from "@aicore8/lib/server";
// Un handle typé par ressource, en haut du fichier.
const core = resourceExport("ai-core");
const cash = core.GetMoney(source, "cash");local cash = exports['ai-core']:GetMoney(source, 'cash')- Types :
resourceExportles lit dansCitizenExportsde@aicore8/shared. Une ressource qui peut ne pas tourner utiliseoptionalExport("x")(null tant qu’elle est arrêtée). - Noms : chaque export répond aussi avec la casse de la première lettre inversée (
GetMoneyetgetMoney). - Les exports sont synchrones et renvoient de petites valeurs. Quand une valeur demande du temps (une apparence enregistrée), l’export prend un callback : aucune promesse ne franchit la frontière d’une ressource.
- Les chemins chauds suivent les événements d’ai-core au lieu d’appeler des exports en boucle (le miroir
onlinede la lib le fait).
Pages
| Page | Ce que vous y trouvez |
|---|---|
| Exports serveur d’ai-core | Chaque export serveur d’ai-core, une page par domaine : personnages, argent, métiers et gangs, objets, clés, médical, téléphone, dispatch, prison, monde, banque, factures, logs, panneau d’administration. |
| Exports client d’ai-core | Chaque export client : données du joueur, HUD, aides de touches, synchro du monde, objets, menu radial, gestes, apparence, ceinture de sécurité. |
| Événements et état | Chaque événement que déclenche ai-core avec ses arguments, les state bags, et les événements ESX / QB / Qbox / vRP que déclenche le pont. |
| Lib : serveur | @aicore8/lib/server et le côté serveur d’aiLib. |
| Lib : client | @aicore8/lib/client et le côté client d’aiLib. |
| Lib : shared et fivem | @aicore8/lib/shared et /fivem : exports, planification, state bags, lecteurs d’entrée, texte et nombres. |
| Lib pour Lua | Comment une ressource Lua utilise aiLib, et les fonctions que seul Lua possède. |
| Types | Chaque type partagé qu’utilisent les signatures (Vec3, ActionResult, InventoryRef...), champ par champ. |
| Pages des scripts | Les exports et événements propres à chaque script ai-* sont sur sa page Developer (par exemple ai-inventory, y compris les API d’ox_inventory et de qb-inventory auxquelles il répond). |