AI Core
Referencia de la APILib: cliente

Lib: cliente

@aicore8/lib/client y el lado de cliente de aiLib: qué son, cómo cargarlos en TypeScript y Lua, y cada página temática.

La lib de cliente es el conjunto de utilidades que usa cada script de cliente ai-* en lugar de escribir natives a mano: hablar con el servidor, el jugador local, puntos de interacción, zonas, peds y blips, la interfaz compartida (notificaciones, barra de progreso, menús, minijuegos), keybinds, y las capas que llegan, a través de ai-core, al script de HUD, muerte, ropa o emotes que use el servidor.

TypeScript

Importa desde @aicore8/lib/client en los archivos bajo resource/client/. Las utilidades que funcionan en cualquier lado (rechazos, lectores de entrada, matemáticas, RecordObjects, ServerClock) vienen de @aicore8/lib/shared.

resource/client/index.ts
import { Points, notify, progress, cache } from "@aicore8/lib/client";
import { RecordObjects, ServerClock } from "@aicore8/lib/shared";

Cada recurso creado a partir de la plantilla de ai-core ya depende del paquete ("@aicore8/lib": "workspace:*" en package.json); la compilación lo empaqueta en dist/client.js.

Lua

Los recursos Lua obtienen las mismas utilidades en la tabla global aiLib desde el recurso ai-lib. Añade dos líneas a tu fxmanifest.lua:

fxmanifest.lua
dependency 'ai-lib'
shared_script '@ai-lib/init.lua'

Después llama a aiLib.<name> en cualquier archivo de cliente. Cada módulo se carga la primera vez que lo usas y se ejecuta dentro de tu recurso, así que los puntos, keybinds y callbacks que creas pertenecen a tu recurso y desaparecen cuando se detiene. Las clases se crean con .new() y sus métodos se llaman con dos puntos: local points = aiLib.Points.new(), después points:add(...).

client.lua
local t = aiLib.locale()

RegisterCommand('hello', function()
    aiLib.notify(t('HELLO'), 'success')
end, false)

Las funciones Lua marcadas con Espera (triggerServerCallback, callAction, progress, menu.show, input, skillCheck, lockpick, itemPicker, fadeOut, fadeIn, player.teleport, waitForEntity, los cargadores request*, pedHeadshot) pausan el código hasta que llega la respuesta. Solo funcionan dentro de un hilo. Los handlers de comandos y de eventos de red ya se ejecutan en uno; en cualquier otro sitio (el onPressed de un punto, un keybind, un callback de menú), envuelve la llamada en CreateThread(function() ... end).

No todas las utilidades de TypeScript tienen un equivalente en Lua. Cada entrada lo indica cuando no lo tiene. Las que faltan en Lua: fromServer, isActionOk, replyError, onCache (Lua tiene cache.onChange), readPlayerState, readWeapon, player.holdAnim, attachProp, PreviewVehicle, NuiScreen, hud.onChange, controls.isDisabled, medical, fuel, drivenVehicle, entityFromNetId, las utilidades de props de vehículo, ScriptCamera, TickLoop (usa aiLib.every(0, fn)), AreaFollower, ServerClock, AdminWorld, RecordObjects y las comprobaciones de pertenencia (hasJob, inGang, onDutyIn, allows, onMembershipChange).

Temas

Utilidades compartidas con el servidor

La entrada de cliente también reexporta las utilidades de /fivem, así que puedes importarlas también desde @aicore8/lib/client. Se documentan una sola vez en Lib: compartido y fivem:

registerExport, resourceExport, optionalExport, callExport, provideExport, isResourceStarted, createLocale, loadLocaleTexts, LOCALE_CONVAR, ByResource, caller, onStop, plateOf, Reasons, every (con los tipos EveryOptions y Job), stateBoolean, stateNumber, stateString (tipo StateParse).

Las clases de state bags EntityState, PlayerState, GlobalKey y GlobalGroup exportadas desde la entrada de cliente son las versiones de cliente de solo lectura: get(id) y onChange(handler), sin set. Las versiones de servidor están en State bags.

Exports que tu script nunca llama

ZoneEngine (el comprobador de zonas detrás de Zones), ModelScanner y readModelScanDef (el escaneo de modelos detrás de Points.addModel) se exportan para ai-lib, que los ejecuta para cada recurso. Usa Zones y Points en su lugar.

En esta página