AI Core
Dokumentacja APIAI Core: eksporty serwerowe

Eksporty serwerowe

Jak wywoływać serwerowe eksporty ai-core z Lua i TypeScript oraz lista wszystkich grup eksportów.

ai-core to zasób frameworka. Inne zasoby pytają go o postać gracza, pieniądze, prace i przedmioty oraz zlecają mu zadania, takie jak "daj temu graczowi klucz" albo "wyślij alert policji". Robią to przez eksporty: funkcje, które ai-core udostępnia do wywołania z dowolnego innego zasobu na serwerze.

Te strony wymieniają każdy eksport serwerowy, który rejestruje ai-core, pogrupowany według tematu. Każdy wpis pokazuje, co robi eksport, jego dokładną sygnaturę, każdy parametr, co zwraca w każdym przypadku i działający przykład w TypeScript i Lua.

Wywołanie eksportu

Eksport wywołuje się nazwą zasobu, do którego należy (ai-core), i nazwą eksportu.

import { resourceExport } from "@aicore8/lib/server";

// Jeden typowany uchwyt na plik, na początku. Tu jest to bezpieczne: FiveM wyszukuje każdy
// eksport przy pierwszym użyciu i zapomina go, gdy ai-core się restartuje.
const core = resourceExport("ai-core");

export function cashOf(source: number): number {
  return core.GetMoney(source, "cash") ?? 0;
}

Co trzeba wiedzieć przed rozpoczęciem:

  • Typy TypeScript. resourceExport("ai-core") jest typowany z AiCoreServerExports w @aicore8/shared, więc twój edytor zna każdą nazwę, parametr i typ zwracany. Nigdy nie pisz resourceExport("ai-core").GetMoney(...) wewnątrz funkcji: trzymaj jeden uchwyt na początku pliku.
  • Lua używa dwukropka. Pisz exports['ai-core']:GetMoney(source, 'cash'), nie z kropką. Odpowiedź null przychodzi w Lua jako nil, tablica jako lista Lua (od indeksu 1), obiekt jako tabela.
  • Dwie pisownie. Każdy eksport odpowiada też z zamienioną wielkością pierwszej litery: GetMoney i getMoney to ta sama funkcja.
  • Eksporty nigdy nie czekają. Każdy eksport odpowiada od razu małą wartością. Gdy odpowiedź wymaga bazy danych (zapisany wygląd, lista rachunków), eksport przyjmuje callback done zamiast zwracać Promise, bo Promise nie może przejść z jednego zasobu do drugiego.
  • Nie na gorących ścieżkach. Wywołanie eksportu kopiuje jego argumenty i odpowiedź. Nie wywołuj eksportów w każdej klatce ani dla każdego gracza w pętli. Dla "kto jest na służbie", imienia postaci lub prac wielu graczy używaj lustra online liba, które śledzi zdarzenia ai-core (Lib: serwer).
  • ai-core musi działać pierwszy. Dodaj dependency 'ai-core' w swoim fxmanifest.lua (zasób ai-* wymienia go w package.json fxDependencies), aby twój zasób startował po ai-core.
  • source to id serwera gracza. To liczba, którą FiveM daje połączonemu graczowi. Id postaci (charId) to inna liczba: id wiersza postaci w bazie danych.

Lib czy eksport?

Większość eksportów ma opakowanie w @aicore8/lib/server (a wiele w aiLib dla Lua). Opakowanie wywołuje ten sam eksport, więc zachowanie jest identyczne; po prostu czyta się je przyjemniej (inventory.addItem(source, "water") zamiast core.AddItem(source, "water")) i zamienia callbacki na Promise tam, gdzie to bezpieczne. Każdy wpis podaje swoje opakowanie w linii Lib. Używaj tego, co wolisz; zasób Lua bez ai-lib wywołuje eksport bezpośrednio.

Przykłady na tych stronach

Przykłady to kompletne pliki serwerowe. Przykłady TypeScript używają addCommand i onClientCallback z liba; przykłady Lua używają aiLib.addCommand i aiLib.onClientCallback z ai-lib, które wymagają tych linii w twoim fxmanifest.lua:

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

Czekające wywołania Lua (aiLib.progressFor, Wait) działają tylko wewnątrz wątku; handlery komend i callbacków już w nim działają.

Typy

Typy, które pojawiają się na kilku stronach (CharacterInfo, InventoryRef, DispatchAlert...), są opisane raz z każdym polem na stronie Typy i linkowane z każdego wpisu, który ich używa.

Grupy eksportów

Postacie i gracze

Dane gracza, postacie, wyszukiwanie id serwera, zmiana postaci, pozycje offline, gracze w zasięgu.

Zapisane postacie

Dowolna postać, wczytana albo nie: znajdź, przeczytaj, jej pieniądze, prace, gangi, metadane, imię, czas gry, zapisz, usuń.

Pieniądze i konta

Salda, dodawanie i zabieranie pieniędzy, konta prac i gangów, przelewy, typy kont.

Prace i gangi

Członkostwa, służba, stopnie, liczniki na służbie, godziny szczytu, definicje prac i gangów.

Metadane i ustawienia

Worek metadanych postaci, branding serwera, nieaktualne skrypty.

Przedmioty

Dodawaj, zabieraj, licz i sprawdzaj przedmioty, schowki, sklepy skryptów, używalne przedmioty, definicje przedmiotów.

Klucze pojazdów

Dawaj, zabieraj i sprawdzaj klucze pojazdów przez działający skrypt kluczy.

Paliwo

Odczytuj i ustawiaj paliwo pojazdu przez działający skrypt paliwa.

Zamki drzwi

Zamykaj, otwieraj i odczytuj drzwi przez działający skrypt zamków drzwi.

Garaże

Odholowanie, odstawienie, otwarcie menu garażu, lista pojazdów gracza w garażu.

Leczenie

Reanimuj, lecz i sprawdzaj, czy gracz jest powalony.

EMS

Ilu medyków jest wolnych, wezwania pomocy.

Wygląd

Zapisany wygląd postaci z działającego skryptu ubrań.

Telefon

Numery telefonów, maile, wiadomości tekstowe i powiadomienia telefonu.

Dispatch

Alerty policji i prac przez działający system alertów.

MDT

Mandaty, nakazy, aresztowania i wpisy o więzieniu w policyjnym MDT.

Więzienie

Uwięzienie, zwolnienie i pozostały czas.

Bankowość

Otwarcie ekranu banku, saldo firmy pracy.

Rachunki

Wysyłaj rachunki, wyświetlaj i opłacaj otwarte rachunki gracza.

Stres i potrzeby

Dodawaj lub zmniejszaj stres, uzupełniaj głód i pragnienie.

Czas i pogoda

Pogoda, czas gry, blackout i zamrożony czas.

Routing buckety

Weź i oddaj wolny routing bucket dla osobnego świata.

Logi

Wysyłaj logi do Discorda, Fivemanage, FiveM Stats i konsoli.

Sprawdzanie połączeń

Sprawdzenia, które przechodzi każdy łączący się gracz, skrypty zastępujące inne.

Panel administratora i komendy

Rejestracja panelu, karta Commands, listy wyszukiwania, zewnętrzne ekrany ustawień.

Most vRP

Eksporty, których używa wbudowany most vRP ai-core.

Powiązane strony

  • Eksporty klienckie: na co ai-core odpowiada we własnej grze gracza.
  • Zdarzenia i stan: zdarzenia wysyłane przez ai-core (ai-core:playerLoaded, ai-core:moneyChanged...), dzięki którym twój zasób śledzi zmiany zamiast pytać ponownie.
  • Lib: serwer: opakowania wymienione w każdym wpisie.

Na tej stronie