Ekrany i sterowanie

Funkcje dla skryptów z własną stroną NUI albo trybem narzędzia: otwórz pełnoekranową stronę z fokusem i ukrytymi HUD-ami, wymień klawisze narzędzia w HUD i blokuj sterowanie bez pisania pętli co klatkę.

NuiScreenCopy Anchor Link

new NuiScreenCopy Anchor Link

Pełnoekranowa strona NUI twojego zasobu w jednym obiekcie. open bierze fokus, ukrywa każdy HUD (przez hud) i wysyła wiadomość otwarcia; close oddaje fokus, pokazuje HUD-y, wysyła { action: "close" } do strony i uruchamia twoje onClose. Własny callback NUI close strony też ją zamyka. Utwórz jeden na zasób, na górze pliku.

Strona: Klient · Czeka: nie

new NuiScreen<M extends NuiPageMessage = NuiPageMessage>(name: string, options?: NuiScreenOptions)

Brak odpowiednika w Lua: zasoby Lua same wywołują SetNuiFocus, aiLib.hud.hide / show i RegisterNUICallback('close', ...).

ParametryCopy Anchor Link

NuiScreenOptionsCopy Anchor Link

NuiPageMessageCopy Anchor Link

Co przyjmują open i send: { action: string; data?: unknown }. Podaj własny typ unii jako M, żeby otypować każdą wiadomość.

SkładoweCopy Anchor Link

PrzykładCopy Anchor Link

import { callAction, NuiScreen, ScriptCamera } from "@aicore-fivem/lib/client";
import { readText } from "@aicore-fivem/lib/shared";

type Message =
  | { action: "open"; data: { items: string[] } }
  | { action: "result"; data: boolean };

const camera = new ScriptCamera();
const screen = new NuiScreen<Message>("shop", {
  onClose: () => camera.stop(500),
});

export function openShop(items: string[]): void {
  camera.start({ x: 26.5, y: -1345.0, z: 30.2 }, { pointAt: { x: 25.7, y: -1347.3, z: 29.5 } }, 500);
  screen.open({ action: "open", data: { items } });
}

// Strona wywołuje fetch(`https://${GetParentResourceName()}/buy`, { body: JSON.stringify("water") }).
screen.on(
  "buy",
  (data) => readText(data, 32),
  async (item) => {
    const reply = await callAction("myshop:buy", [item], { fallback: "BUY_FAILED" });
    return { ok: reply !== null };
  },
);

hudCopy Anchor Link

HUD-y (ai-hud i inne skrypty HUD obsługiwane przez ai-core) przez ai-core. Pełnoekranowe UI ukrywa je przy otwarciu i pokazuje przy zamknięciu. Powody są liczone per zasób, więc dwa ekrany otwarte naraz trzymają HUD-y ukryte, dopóki oba się nie zamkną. Dopóki obowiązuje jakikolwiek powód, ai-core ukrywa każdy HUD i minimapę.

hud.hideCopy Anchor Link

Ukrywa każdy HUD z powodu, aż do hud.show z tym samym powodem.

Strona: Klient · Czeka: nie

hud.hide(reason: string): void

aiLib.hud.hide(reason)

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

void.

PrzykładCopy Anchor Link

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

RegisterCommand(
  "cinema",
  () => {
    if (hud.visible) hud.hide("cinema");
    else hud.show("cinema");
  },
  false,
);

hud.showCopy Anchor Link

Usuwa jeden powód ukrycia. HUD-y wracają, gdy nie zostaje żaden powód żadnego zasobu.

Strona: Klient · Czeka: nie

hud.show(reason: string): void

aiLib.hud.show(reason)

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

void. Zobacz przykład hud.hide.

hud.visibleCopy Anchor Link

Czy HUD-y są teraz pokazane (żadne pełnoekranowe UI nie jest otwarte).

Strona: Klient · Czeka: nie

hud.visible: boolean // właściwość tylko do odczytu

local visible = aiLib.hud.visible() -- w Lua to funkcja

Zwracana wartośćCopy Anchor Link

boolean: true, gdy nie obowiązuje żaden powód ukrycia żadnego zasobu.

hud.onChangeCopy Anchor Link

Uruchamia handler za każdym razem, gdy HUD-y się pokazują albo ukrywają. Skrypt HUD używa go, żeby się ukryć.

Strona: Klient · Czeka: nie

hud.onChange(fn: (visible: boolean) => void): void

Brak odpowiednika w Lua: nasłuchuj lokalnego zdarzenia ai-core:client:hudVisible (visible).

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

void.

PrzykładCopy Anchor Link

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

hud.onChange((visible) => SendNUIMessage({ action: "visible", data: visible }));

keyHintsCopy Anchor Link

Linie pomocy klawiszy, które skrypt pokazuje przez jakiś czas (klawisze noclipa administratora, sterowanie minigry), wymieniane przez HUD po lewej obok tych, które klawisze deklarują przez hint. Podpowiedzi zatrzymanego zasobu znikają same.

keyHints.showCopy Anchor Link

Pokazuje podpowiedź klawisza albo zmienia tę o tym samym id.

Strona: Klient · Czeka: nie

keyHints.show(id: string, hint: KeyHintRequest): void

aiLib.keyHints.show(id, hint)

ParametryCopy Anchor Link

KeyHintRequestCopy Anchor Link

Typ to KeyHintRequest.

Zwracana wartośćCopy Anchor Link

void.

PrzykładCopy Anchor Link

import { createLocale, keyHints } from "@aicore-fivem/lib/client";

const Locale = createLocale<typeof import("../../locales/en.json")>();

export function startPlacing(): void {
  keyHints.show("rotate", { label: Locale("ROTATE"), key: "Q / E", icon: "rotate" });
  keyHints.show("place", { label: Locale("PLACE"), keybind: "myscript_place", icon: "check" });
}

export function stopPlacing(): void {
  keyHints.hide("rotate");
  keyHints.hide("place");
}

keyHints.hideCopy Anchor Link

Usuwa jedną z twoich podpowiedzi klawiszy. Nieznane id nic nie robi.

Strona: Klient · Czeka: nie

keyHints.hide(id: string): void

aiLib.keyHints.hide(id)

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

void. Zobacz przykład keyHints.show.

controlsCopy Anchor Link

Wyłączone sterowanie twojego zasobu, z jednym zadaniem co klatkę dla wszystkich. Każdy powód (cuffed, menu, placing) dodaje swoje sterowanie i usuwa je, gdy się kończy; zadanie działa tylko wtedy, gdy aktywny jest jakiś powód. Nigdy nie pisz własnego setTick z DisableControlAction.

controls.disableCopy Anchor Link

Wyłącza listę sterowania co klatkę aż do controls.enable(reason). Ponowne wywołanie z tym samym powodem zastępuje listę tego powodu.

Strona: Klient · Czeka: nie

controls.disable(reason: string, controls: readonly number[], group?: number): void

aiLib.controls.disable(reason, controls, group)

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

void.

PrzykładCopy Anchor Link

import { controls, onServerEvent } from "@aicore-fivem/lib/client";

const CUFFED = [21, 22, 23, 24, 25, 37, 44, 140, 141, 142, 143, 257, 263, 264];

onServerEvent(
  "mypolice:cuffed",
  { args: ([on]) => (typeof on === "boolean" ? [on] : null) },
  (on) => (on ? controls.disable("cuffed", CUFFED) : controls.enable("cuffed")),
);

controls.disableAllCopy Anchor Link

Wyłącza całe sterowanie (grupy wejścia 0, 1 i 2) co klatkę aż do controls.enable(reason), z wyjątkiem tego, które zostawisz. Używaj go dla noclipa albo wolnej kamery i czytaj wyłączone klawisze przez IsDisabledControlPressed.

Strona: Klient · Czeka: nie

controls.disableAll(reason: string, except?: readonly number[]): void

aiLib.controls.disableAll(reason, except)

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

void.

PrzykładCopy Anchor Link

import { controls, every } from "@aicore-fivem/lib/client";

const fly = every(0, () => {
  if (IsDisabledControlPressed(0, 32)) console.log("forward");
}, { active: false, name: "noclip" });

export function noclip(on: boolean): void {
  if (on) controls.disableAll("noclip", [1, 2, 249]);
  else controls.enable("noclip");
  fly.set(on);
}

controls.enableCopy Anchor Link

Kończy jeden powód: jego sterowanie znowu działa, chyba że inny powód nadal je wyłącza. Nieznany powód nic nie robi.

Strona: Klient · Czeka: nie

controls.enable(reason: string): void

aiLib.controls.enable(reason)

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

void. Zobacz przykłady wyżej.

controls.isDisabledCopy Anchor Link

Czy powód twojego zasobu jest teraz aktywny.

Strona: Klient · Czeka: nie

controls.isDisabled(reason: string): boolean

Brak odpowiednika w Lua.

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

boolean: true, dopóki ten powód obowiązuje.

PrzykładCopy Anchor Link

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

if (controls.isDisabled("cuffed")) console.log("the player is cuffed");