Exports de cliente de ai-core
Qué son los exports de cliente de ai-core, cómo llamarlos desde TypeScript y Lua, y qué utilidad de la lib envuelve a cada uno.
Un export de cliente es una función que el lado de cliente de ai-core ofrece a todos los demás recursos en el juego del mismo jugador. Tu script de cliente lo llama para leer los datos del jugador local, ocultar el HUD, añadir un elemento al menú radial, comprobar un objeto, reproducir un emote, etc.
La mayoría de estos exports son capas: ai-core no hace el trabajo por sí mismo, reenvía la llamada al script que el servidor tenga para esa tarea (el inventario, el script de ropa, el menú radial, el menú de emotes, el script de muerte, el MDT). Tu script llama a un solo nombre y sigue funcionando cuando el dueño del servidor cambia uno de esos scripts por otro.
Antes de empezar
- Cada export de cliente es síncrono: responde al momento y nunca espera. Nada en estas páginas devuelve una Promise, y nada necesita un thread en Lua. El único export cuya respuesta necesita tiempo (
OpenItemPicker) responde mediante un evento. - Llámalos solo desde código de cliente. El servidor tiene su propia lista: exports de servidor de ai-core.
- ai-core debe estar iniciado. Un recurso que puede funcionar sin ai-core usa
optionalExport("ai-core")en TypeScript (esnullmientras ai-core está detenido). - Cada export responde también con la primera letra en la otra caja:
GetPlayerDataygetPlayerDatason la misma función. - Lo que un recurso añade con estos exports (motivos de ocultación del HUD, ayudas de teclas, elementos radiales, pausas de la sincronización del mundo) pertenece a ese recurso. ai-core lo quita cuando el recurso se detiene, así que un fallo o un reinicio nunca deja el HUD oculto ni un elemento de menú muerto.
Llamar a un export
import { resourceExport } from "@aicore8/lib/client";
// Un handle tipado, al principio del archivo. Los tipos vienen de @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,
);Usa la utilidad de la lib cuando la haya
La mayoría de los exports tienen una utilidad en @aicore8/lib/client y la misma utilidad en aiLib para recursos en Lua (shared_script '@ai-lib/init.lua'). Las utilidades llaman al export por ti, comprueban su respuesta y añaden un listener de cambios donde existe. Prefiérelas; llama al export directamente cuando no puedas usar la lib.
| Export | Lib de TypeScript | aiLib de Lua | Página |
|---|---|---|---|
GetPlayerData, IsPlayerLoaded, GetDefinitions | getPlayerData, onPlayerData | aiLib.playerData.get, aiLib.playerData.onChange | Jugador |
HideHud, ShowHud, IsHudVisible | hud.hide, hud.show, hud.visible, hud.onChange | aiLib.hud.hide, aiLib.hud.show, aiLib.hud.visible | HUD |
OpenHudSettings, HasHudSettings | ninguna | ninguna | HUD |
ShowKeyHint, HideKeyHint | keyHints.show, keyHints.hide | aiLib.keyHints.show, aiLib.keyHints.hide | Keybinds y ayudas de teclas |
GetKeybindKey, GetKeyHints, OpenKeyboard | ninguna | ninguna | Keybinds y ayudas de teclas |
PauseWorldSync, ResumeWorldSync | world.pauseSync, world.resumeSync | aiLib.world.pauseSync, aiLib.world.resumeSync | Sincronización de clima y hora |
OpenInventory, HasItem, GetCurrentWeapon | inventory.openInventory, inventory.hasItem, inventory.currentWeapon | aiLib.inventory.* (mismos nombres) | Objetos |
OpenItemPicker | itemPicker | aiLib.itemPicker | Objetos |
AddRadialItem, RemoveRadialItem, RefreshRadial | radial.add, radial.remove, radial.refresh | aiLib.radial.* (mismos nombres) | Menú radial |
IsHandsUp, IsPointing, GetGestureProvider, PlayEmote, CancelEmote, GetEmoteProvider | gestures.* | aiLib.gestures.* | Gestos y emotes |
ApplyAppearance, GetPedAppearance, OpenClothingMenu, WearOutfit, ReloadSkin | appearance.apply, read, openMenu, wearOutfit, reloadSkin | aiLib.appearance.* (mismos nombres) | Aspecto |
IsDead | medical.isDead, medical.onChange | ninguna (llama al export) | Médico |
GetSeatbelt, GetSeatbeltProvider | seatbelt.isOn, seatbelt.provider, seatbelt.onChange | aiLib.seatbelt.* (mismos nombres) | Cinturón de seguridad |
OpenMdt | mdt.open | aiLib.mdt.open | MDT |
ExternalNotify | ninguna (la usa ai-lib) | ninguna | Notificaciones |
No llames a exports en cada frame
Los exports cruzan el límite de un recurso, lo que cuesta más que llamar a una función local. Lee un valor una vez y después sigue el evento que te avisa cuando cambia. Cada página nombra ese evento; todos están listados en Eventos y estado.
Los menús, diálogos de entrada, notificaciones, avisos, la barra de progreso y los minijuegos son de ai-lib, no de ai-core. Usa notify, menu, input, progress y skillCheck de la lib (o los mismos nombres en aiLib).
Puente de vRP
Los exports que usa el puente de vRP integrado en ai-core - el almacén de datos de vRP, su API de base de datos, el mapeo de permisos y la lista de permisos.
Jugador
Lee el personaje, el dinero, los trabajos, el servicio y las bandas del jugador local, comprueba si hay un personaje cargado y lee las definiciones de trabajos y bandas.