Dokumentacja API
Przegląd API
Jak wywołać AI Core z innego skryptu - eksporty, zdarzenia i lib, w TypeScript i Lua.
Wszystko, co inny skrypt może wywołać: eksporty ai-core, zdarzenia, które wysyła, oraz funkcje pomocnicze @aicore8/lib (własne eksporty każdego skryptu ai-* są na jego stronie w sekcji Skrypty). Każda sygnatura na tych stronach pochodzi ze źródła (@aicore8/shared exports.ts, JSDoc liba, wywołania eksportów w każdym skrypcie).
Wybierz właściwą drogę
| Piszesz | Użyj |
|---|---|
| Skrypt ai-* lub dowolny zasób TypeScript | @aicore8/lib: inventory, vehicleKeys, online, medical... Lib wywołuje ai-core za ciebie. |
| Zasób Lua | aiLib z ai-lib (shared_script '@ai-lib/init.lua') albo bezpośrednio eksporty ai-core. |
| Skrypt ESX / QB / Qbox / vRP | Nic nowego: most odpowiada na własne API frameworka. Zobacz Warstwy i most. |
Przedmioty, klucze pojazdów, alerty, telefon, pogoda, więzienie, ubrania i śmierci zawsze przechodzą przez ai-core, nigdy przez eksporty konkretnego skryptu: ai-core przekazuje wywołanie do skryptu, którego serwer używa do tego zadania.
Wywołanie eksportu
import { resourceExport } from "@aicore8/lib/server";
// Jeden typowany uchwyt na zasób, na początku pliku.
const core = resourceExport("ai-core");
const cash = core.GetMoney(source, "cash");local cash = exports['ai-core']:GetMoney(source, 'cash')- Typy:
resourceExportczyta je zCitizenExportsw@aicore8/shared. Zasób, który może nie działać, używaoptionalExport("x")(null, gdy jest zatrzymany). - Nazwy: każdy eksport odpowiada też z zamienioną wielkością pierwszej litery (
GetMoneyigetMoney). - Eksporty są synchroniczne i zwracają małe wartości. Gdy wartość wymaga czasu (zapisany wygląd), eksport przyjmuje callback: żaden promise nie przechodzi przez granicę zasobu.
- Gorące ścieżki śledzą zdarzenia ai-core zamiast wywoływać eksporty w pętli (tak robi lustro
onlineliba).
Strony
| Strona | Co tam znajdziesz |
|---|---|
| Eksporty serwerowe ai-core | Każdy eksport serwerowy ai-core, jedna strona na obszar: postacie, pieniądze, prace i gangi, przedmioty, klucze, leczenie, telefon, dispatch, więzienie, świat, bankowość, rachunki, logi, panel administratora. |
| Eksporty klienckie ai-core | Każdy eksport kliencki: dane gracza, HUD, podpowiedzi klawiszy, synchronizacja świata, przedmioty, menu radialne, gesty, wygląd, pas bezpieczeństwa. |
| Zdarzenia i stan | Każde zdarzenie wysyłane przez ai-core z jego argumentami, state bagi oraz zdarzenia ESX / QB / Qbox / vRP wysyłane przez most. |
| Lib: serwer | @aicore8/lib/server i serwerowa strona aiLib. |
| Lib: klient | @aicore8/lib/client i kliencka strona aiLib. |
| Lib: shared i fivem | @aicore8/lib/shared i /fivem: eksporty, planowanie, state bagi, czytniki danych wejściowych, tekst i liczby. |
| Lib dla Lua | Jak zasób Lua używa aiLib i funkcje, które ma tylko Lua. |
| Typy | Każdy wspólny typ używany w sygnaturach (Vec3, ActionResult, InventoryRef...), pole po polu. |
| Strony skryptów | Własne eksporty i zdarzenia każdego skryptu ai-* są na jego stronie Developer (na przykład ai-inventory, łącznie z API ox_inventory i qb-inventory, na które odpowiada). |