Ekranlar ve kontroller

Kendi NUI sayfası ya da araç modu olan script’ler için yardımcılar: odak alan ve HUD’ları gizleyen tam ekran bir sayfa açmak, bir aracın tuşlarını HUD’da listelemek ve kare başı bir döngü yazmadan kontrolleri engellemek.

NuiScreenCopy Anchor Link

new NuiScreenCopy Anchor Link

Resource’unun tam ekran NUI sayfası tek bir nesnede. open odağı alır, tüm HUD’ları gizler (hud üzerinden) ve açılış mesajını gönderir; close odağı geri verir, HUD’ları gösterir, sayfaya { action: "close" } gönderir ve senin onClose’unu çalıştırır. Sayfanın kendi close NUI callback’i de onu kapatır. Resource başına, dosyanın en üstünde bir tane oluştur.

Taraf: Client · Bekler: hayır

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

Lua karşılığı yok: Lua resource’ları SetNuiFocus, aiLib.hud.hide / show ve RegisterNUICallback('close', ...) çağrılarını kendileri yapar.

ParametrelerCopy Anchor Link

NuiScreenOptionsCopy Anchor Link

NuiPageMessageCopy Anchor Link

open ve send’in aldığı: { action: string; data?: unknown }. Her mesajı tiplemek için kendi union tipini M olarak geçir.

ÜyelerCopy Anchor Link

ÖrnekCopy 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 } });
}

// Sayfa fetch(`https://${GetParentResourceName()}/buy`, { body: JSON.stringify("water") }) çağırır.
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

ai-core üzerinden HUD’lar (ai-hud ve ai-core’un desteklediği diğer HUD script’leri). Tam ekran bir arayüz açılışta onları gizler ve kapanışta gösterir. Sebepler resource başına sayılır; bu yüzden aynı anda açık iki ekran, ikisi de kapanana kadar HUD’ları gizli tutar. Herhangi bir sebep geçerliyken ai-core tüm HUD’ları ve minimap’i gizler.

hud.hideCopy Anchor Link

Aynı sebeple hud.show çağrılana kadar tüm HUD’ları bir sebeple gizler.

Taraf: Client · Bekler: hayır

hud.hide(reason: string): void

aiLib.hud.hide(reason)

ParametrelerCopy Anchor Link

Dönüş değeriCopy Anchor Link

void.

ÖrnekCopy 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

Bir gizleme sebebini kaldırır. Hiçbir resource’un sebebi kalmadığında HUD’lar geri gelir.

Taraf: Client · Bekler: hayır

hud.show(reason: string): void

aiLib.hud.show(reason)

ParametrelerCopy Anchor Link

Dönüş değeriCopy Anchor Link

void. hud.hide örneğine bak.

hud.visibleCopy Anchor Link

HUD’ların şu an görünüp görünmediği (açık tam ekran arayüz yok).

Taraf: Client · Bekler: hayır

hud.visible: boolean // salt okunur özellik

local visible = aiLib.hud.visible() -- Lua’da bir fonksiyon

Dönüş değeriCopy Anchor Link

boolean: hiçbir resource’un gizleme sebebi geçerli değilse true.

hud.onChangeCopy Anchor Link

HUD’lar her gösterildiğinde ya da gizlendiğinde bir handler çalıştırır. Bir HUD script’i kendini gizlemek için bunu kullanır.

Taraf: Client · Bekler: hayır

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

Lua karşılığı yok: yerel ai-core:client:hudVisible (visible) event’ini dinle.

ParametrelerCopy Anchor Link

Dönüş değeriCopy Anchor Link

void.

ÖrnekCopy Anchor Link

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

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

keyHintsCopy Anchor Link

Bir script’in bir süre gösterdiği tuş yardım satırları (bir admin noclip’inin tuşları, bir minigame’in kontrolleri); HUD bunları solda, keybind’lerin hint ile bildirdiklerinin yanında listeler. Duran bir resource’un ipuçları kendiliğinden kaybolur.

keyHints.showCopy Anchor Link

Bir tuş ipucu gösterir ya da aynı id’ye sahip olanı değiştirir.

Taraf: Client · Bekler: hayır

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

aiLib.keyHints.show(id, hint)

ParametrelerCopy Anchor Link

KeyHintRequestCopy Anchor Link

Tipi KeyHintRequest’tir.

Dönüş değeriCopy Anchor Link

void.

ÖrnekCopy 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

Tuş ipuçlarından birini kaldırır. Bilinmeyen bir id hiçbir şey yapmaz.

Taraf: Client · Bekler: hayır

keyHints.hide(id: string): void

aiLib.keyHints.hide(id)

ParametrelerCopy Anchor Link

Dönüş değeriCopy Anchor Link

void. keyHints.show örneğine bak.

controlsCopy Anchor Link

Resource’unun devre dışı kontrolleri; hepsi için tek bir kare başı görevle. Her sebep (cuffed, menu, placing) kendi kontrollerini ekler ve bittiğinde onları kaldırır; görev yalnızca herhangi bir sebep aktifken çalışır. DisableControlAction ile asla kendi setTick’ini yazma.

controls.disableCopy Anchor Link

controls.enable(reason) çağrılana kadar bir kontrol listesini her karede devre dışı bırakır. Aynı sebeple tekrar çağırmak o sebebin listesinin yerine geçer.

Taraf: Client · Bekler: hayır

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

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

ParametrelerCopy Anchor Link

Dönüş değeriCopy Anchor Link

void.

ÖrnekCopy 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

controls.enable(reason) çağrılana kadar, tuttukların dışında her kontrolü (girdi grupları 0, 1 ve 2) her karede devre dışı bırakır. Bir noclip ya da serbest kamera için kullan ve devre dışı tuşları IsDisabledControlPressed ile oku.

Taraf: Client · Bekler: hayır

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

aiLib.controls.disableAll(reason, except)

ParametrelerCopy Anchor Link

Dönüş değeriCopy Anchor Link

void.

ÖrnekCopy 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

Bir sebebi bitirir: başka bir sebep onları hâlâ devre dışı bırakmıyorsa kontrolleri yeniden çalışır. Bilinmeyen bir sebep hiçbir şey yapmaz.

Taraf: Client · Bekler: hayır

controls.enable(reason: string): void

aiLib.controls.enable(reason)

ParametrelerCopy Anchor Link

Dönüş değeriCopy Anchor Link

void. Yukarıdaki örneklere bak.

controls.isDisabledCopy Anchor Link

Resource’unun bir sebebinin şu an aktif olup olmadığı.

Taraf: Client · Bekler: hayır

controls.isDisabled(reason: string): boolean

Lua karşılığı yok.

ParametrelerCopy Anchor Link

Dönüş değeriCopy Anchor Link

boolean: o sebep geçerliyken true.

ÖrnekCopy Anchor Link

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

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