Exports serveur
Comment appeler les exports serveur d’ai-core depuis Lua et TypeScript, et la liste de chaque groupe d’exports.
ai-core est la ressource du framework. Les autres ressources lui demandent le personnage, l’argent, les métiers et les objets d’un joueur, et lui confient du travail comme « donne une clé à ce joueur » ou « envoie une alerte police ». Elles le font via des exports : des fonctions qu’ai-core rend appelables depuis n’importe quelle autre ressource du serveur.
Ces pages listent chaque export serveur qu’enregistre ai-core, regroupés par thème. Chaque entrée montre ce que fait l’export, sa signature exacte, chaque paramètre, ce qu’il renvoie dans chaque cas, et un exemple fonctionnel en TypeScript et en Lua.
Appeler un export
Un export s’appelle par le nom de la ressource qui le possède (ai-core) et le nom de l’export.
import { resourceExport } from "@aicore8/lib/server";
// Un handle typé par fichier, en haut. C’est sûr ici : FiveM recherche chaque
// export à la première utilisation et l’oublie quand ai-core redémarre.
const core = resourceExport("ai-core");
export function cashOf(source: number): number {
return core.GetMoney(source, "cash") ?? 0;
}Ce qu’il faut savoir avant de commencer :
- Types TypeScript.
resourceExport("ai-core")est typé depuisAiCoreServerExportsdans@aicore8/shared, si bien que votre éditeur connaît chaque nom, paramètre et type de retour. N’écrivez jamaisresourceExport("ai-core").GetMoney(...)dans une fonction : gardez l’unique handle en haut du fichier. - Lua utilise deux-points. Écrivez
exports['ai-core']:GetMoney(source, 'cash'), pas un point. Une réponsenullarrive en Lua commenil, un tableau comme une liste Lua (index 1 en premier), un objet comme une table. - Deux orthographes. Chaque export répond aussi avec la casse de la première lettre inversée :
GetMoneyetgetMoneysont la même fonction. - Les exports n’attendent jamais. Chaque export répond tout de suite avec une petite valeur. Quand la réponse a besoin de la base de données (une apparence enregistrée, une liste de factures), l’export prend un callback
doneau lieu de renvoyer une Promise, car une Promise ne peut pas passer d’une ressource à une autre. - Pas dans les chemins chauds. Un appel d’export copie ses arguments et sa réponse. N’appelez pas d’exports à chaque frame ni pour chaque joueur dans une boucle. Pour « qui est en service », le nom ou les métiers d’un personnage sur beaucoup de joueurs, utilisez le miroir
onlinede la lib, qui suit les événements d’ai-core (Lib : serveur). - ai-core doit tourner en premier. Mettez
dependency 'ai-core'dans votrefxmanifest.lua(une ressource ai-* le liste dansfxDependenciesdepackage.json), pour que votre ressource démarre après ai-core. sourceest l’id serveur du joueur. C’est le nombre que FiveM donne à un joueur connecté. Un id de personnage (charId) est un autre nombre : l’id de la ligne du personnage dans la base de données.
La lib ou l’export ?
La plupart des exports ont une enveloppe dans @aicore8/lib/server (et beaucoup dans aiLib en Lua). L’enveloppe appelle le même export, le comportement est donc identique ; elle se lit simplement mieux (inventory.addItem(source, "water") au lieu de core.AddItem(source, "water")) et transforme les callbacks en Promises quand c’est sûr. Chaque entrée nomme son enveloppe sur la ligne Lib. Utilisez ce que vous préférez ; une ressource Lua sans ai-lib appelle l’export directement.
Les exemples de ces pages
Les exemples sont des fichiers serveur complets. Les exemples TypeScript utilisent addCommand et onClientCallback de la lib ; les exemples Lua utilisent aiLib.addCommand et aiLib.onClientCallback d’ai-lib, qui demandent ces lignes dans votre fxmanifest.lua :
shared_script '@ai-lib/init.lua'
dependency 'ai-lib'
dependency 'ai-core'Les appels Lua qui attendent (aiLib.progressFor, Wait) ne fonctionnent que dans un thread ; les handlers de commandes et de callbacks tournent déjà dans un thread.
Types
Les types qui apparaissent sur plusieurs pages (CharacterInfo, InventoryRef, DispatchAlert...) sont documentés une seule fois avec chaque champ sur la page Types et liés depuis chaque entrée qui les utilise.
Groupes d’exports
Personnages et joueurs
Données du joueur, personnages, recherche par id serveur, changement de personnage, positions hors ligne, joueurs à portée.
Personnages stockés
N’importe quel personnage, chargé ou non : le trouver, le lire, son argent, ses métiers, ses gangs, ses métadonnées, son nom, son temps de jeu, le sauvegarder, le supprimer.
Argent et comptes
Soldes, ajout et retrait d’argent, comptes de métier et de gang, virements, types de comptes.
Métiers et gangs
Appartenances, service, grades, effectifs en service, heures de pointe, définitions des métiers et des gangs.
Métadonnées et réglages
Le sac de métadonnées d’un personnage, l’identité visuelle du serveur, les scripts obsolètes.
Objets
Ajouter, retirer, compter et vérifier des objets, coffres, magasins de script, objets utilisables, définitions d’objets.
Clés de véhicule
Donner, retirer et vérifier des clés de véhicule via le script de clés qui tourne.
Carburant
Lire et fixer le carburant d’un véhicule via le script de carburant qui tourne.
Serrures de portes
Verrouiller, déverrouiller et lire des portes via le script de serrures qui tourne.
Garages
Mettre en fourrière, ranger, ouvrir un menu de garage, lister les véhicules garés d’un joueur.
Médical
Réanimer, soigner et vérifier si un joueur est à terre.
EMS
Combien de médecins sont libres, appels de détresse.
Apparence
L’apparence enregistrée d’un personnage depuis le script de vêtements qui tourne.
Téléphone
Numéros de téléphone, mails, SMS et notifications du téléphone.
Dispatch
Alertes police et métier via le système d’alertes qui tourne.
MDT
Amendes, mandats, arrestations et peines de prison dans le MDT de police.
Prison
Emprisonner, libérer et temps restant.
Banque
Ouvrir un écran de banque, le solde de société d’un métier.
Factures
Envoyer des factures, lister et payer les factures ouvertes d’un joueur.
Stress et besoins
Ajouter ou soulager du stress, remplir la faim et la soif.
Heure et météo
Météo, heure du jeu, coupure de courant et heure figée.
Routing buckets
Prendre et rendre un routing bucket libre pour un monde séparé.
Logs
Envoyer des logs vers Discord, Fivemanage, FiveM Stats et la console.
Vérifications de connexion
Vérifications que passe chaque joueur qui se connecte, scripts qui en remplacent d’autres.
Panneau d’administration et commandes
Enregistrement dans le panneau, l’onglet Commands, listes de recherche, écrans de réglages externes.
Pont vRP
Les exports qu’utilise le pont vRP intégré d’ai-core.
Pages liées
- Exports client : ce qu’ai-core répond dans le propre jeu du joueur.
- Événements et état : les événements que déclenche ai-core (
ai-core:playerLoaded,ai-core:moneyChanged...), qui permettent à votre ressource de suivre les changements au lieu de redemander. - Lib : serveur : les enveloppes nommées sur chaque entrée.
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.
Personnages et joueurs
Lire les données et le personnage d’un joueur chargé, trouver un joueur par id de personnage ou citizen id, changer de personnage, déplacer un personnage hors ligne, joueurs à portée.