AI Core
Referência da APIExports de cliente do ai-core

Exports de cliente do ai-core

O que são os exports de cliente do ai-core, como chamá-los de TypeScript e Lua, e qual helper da lib envolve cada um.

Um export de cliente é uma função que o lado cliente do ai-core oferece a todos os outros recursos no jogo do mesmo jogador. Seu script de cliente o chama para ler os dados do jogador local, esconder o HUD, adicionar um item ao menu radial, verificar um item, tocar um emote e assim por diante.

A maioria destes exports são camadas: o ai-core não faz o trabalho ele mesmo, ele encaminha a chamada para o script que o servidor roda para aquela tarefa (o inventário, o script de roupas, o menu radial, o menu de emotes, o script de morte, o MDT). Seu script chama um nome só e continua funcionando quando o dono do servidor troca um desses scripts por outro.

Antes de começar

  • Todo export de cliente é síncrono: responde na hora e nunca espera. Nada nestas páginas retorna uma Promise, e nada precisa de thread em Lua. O único export cuja resposta precisa de tempo (OpenItemPicker) responde por um evento.
  • Chame-os só de código de cliente. O servidor tem a sua própria lista: Exports de servidor do ai-core.
  • O ai-core precisa estar iniciado. Um recurso que pode rodar sem o ai-core usa optionalExport("ai-core") em TypeScript (ele é null enquanto o ai-core está parado).
  • Cada export também responde com a primeira letra na caixa trocada: GetPlayerData e getPlayerData são a mesma função.
  • O que um recurso adiciona por estes exports (motivos de esconder o HUD, dicas de teclas, itens radiais, pausas da sincronização do mundo) pertence a esse recurso. O ai-core os remove quando o recurso para, então um crash ou restart nunca deixa o HUD escondido ou um item de menu morto para trás.

Chamando um export

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

// Um handle tipado, no topo do arquivo. Os tipos vêm 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,
);

Use o helper da lib quando houver um

A maioria dos exports tem um helper em @aicore8/lib/client e o mesmo helper no aiLib para recursos em Lua (shared_script '@ai-lib/init.lua'). Os helpers chamam o export por você, verificam a resposta e adicionam um listener de mudança quando existe um. Prefira-os; chame o export diretamente quando não puder usar a lib.

ExportLib TypeScriptaiLib em LuaPágina
GetPlayerData, IsPlayerLoaded, GetDefinitionsgetPlayerData, onPlayerDataaiLib.playerData.get, aiLib.playerData.onChangeJogador
HideHud, ShowHud, IsHudVisiblehud.hide, hud.show, hud.visible, hud.onChangeaiLib.hud.hide, aiLib.hud.show, aiLib.hud.visibleHUD
OpenHudSettings, HasHudSettingsnenhumnenhumHUD
ShowKeyHint, HideKeyHintkeyHints.show, keyHints.hideaiLib.keyHints.show, aiLib.keyHints.hideKeybinds e dicas de teclas
GetKeybindKey, GetKeyHints, OpenKeyboardnenhumnenhumKeybinds e dicas de teclas
PauseWorldSync, ResumeWorldSyncworld.pauseSync, world.resumeSyncaiLib.world.pauseSync, aiLib.world.resumeSyncSincronização de clima e hora
OpenInventory, HasItem, GetCurrentWeaponinventory.openInventory, inventory.hasItem, inventory.currentWeaponaiLib.inventory.* (mesmos nomes)Itens
OpenItemPickeritemPickeraiLib.itemPickerItens
AddRadialItem, RemoveRadialItem, RefreshRadialradial.add, radial.remove, radial.refreshaiLib.radial.* (mesmos nomes)Menu radial
IsHandsUp, IsPointing, GetGestureProvider, PlayEmote, CancelEmote, GetEmoteProvidergestures.*aiLib.gestures.*Gestos e emotes
ApplyAppearance, GetPedAppearance, OpenClothingMenu, WearOutfit, ReloadSkinappearance.apply, read, openMenu, wearOutfit, reloadSkinaiLib.appearance.* (mesmos nomes)Aparência
IsDeadmedical.isDead, medical.onChangenenhum (chame o export)Médico
GetSeatbelt, GetSeatbeltProviderseatbelt.isOn, seatbelt.provider, seatbelt.onChangeaiLib.seatbelt.* (mesmos nomes)Cinto de segurança
OpenMdtmdt.openaiLib.mdt.openMDT
ExternalNotifynenhum (usado pelo ai-lib)nenhumNotificações

Não chame exports a cada frame

Exports cruzam a fronteira de um recurso, o que custa mais que uma chamada de função local. Leia um valor uma vez e depois siga o evento que avisa quando ele muda. Cada página nomeia esse evento; todos estão listados em Eventos e estado.

Os menus, caixas de entrada, notificações, prompts, barra de progresso e minigames são do ai-lib, não do ai-core. Use notify, menu, input, progress e skillCheck da lib (ou os mesmos nomes no aiLib).

Nesta página