Wspólne UI

ai-lib rysuje jedno wspólne UI za każdy zasób: karty powiadomień, pasek postępu, prompty "naciśnij E", menu, okna wejścia i minigry. Twój skrypt tylko o nie prosi, więc każdy skrypt na serwerze wygląda tak samo, a ty nie piszesz do nich żadnego NUI. Wybierak przedmiotów rysuje ai-core.

Teksty, które podajesz, są pokazywane tak, jak są: najpierw je przetłumacz (Locale("KEY") w TypeScript, t('KEY') w Lua).

PowiadomieniaCopy Anchor Link

notifyCopy Anchor Link

Pokazuje kartę powiadomienia na ekranie tego gracza.

Strona: Klient · Czeka: nie

notify(text: string, kind?: NotificationKind, duration?: number): void

aiLib.notify(text, kind, duration)

ParametryCopy Anchor Link

Typ kind to NotificationKind. Żeby powiadomić gracza z serwera, użyj serwerowego notify(source, text, kind).

Zwracana wartośćCopy Anchor Link

void.

PrzykładCopy Anchor Link

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

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

notify(Locale("WELCOME"));
notify(Locale("NO_MONEY"), "error");
notify(Locale("SAVED"), "success", 2000);

Pasek postępuCopy Anchor Link

progressCopy Anchor Link

Wykonuje akcję z czasem z paskiem postępu ai-lib i opcjonalną animacją albo scenariuszem i czeka, aż się skończy. Kończy się wcześniej (anulowana), gdy gracz zginie, wsiądzie do pojazdu, naciśnie klawisz anulowania ai-lib (domyślnie Backspace, tylko z canCancel) albo twój skrypt wywoła cancelProgress(). Jeden pasek na zasób naraz.

Strona: Klient · Czeka: tak (Promise w TypeScript, w Lua wstrzymuje wątek)

progress(options: ProgressOptions): Promise<boolean>

local finished = aiLib.progress(options) -- boolean, wywołuj wewnątrz wątku

ParametryCopy Anchor Link

ProgressOptionsCopy Anchor Link

Zwracana wartośćCopy Anchor Link

Promise<boolean>: true, gdy pasek dobiegł końca; false, gdy został anulowany, albo od razu, gdy inny pasek twojego zasobu jeszcze trwa. Lua zwraca tę samą wartość logiczną.

PrzykładCopy Anchor Link

import { callAction, createLocale, nearestVehicle, notify, progress } from "@aicore-fivem/lib/client";

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

export async function repair(): Promise<void> {
  const vehicle = nearestVehicle(4, { notOwn: true });
  if (!vehicle) return notify(Locale("NO_VEHICLE"), "error");
  const [x = 0, y = 0, z = 0] = GetEntityCoords(vehicle, false);
  const done = await progress({
    label: Locale("REPAIRING"),
    duration: 8000,
    face: { x, y, z },
    anim: { dict: "mini@repair", clip: "fixing_a_player" },
    canCancel: true,
    disable: { move: true, combat: true },
  });
  if (!done) return notify(Locale("CANCELLED"), "error");
  await callAction("mymech:repair", [NetworkGetNetworkIdFromEntity(vehicle)], { fallback: "REPAIR_FAILED" });
}

cancelProgressCopy Anchor Link

Anuluje trwający pasek twojego zasobu, niezależnie od tego, czy gracz może go anulować. Wywołanie progress rozwiązuje się wtedy false. Nic się nie dzieje, gdy żaden pasek nie trwa.

Strona: Klient · Czeka: nie

cancelProgress(): void

aiLib.progress.cancel()

Zwracana wartośćCopy Anchor Link

void.

PrzykładCopy Anchor Link

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

// Serwer mówi, że cel został okradziony przez kogoś innego.
onServerEvent("myrob:taken", () => cancelProgress());

isProgressRunningCopy Anchor Link

Czy pasek twojego zasobu trwa teraz.

Strona: Klient · Czeka: nie

isProgressRunning(): boolean

local running = aiLib.progress.isRunning()

Zwracana wartośćCopy Anchor Link

boolean: true, dopóki trwa pasek twojego zasobu. Paski innych zasobów się nie liczą.

PrzykładCopy Anchor Link

import { isProgressRunning, menu } from "@aicore-fivem/lib/client";

export async function openMenu(): Promise<void> {
  if (isProgressRunning()) return; // zajęty
  await menu({ title: "Actions", items: [{ id: "a", label: "Action" }] });
}

Menu i okna dialogoweCopy Anchor Link

menuCopy Anchor Link

Pokazuje menu ai-lib i czeka na wybór gracza. Strzałki przesuwają, Enter wybiera. Pozycje z checked to wiersze-przełączniki, które przełączają się w miejscu bez zamykania menu. W podmenu (back: true) krótkie Escape rozwiązuje się MENU_BACK, żebyś mógł otworzyć poprzednie menu; przytrzymanie Escape zamyka.

Strona: Klient · Czeka: tak (Promise w TypeScript, w Lua wstrzymuje wątek)

menu(request: MenuRequest, listeners?: ((item: string) => void) | MenuListeners): Promise<string | null>

local picked = aiLib.menu.show(request, listeners) -- string albo nil, wywołuj wewnątrz wątku

ParametryCopy Anchor Link

MenuRequestCopy Anchor Link

MenuItemCopy Anchor Link

Typy to MenuRequest i MenuItem.

MenuListenersCopy Anchor Link

Zwracana wartośćCopy Anchor Link

Promise<string | null>: id wybranej pozycji; "__back" (MENU_BACK z @aicore-fivem/shared) po krótkim Escape w podmenu; null, gdy gracz zamknął menu. Lua zwraca to samo, nil przy zamknięciu.

PrzykładCopy Anchor Link

import { callAction, createLocale, menu } from "@aicore-fivem/lib/client";
import { MENU_BACK } from "@aicore-fivem/shared";

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

export async function vehicleMenu(vehicle: number): Promise<void> {
  const pick = await menu({
    title: Locale("VEHICLE"),
    items: [
      { id: "doors", label: Locale("DOORS"), icon: "door-open" },
      { id: "engine", label: Locale("ENGINE"), icon: "power-off", checked: engineOn },
    ],
  }, {
    onToggle: (item, checked) => {
      if (item !== "engine") return;
      engineOn = checked;
      SetVehicleEngineOn(vehicle, checked, false, true);
    },
  });
  if (pick === "doors") await doorsMenu(vehicle);
}

async function doorsMenu(vehicle: number): Promise<void> {
  const pick = await menu({
    title: Locale("DOORS"),
    back: true,
    items: [0, 1, 2, 3].map((door) => ({ id: String(door), label: Locale("DOOR", door + 1) })),
  });
  if (pick === MENU_BACK) return vehicleMenu(vehicle);
  if (pick !== null) SetVehicleDoorOpen(vehicle, Number(pick), false, false);
}

inputCopy Anchor Link

Pokazuje okno wejścia ai-lib i czeka na wartości. Każde pole to pole liczbowe albo tekstowe.

Strona: Klient · Czeka: tak (Promise w TypeScript, w Lua wstrzymuje wątek)

input(request: InputRequest): Promise<Record<string, string | number> | null>

local values = aiLib.input(request) -- tabela albo nil, wywołuj wewnątrz wątku

ParametryCopy Anchor Link

InputRequestCopy Anchor Link

InputField: numberCopy Anchor Link

InputField: textCopy Anchor Link

Typy to InputRequest i InputField.

Zwracana wartośćCopy Anchor Link

Promise<Record<string, string | number> | null>: wpisane wartości według name pola, gdy gracz potwierdził; null, gdy zamknął okno. Wartości, które nie są ani stringiem, ani liczbą, są pomijane. Lua zwraca tabelę albo nil.

PrzykładCopy Anchor Link

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

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

export async function sendBill(target: number): Promise<void> {
  const values = await input({
    title: Locale("BILL"),
    confirm: Locale("SEND"),
    fields: [
      { name: "amount", label: Locale("AMOUNT"), type: "number", min: 1, max: 100000 },
      { name: "reason", label: Locale("REASON"), type: "text", maxLength: 80 },
    ],
  });
  if (!values) return;
  await callAction("mybill:send", [target, values.amount, values.reason], { fallback: "BILL_FAILED" });
}

itemPickerCopy Anchor Link

Narzędzia administratora: pokazuje wybierak przedmiotów ai-core. Wymienia każdy przedmiot aktywnego ekwipunku z obrazkiem i wyszukiwaniem; kliknięcia wypełniają listę po prawej (1 na kliknięcie, 10 z Ctrl, 100 z Shift), która zatrzymuje się na limicie wagi celu. Lista przedmiotów jest wysyłana tylko administratorom.

Strona: Klient · Czeka: tak (Promise w TypeScript, w Lua wstrzymuje wątek)

itemPicker(request: ItemPickerRequest): Promise<PickedItem[] | null>

local list = aiLib.itemPicker(request) -- tabela albo nil, wywołuj wewnątrz wątku

ParametryCopy Anchor Link

ItemPickerRequestCopy Anchor Link

Zwracana wartośćCopy Anchor Link

Promise<PickedItem[] | null>: lista, którą wziął administrator, każdy wiersz { name: string; count: number } (count to liczba całkowita powyżej 0); null, gdy wybierak został zamknięty. Lua zwraca listę albo nil. Typy to ItemPickerRequest i PickedItem.

PrzykładCopy Anchor Link

import { callAction, itemPicker } from "@aicore-fivem/lib/client";

export async function giveItems(target: number): Promise<void> {
  const list = await itemPicker({ title: "Give items", target });
  if (!list || list.length === 0) return;
  await callAction("myadmin:give", [target, list], { fallback: "GIVE_FAILED" });
}

Prompty ręcznieCopy Anchor Link

Punkty pokazują i ukrywają prompty za ciebie. Używaj tych funkcji tylko dla promptu, który nie jest związany z miejscem.

showPromptCopy Anchor Link

Pokazuje (albo zmienia tekst) jednego z promptów twojego zasobu: ramkę "naciśnij E" po prawej stronie ekranu. Z at prompt zamiast tego unosi się nad punktem w świecie albo miejscem na encji.

Strona: Klient · Czeka: nie

showPrompt(id: string, text: string, at?: PromptAnchor): void

aiLib.showPrompt(id, text) -- brak kotwicy w świecie w Lua

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

void.

PrzykładCopy Anchor Link

Zobacz onPromptPressed.

hidePromptCopy Anchor Link

Ukrywa jeden z promptów twojego zasobu. Id, które nie jest pokazane, nic nie robi.

Strona: Klient · Czeka: nie

hidePrompt(id: string): void

aiLib.hidePrompt(id)

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

void.

onPromptPressedCopy Anchor Link

Uruchamia handler, gdy gracz naciśnie klawisz interakcji (domyślnie E), gdy jeden z promptów twojego zasobu jest na wierzchu.

Strona: Klient · Czeka: nie

onPromptPressed(handler: (id: string) => void): void

aiLib.onPromptPressed(function(id) end)

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

void.

PrzykładCopy Anchor Link

import { createLocale, hidePrompt, onCache, onPromptPressed, showPrompt } from "@aicore-fivem/lib/client";

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

// "Naciśnij E, żeby wyrzucić" podczas siedzenia na miejscu pasażera.
onCache("seat", (seat) => {
  if (seat === 0) showPrompt("eject", Locale("EJECT"));
  else hidePrompt("eject");
});

onPromptPressed((id) => {
  if (id !== "eject") return;
  TaskLeaveVehicle(PlayerPedId(), GetVehiclePedIsIn(PlayerPedId(), false), 4160);
});

MinigryCopy Anchor Link

skillCheckCopy Anchor Link

Test umiejętności ai-lib: wskazówka obiega pierścień raz na etap, a gracz naciska pokazany klawisz, gdy jest ona na zielonym łuku. Ma typowy kształt testu umiejętności FiveM ("easy" | "medium" | "hard" albo { areaSize, speedMultiplier }), więc kod napisany dla testu umiejętności ox_lib działa tak samo.

Strona: Klient · Czeka: tak (Promise w TypeScript, w Lua wstrzymuje wątek)

skillCheck(difficulty: SkillDifficulty | SkillDifficulty[], keys?: string[]): Promise<boolean>

local passed = aiLib.skillCheck(difficulty, keys) -- boolean, wywołuj wewnątrz wątku

ParametryCopy Anchor Link

SkillDifficultyCopy Anchor Link

SkillDifficulty to jedno z:

Zwracana wartośćCopy Anchor Link

Promise<boolean>: true, gdy trafiono każdy etap; false przy chybieniu, złym klawiszu albo Escape.

PrzykładCopy Anchor Link

import { callAction, skillCheck } from "@aicore-fivem/lib/client";

export async function hotwire(netId: number): Promise<void> {
  const passed = await skillCheck(["easy", "easy", "medium", { areaSize: 30, speedMultiplier: 1.5 }], ["w", "a", "s", "d"]);
  await callAction("mykeys:hotwire", [netId, passed], { fallback: "HOTWIRE_FAILED" });
}

lockpickCopy Anchor Link

Wytrych ai-lib: gracz przesuwa wytrych klawiszami A / D (albo strzałkami) i przytrzymuje W, żeby obrócić zamek. Zamek obraca się tym dalej, im bliżej wytrych jest ukrytego dobrego punktu; forsowanie zużywa wytrych.

Strona: Klient · Czeka: tak (Promise w TypeScript, w Lua wstrzymuje wątek)

lockpick(options?: LockpickOptions): Promise<LockpickResult>

local result = aiLib.lockpick(options) -- 'opened' | 'broken' | 'cancelled', wywołuj wewnątrz wątku

ParametryCopy Anchor Link

LockpickOptionsCopy Anchor Link

Zwracana wartośćCopy Anchor Link

Promise<LockpickResult> (LockpickResult): "opened", gdy obróciła się każda zapadka; "broken", gdy złamał się ostatni wytrych (zabierz przedmiot wytrycha); "cancelled", gdy gracz nacisnął Escape.

PrzykładCopy Anchor Link

import { callAction, lockpick } from "@aicore-fivem/lib/client";

export async function pickDoor(doorId: string): Promise<void> {
  const result = await lockpick({ difficulty: "hard", pins: 3, picks: 2 });
  if (result === "cancelled") return;
  await callAction("mydoors:picked", [doorId, result], { fallback: "PICK_FAILED" });
}