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

Lib : client

@aicore8/lib/client et le côté client d’aiLib : ce qu’ils sont, comment les charger en TypeScript et en Lua, et chaque page thématique.

La lib client est l’ensemble des helpers que chaque script client ai-* utilise au lieu d’écrire les natives à la main : parler au serveur, le joueur local, les points d’interaction, les zones, les peds et les blips, l’interface partagée (notifications, barre de progression, menus, mini-jeux), les raccourcis clavier, et les couches qui atteignent, via ai-core, le script de HUD, de mort, de vêtements ou d’emotes que le serveur fait tourner.

TypeScript

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

resource/client/index.ts
import { Points, notify, progress, cache } from "@aicore8/lib/client";
import { RecordObjects, ServerClock } 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/client.js.

Lua

Les ressources Lua obtiennent les mêmes helpers sur la table globale aiLib de 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 client. Chaque module se charge la première fois que vous l’utilisez et tourne dans votre ressource, si bien que les points, raccourcis clavier et callbacks que vous créez appartiennent à votre ressource et disparaissent quand elle s’arrête. Les classes se créent avec .new() et leurs méthodes s’appellent avec deux-points : local points = aiLib.Points.new(), puis points:add(...).

client.lua
local t = aiLib.locale()

RegisterCommand('hello', function()
    aiLib.notify(t('HELLO'), 'success')
end, false)

Les fonctions Lua marquées Attend (triggerServerCallback, callAction, progress, menu.show, input, skillCheck, lockpick, itemPicker, fadeOut, fadeIn, player.teleport, waitForEntity, les chargeurs request*, pedHeadshot) mettent le code en pause jusqu’à l’arrivée de la réponse. Elles ne fonctionnent que dans un thread. Les gestionnaires de commandes et d’événements réseau tournent déjà dans un thread ; partout ailleurs (le onPressed d’un point, un raccourci clavier, un callback de menu), 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 : fromServer, isActionOk, replyError, onCache (Lua a cache.onChange), readPlayerState, readWeapon, player.holdAnim, attachProp, PreviewVehicle, NuiScreen, hud.onChange, controls.isDisabled, medical, fuel, drivenVehicle, entityFromNetId, les helpers de propriétés de véhicule, ScriptCamera, TickLoop (utilisez aiLib.every(0, fn)), AreaFollower, ServerClock, AdminWorld, RecordObjects, et les vérifications d’appartenance (hasJob, inGang, onDutyIn, allows, onMembershipChange).

Thèmes

Helpers partagés avec le serveur

L’entrée client réexporte aussi les helpers /fivem, vous pouvez donc les importer depuis @aicore8/lib/client également. Ils sont documentés une seule fois sur 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 l’entrée client sont les versions client en lecture seule : get(id) et onChange(handler), pas de set. Les versions serveur sont sur State bags.

Exports que votre script n’appelle jamais

ZoneEngine (le vérificateur de zones derrière Zones), ModelScanner et readModelScanDef (le scan de modèles derrière Points.addModel) sont exportés pour ai-lib, qui les fait tourner pour chaque ressource. Utilisez Zones et Points à la place.

Sur cette page