Зоны

Зона это область, которая выполняет код, когда игрок входит в неё или выходит из неё: вход в район, область ограничения скорости, маркер, который рисуется только поблизости. Когда игрок должен что-то сделать в этом месте (нажать клавишу, выбрать опцию target), используйте точку: это зона с уже подключёнными подсказкой, target, педом и блипом.

В TypeScript каждую зону проверяет единая проверка ai-lib для всех ресурсов (зоны лежат в сетке по 64 м, поэтому миллион зон стоит столько же, сколько несколько). Ваш ресурс проверяет свои зоны сам, только пока ai-lib не запущен. В Lua каждый ресурс запускает одну задачу планировщика для своих зон.

new ZonesCopy Anchor Link

Создаёт группу зон. Создайте одну группу на функцию в начале файла.

Сторона: Клиент · Ждёт: нет

new Zones()

local zones = aiLib.Zones.new()

ВозвращаетCopy Anchor Link

Группа Zones с методами ниже.

ПримерCopy Anchor Link

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

const zones = new Zones();

zones.addCopy Anchor Link

Добавляет зону или заменяет зону с тем же id. Если в заменяемой зоне был игрок, сначала выполняется её onExit.

Сторона: Клиент · Ждёт: нет

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

zones:add(id, options)

ПараметрыCopy Anchor Link

ZoneOptionsCopy Anchor Link

ZoneShapeCopy Anchor Link

ZoneShape это один из трёх объектов, выбираемый по type:

В Lua center может быть vector3, а точки таблицами { x = ..., y = ... }.

ВозвращаетCopy Anchor Link

void.

ПримерCopy 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

Удаляет одну зону. Если игрок был внутри, выполняется onExit. Неизвестный id ничего не делает.

Сторона: Клиент · Ждёт: нет

zones.remove(id: string): void

zones:remove(id)

ПараметрыCopy Anchor Link

ВозвращаетCopy Anchor Link

void.

ПримерCopy Anchor Link

zones.remove("safezone");

zones.clearCopy Anchor Link

Удаляет все зоны группы; onExit выполняется для тех, в которых находится игрок.

Сторона: Клиент · Ждёт: нет

zones.clear(): void

zones:clear()

ВозвращаетCopy Anchor Link

void.

ПримерCopy Anchor Link

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

zones.isInsideCopy Anchor Link

Находится ли игрок внутри зоны, по результату её последней проверки.

Сторона: Клиент · Ждёт: нет

zones.isInside(id: string): boolean

local inside = zones:isInside(id)

ПараметрыCopy Anchor Link

ВозвращаетCopy Anchor Link

boolean: true, пока внутри; false снаружи или для неизвестного id. Отражает последнюю проверку, поэтому может устареть до interval мс.

ПримерCopy Anchor Link

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

zones.sizeCopy Anchor Link

Сколько зон содержит группа.

Сторона: Клиент · Ждёт: нет

zones.size: number // свойство только для чтения

Lua-аналога нет.

ВозвращаетCopy Anchor Link

number: количество зон в этой группе.

ПримерCopy Anchor Link

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