Lib : shared et fivem
@aicore8/lib/shared et /fivem : les utilitaires qui fonctionnent des deux côtés, le rôle de chaque entrée et toutes les pages thématiques.
Deux parties de la lib fonctionnent aussi bien sur le client que sur le serveur :
| Entrée | Ce qu’elle contient | Où l’utiliser |
|---|---|---|
@aicore8/lib/shared | Des utilitaires simples qui n’appellent jamais de native FiveM : refus, lecteurs d’entrée, formatage des nombres et du texte, calcul vectoriel, géométrie des zones, lecteurs de données du panneau, textes de langue d’une page NUI. | Client, serveur, resource/common/ et code NUI (React). |
@aicore8/lib/fivem | Des utilitaires qui appellent des natives présentes des deux côtés : exports entre ressources, planificateur, gestion de l’arrêt d’une ressource, chargeur de fichiers de langue. | Client, serveur et resource/common/. Pas dans le code NUI. |
Les entrées client et serveur réexportent tout ce que contient /fivem : dans un fichier client ou serveur, vous pouvez donc aussi importer ces utilitaires depuis @aicore8/lib/client ou @aicore8/lib/server. N’utilisez /fivem que dans les fichiers de resource/common/ que les deux côtés intègrent à leur bundle.
import { fail, readInt, groupDigits } from "@aicore8/lib/shared";
import { resourceExport, every, createLocale } from "@aicore8/lib/fivem";Lua
Seuls quelques-uns de ces utilitaires ont un équivalent Lua sur aiLib (chargez-le avec shared_script '@ai-lib/init.lua', voir Lib pour Lua) : every, waitFor, formatText, locale, fail, numbers.round, numbers.groupDigits, numbers.headingTo et stripGameText. Chaque entrée montre l’appel Lua quand il existe, et précise quand il n’y en a pas. Pour le reste, Lua a ses propres outils : le calcul vectoriel (#(a - b) pour une distance), Entity(e).state pour les state bags, exports['name']:Fn() pour les exports.
Thèmes
Exports entre ressources
registerExport, resourceExport, optionalExport, callExport, provideExport, isResourceStarted.
Planification et cycle de vie
every, onStop, caller, ByResource, Reasons, sleep, waitFor.
State bags
EntityState, PlayerState, GlobalKey, GlobalGroup et leurs parseurs : lire les valeurs répliquées depuis la mémoire.
Actions et entrées du client
ActionResult, fail, isActionOk, replyError, readInt, readText, readId, readVec3, oneArg, asArgs.
Texte et nombres
formatText, round, groupDigits, formatWeight, stripGameText, randomInt, pickRandom, rollChance, ServerClock.
Positions
distance, flatDistance, headingTo, nearestOf, gridCell, cellKey.
Véhicules
plateOf, normalizePlate, vehicleTypeOfClass, toVehicleProps, toVehicleSetup.
Données du panneau
num, int, bool, str, record, vec4, spec, readRecords, RecordObjects, withoutSchemaKey.
Accès, blips et PNJ des lieux
readAccess, ACCESS_FIELDS, decideAccess, readBlipStyle, readPlacePed et leurs champs de panneau.
Langue
createLocale, loadLocaleTexts, LangTexts : les fichiers de langue de votre ressource en jeu et dans la NUI.
Journalisation
createLogger, logSafe, previewJson.
Géométrie des zones
ZoneShape, zoneContains, zoneBounds, polyFromCorners, readZoneShape.
Les types partagés (Vec3, Vec4, ActionResult, AccessRule, BlipStyle, ZoneShape, VehicleProps...) sont expliqués champ par champ sur Types partagés.
Base de données
createDatabaseTables installe votre sql/main.sql au démarrage ; WriteQueue exécute les écritures en base l’une après l’autre.
Exports entre ressources
registerExport, resourceExport, optionalExport, callExport, provideExport et isResourceStarted : proposer et appeler des exports depuis TypeScript.