Client-Exports von ai-core
Was die Client-Exports von ai-core sind, wie du sie aus TypeScript und Lua aufrufst und welcher Lib-Helfer jeden umschließt.
Ein Client-Export ist eine Funktion, die die Clientseite von ai-core jeder anderen Ressource im Spiel desselben Spielers anbietet. Dein Client-Skript ruft sie auf, um die Daten des lokalen Spielers zu lesen, das HUD auszublenden, einen Eintrag im Radialmenü hinzuzufügen, ein Item zu prüfen, ein Emote abzuspielen und so weiter.
Die meisten dieser Exports sind Ebenen: ai-core erledigt die Aufgabe nicht selbst, sondern leitet den Aufruf an das Skript weiter, das der Server für diese Aufgabe nutzt (das Inventar, das Kleidungs-Skript, das Radialmenü, das Emote-Menü, das Tod-Skript, das MDT). Dein Skript ruft einen Namen auf und funktioniert weiter, wenn der Serverbesitzer eines dieser Skripte gegen ein anderes tauscht.
Bevor du anfängst
- Jeder Client-Export ist synchron: Er antwortet sofort und wartet nie. Nichts auf diesen Seiten gibt ein Promise zurück, und nichts braucht in Lua einen Thread. Der eine Export, dessen Antwort Zeit braucht (
OpenItemPicker), antwortet über ein Event. - Rufe sie nur aus Client-Code auf. Der Server hat seine eigene Liste: Server-Exports von ai-core.
- ai-core muss gestartet sein. Eine Ressource, die ohne ai-core laufen kann, nutzt in TypeScript
optionalExport("ai-core")(es istnull, solange ai-core gestoppt ist). - Jeder Export antwortet auch mit vertauschter Groß-/Kleinschreibung des ersten Buchstabens:
GetPlayerDataundgetPlayerDatasind dieselbe Funktion. - Was eine Ressource über diese Exports hinzufügt (Gründe zum Ausblenden des HUD, Tastenhinweise, Radial-Einträge, Pausen der Welt-Synchronisierung), gehört dieser Ressource. ai-core entfernt es, wenn die Ressource stoppt, sodass ein Absturz oder Neustart nie ein ausgeblendetes HUD oder einen toten Menüeintrag zurücklässt.
Einen Export aufrufen
import { resourceExport } from "@aicore8/lib/client";
// Ein typisiertes Handle, oben in der Datei. Die Typen kommen aus @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,
);Nutze den Lib-Helfer, wenn es einen gibt
Die meisten Exports haben einen Helfer in @aicore8/lib/client und denselben Helfer auf aiLib für Lua-Ressourcen (shared_script '@ai-lib/init.lua'). Die Helfer rufen den Export für dich auf, prüfen seine Antwort und fügen einen Änderungs-Listener hinzu, wo es einen gibt. Bevorzuge sie; rufe den Export direkt auf, wenn du die Lib nicht nutzen kannst.
| Export | TypeScript-Lib | Lua aiLib | Seite |
|---|---|---|---|
GetPlayerData, IsPlayerLoaded, GetDefinitions | getPlayerData, onPlayerData | aiLib.playerData.get, aiLib.playerData.onChange | Spieler |
HideHud, ShowHud, IsHudVisible | hud.hide, hud.show, hud.visible, hud.onChange | aiLib.hud.hide, aiLib.hud.show, aiLib.hud.visible | HUD |
OpenHudSettings, HasHudSettings | keiner | keiner | HUD |
ShowKeyHint, HideKeyHint | keyHints.show, keyHints.hide | aiLib.keyHints.show, aiLib.keyHints.hide | Tastenbelegungen und Tastenhinweise |
GetKeybindKey, GetKeyHints, OpenKeyboard | keiner | keiner | Tastenbelegungen und Tastenhinweise |
PauseWorldSync, ResumeWorldSync | world.pauseSync, world.resumeSync | aiLib.world.pauseSync, aiLib.world.resumeSync | Wetter- und Zeitsynchronisierung |
OpenInventory, HasItem, GetCurrentWeapon | inventory.openInventory, inventory.hasItem, inventory.currentWeapon | aiLib.inventory.* (gleiche Namen) | Items |
OpenItemPicker | itemPicker | aiLib.itemPicker | Items |
AddRadialItem, RemoveRadialItem, RefreshRadial | radial.add, radial.remove, radial.refresh | aiLib.radial.* (gleiche Namen) | Radialmenü |
IsHandsUp, IsPointing, GetGestureProvider, PlayEmote, CancelEmote, GetEmoteProvider | gestures.* | aiLib.gestures.* | Gesten und Emotes |
ApplyAppearance, GetPedAppearance, OpenClothingMenu, WearOutfit, ReloadSkin | appearance.apply, read, openMenu, wearOutfit, reloadSkin | aiLib.appearance.* (gleiche Namen) | Aussehen |
IsDead | medical.isDead, medical.onChange | keiner (rufe den Export auf) | Medizin |
GetSeatbelt, GetSeatbeltProvider | seatbelt.isOn, seatbelt.provider, seatbelt.onChange | aiLib.seatbelt.* (gleiche Namen) | Sicherheitsgurt |
OpenMdt | mdt.open | aiLib.mdt.open | MDT |
ExternalNotify | keiner (von ai-lib genutzt) | keiner | Benachrichtigungen |
Rufe Exports nicht in jedem Frame auf
Exports überqueren eine Ressourcengrenze, was mehr kostet als ein lokaler Funktionsaufruf. Lies einen Wert einmal und folge dann dem Event, das dir sagt, wann er sich ändert. Jede Seite nennt dieses Event; sie sind alle in Events und Zustand aufgelistet.
Die Menüs, Eingabedialoge, Benachrichtigungen, Aufforderungen, der Fortschrittsbalken und die Minispiele gehören zu ai-lib, nicht zu ai-core. Nutze notify, menu, input, progress und skillCheck der Lib (oder dieselben Namen auf aiLib).
vRP-Brücke
Die Exports, die die eingebaute vRP-Brücke von ai-core nutzt - der Datenspeicher von vRP, seine Datenbank-API, die Berechtigungszuordnung und die Berechtigungsliste.
Spieler
Charakter, Geld, Jobs, Dienst und Gangs des lokalen Spielers lesen, prüfen, ob ein Charakter geladen ist, und Job- und Gang-Definitionen lesen.