HUD

Cuando tu script abre una interfaz a pantalla completa (una tienda, un teléfono, un modo foto), el HUD debería apartarse. Estos exports ocultan y muestran el HUD que tenga el servidor: ai-hud, o un HUD de terceros que ai-core conoce (tgiann-lumihud, tgiann-hudv2, tgiann-modern-hud, tgiann-statushud, jg-hud, 0r-hud-v3, codem-supreme-hud, Codem-BlackHUDV2, wais-hudv6, qb-hud, ps-hud). Sin un HUD conocido, ai-core oculta y muestra el minimapa en su lugar. Otro script no puede ocultar qb-hud ni ps-hud: con ellos solo el minimapa sigue el estado.

La ocultación funciona con motivos. Cada recurso oculta el HUD bajo un nombre de su elección ("shop", "photo-mode"). Los HUD siguen ocultos mientras algún recurso tenga al menos un motivo puesto, así que dos pantallas abiertas a la vez nunca se pelean: el HUD vuelve solo cuando se cierran las dos. Los motivos pertenecen al recurso que los puso y se quitan cuando se detiene.

HideHudCopy Anchor Link

Oculta cada HUD (y el minimapa cuando no hay ningún HUD conocido en marcha) bajo un motivo de tu recurso. Llámalo cuando se abra tu interfaz a pantalla completa.

Lado: Cliente · Espera: no

HideHud(reason: string): void

exports['ai-core']:HideHud(reason) -- o aiLib.hud.hide(reason)

ParámetrosCopy Anchor Link

DevuelveCopy Anchor Link

Nada. Un reason que no es una cadena se ignora.

EjemploCopy Anchor Link

import { hud } from "@aicore-fivem/lib/client";

export function openShop(): void {
  hud.hide("shop"); // igual que resourceExport("ai-core").HideHud("shop")
  SetNuiFocus(true, true);
  SendNUIMessage({ action: "open" });
}

RegisterNuiCallback("close", (_data: unknown, cb: (r: unknown) => void) => {
  SetNuiFocus(false, false);
  hud.show("shop");
  cb(true);
});

ShowHudCopy Anchor Link

Quita un motivo de ocultación de tu recurso. Los HUD vuelven cuando ningún recurso tiene un motivo pendiente.

Lado: Cliente · Espera: no

ShowHud(reason: string): void

exports['ai-core']:ShowHud(reason) -- o aiLib.hud.show(reason)

ParámetrosCopy Anchor Link

DevuelveCopy Anchor Link

Nada.

EjemploCopy Anchor Link

Consulta el ejemplo de HideHud.

IsHudVisibleCopy Anchor Link

Indica si los HUD se muestran ahora mismo, es decir, si ningún recurso tiene puesto un motivo de ocultación. Un recurso de HUD lo usa al iniciar; después sigue el evento de cliente ai-core:client:hudVisible.

Lado: Cliente · Espera: no

IsHudVisible(): boolean

local visible = exports['ai-core']:IsHudVisible() -- o aiLib.hud.visible()

ParámetrosCopy Anchor Link

Ninguno.

DevuelveCopy Anchor Link

boolean: true cuando no hay ningún motivo de ocultación, false mientras haya al menos uno.

EjemploCopy Anchor Link

import { hud } from "@aicore-fivem/lib/client";

// Un HUD propio: empieza en el estado correcto y después sigue cada cambio.
function setVisible(visible: boolean): void {
  SendNUIMessage({ action: "visible", data: visible });
}

setVisible(hud.visible);
hud.onChange(setVisible);

OpenHudSettingsCopy Anchor Link

Abre la pantalla de ajustes propia del HUD en marcha (el /hud de ai-hud o de tgiann-lumihud, por ejemplo). La entrada HUD del menú radial lo usa; cualquier script puede hacerlo.

Lado: Cliente · Espera: no

OpenHudSettings(): boolean

local opened = exports['ai-core']:OpenHudSettings() -- boolean

ParámetrosCopy Anchor Link

Ninguno.

DevuelveCopy Anchor Link

boolean: true cuando el HUD en marcha tiene pantalla de ajustes y se le pidió que la abra. false cuando no hay ningún HUD conocido en marcha o el que está en marcha no tiene pantalla de ajustes.

EjemploCopy Anchor Link

import { notify, resourceExport } from "@aicore-fivem/lib/client";
import { Locale } from "common";

const core = resourceExport("ai-core");

RegisterCommand(
  "hudsettings",
  () => {
    if (!core.OpenHudSettings()) notify(Locale("NO_HUD_SETTINGS"), "error");
  },
  false,
);

HasHudSettingsCopy Anchor Link

Indica si el HUD en marcha tiene pantalla de ajustes, para que puedas mostrar u ocultar un botón de "ajustes del HUD".

Lado: Cliente · Espera: no

HasHudSettings(): boolean

local has = exports['ai-core']:HasHudSettings() -- boolean

ParámetrosCopy Anchor Link

Ninguno.

DevuelveCopy Anchor Link

boolean: true cuando hay en marcha un HUD conocido con pantalla de ajustes, false en otro caso.

EjemploCopy Anchor Link

import { radial, resourceExport } from "@aicore-fivem/lib/client";

const core = resourceExport("ai-core");

// Un elemento radial que solo se muestra cuando el HUD tiene ajustes que abrir.
radial.add({
  id: "myscript_hud",
  label: "HUD",
  icon: "sliders",
  canShow: () => core.HasHudSettings(),
  onPressed: () => void core.OpenHudSettings(),
});