Referencia de la API
Resumen de la API
Cómo llamar a AI Core desde otro script - exports, eventos y la lib, en TypeScript y Lua.
Todo lo que otro script puede llamar: los exports de ai-core, los eventos que dispara, los exports de cada script ai-* y las utilidades de @aicore-fivem/lib. Cada firma de estas páginas sale del código fuente (@aicore-fivem/shared exports.ts, el JSDoc de la lib, las llamadas de export de cada script).
Elige la puerta correcta
| Escribes | Usa |
|---|---|
| Un script ai-* o cualquier recurso en TypeScript | @aicore-fivem/lib: inventory, vehicleKeys, online, medical... La lib llama a ai-core por ti. |
| Un recurso en Lua | aiLib de ai-lib (shared_script '@ai-lib/init.lua'), o directamente los exports de ai-core. |
| Un script de ESX / QB / Qbox | Nada nuevo: el puente responde a la API propia del framework. Ver Capas y el puente. |
Objetos, llaves de vehículos, alertas, teléfono, clima, prisión, ropa y muertes siempre pasan por ai-core, nunca por los exports de un script concreto: ai-core reenvía al script que el servidor use para esa tarea.
Llamar a un export
import { resourceExport } from "@aicore-fivem/lib/server";
// One typed handle per resource, at the top of the file.
const core = resourceExport("ai-core");
const cash = core.GetMoney(source, "cash");local cash = exports['ai-core']:GetMoney(source, 'cash')- Tipos:
resourceExportlos lee deCitizenExportsen@aicore-fivem/shared. Un recurso que puede no estar en marcha usaoptionalExport("x")(null mientras está detenido). - Nombres: cada export responde también con la primera letra en la otra caja (
GetMoneyygetMoney). - Los exports son síncronos y devuelven valores pequeños. Cuando un valor necesita tiempo (un aspecto guardado), el export recibe un callback: ninguna promesa cruza el límite de un recurso.
- Las rutas calientes siguen los eventos de ai-core en lugar de llamar a exports en un bucle (el espejo
onlinede la lib lo hace así).
Páginas
| Página | Qué |
|---|---|
| Exports de servidor de ai-core | Personajes, dinero, trabajos, bandas, objetos, llaves, médico, teléfono, despacho, prisión, mundo, buckets, logs, conexión, panel de administración. |
| Exports de cliente de ai-core | Datos del jugador, HUD, ayudas de teclas, sincronización del mundo, objetos, radial, gestos, aspectos, diálogos. |
| Eventos y estado | Eventos CORE.* con sus datos, state bags, eventos de framework que dispara el puente. |
| Exports de scripts | Exports de cada script ai-*, incluidas las API de ox_inventory, pma-voice y qb-weathersync que sustituyen. |
| Lib: cliente | @aicore-fivem/lib/client. |
| Lib: servidor | @aicore-fivem/lib/server. |
| Lib: shared y fivem | @aicore-fivem/lib/shared y /fivem. |
| Lib para Lua | aiLib en recursos Lua. |