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 y las utilidades de @aicore8/lib (los exports propios de cada script ai-* están en su página dentro de Scripts). Cada firma de estas páginas sale del código fuente (exports.ts de @aicore8/shared, 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 | @aicore8/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 / vRP | Nada nuevo: el puente responde a la propia API del framework. Consulta Capas y el puente. |
Objetos, llaves de vehículos, alertas, teléfono, clima, prisión, ropa y muertes pasan siempre por ai-core, nunca por los exports de un script concreto: ai-core lo reenvía al script que el servidor tenga para esa tarea.
Llamar a un export
import { resourceExport } from "@aicore8/lib/server";
// Un handle tipado por recurso, al principio del archivo.
const core = resourceExport("ai-core");
const cash = core.GetMoney(source, "cash");local cash = exports['ai-core']:GetMoney(source, 'cash')- Tipos:
resourceExportlos lee deCitizenExportsen@aicore8/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é encuentras ahí |
|---|---|
| Exports de servidor de ai-core | Cada export de servidor de ai-core, una página por área: personajes, dinero, trabajos y bandas, objetos, llaves, médico, teléfono, dispatch, prisión, mundo, banca, facturación, logs, panel de administración. |
| Exports de cliente de ai-core | Cada export de cliente: datos del jugador, HUD, ayudas de teclas, sincronización del mundo, objetos, menú radial, gestos, aspecto, cinturón de seguridad. |
| Eventos y estado | Cada evento que dispara ai-core con sus argumentos, los state bags y los eventos de ESX / QB / Qbox / vRP que dispara el puente. |
| Lib: servidor | @aicore8/lib/server y el lado de servidor de aiLib. |
| Lib: cliente | @aicore8/lib/client y el lado de cliente de aiLib. |
| Lib: compartida y fivem | @aicore8/lib/shared y /fivem: exports, planificación, state bags, lectores de entrada, texto y números. |
| Lib para Lua | Cómo usa aiLib un recurso en Lua, y las funciones que solo tiene Lua. |
| Tipos | Cada tipo compartido que usan las firmas (Vec3, ActionResult, InventoryRef...), campo por campo. |
| Páginas de scripts | Los exports y eventos propios de cada script ai-* están en su página Developer (por ejemplo ai-inventory, incluidas las API de ox_inventory y qb-inventory a las que responde). |