Exports de servidor
Cómo llamar a los exports de servidor de ai-core desde Lua y TypeScript, y la lista de cada grupo de exports.
ai-core es el recurso del framework. Los demás recursos le piden el personaje, el dinero, los trabajos y los objetos de un jugador, y le envían tareas como "dale una llave a este jugador" o "envía una alerta a la policía". Lo hacen mediante exports: funciones que ai-core hace llamables desde cualquier otro recurso del servidor.
Estas páginas listan cada export de servidor que registra ai-core, agrupados por tema. Cada entrada muestra qué hace el export, su firma exacta, cada parámetro, qué devuelve en cada caso y un ejemplo que funciona en TypeScript y Lua.
Llamar a un export
Un export se llama por el nombre del recurso al que pertenece (ai-core) y el nombre del export.
import { resourceExport } from "@aicore8/lib/server";
// Un handle tipado por archivo, al principio. Aquí es seguro: FiveM busca cada
// export la primera vez que se usa y lo olvida cuando ai-core se reinicia.
const core = resourceExport("ai-core");
export function cashOf(source: number): number {
return core.GetMoney(source, "cash") ?? 0;
}Lo que debes saber antes de empezar:
- Tipos de TypeScript.
resourceExport("ai-core")está tipado desdeAiCoreServerExportsen@aicore8/shared, así que tu editor conoce cada nombre, parámetro y tipo de retorno. Nunca escribasresourceExport("ai-core").GetMoney(...)dentro de una función: deja el único handle al principio del archivo. - Lua usa dos puntos. Escribe
exports['ai-core']:GetMoney(source, 'cash'), no un punto. Una respuestanullllega a Lua comonil, un array como una lista de Lua (empezando por el índice 1), un objeto como una tabla. - Dos grafías. Cada export responde también con la primera letra en la otra caja:
GetMoneyygetMoneyson la misma función. - Los exports nunca esperan. Cada export responde al momento con un valor pequeño. Cuando la respuesta necesita la base de datos (un aspecto guardado, una lista de facturas), el export recibe un callback
doneen lugar de devolver una Promise, porque una Promise no puede pasar de un recurso a otro. - No en rutas calientes. Una llamada a un export copia sus argumentos y su respuesta. No llames a exports en cada frame ni para cada jugador en un bucle. Para "quién está de servicio", el nombre de un personaje o los trabajos de muchos jugadores, usa el espejo
onlinede la lib, que sigue los eventos de ai-core (Lib: servidor). - ai-core debe ejecutarse primero. Pon
dependency 'ai-core'en tufxmanifest.lua(un recurso ai-* lo lista enfxDependenciesdepackage.json), para que tu recurso se inicie después de ai-core. sourcees el id de servidor del jugador. Es el número que FiveM da a un jugador conectado. Un id de personaje (charId) es otro número: el id de la fila del personaje en la base de datos.
¿La lib o el export?
La mayoría de los exports tienen un envoltorio en @aicore8/lib/server (y muchos en el aiLib de Lua). El envoltorio llama al mismo export, así que el comportamiento es idéntico; solo se lee mejor (inventory.addItem(source, "water") en lugar de core.AddItem(source, "water")) y convierte los callbacks en Promises donde es seguro. Cada entrada nombra su envoltorio en la línea Lib. Usa el que prefieras; un recurso en Lua sin ai-lib llama al export directamente.
Ejemplos de estas páginas
Los ejemplos son archivos de servidor completos. Los ejemplos de TypeScript usan addCommand y onClientCallback de la lib; los de Lua usan aiLib.addCommand y aiLib.onClientCallback de ai-lib, que necesitan estas líneas en tu fxmanifest.lua:
shared_script '@ai-lib/init.lua'
dependency 'ai-lib'
dependency 'ai-core'Las llamadas de Lua que esperan (aiLib.progressFor, Wait) solo funcionan dentro de un thread; los handlers de comandos y callbacks ya se ejecutan en uno.
Tipos
Los tipos que aparecen en varias páginas (CharacterInfo, InventoryRef, DispatchAlert...) se documentan una sola vez con cada campo en la página de Tipos y se enlazan desde cada entrada que los usa.
Grupos de exports
Personajes y jugadores
Datos del jugador, personajes, búsquedas por id de servidor, cambio de personaje, posiciones sin conexión, jugadores en el scope.
Personajes guardados
Cualquier personaje, cargado o no: encontrarlo, leerlo, su dinero, trabajos, bandas, metadatos, nombre, tiempo jugado, guardarlo, borrarlo.
Dinero y cuentas
Saldos, añadir y quitar dinero, cuentas de trabajos y bandas, transferencias, tipos de cuenta.
Trabajos y bandas
Pertenencias, servicio, rangos, recuentos de servicio, prime time, definiciones de trabajos y bandas.
Metadatos y ajustes
La bolsa de metadatos de un personaje, la marca del servidor, scripts desactualizados.
Objetos
Añadir, quitar, contar y comprobar objetos, alijos, tiendas de scripts, objetos usables, definiciones de objetos.
Llaves de vehículos
Da, quita y comprueba llaves de vehículos a través del script de llaves en marcha.
Combustible
Lee y pon el combustible de un vehículo a través del script de combustible en marcha.
Cerraduras de puertas
Cierra, abre y lee puertas a través del script de cerraduras en marcha.
Garajes
Depósito, guardar, abrir un menú de garaje, listar los vehículos guardados de un jugador.
Médico
Reanimar, curar y comprobar si un jugador está caído.
EMS
Cuántos médicos están libres, llamadas de auxilio.
Aspecto
El aspecto guardado de un personaje desde el script de ropa en marcha.
Teléfono
Números de teléfono, correos, mensajes de texto y notificaciones del teléfono.
Dispatch
Alertas de policía y de trabajos a través del sistema de alertas en marcha.
MDT
Multas, órdenes de búsqueda, arrestos y registros de cárcel en el MDT de la policía.
Prisión
Encarcelar, liberar y tiempo restante.
Banca
Abrir una pantalla de banco, el saldo de sociedad de un trabajo.
Facturación
Envía facturas, lista y paga las facturas abiertas de un jugador.
Estrés y necesidades
Añadir o aliviar estrés, rellenar hambre y sed.
Hora y clima
Clima, hora del juego, apagón y hora congelada.
Routing buckets
Toma y devuelve un routing bucket libre para un mundo separado.
Logs
Envía logs a Discord, Fivemanage, FiveM Stats y la consola.
Comprobaciones de conexión
Comprobaciones que supera cada jugador que se conecta, scripts que sustituyen a otros.
Panel de administración y comandos
Registro de paneles, la pestaña Commands, listas de valores, pantallas de ajustes externas.
Puente de vRP
Exports que usa el puente de vRP integrado en ai-core.
Páginas relacionadas
- Exports de cliente: lo que responde ai-core en el propio juego del jugador.
- Eventos y estado: los eventos que dispara ai-core (
ai-core:playerLoaded,ai-core:moneyChanged...), que permiten a tu recurso seguir los cambios en lugar de volver a preguntar. - Lib: servidor: los envoltorios que nombra cada entrada.
Resumen de la API
Cómo llamar a AI Core desde otro script - exports, eventos y la lib, en TypeScript y Lua.
Personajes y jugadores
Lee los datos y el personaje de un jugador cargado, encuentra a un jugador por id de personaje o citizen id, cambia de personaje, mueve a un personaje desconectado, jugadores en el scope.