Lib: Shared und fivem
@aicore8/lib/shared und /fivem: die Helfer, die auf beiden Seiten funktionieren, wofür jeder Einstieg da ist, und jede Themenseite.
Zwei Teile der Lib funktionieren auf dem Client und auf dem Server gleichermaßen:
| Einstieg | Was er enthält | Wo du ihn nutzen kannst |
|---|---|---|
@aicore8/lib/shared | Einfache Helfer, die nie ein FiveM-Native aufrufen: Ablehnungen, Eingabeleser, Zahlen- und Textformatierung, Vektor-Mathematik, Zonengeometrie, Leser für Panel-Daten, die Sprachtexte einer NUI-Seite. | Client, Server, resource/common/ und NUI-Code (React). |
@aicore8/lib/fivem | Helfer, die Natives aufrufen, die es auf beiden Seiten gibt: Exports zwischen Ressourcen, der Scheduler, Behandlung des Ressourcen-Stopps, der Lader für Sprachdateien. | Client, Server und resource/common/. Nicht im NUI-Code. |
Die Client- und Server-Einstiege exportieren alles aus /fivem erneut, sodass du diese Helfer in einer Client- oder Server-Datei auch aus @aicore8/lib/client oder @aicore8/lib/server importieren kannst. Nutze /fivem nur in Dateien unter resource/common/, die beide Seiten bündeln.
import { fail, readInt, groupDigits } from "@aicore8/lib/shared";
import { resourceExport, every, createLocale } from "@aicore8/lib/fivem";Lua
Nur wenige dieser Helfer haben einen Lua-Zwilling auf aiLib (lade es mit shared_script '@ai-lib/init.lua', siehe Lib für Lua): every, waitFor, formatText, locale, fail, numbers.round, numbers.groupDigits, numbers.headingTo und stripGameText. Jeder Eintrag zeigt den Lua-Aufruf, wenn es einen gibt, und sagt es, wenn es keinen gibt. Für den Rest hat Lua eigene Werkzeuge: Vektor-Mathematik (#(a - b) für eine Entfernung), Entity(e).state für State Bags, exports['name']:Fn() für Exports.
Themen
Exports zwischen Ressourcen
registerExport, resourceExport, optionalExport, callExport, provideExport, isResourceStarted.
Scheduling und Lebenszyklus
every, onStop, caller, ByResource, Reasons, sleep, waitFor.
State Bags
EntityState, PlayerState, GlobalKey, GlobalGroup und ihre Parser: replizierte Werte aus dem Speicher lesen.
Aktionen und Client-Eingaben
ActionResult, fail, isActionOk, replyError, readInt, readText, readId, readVec3, oneArg, asArgs.
Text und Zahlen
formatText, round, groupDigits, formatWeight, stripGameText, randomInt, pickRandom, rollChance, ServerClock.
Positionen
distance, flatDistance, headingTo, nearestOf, gridCell, cellKey.
Fahrzeuge
plateOf, normalizePlate, vehicleTypeOfClass, toVehicleProps, toVehicleSetup.
Panel-Daten
num, int, bool, str, record, vec4, spec, readRecords, RecordObjects, withoutSchemaKey.
Zugriff, Blips und Orts-NPCs
readAccess, ACCESS_FIELDS, decideAccess, readBlipStyle, readPlacePed und ihre Panel-Felder.
Sprache
createLocale, loadLocaleTexts, LangTexts: die Sprachdateien deiner Ressource im Spiel und in der NUI.
Logging
createLogger, logSafe, previewJson.
Zonengeometrie
ZoneShape, zoneContains, zoneBounds, polyFromCorners, readZoneShape.
Gemeinsame Typen (Vec3, Vec4, ActionResult, AccessRule, BlipStyle, ZoneShape, VehicleProps...) werden Feld für Feld auf Gemeinsame Typen erklärt.
Datenbank
createDatabaseTables installiert beim Start deine sql/main.sql; WriteQueue führt Datenbank-Schreibvorgänge nacheinander aus.
Exports zwischen Ressourcen
registerExport, resourceExport, optionalExport, callExport, provideExport und isResourceStarted: Exports aus TypeScript anbieten und aufrufen.