Interaktionspunkte

Ein Punkt ist jeder Ort, den ein Spieler nutzt: eine Ladentheke, eine Tür, ein NPC, ein Rückgabeplatz, jeder Geldautomat, der Kofferraum jedes Autos. Du beschreibst ihn einmal (wo, welcher Text, was passiert), und die Lib zeichnet ihn so, wie der Serverbetreiber es gewählt hat.

Prompt oder TargetCopy Anchor Link

Der Betreiber wählt den Interaktionsstil im Admin-Panel von ai-core (Interaction). Dasselbe onPressed läuft in beiden Fällen, daher ist es deinem Skript egal, welcher aktiv ist.

Wenn der Betreiber Target gewählt hat, aber kein Target-Skript läuft, ist jeder Punkt ein Prompt. Ein Punkt kann die Wahl des Betreibers überschreiben: promptOnly behält einen Prompt (Dinge, die aus einem Fahrzeug heraus getan werden: Zapfsäulen, Waschanlagen), preferTarget nutzt eine Target-Option, sobald ein Target-Skript läuft (Sitze). Wenn ein Target-Skript startet oder stoppt oder der Betreiber den Stil wechselt, zieht jeder Punkt von selbst um.

new PointsCopy Anchor Link

Erstellt eine Gruppe von Punkten. Erstelle eine Gruppe pro Feature am Anfang der Datei und füge ihr Punkte hinzu.

Seite: Client · Wartet: nein

new Points()

local points = aiLib.Points.new()

RückgabewertCopy Anchor Link

Eine Points-Gruppe mit den Methoden unten.

BeispielCopy Anchor Link

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

const points = new Points();

points.addCopy Anchor Link

Fügt einen Punkt an einem Ort hinzu oder ersetzt den Punkt mit derselben ID. Ein Punkt kann seinen eigenen NPC (ped) und Karten-Blip (blip) mitbringen.

Seite: Client · Wartet: nein

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

points:add(id, options)

ParameterCopy Anchor Link

PointOptionsCopy Anchor Link

PointPedCopy Anchor Link

Das Feld ped nimmt die Optionen von LocalPed außer onSpawn und onDespawn (die der Punkt nutzt):

PointBlipCopy Anchor Link

Das Feld blip nimmt die Blip-Optionen; coords ist standardmäßig der Punkt:

PromptAnchorCopy Anchor Link

Was eine world-Funktion zurückgibt (PromptAnchor), eines von:

RückgabewertCopy Anchor Link

void.

BeispielCopy 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();

// Eine Ladentheke mit Ladenbesitzer und Karten-Blip.
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" }),
});

// Ein Lager, das nur die Polizei öffnen kann; der Text folgt einem Zustand.
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 liest den Job: erneut prüfen, wenn sich Jobs, Dienst oder Gangs ändern.
onMembershipChange(() => points.refresh());

points.addModelCopy Anchor Link

Fügt einen Punkt auf jedem Weltobjekt bestimmter Modelle hinzu (Geldautomaten, Verkaufsautomaten, Müllcontainer, Stühle) oder ersetzt den Punkt mit derselben ID. Im Target-Modus ist es eine Target-Option auf diesen Modellen; im Prompt-Modus erscheint ein Prompt in der Nähe des nächsten. Die Suche nach dem nächsten Objekt läuft einmal in ai-lib für jede Ressource, zweimal pro Sekunde, und pausiert, solange der Spieler stillsteht.

Seite: Client · Wartet: nein

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

points:addModel(id, options)

ParameterCopy Anchor Link

ModelPointOptionsCopy Anchor Link

RückgabewertCopy Anchor Link

void.

BeispielCopy 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

Fügt einen Punkt auf jedem vernetzten Fahrzeug hinzu (Kofferraum, Motorhaube, schieben, reparieren) oder ersetzt den Punkt mit derselben ID. Im Target-Modus ist es die globale Fahrzeugoption des Target-Skripts; im Prompt-Modus erscheint ein Prompt am nächsten vernetzten Fahrzeug innerhalb von radius.

Seite: Client · Wartet: nein

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

points:addVehicle(id, options)

ParameterCopy Anchor Link

RückgabewertCopy Anchor Link

void.

BeispielCopy 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

Entfernt einen Punkt mit seinem Prompt, seiner Target-Option, seinem NPC und Blip. Funktioniert für Punkte, die mit add, addModel und addVehicle erstellt wurden. Eine unbekannte ID tut nichts.

Seite: Client · Wartet: nein

points.remove(id: string): void

points:remove(id)

ParameterCopy Anchor Link

RückgabewertCopy Anchor Link

void.

BeispielCopy Anchor Link

points.remove("shop");

points.clearCopy Anchor Link

Entfernt jeden Punkt der Gruppe.

Seite: Client · Wartet: nein

points.clear(): void

points:clear()

RückgabewertCopy Anchor Link

void.

BeispielCopy Anchor Link

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

points.refreshCopy Anchor Link

Liest canShow und Label-Funktionen erneut. Rufe es auf, wenn sich etwas geändert hat, das sie lesen: der Job, der Dienst, ein Fahrzeug, ein Zustand, den der Server gesendet hat. Prompts aktualisieren sich sofort; Target-Optionen lesen canShow, wenn das Auge öffnet, und ein geändertes Label wird neu gesetzt.

Seite: Client · Wartet: nein

points.refresh(id?: string): void

points:refresh() -- jeder Punkt der Gruppe

ParameterCopy Anchor Link

RückgabewertCopy Anchor Link

void.

BeispielCopy 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());
// Eine Kasse hat sich geändert: nur ihren Punkt aktualisieren.
robbed.onChange((netId) => points.refresh(`register:${netId}`));

points.isInsideCopy Anchor Link

Ob der Spieler gerade im Radius eines Punkts steht (Punkte, die mit add erstellt wurden).

Seite: Client · Wartet: nein

points.isInside(id: string): boolean

Kein Lua-Zwilling.

ParameterCopy Anchor Link

RückgabewertCopy Anchor Link

boolean: true, solange der Spieler drin ist; false draußen, oder bei einer unbekannten ID oder einem Modellpunkt.

BeispielCopy Anchor Link

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

points.restyleCopy Anchor Link

Stellt jeden Punkt der Gruppe auf den aktuellen Interaktionsstil um. Die Lib ruft es selbst auf, wenn der Betreiber den Stil wechselt oder ein Target-Skript startet oder stoppt; du brauchst es nie.

Seite: Client · Wartet: nein

points.restyle(): void

Kein Lua-Zwilling (Lua stellt ebenfalls von selbst um).

RückgabewertCopy Anchor Link

void.

Punkte aus Panel-EinträgenCopy Anchor Link

Die meisten Punkte kommen aus einer Records-Datei des Admin-Panels deines Skripts (Shops, Garagen, Mietschalter). Spiegle die Datei auf dem Client mit AdminWorld und baue dann die Punkte jedes Eintrags mit RecordObjects: Ein bearbeiteter Eintrag baut nur seine eigenen Punkte neu auf, ein gelöschter entfernt sie.

new RecordObjectsCopy Anchor Link

Hält die Weltobjekte einer Records-Datei (Punkte, Blips, Peds, Zonen) Eintrag für Eintrag im Gleichschritt mit der Datei. build(key, record) erstellt die Objekte eines Eintrags und gibt zurück, wie sie entfernt werden. Es baut jeden Eintrag in seinem Konstruktor.

Seite: Client und Server (aus @aicore-fivem/lib/shared) · Wartet: nein

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

Kein Lua-Zwilling.

ParameterCopy Anchor Link

MitgliederCopy Anchor Link

BeispielCopy 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);
});

// Eine Einstellung, die jeder Shop liest, hat sich geändert: alle neu bauen.
world.onChange("settings", () => shops.rebuildAll());

new AdminWorldCopy Anchor Link

Die Client-Kopie der Welt-Panel-Dateien deines Skripts (die Dateien, deren Schema sync: "all" sagt, siehe Admin-Panel). Sie liest die Kopie, die FiveM beim Start gecacht hat, fragt den Server einmal nach den seitdem geänderten Einträgen und folgt dann Live-Änderungen. Sie fragt nie zyklisch ab.

Seite: Client · Wartet: nein (das ready-Promise sagt, wann die Änderungen seit dem Start angekommen sind)

new AdminWorld(files: string[])

Kein Lua-Zwilling.

ParameterCopy Anchor Link

MitgliederCopy Anchor Link

BeispielCopy 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));