Referência da API
Visão geral da API
Como chamar o AI Core de outro script - exports, eventos e a lib, em TypeScript e Lua.
Tudo o que outro script pode chamar: os exports do ai-core, os eventos que ele dispara e os helpers do @aicore8/lib (os exports próprios de cada script ai-* ficam na página dele em Scripts). Cada assinatura destas páginas vem do código-fonte (@aicore8/shared exports.ts, o JSDoc da lib, as chamadas de export de cada script).
Escolha a porta certa
| Você escreve | Use |
|---|---|
| Um script ai-* ou qualquer recurso em TypeScript | @aicore8/lib: inventory, vehicleKeys, online, medical... A lib chama o ai-core por você. |
| Um recurso em Lua | aiLib do ai-lib (shared_script '@ai-lib/init.lua'), ou os exports do ai-core diretamente. |
| Um script de ESX / QB / Qbox / vRP | Nada novo: a ponte responde à API do próprio framework. Veja Camadas e a ponte. |
Itens, chaves de veículos, alertas, celular, clima, prisão, roupas e mortes sempre passam pelo ai-core, nunca pelos exports de um script específico: o ai-core encaminha para o script que o servidor roda para aquela tarefa.
Chamando um export
import { resourceExport } from "@aicore8/lib/server";
// Um handle tipado por recurso, no topo do arquivo.
const core = resourceExport("ai-core");
const cash = core.GetMoney(source, "cash");local cash = exports['ai-core']:GetMoney(source, 'cash')- Tipos:
resourceExportos lê deCitizenExportsem@aicore8/shared. Um recurso que pode não estar rodando usaoptionalExport("x")(null enquanto parado). - Nomes: cada export também responde com a primeira letra na caixa trocada (
GetMoneyegetMoney). - Exports são síncronos e retornam valores pequenos. Quando um valor precisa de tempo (um visual salvo), o export recebe um callback: nenhuma promise cruza a fronteira de um recurso.
- Caminhos quentes seguem os eventos do ai-core em vez de chamar exports em loop (o espelho
onlineda lib faz isso).
Páginas
| Página | O que você encontra nela |
|---|---|
| Exports de servidor do ai-core | Cada export de servidor do ai-core, uma página por área: personagens, dinheiro, empregos e gangues, itens, chaves, médico, celular, dispatch, prisão, mundo, banco, faturas, logs, painel de administração. |
| Exports de cliente do ai-core | Cada export de cliente: dados do jogador, HUD, dicas de teclas, sincronização do mundo, itens, menu radial, gestos, aparência, cinto de segurança. |
| Eventos e estado | Cada evento que o ai-core dispara com seus argumentos, os state bags e os eventos de ESX / QB / Qbox / vRP que a ponte dispara. |
| Lib: servidor | @aicore8/lib/server e o lado servidor do aiLib. |
| Lib: cliente | @aicore8/lib/client e o lado cliente do aiLib. |
| Lib: compartilhada e fivem | @aicore8/lib/shared e /fivem: exports, agendamento, state bags, leitores de entrada, texto e números. |
| Lib para Lua | Como um recurso em Lua usa o aiLib, e as funções que só o Lua tem. |
| Tipos | Cada tipo compartilhado que as assinaturas usam (Vec3, ActionResult, InventoryRef...), campo por campo. |
| Páginas dos scripts | Os exports e eventos próprios de cada script ai-* ficam na página Developer dele (por exemplo ai-inventory, incluindo as APIs do ox_inventory e do qb-inventory que ele responde). |