Zonen

Eine Zone ist ein Bereich, der Code ausführt, wenn der Spieler ihn betritt oder verlässt: ein Viertel betreten, ein Bereich mit Tempolimit, ein Marker, der nur in der Nähe gezeichnet wird. Wenn der Spieler an dem Ort etwas tun soll (eine Taste drücken, eine Target-Option wählen), nutze stattdessen einen Punkt: Er ist eine Zone, bei der Prompt, Target, Ped und Blip schon verdrahtet sind.

In TypeScript wird jede Zone von dem einen Prüfer von ai-lib für alle Ressourcen geprüft (Zonen liegen in einem 64-m-Raster, daher kostet eine Million Zonen so viel wie ein paar). Deine Ressource prüft ihre eigenen Zonen nur, solange ai-lib nicht läuft. In Lua führt jede Ressource einen Scheduler-Job für ihre Zonen aus.

new ZonesCopy Anchor Link

Erstellt eine Gruppe von Zonen. Erstelle eine Gruppe pro Feature am Anfang der Datei.

Seite: Client · Wartet: nein

new Zones()

local zones = aiLib.Zones.new()

RückgabewertCopy Anchor Link

Eine Zones-Gruppe mit den Methoden unten.

BeispielCopy Anchor Link

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

const zones = new Zones();

zones.addCopy Anchor Link

Fügt eine Zone hinzu oder ersetzt die Zone mit derselben ID. Wenn der Spieler in der ersetzten Zone war, läuft zuerst ihr onExit.

Seite: Client · Wartet: nein

zones.add(id: string, options: ZoneOptions): void

zones:add(id, options)

ParameterCopy Anchor Link

ZoneOptionsCopy Anchor Link

ZoneShapeCopy Anchor Link

ZoneShape ist eines von drei Objekten, gewählt nach type:

In Lua darf center ein vector3 sein und die Punkte Tabellen { x = ..., y = ... }.

RückgabewertCopy Anchor Link

void.

BeispielCopy Anchor Link

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

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

zones.add("safezone", {
  shape: { type: "cylinder", center: { x: 298.6, y: -584.5, z: 43.3 }, radius: 60, height: 30 },
  onEnter: () => notify(Locale("SAFEZONE_IN"), "info"),
  onExit: () => notify(Locale("SAFEZONE_OUT"), "info"),
});

zones.add("yard", {
  shape: {
    type: "poly",
    points: [
      { x: 1700.1, y: 2560.4 },
      { x: 1780.6, y: 2560.4 },
      { x: 1780.6, y: 2620.2 },
      { x: 1700.1, y: 2620.2 },
    ],
    minZ: 40,
    maxZ: 60,
  },
  interval: 1000,
  onEnter: () => SetPedMoveRateOverride(PlayerPedId(), 0.8),
});

zones.removeCopy Anchor Link

Entfernt eine Zone. Wenn der Spieler drin war, läuft onExit. Eine unbekannte ID tut nichts.

Seite: Client · Wartet: nein

zones.remove(id: string): void

zones:remove(id)

ParameterCopy Anchor Link

RückgabewertCopy Anchor Link

void.

BeispielCopy Anchor Link

zones.remove("safezone");

zones.clearCopy Anchor Link

Entfernt jede Zone der Gruppe; onExit läuft für die, in denen der Spieler ist.

Seite: Client · Wartet: nein

zones.clear(): void

zones:clear()

RückgabewertCopy Anchor Link

void.

BeispielCopy Anchor Link

onServerEvent("myscript:eventOver", () => zones.clear());

zones.isInsideCopy Anchor Link

Ob der Spieler in einer Zone ist, Stand ihrer letzten Prüfung.

Seite: Client · Wartet: nein

zones.isInside(id: string): boolean

local inside = zones:isInside(id)

ParameterCopy Anchor Link

RückgabewertCopy Anchor Link

boolean: true, solange drin; false draußen oder bei einer unbekannten ID. Es spiegelt die letzte Prüfung wider, kann also bis zu interval ms alt sein.

BeispielCopy Anchor Link

if (zones.isInside("safezone")) return notify(Locale("NO_WEAPONS_HERE"), "error");

zones.sizeCopy Anchor Link

Wie viele Zonen die Gruppe enthält.

Seite: Client · Wartet: nein

zones.size: number // schreibgeschützte Eigenschaft

Kein Lua-Zwilling.

RückgabewertCopy Anchor Link

number: die Anzahl der Zonen in dieser Gruppe.

BeispielCopy Anchor Link

console.log(`${zones.size} zones loaded`);