Экраны и управление

Помощники для скриптов с собственной страницей NUI или режимом инструмента: открыть полноэкранную страницу с фокусом и скрытыми HUD, показать клавиши инструмента на HUD и заблокировать элементы управления без покадрового цикла.

NuiScreenCopy Anchor Link

new NuiScreenCopy Anchor Link

Полноэкранная страница NUI вашего ресурса в одном объекте. open забирает фокус, скрывает все HUD (через hud) и отправляет сообщение об открытии; close возвращает фокус, показывает HUD, отправляет странице { action: "close" } и выполняет ваш onClose. Собственный NUI-колбэк страницы close тоже её закрывает. Создайте один на ресурс, в начале файла.

Сторона: Клиент · Ждёт: нет

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

Lua-аналога нет: ресурсы на Lua сами вызывают SetNuiFocus, aiLib.hud.hide / show и RegisterNUICallback('close', ...).

ПараметрыCopy Anchor Link

NuiScreenOptionsCopy Anchor Link

NuiPageMessageCopy Anchor Link

Что принимают open и send: { action: string; data?: unknown }. Передайте свой тип-объединение как M, чтобы типизировать каждое сообщение.

ЧленыCopy Anchor Link

ПримерCopy 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 } });
}

// Страница вызывает 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 (ai-hud и другие HUD-скрипты, которые поддерживает ai-core) через ai-core. Полноэкранный интерфейс скрывает их при открытии и показывает при закрытии. Причины считаются по ресурсам, поэтому два одновременно открытых экрана держат HUD скрытыми, пока оба не закроются. Пока действует хоть одна причина, ai-core скрывает все HUD и мини-карту.

hud.hideCopy Anchor Link

Скрывает все HUD по причине до вызова hud.show с той же причиной.

Сторона: Клиент · Ждёт: нет

hud.hide(reason: string): void

aiLib.hud.hide(reason)

ПараметрыCopy Anchor Link

ВозвращаетCopy Anchor Link

void.

ПримерCopy 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

Убирает одну причину скрытия. HUD возвращаются, когда не осталось ни одной причины ни одного ресурса.

Сторона: Клиент · Ждёт: нет

hud.show(reason: string): void

aiLib.hud.show(reason)

ПараметрыCopy Anchor Link

ВозвращаетCopy Anchor Link

void. См. пример hud.hide.

hud.visibleCopy Anchor Link

Показываются ли HUD сейчас (не открыт полноэкранный интерфейс).

Сторона: Клиент · Ждёт: нет

hud.visible: boolean // свойство только для чтения

local visible = aiLib.hud.visible() -- в Lua это функция

ВозвращаетCopy Anchor Link

boolean: true, если не действует ни одна причина скрытия ни одного ресурса.

hud.onChangeCopy Anchor Link

Запускает обработчик каждый раз, когда HUD показываются или скрываются. HUD-скрипт использует это, чтобы скрывать себя.

Сторона: Клиент · Ждёт: нет

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

Lua-аналога нет: слушайте локальное событие ai-core:client:hudVisible (visible).

ПараметрыCopy Anchor Link

ВозвращаетCopy Anchor Link

void.

ПримерCopy Anchor Link

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

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

keyHintsCopy Anchor Link

Строки подсказок клавиш, которые скрипт показывает на время (клавиши noclip администратора, управление мини-игрой); HUD показывает их слева рядом с теми, которые клавиши объявляют через hint. Подсказки остановленного ресурса исчезают сами.

keyHints.showCopy Anchor Link

Показывает подсказку клавиши или меняет подсказку с тем же id.

Сторона: Клиент · Ждёт: нет

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

aiLib.keyHints.show(id, hint)

ПараметрыCopy Anchor Link

KeyHintRequestCopy Anchor Link

Тип: KeyHintRequest.

ВозвращаетCopy Anchor Link

void.

ПримерCopy 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

Удаляет одну из ваших подсказок клавиш. Неизвестный id ничего не делает.

Сторона: Клиент · Ждёт: нет

keyHints.hide(id: string): void

aiLib.keyHints.hide(id)

ПараметрыCopy Anchor Link

ВозвращаетCopy Anchor Link

void. См. пример keyHints.show.

controlsCopy Anchor Link

Отключённые элементы управления вашего ресурса, с одной покадровой задачей для всех. Каждая причина (cuffed, menu, placing) добавляет свои элементы управления и убирает их, когда заканчивается; задача работает, только пока активна хоть одна причина. Никогда не пишите свой setTick с DisableControlAction.

controls.disableCopy Anchor Link

Отключает список элементов управления каждый кадр до вызова controls.enable(reason). Повторный вызов с той же причиной заменяет список этой причины.

Сторона: Клиент · Ждёт: нет

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

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

ПараметрыCopy Anchor Link

ВозвращаетCopy Anchor Link

void.

ПримерCopy 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

Отключает все элементы управления (группы ввода 0, 1 и 2) каждый кадр до вызова controls.enable(reason), кроме тех, которые вы оставляете. Используйте для noclip или свободной камеры и читайте отключённые клавиши через IsDisabledControlPressed.

Сторона: Клиент · Ждёт: нет

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

aiLib.controls.disableAll(reason, except)

ПараметрыCopy Anchor Link

ВозвращаетCopy Anchor Link

void.

ПримерCopy 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

Завершает одну причину: её элементы управления снова работают, если их не отключает другая причина. Неизвестная причина ничего не делает.

Сторона: Клиент · Ждёт: нет

controls.enable(reason: string): void

aiLib.controls.enable(reason)

ПараметрыCopy Anchor Link

ВозвращаетCopy Anchor Link

void. См. примеры выше.

controls.isDisabledCopy Anchor Link

Активна ли сейчас причина вашего ресурса.

Сторона: Клиент · Ждёт: нет

controls.isDisabled(reason: string): boolean

Lua-аналога нет.

ПараметрыCopy Anchor Link

ВозвращаетCopy Anchor Link

boolean: true, пока эта причина действует.

ПримерCopy Anchor Link

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

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