Punkty interakcji

Punkt to każde miejsce, z którego korzysta gracz: lada sklepu, drzwi, NPC, miejsce zwrotu, każdy bankomat, bagażnik każdego auta. Opisujesz go raz (gdzie, jaki tekst, co się dzieje), a lib rysuje go tak, jak wybrał właściciel serwera.

Prompt albo targetCopy Anchor Link

Właściciel wybiera styl interakcji w panelu administratora ai-core (Interaction [Interakcja]). W obu przypadkach działa to samo onPressed, więc twojego skryptu nie obchodzi, który jest włączony.

Gdy właściciel wybrał target, ale nie działa żaden skrypt targetu, każdy punkt jest promptem. Punkt może nadpisać wybór właściciela: promptOnly zostawia prompt (rzeczy robione z pojazdu: dystrybutory, myjnie), preferTarget używa opcji targetu zawsze, gdy działa skrypt targetu (siedzenia). Gdy skrypt targetu startuje albo się zatrzymuje albo właściciel zmienia styl, każdy punkt przechodzi sam.

new PointsCopy Anchor Link

Tworzy grupę punktów. Zrób jedną grupę na funkcję na górze pliku i dodawaj do niej punkty.

Strona: Klient · Czeka: nie

new Points()

local points = aiLib.Points.new()

Zwracana wartośćCopy Anchor Link

Grupa Points z metodami poniżej.

PrzykładCopy Anchor Link

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

const points = new Points();

points.addCopy Anchor Link

Dodaje punkt w miejscu albo zastępuje punkt o tym samym id. Punkt może nieść własnego NPC (ped) i blip na mapie (blip).

Strona: Klient · Czeka: nie

points.add(id: string, options: PointOptions): void

points:add(id, options)

ParametryCopy Anchor Link

PointOptionsCopy Anchor Link

PointPedCopy Anchor Link

Pole ped przyjmuje opcje LocalPed z wyjątkiem onSpawn i onDespawn (używa ich punkt):

PointBlipCopy Anchor Link

Pole blip przyjmuje opcje blipa; coords domyślnie to punkt:

PromptAnchorCopy Anchor Link

Co zwraca funkcja world (PromptAnchor), jedno z:

Zwracana wartośćCopy Anchor Link

void.

PrzykładCopy Anchor Link

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

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

// Lada sklepu ze sprzedawcą i blipem na mapie.
points.add("shop", {
  coords: { x: 25.7, y: -1347.3, z: 29.5 },
  label: Locale("OPEN_SHOP"),
  icon: "basket-shopping",
  ped: { model: "mp_m_shopkeep_01", coords: { x: 24.5, y: -1346.6, z: 29.5, heading: 270 } },
  blip: { sprite: 52, color: 2, label: Locale("SHOP") },
  onPressed: () => callAction("myshop:open", [], { fallback: "SHOP_FAILED" }),
});

// Schowek, który może otworzyć tylko policja; tekst podąża za stanem.
let locked = true;
points.add("evidence", {
  coords: { x: 474.9, y: -996.4, z: 26.3 },
  label: () => (locked ? Locale("UNLOCK") : Locale("LOCK")),
  icon: "box-archive",
  canShow: () => hasJob(["police"], 2),
  onPressed: async () => {
    const reply = await callAction("myscript:toggle", [], { fallback: "TOGGLE_FAILED" });
    if (reply) locked = !locked;
    points.refresh("evidence");
  },
});

// canShow czyta pracę: sprawdź ponownie, gdy zmienią się prace, służba albo gangi.
onMembershipChange(() => points.refresh());

points.addModelCopy Anchor Link

Dodaje punkt na każdym obiekcie świata o danych modelach (bankomaty, automaty, kontenery, krzesła) albo zastępuje punkt o tym samym id. W trybie targetu to opcja targetu na tych modelach; w trybie promptu prompt pokazuje się przy najbliższym z nich. Skanowanie w poszukiwaniu najbliższego obiektu działa raz w ai-lib za wszystkie zasoby, dwa razy na sekundę, i wstrzymuje się, gdy gracz stoi w miejscu.

Strona: Klient · Czeka: nie

points.addModel(id: string, options: ModelPointOptions): void

points:addModel(id, options)

ParametryCopy Anchor Link

ModelPointOptionsCopy Anchor Link

Zwracana wartośćCopy Anchor Link

void.

PrzykładCopy Anchor Link

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

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

points.addModel("atm", {
  models: ["prop_atm_01", "prop_atm_02", "prop_atm_03", "prop_fleeca_atm"],
  label: Locale("USE_ATM"),
  icon: "credit-card",
  onPressed: (atm) => callAction("mybank:atm", [NetworkGetNetworkIdFromEntity(atm)], { fallback: "ATM_FAILED" }),
});

points.addVehicleCopy Anchor Link

Dodaje punkt na każdym pojeździe sieciowym (bagażnik, maska, pchanie, naprawa) albo zastępuje punkt o tym samym id. W trybie targetu to globalna opcja pojazdów skryptu targetu; w trybie promptu prompt pokazuje się przy najbliższym pojeździe sieciowym w promieniu radius.

Strona: Klient · Czeka: nie

points.addVehicle(id: string, options: VehiclePointOptions): void

points:addVehicle(id, options)

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

void.

PrzykładCopy Anchor Link

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

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

points.addVehicle("trunk", {
  label: Locale("OPEN_TRUNK"),
  icon: "box-open",
  radius: 2.5,
  canShow: (vehicle) => vehicle !== 0 && cache.vehicle === false && GetVehicleDoorLockStatus(vehicle) < 2,
  onPressed: (vehicle) => SetVehicleDoorOpen(vehicle, 5, false, false),
});

points.removeCopy Anchor Link

Usuwa jeden punkt z jego promptem, opcją targetu, NPC i blipem. Działa dla punktów zrobionych przez add, addModel i addVehicle. Nieznane id nic nie robi.

Strona: Klient · Czeka: nie

points.remove(id: string): void

points:remove(id)

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

void.

PrzykładCopy Anchor Link

points.remove("shop");

points.clearCopy Anchor Link

Usuwa każdy punkt grupy.

Strona: Klient · Czeka: nie

points.clear(): void

points:clear()

Zwracana wartośćCopy Anchor Link

void.

PrzykładCopy Anchor Link

onServerEvent("myscript:jobEnded", () => points.clear());

points.refreshCopy Anchor Link

Ponownie czyta canShow i etykiety-funkcje. Wywołaj ją, gdy zmieniło się coś, co czytają: praca, służba, pojazd, stan wysłany przez serwer. Prompty aktualizują się od razu; opcje targetu czytają canShow, gdy oko się otwiera, a zmieniona etykieta jest zakładana ponownie.

Strona: Klient · Czeka: nie

points.refresh(id?: string): void

points:refresh() -- każdy punkt grupy

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

void.

PrzykładCopy Anchor Link

import { EntityState, onCache, onMembershipChange, Points, stateBoolean } from "@aicore-fivem/lib/client";

const points = new Points();
const robbed = new EntityState("robbed", stateBoolean);

onCache("vehicle", () => points.refresh());
onMembershipChange(() => points.refresh());
// Zmieniła się jedna kasa: odśwież tylko jej punkt.
robbed.onChange((netId) => points.refresh(`register:${netId}`));

points.isInsideCopy Anchor Link

Czy gracz stoi teraz w promieniu punktu (punkty zrobione przez add).

Strona: Klient · Czeka: nie

points.isInside(id: string): boolean

Brak odpowiednika w Lua.

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

boolean: true, dopóki gracz jest wewnątrz; false na zewnątrz albo dla nieznanego id lub punktu modelu.

PrzykładCopy Anchor Link

if (points.isInside("garage")) notify(Locale("PARK_HERE"), "info");

points.restyleCopy Anchor Link

Przestawia każdy punkt grupy na bieżący styl interakcji. Lib wywołuje to sam, gdy właściciel zmieni styl albo skrypt targetu wystartuje lub się zatrzyma; nigdy tego nie potrzebujesz.

Strona: Klient · Czeka: nie

points.restyle(): void

Brak odpowiednika w Lua (Lua też sam zmienia styl).

Zwracana wartośćCopy Anchor Link

void.

Punkty z rekordów paneluCopy Anchor Link

Większość punktów pochodzi z pliku rekordów panelu administratora twojego skryptu (sklepy, garaże, punkty wypożyczeń). Odwzoruj plik na kliencie przez AdminWorld, potem zbuduj punkty każdego rekordu przez RecordObjects: edytowany rekord przebudowuje tylko własne punkty, usunięty je usuwa.

new RecordObjectsCopy Anchor Link

Utrzymuje obiekty świata z pliku rekordów (punkty, blipy, pedy, strefy) zgodne z plikiem, po jednym rekordzie. build(key, record) tworzy obiekty jednego rekordu i zwraca, jak je usunąć. Buduje każdy rekord w konstruktorze.

Strona: Klient i serwer (z @aicore-fivem/lib/shared) · Czeka: nie

new RecordObjects<T>(
  source: RecordSource,
  file: string,
  records: RecordReader<T> | ReadonlyMap<string, T>,
  build: (key: string, record: T) => (() => void) | void,
)

Brak odpowiednika w Lua.

ParametryCopy Anchor Link

SkładoweCopy Anchor Link

PrzykładCopy Anchor Link

import { AdminWorld, callAction, createLocale, Points } from "@aicore-fivem/lib/client";
import { readVec3, RecordObjects, str } from "@aicore-fivem/lib/shared";

const Locale = createLocale<typeof import("../../locales/en.json")>();
const world = new AdminWorld(["settings", "shops"]);
const points = new Points();

interface Shop { label: string; coords: { x: number; y: number; z: number } }
const readShop = (_key: string, raw: Record<string, unknown>): Shop | null => {
  const coords = readVec3(raw.coords);
  return coords ? { label: str(raw.label, "Shop"), coords } : null;
};

const shops = new RecordObjects(world, "shops", readShop, (id, shop) => {
  points.add(id, {
    coords: shop.coords,
    label: Locale("OPEN_SHOP", shop.label),
    onPressed: () => callAction("myshop:open", [id], { fallback: "SHOP_FAILED" }),
  });
  return () => points.remove(id);
});

// Zmieniło się ustawienie, które czyta każdy sklep: przebuduj je wszystkie.
world.onChange("settings", () => shops.rebuildAll());

new AdminWorldCopy Anchor Link

Kliencka kopia światowych plików panelu twojego skryptu (plików, których schemat mówi sync: "all", zobacz Panel administratora). Czyta kopię zapisaną przez FiveM w pamięci podręcznej przy starcie, raz pyta serwer o rekordy zmienione od tego czasu, potem śledzi zmiany na żywo. Nigdy nie odpytuje.

Strona: Klient · Czeka: nie (promise ready mówi, kiedy przyszły zmiany od startu)

new AdminWorld(files: string[])

Brak odpowiednika w Lua.

ParametryCopy Anchor Link

SkładoweCopy Anchor Link

PrzykładCopy Anchor Link

import { AdminWorld } from "@aicore-fivem/lib/client";
import { num, record } from "@aicore-fivem/lib/shared";

const world = new AdminWorld(["settings"]);
const settings = world.view("settings", (raw) => ({
  radius: num(record(raw).radius, 2),
}));

world.onChange("settings", () => console.log("new radius", settings.value.radius));