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 énullenquanto o ai-core está parado). - Cada export também responde com a primeira letra na caixa trocada:
GetPlayerDataegetPlayerDatasã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
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.
| Export | Lib TypeScript | aiLib em Lua | Página |
|---|---|---|---|
GetPlayerData, IsPlayerLoaded, GetDefinitions | getPlayerData, onPlayerData | aiLib.playerData.get, aiLib.playerData.onChange | Jogador |
HideHud, ShowHud, IsHudVisible | hud.hide, hud.show, hud.visible, hud.onChange | aiLib.hud.hide, aiLib.hud.show, aiLib.hud.visible | HUD |
OpenHudSettings, HasHudSettings | nenhum | nenhum | HUD |
ShowKeyHint, HideKeyHint | keyHints.show, keyHints.hide | aiLib.keyHints.show, aiLib.keyHints.hide | Keybinds e dicas de teclas |
GetKeybindKey, GetKeyHints, OpenKeyboard | nenhum | nenhum | Keybinds e dicas de teclas |
PauseWorldSync, ResumeWorldSync | world.pauseSync, world.resumeSync | aiLib.world.pauseSync, aiLib.world.resumeSync | Sincronização de clima e hora |
OpenInventory, HasItem, GetCurrentWeapon | inventory.openInventory, inventory.hasItem, inventory.currentWeapon | aiLib.inventory.* (mesmos nomes) | Itens |
OpenItemPicker | itemPicker | aiLib.itemPicker | Itens |
AddRadialItem, RemoveRadialItem, RefreshRadial | radial.add, radial.remove, radial.refresh | aiLib.radial.* (mesmos nomes) | Menu radial |
IsHandsUp, IsPointing, GetGestureProvider, PlayEmote, CancelEmote, GetEmoteProvider | gestures.* | aiLib.gestures.* | Gestos e emotes |
ApplyAppearance, GetPedAppearance, OpenClothingMenu, WearOutfit, ReloadSkin | appearance.apply, read, openMenu, wearOutfit, reloadSkin | aiLib.appearance.* (mesmos nomes) | Aparência |
IsDead | medical.isDead, medical.onChange | nenhum (chame o export) | Médico |
GetSeatbelt, GetSeatbeltProvider | seatbelt.isOn, seatbelt.provider, seatbelt.onChange | aiLib.seatbelt.* (mesmos nomes) | Cinto de segurança |
OpenMdt | mdt.open | aiLib.mdt.open | MDT |
ExternalNotify | nenhum (usado pelo ai-lib) | nenhum | Notificaçõ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).
Ponte vRP
Os exports que a ponte vRP embutida do ai-core usa - o armazenamento de dados do vRP, a API de banco de dados, o mapeamento de permissões e a lista de permissões.
Jogador
Leia o personagem, o dinheiro, os empregos, o serviço e as gangues do jogador local, verifique se um personagem está carregado e leia as definições de empregos e gangues.