API-Referenz
API-Übersicht
Wie ein anderes Skript AI Core aufruft - Exports, Events und die Lib, in TypeScript und Lua.
Alles, was ein anderes Skript aufrufen kann: die Exports von ai-core, die Events, die es auslöst, und die Helfer von @aicore8/lib (die eigenen Exports jedes ai-*-Skripts stehen auf seiner Seite unter Skripte). Jede Signatur auf diesen Seiten stammt aus dem Quellcode (@aicore8/shared exports.ts, das JSDoc der Lib, die Export-Aufrufe jedes Skripts).
Der richtige Zugang
| Du schreibst | Nutze |
|---|---|
| Ein ai-*-Skript oder eine beliebige TypeScript-Ressource | @aicore8/lib: inventory, vehicleKeys, online, medical... Die Lib ruft ai-core für dich auf. |
| Eine Lua-Ressource | aiLib aus ai-lib (shared_script '@ai-lib/init.lua') oder direkt die Exports von ai-core. |
| Ein ESX- / QB- / Qbox- / vRP-Skript | Nichts Neues: Die Brücke beantwortet die eigene API des Frameworks. Siehe Ebenen und die Brücke. |
Items, Fahrzeugschlüssel, Alarme, Handy, Wetter, Gefängnis, Kleidung und Tode laufen immer über ai-core, nie über die Exports eines bestimmten Skripts: ai-core leitet an das Skript weiter, das der Server für diese Aufgabe nutzt.
Einen Export aufrufen
import { resourceExport } from "@aicore8/lib/server";
// Ein typisiertes Handle pro Ressource, oben in der Datei.
const core = resourceExport("ai-core");
const cash = core.GetMoney(source, "cash");local cash = exports['ai-core']:GetMoney(source, 'cash')- Typen:
resourceExportliest sie ausCitizenExportsin@aicore8/shared. Eine Ressource, die eventuell nicht läuft, nutztoptionalExport("x")(null, solange sie gestoppt ist). - Namen: Jeder Export antwortet auch mit vertauschter Groß-/Kleinschreibung des ersten Buchstabens (
GetMoneyundgetMoney). - Exports sind synchron und geben kleine Werte zurück. Wo ein Wert Zeit braucht (ein gespeichertes Aussehen), nimmt der Export einen Callback: Kein Promise überquert eine Ressourcengrenze.
- Heiße Pfade folgen den Events von ai-core, statt Exports in einer Schleife aufzurufen (der
online-Spiegel der Lib macht das).
Seiten
| Seite | Was du dort findest |
|---|---|
| Server-Exports von ai-core | Jeder Server-Export von ai-core, eine Seite pro Bereich: Charaktere, Geld, Jobs und Gangs, Items, Schlüssel, Medizin, Handy, Dispatch, Gefängnis, Welt, Bank, Rechnungen, Logs, Admin-Panel. |
| Client-Exports von ai-core | Jeder Client-Export: Spielerdaten, HUD, Tastenhinweise, Welt-Sync, Items, Radialmenü, Gesten, Aussehen, Sicherheitsgurt. |
| Events und Zustand | Jedes Event, das ai-core auslöst, mit seinen Argumenten, die State Bags und die ESX- / QB- / Qbox- / vRP-Events, die die Brücke auslöst. |
| Lib: Server | @aicore8/lib/server und die Serverseite von aiLib. |
| Lib: Client | @aicore8/lib/client und die Clientseite von aiLib. |
| Lib: shared und fivem | @aicore8/lib/shared und /fivem: Exports, Zeitplanung, State Bags, Eingabeleser, Text und Zahlen. |
| Lib für Lua | Wie eine Lua-Ressource aiLib nutzt, und die Funktionen, die nur Lua hat. |
| Typen | Jeder gemeinsame Typ, den die Signaturen nutzen (Vec3, ActionResult, InventoryRef...), Feld für Feld. |
| Skriptseiten | Die eigenen Exports und Events jedes ai-*-Skripts stehen auf seiner Developer-Seite (zum Beispiel ai-inventory, einschließlich der APIs von ox_inventory und qb-inventory, die es beantwortet). |