AI Core
Référence de l’APILib : serveur

Lib : serveur

@aicore8/lib/server et le côté serveur d’aiLib : ce qu’ils sont, comment les charger en TypeScript et en Lua, et toutes les pages thématiques.

La lib serveur est l’ensemble des helpers que chaque script serveur ai-* utilise au lieu de réécrire le même code : répondre aux clients en sécurité, commandes, joueurs, objets, véhicules, argent, logs et panneau d’administration. La plupart des helpers qui touchent un autre système (inventaire, clés, téléphone, prison...) passent par ai-core, si bien que votre script continue de fonctionner quand le propriétaire du serveur change de script d’inventaire ou de téléphone.

TypeScript

Importez depuis @aicore8/lib/server dans les fichiers sous resource/server/. Les helpers qui fonctionnent de n’importe quel côté (refus, lecteurs d’entrées, maths) viennent de @aicore8/lib/shared.

resource/server/index.ts
import { onClientCallback, inventory, notify } from "@aicore8/lib/server";
import { fail, oneArg, readId } from "@aicore8/lib/shared";

Chaque ressource créée à partir du modèle ai-core dépend déjà du paquet ("@aicore8/lib": "workspace:*" dans package.json) ; le build l’intègre dans dist/server.js.

Lua

Les ressources Lua obtiennent les mêmes helpers sur la table globale aiLib fournie par la ressource ai-lib. Ajoutez deux lignes à votre fxmanifest.lua :

fxmanifest.lua
dependency 'ai-lib'
shared_script '@ai-lib/init.lua'

Appelez ensuite aiLib.<name> dans n’importe quel fichier serveur. Chaque module se charge la première fois que vous l’utilisez et tourne à l’intérieur de votre ressource, si bien que les commandes et callbacks que vous enregistrez appartiennent à votre ressource et disparaissent quand elle s’arrête.

server.lua
aiLib.addCommand('hello', { help = 'Says hello' }, function(source)
    aiLib.notify(source, 'Hello!', 'success')
end)

Les fonctions Lua marquées Attend (progressFor, minigameFor, spawnVehicle, triggerClientCallback, billing.unpaid, appearance.get) mettent le code en pause jusqu’à l’arrivée de la réponse. Elles ne fonctionnent qu’à l’intérieur d’un thread. Les gestionnaires de aiLib.onClientCallback et aiLib.onClientEvent tournent déjà dans un thread ; partout ailleurs, enveloppez l’appel dans CreateThread(function() ... end).

Tous les helpers TypeScript n’ont pas d’équivalent Lua. Chaque entrée le précise quand il n’y en a pas. Ceux qui manquent en Lua : PendingActions, PlayerMap, Cooldowns, KeyedCooldowns, SourceLock, KeyWatchers, les helpers de position, AreaStream, les classes de state bag, AdminPanel, DataFile et les helpers de base de données (les ressources Lua utilisent l’API oxmysql d’ai-mysql pour le SQL).

Thèmes

Helpers partagés avec le client

Le point d’entrée serveur réexporte aussi les helpers de /fivem, vous pouvez donc les importer depuis @aicore8/lib/server également. Ils sont documentés une seule fois dans Lib : shared et fivem :

registerExport, resourceExport, optionalExport, callExport, provideExport, isResourceStarted, createLocale, loadLocaleTexts, LOCALE_CONVAR, ByResource, caller, onStop, plateOf, Reasons, every (avec les types EveryOptions et Job), stateBoolean, stateNumber, stateString (type StateParse).

Les classes de state bag EntityState, PlayerState, GlobalKey et GlobalGroup exportées par le point d’entrée serveur sont les versions serveur : elles ajoutent set. Voir State bags.

Deux helpers utilisés seulement par ai-core

sendPlayerData(source, key, value) et patchPlayerData(source, key, patch) envoient une valeur des données d’un joueur (AiPlayerData) au client de ce joueur. ai-core les appelle ; votre script n’en a jamais besoin. Lisez les données du joueur côté client avec getPlayerData (Lib : client).

Sur cette page