AI Core
Referencia de la APIExports de cliente de ai-core

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 (es null mientras ai-core está detenido).
  • Cada export responde también con la primera letra en la otra caja: GetPlayerData y getPlayerData son 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

resource/client/index.ts
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.

ExportLib de TypeScriptaiLib de LuaPágina
GetPlayerData, IsPlayerLoaded, GetDefinitionsgetPlayerData, onPlayerDataaiLib.playerData.get, aiLib.playerData.onChangeJugador
HideHud, ShowHud, IsHudVisiblehud.hide, hud.show, hud.visible, hud.onChangeaiLib.hud.hide, aiLib.hud.show, aiLib.hud.visibleHUD
OpenHudSettings, HasHudSettingsningunaningunaHUD
ShowKeyHint, HideKeyHintkeyHints.show, keyHints.hideaiLib.keyHints.show, aiLib.keyHints.hideKeybinds y ayudas de teclas
GetKeybindKey, GetKeyHints, OpenKeyboardningunaningunaKeybinds y ayudas de teclas
PauseWorldSync, ResumeWorldSyncworld.pauseSync, world.resumeSyncaiLib.world.pauseSync, aiLib.world.resumeSyncSincronización de clima y hora
OpenInventory, HasItem, GetCurrentWeaponinventory.openInventory, inventory.hasItem, inventory.currentWeaponaiLib.inventory.* (mismos nombres)Objetos
OpenItemPickeritemPickeraiLib.itemPickerObjetos
AddRadialItem, RemoveRadialItem, RefreshRadialradial.add, radial.remove, radial.refreshaiLib.radial.* (mismos nombres)Menú radial
IsHandsUp, IsPointing, GetGestureProvider, PlayEmote, CancelEmote, GetEmoteProvidergestures.*aiLib.gestures.*Gestos y emotes
ApplyAppearance, GetPedAppearance, OpenClothingMenu, WearOutfit, ReloadSkinappearance.apply, read, openMenu, wearOutfit, reloadSkinaiLib.appearance.* (mismos nombres)Aspecto
IsDeadmedical.isDead, medical.onChangeninguna (llama al export)Médico
GetSeatbelt, GetSeatbeltProviderseatbelt.isOn, seatbelt.provider, seatbelt.onChangeaiLib.seatbelt.* (mismos nombres)Cinturón de seguridad
OpenMdtmdt.openaiLib.mdt.openMDT
ExternalNotifyninguna (la usa ai-lib)ningunaNotificaciones

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).

En esta página