Referencia de la API
Exports de cliente de ai-core
Cada export de cliente de ai-core - datos del jugador, HUD, ayudas de teclas, sincronización del mundo, objetos, radial, gestos, aspectos y diálogos.
Tipados como AiCoreClientExports en @aicore-fivem/shared (exports.ts).
import { resourceExport } from "@aicore-fivem/lib/client";
const core = resourceExport("ai-core");La mayoría tiene una utilidad de la lib más fácil de usar (en la última columna); los recursos en Lua tienen las mismas utilidades en aiLib.
Jugador
| Export | Qué | Lib |
|---|---|---|
GetPlayerData(): AiPlayerData | null | Los datos del jugador local: personaje, dinero, trabajos, servicio, trabajo, bandas, banda activa, metadatos. | getPlayerData, onPlayerData |
IsPlayerLoaded(): boolean | Si hay un personaje cargado. | |
IsDead(): boolean | El jugador local está abatido en el script de muerte que esté en marcha. | medical.isDead |
GetDefinitions(file: "jobs" | "gangs"): Record<string, unknown> | null | Definiciones de trabajos o bandas tal como las guarda el archivo del panel. |
local data = exports['ai-core']:GetPlayerData()
if data and data.duty == 'police' then
-- on duty
endHUD
| Export | Qué | Lib |
|---|---|---|
HideHud(reason: string): void | Oculta todos los HUD mientras se mantenga algún motivo (los motivos de un recurso detenido se van con él). | hud.hide |
ShowHud(reason: string): void | Quita un motivo. | hud.show |
IsHudVisible(): boolean | Si los HUD se muestran ahora. | hud.visible |
OpenHudSettings(): boolean | Abre los ajustes propios del HUD en marcha; false si no tiene. | |
HasHudSettings(): boolean | Si el HUD en marcha tiene ajustes. |
core.HideHud("photo-mode");
// ...
core.ShowHud("photo-mode");exports['ai-core']:HideHud('photo-mode')
exports['ai-core']:ShowHud('photo-mode')Teclas y ayudas de teclas
| Export | Qué | Lib |
|---|---|---|
GetKeybindKey(name: string): string | null | La tecla con la que se registró un Keybind de la lib; null hasta que se registra. | Keybind.currentKey |
ShowKeyHint(id: string, hint: KeyHintRequest): void | Muestra una ayuda de tecla (label, keybind?, key?, icon?) hasta que se oculta. | keyHints.show |
HideKeyHint(id: string): void | La oculta. | keyHints.hide |
GetKeyHints(): KeyHintView[] | Las ayudas que muestran ahora los HUD (id, key, label, icon?). | |
OpenKeyboard(): void | Abre la pantalla de teclas: cada tecla con una acción. |
exports['ai-core']:ShowKeyHint('noclip_speed', { label = 'Speed', key = 'SHIFT', icon = 'gauge' })Sincronización de clima y hora
| Export | Qué | Lib |
|---|---|---|
PauseWorldSync(reason: string): void | Pausa la sincronización de clima y hora mientras se mantenga algún motivo (interiores, escenas). | world.pauseSync |
ResumeWorldSync(reason: string): void | Quita un motivo. | world.resumeSync |
IsWorldSyncPaused(): boolean | Si la sincronización está pausada ahora. |
Objetos
| Export | Qué | Lib |
|---|---|---|
OpenInventory(): void | Abre la pantalla del inventario propio del jugador. | inventory.openInventory |
HasItem(item: string, count?: number): boolean | Si el jugador tiene el objeto. | inventory.hasItem |
GetCurrentWeapon(): HeldWeapon | null | El objeto de arma en la mano (name, label, image?). | inventory.currentWeapon |
OpenItemPicker(requestId: number, request: ItemPickerRequest): void | Herramientas de admin: la cuadrícula de objetos con búsqueda; el resultado llega como MENU_EVENTS.menuResult. | itemPicker |
Menú radial
Los elementos llegan al menú radial que esté en marcha; ai-core los quita cuando se detiene el recurso que los añadió.
| Export | Qué | Lib |
|---|---|---|
AddRadialItem(item: RadialItem): void | Añade o reemplaza un elemento (id, label, icon?, parent?, items?, canShow?, onPressed?, keepOpen?, whileDead?). | radial.add |
RemoveRadialItem(id: string): void | Quita un elemento. | radial.remove |
RefreshRadial(): void | Vuelve a leer cada canShow de una rueda abierta. | radial.refresh |
exports['ai-core']:AddRadialItem({
id = 'myscript_engine', label = 'Engine', icon = 'power-off', parent = 'vehicle',
canShow = function() return IsPedInAnyVehicle(PlayerPedId(), false) end,
onPressed = function() ExecuteCommand('engine') end,
})Gestos
| Export | Qué | Lib |
|---|---|---|
GetGestureProvider(): string | null | El script de emotes que responde a manos arriba y señalar. | gestures.provider |
IsHandsUp(): boolean | El jugador local tiene las manos arriba. | gestures.isHandsUp |
IsPointing(): boolean | El jugador local está señalando. | gestures.isPointing |
Aspecto
| Export | Qué | Lib |
|---|---|---|
ApplyAppearance(ped: number, look: CharacterAppearance): boolean | Pone un aspecto de GetCharacterAppearance en un ped del mismo modelo a través del script de ropa activo. | appearance.apply |
GetPedAppearance(ped: number): CharacterAppearance | null | El aspecto que lleva un ped ahora. | appearance.read |
Los menús, diálogos de entrada, notificaciones, prompts, barra de progreso y minijuegos son de ai-lib, no de ai-core: ver Exports de scripts.