AI Core
Dokumentacja APIEksporty klienckie ai-core

Eksporty klienckie ai-core

Czym są eksporty klienckie ai-core, jak je wywoływać z TypeScript i Lua oraz która funkcja pomocnicza liba opakowuje każdy z nich.

Eksport kliencki to funkcja, którą kliencka strona ai-core oferuje każdemu innemu zasobowi w grze tego samego gracza. Twój skrypt kliencki wywołuje go, aby odczytać dane lokalnego gracza, ukryć HUD, dodać element menu radialnego, sprawdzić przedmiot, odtworzyć emotkę i tak dalej.

Większość tych eksportów to warstwy: ai-core nie wykonuje zadania sam, tylko przekazuje wywołanie do skryptu, którego serwer używa do tego zadania (ekwipunek, skrypt ubrań, menu radialne, menu emotek, skrypt śmierci, MDT). Twój skrypt wywołuje jedną nazwę i działa dalej, gdy właściciel serwera zamieni jeden z tych skryptów na inny.

Zanim zaczniesz

  • Każdy eksport kliencki jest synchroniczny: odpowiada od razu i nigdy nie czeka. Nic na tych stronach nie zwraca Promise i nic nie potrzebuje wątku w Lua. Jedyny eksport, którego odpowiedź wymaga czasu (OpenItemPicker), odpowiada przez zdarzenie.
  • Wywołuj je tylko z kodu klienckiego. Serwer ma własną listę: eksporty serwerowe ai-core.
  • ai-core musi być uruchomiony. Zasób, który może działać bez ai-core, używa w TypeScript optionalExport("ai-core") (jest null, dopóki ai-core jest zatrzymany).
  • Każdy eksport odpowiada też z zamienioną wielkością pierwszej litery: GetPlayerData i getPlayerData to ta sama funkcja.
  • Rzeczy, które zasób dodaje przez te eksporty (powody ukrycia HUD, podpowiedzi klawiszy, elementy radialne, wstrzymania synchronizacji świata), należą do tego zasobu. ai-core usuwa je, gdy zasób się zatrzymuje, więc awaria lub restart nigdy nie zostawia ukrytego HUD ani martwego elementu menu.

Wywołanie eksportu

resource/client/index.ts
import { resourceExport } from "@aicore8/lib/client";

// Jeden typowany uchwyt na początku pliku. Typy pochodzą z @aicore8/shared (AiCoreClientExports).
const core = resourceExport("ai-core");

RegisterCommand(
  "myjob",
  () => {
    const data = core.GetPlayerData();
    console.log(data ? `job: ${data.job.job}` : "no character loaded");
  },
  false,
);

Używaj funkcji pomocniczej liba, gdy istnieje

Większość eksportów ma funkcję pomocniczą w @aicore8/lib/client i tę samą funkcję w aiLib dla zasobów Lua (shared_script '@ai-lib/init.lua'). Funkcje pomocnicze wywołują eksport za ciebie, sprawdzają jego odpowiedź i dodają nasłuchiwanie zmian, gdzie ono istnieje. Preferuj je; wywołuj eksport bezpośrednio, gdy nie możesz użyć liba.

EksportLib TypeScriptaiLib w LuaStrona
GetPlayerData, IsPlayerLoaded, GetDefinitionsgetPlayerData, onPlayerDataaiLib.playerData.get, aiLib.playerData.onChangeGracz
HideHud, ShowHud, IsHudVisiblehud.hide, hud.show, hud.visible, hud.onChangeaiLib.hud.hide, aiLib.hud.show, aiLib.hud.visibleHUD
OpenHudSettings, HasHudSettingsbrakbrakHUD
ShowKeyHint, HideKeyHintkeyHints.show, keyHints.hideaiLib.keyHints.show, aiLib.keyHints.hideSkróty i podpowiedzi klawiszy
GetKeybindKey, GetKeyHints, OpenKeyboardbrakbrakSkróty i podpowiedzi klawiszy
PauseWorldSync, ResumeWorldSyncworld.pauseSync, world.resumeSyncaiLib.world.pauseSync, aiLib.world.resumeSyncSynchronizacja pogody i czasu
OpenInventory, HasItem, GetCurrentWeaponinventory.openInventory, inventory.hasItem, inventory.currentWeaponaiLib.inventory.* (te same nazwy)Przedmioty
OpenItemPickeritemPickeraiLib.itemPickerPrzedmioty
AddRadialItem, RemoveRadialItem, RefreshRadialradial.add, radial.remove, radial.refreshaiLib.radial.* (te same nazwy)Menu radialne
IsHandsUp, IsPointing, GetGestureProvider, PlayEmote, CancelEmote, GetEmoteProvidergestures.*aiLib.gestures.*Gesty i emotki
ApplyAppearance, GetPedAppearance, OpenClothingMenu, WearOutfit, ReloadSkinappearance.apply, read, openMenu, wearOutfit, reloadSkinaiLib.appearance.* (te same nazwy)Wygląd
IsDeadmedical.isDead, medical.onChangebrak (wywołaj eksport)Leczenie
GetSeatbelt, GetSeatbeltProviderseatbelt.isOn, seatbelt.provider, seatbelt.onChangeaiLib.seatbelt.* (te same nazwy)Pas bezpieczeństwa
OpenMdtmdt.openaiLib.mdt.openMDT
ExternalNotifybrak (używany przez ai-lib)brakPowiadomienia

Nie wywołuj eksportów w każdej klatce

Eksporty przechodzą przez granicę zasobu, co kosztuje więcej niż wywołanie lokalnej funkcji. Odczytaj wartość raz, potem śledź zdarzenie, które mówi, kiedy się zmienia. Każda strona wymienia to zdarzenie; wszystkie są w Zdarzenia i stan.

Menu, okna wprowadzania, powiadomienia, podpowiedzi, pasek postępu i minigry należą do ai-lib, nie do ai-core. Używaj notify, menu, input, progress i skillCheck z liba (albo tych samych nazw w aiLib).

Na tej stronie