HUD

Quando seu script abre uma UI de tela cheia (uma loja, um celular, um modo foto), o HUD deve sair do caminho. Estes exports escondem e mostram o HUD que o servidor roda: ai-hud, ou um HUD de terceiros que o ai-core conhece (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). Sem nenhum HUD conhecido, o ai-core esconde e mostra o minimapa. O qb-hud e o ps-hud não podem ser escondidos por outro script: com eles só o minimapa acompanha.

Esconder funciona com motivos. Cada recurso esconde o HUD sob um nome de sua escolha ("shop", "photo-mode"). Os HUDs ficam escondidos enquanto pelo menos um motivo estiver definido por qualquer recurso, então duas telas abertas ao mesmo tempo nunca brigam: o HUD só volta depois que as duas fecham. Os motivos pertencem ao recurso que os definiu e são removidos quando ele para.

HideHudCopy Anchor Link

Esconde todos os HUDs (e o minimapa quando nenhum HUD conhecido está rodando) sob um motivo do seu recurso. Chame quando sua UI de tela cheia abrir.

Lado: Cliente · Espera: não

HideHud(reason: string): void

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

ParâmetrosCopy Anchor Link

RetornoCopy Anchor Link

Nada. Um reason que não é string é ignorado.

ExemploCopy Anchor Link

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

export function openShop(): void {
  hud.hide("shop"); // o mesmo 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

Limpa um motivo de esconder do seu recurso. Os HUDs voltam quando nenhum recurso tem mais motivo.

Lado: Cliente · Espera: não

ShowHud(reason: string): void

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

ParâmetrosCopy Anchor Link

RetornoCopy Anchor Link

Nada.

ExemploCopy Anchor Link

Veja o exemplo de HideHud.

IsHudVisibleCopy Anchor Link

Diz se os HUDs aparecem agora, ou seja, se nenhum recurso tem um motivo de esconder definido. Um recurso de HUD usa isto ao iniciar; depois segue o evento de cliente ai-core:client:hudVisible.

Lado: Cliente · Espera: não

IsHudVisible(): boolean

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

ParâmetrosCopy Anchor Link

Nenhum.

RetornoCopy Anchor Link

boolean: true quando nenhum motivo de esconder está definido, false enquanto pelo menos um estiver.

ExemploCopy Anchor Link

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

// Um HUD próprio: começa no estado certo e depois segue cada mudança.
function setVisible(visible: boolean): void {
  SendNUIMessage({ action: "visible", data: visible });
}

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

OpenHudSettingsCopy Anchor Link

Abre a tela de configurações do próprio HUD ativo (o /hud do ai-hud ou do tgiann-lumihud, por exemplo). A entrada de HUD do menu radial usa isto; qualquer script pode.

Lado: Cliente · Espera: não

OpenHudSettings(): boolean

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

ParâmetrosCopy Anchor Link

Nenhum.

RetornoCopy Anchor Link

boolean: true quando o HUD ativo tem uma tela de configurações e ela recebeu o pedido de abrir. false quando nenhum HUD conhecido está rodando ou o que está rodando não tem tela de configurações.

ExemploCopy 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

Diz se o HUD ativo tem uma tela de configurações, para você mostrar ou esconder um botão "HUD settings".

Lado: Cliente · Espera: não

HasHudSettings(): boolean

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

ParâmetrosCopy Anchor Link

Nenhum.

RetornoCopy Anchor Link

boolean: true quando um HUD conhecido está rodando e tem uma tela de configurações, false caso contrário.

ExemploCopy Anchor Link

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

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

// Um item radial que só aparece quando o HUD tem configurações para abrir.
radial.add({
  id: "myscript_hud",
  label: "HUD",
  icon: "sliders",
  canShow: () => core.HasHudSettings(),
  onPressed: () => void core.OpenHudSettings(),
});