AI Core
Dokumentacja APILib: klient

Lib: klient

@aicore8/lib/client i kliencka strona aiLib: czym są, jak je wczytać w TypeScript i Lua oraz każda strona tematyczna.

Lib kliencki to zestaw funkcji pomocniczych, których każdy kliencki skrypt ai-* używa zamiast pisać natywki ręcznie: rozmowa z serwerem, lokalny gracz, punkty interakcji, strefy, pedy i blipy, wspólne UI (powiadomienia, pasek postępu, menu, minigry), klawisze i warstwy, które przez ai-core docierają do dowolnego skryptu HUD, śmierci, ubrań albo emotek, którego używa serwer.

TypeScript

Importuj z @aicore8/lib/client w plikach w resource/client/. Funkcje działające po każdej stronie (odmowy, czytniki wejścia, matematyka, RecordObjects, ServerClock) pochodzą z @aicore8/lib/shared.

resource/client/index.ts
import { Points, notify, progress, cache } from "@aicore8/lib/client";
import { RecordObjects, ServerClock } from "@aicore8/lib/shared";

Każdy zasób zrobiony z szablonu ai-core już zależy od tego pakietu ("@aicore8/lib": "workspace:*" w package.json); build pakuje go do dist/client.js.

Lua

Zasoby Lua dostają te same funkcje w globalnej tabeli aiLib z zasobu ai-lib. Dodaj dwie linie do swojego fxmanifest.lua:

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

Potem wywołuj aiLib.<name> w dowolnym pliku klienta. Każdy moduł wczytuje się przy pierwszym użyciu i działa wewnątrz twojego zasobu, więc punkty, klawisze i callbacki, które tworzysz, należą do twojego zasobu i znikają, gdy się zatrzyma. Klasy tworzy się przez .new(), a ich metody wywołuje z dwukropkiem: local points = aiLib.Points.new(), potem points:add(...).

client.lua
local t = aiLib.locale()

RegisterCommand('hello', function()
    aiLib.notify(t('HELLO'), 'success')
end, false)

Funkcje Lua oznaczone jako Czeka (triggerServerCallback, callAction, progress, menu.show, input, skillCheck, lockpick, itemPicker, fadeOut, fadeIn, player.teleport, waitForEntity, loadery request*, pedHeadshot) wstrzymują kod, aż przyjdzie odpowiedź. Działają tylko wewnątrz wątku. Handlery komend i zdarzeń sieciowych już w nim działają; w każdym innym miejscu (onPressed punktu, klawisz, callback menu) opakuj wywołanie w CreateThread(function() ... end).

Nie każda funkcja TypeScript ma odpowiednik w Lua. Każdy wpis mówi to wprost, gdy go nie ma. Brakuje w Lua: fromServer, isActionOk, replyError, onCache (Lua ma cache.onChange), readPlayerState, readWeapon, player.holdAnim, attachProp, PreviewVehicle, NuiScreen, hud.onChange, controls.isDisabled, medical, fuel, drivenVehicle, entityFromNetId, funkcji właściwości pojazdów, ScriptCamera, TickLoop (użyj aiLib.every(0, fn)), AreaFollower, ServerClock, AdminWorld, RecordObjects i sprawdzeń członkostwa (hasJob, inGang, onDutyIn, allows, onMembershipChange).

Tematy

Funkcje wspólne z serwerem

Wejście klienta ponownie eksportuje też funkcje /fivem, więc możesz je importować także z @aicore8/lib/client. Są opisane raz na stronie Lib: shared i fivem:

registerExport, resourceExport, optionalExport, callExport, provideExport, isResourceStarted, createLocale, loadLocaleTexts, LOCALE_CONVAR, ByResource, caller, onStop, plateOf, Reasons, every (z typami EveryOptions i Job), stateBoolean, stateNumber, stateString (typ StateParse).

Klasy state bagów EntityState, PlayerState, GlobalKey i GlobalGroup eksportowane z wejścia klienta to klienckie wersje tylko do odczytu: get(id) i onChange(handler), bez set. Wersje serwerowe są na stronie State bagi.

Eksporty, których twój skrypt nigdy nie wywołuje

ZoneEngine (mechanizm sprawdzania stref za Zones), ModelScanner i readModelScanDef (skanowanie modeli za Points.addModel) są eksportowane dla ai-lib, który uruchamia je za każdy zasób. Zamiast nich używaj Zones i Points.

Na tej stronie