AI Core
API-ReferenzLib: Server

Lib: Server

@aicore8/lib/server und die Server-Seite von aiLib: was sie sind, wie du sie in TypeScript und Lua lädst, und jede Themenseite.

Die Server-Lib ist die Sammlung von Helfern, die jedes ai-*-Server-Skript nutzt, statt denselben Code noch einmal zu schreiben: Clients sicher antworten, Befehle, Spieler, Items, Fahrzeuge, Geld, Logs und das Admin-Panel. Die meisten Helfer, die ein anderes System berühren (Inventar, Schlüssel, Handy, Gefängnis...), laufen über ai-core, damit dein Skript weiter funktioniert, wenn der Serverbetreiber das Inventar- oder Handy-Skript austauscht.

TypeScript

Importiere aus @aicore8/lib/server in Dateien unter resource/server/. Helfer, die auf jeder Seite funktionieren (Ablehnungen, Eingabeleser, Mathematik), kommen aus @aicore8/lib/shared.

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

Jede Ressource, die aus der ai-core-Vorlage erstellt wurde, hängt bereits von dem Paket ab ("@aicore8/lib": "workspace:*" in package.json); der Build bündelt es in dist/server.js.

Lua

Lua-Ressourcen bekommen dieselben Helfer in der globalen Tabelle aiLib aus der Ressource ai-lib. Füge zwei Zeilen in deine fxmanifest.lua ein:

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

Rufe dann aiLib.<name> in einer beliebigen Server-Datei auf. Jedes Modul lädt beim ersten Gebrauch und läuft innerhalb deiner Ressource, sodass Befehle und Callbacks, die du registrierst, zu deiner Ressource gehören und verschwinden, wenn sie stoppt.

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

Lua-Funktionen, die mit Wartet markiert sind (progressFor, minigameFor, spawnVehicle, triggerClientCallback, billing.unpaid, appearance.get), halten den Code an, bis die Antwort kommt. Sie funktionieren nur innerhalb eines Threads. Handler von aiLib.onClientCallback und aiLib.onClientEvent laufen bereits in einem; überall sonst packst du den Aufruf in CreateThread(function() ... end).

Nicht jeder TypeScript-Helfer hat einen Lua-Zwilling. Jeder Eintrag sagt es, wenn er keinen hat. Diese fehlen in Lua: PendingActions, PlayerMap, Cooldowns, KeyedCooldowns, SourceLock, KeyWatchers, die Positionshelfer, AreaStream, die State-Bag-Klassen, AdminPanel, DataFile und die Datenbankhelfer (Lua-Ressourcen nutzen für SQL die oxmysql-API von ai-mysql).

Themen

Mit dem Client geteilte Helfer

Der Server-Einstieg exportiert auch die /fivem-Helfer erneut, sodass du sie auch aus @aicore8/lib/server importieren kannst. Sie sind einmal auf Lib: Shared und fivem dokumentiert:

registerExport, resourceExport, optionalExport, callExport, provideExport, isResourceStarted, createLocale, loadLocaleTexts, LOCALE_CONVAR, ByResource, caller, onStop, plateOf, Reasons, every (mit den Typen EveryOptions und Job), stateBoolean, stateNumber, stateString (Typ StateParse).

Die State-Bag-Klassen EntityState, PlayerState, GlobalKey und GlobalGroup, die der Server-Einstieg exportiert, sind die Server-Versionen: Sie fügen set hinzu. Siehe State Bags.

Zwei Helfer, die nur ai-core nutzt

sendPlayerData(source, key, value) und patchPlayerData(source, key, patch) schicken einen Wert der Spielerdaten (AiPlayerData) an den Client dieses Spielers. ai-core ruft sie auf; dein Skript braucht sie nie. Lies Spielerdaten auf dem Client mit getPlayerData (Lib: Client).

Auf dieser Seite