Слои через ai-core

Эти объекты никогда не общаются с конкретным скриптом. Они спрашивают ai-core, а ai-core передаёт вызов тому скрипту, который сервер использует для этой задачи: ai-death или другому скрипту смерти, ai-appearance или tgiann-clothing, любому поддерживаемому скрипту эмоций или радиального меню. Ваш скрипт продолжает работать, когда владелец меняет один из них. Как работают слои, описано на странице Слои и мост.

Когда скрипт такого вида не запущен, вызовы отвечают false, null или собственным значением игры, как сказано в каждой записи.

medicalCopy Anchor Link

medical.isDeadCopy Anchor Link

Лежит ли локальный игрок без сознания (мёртв или в last stand) в том скрипте смерти, который запущен. Скрипты смерти держат упавшего педа живым, чтобы анимировать его, поэтому одного IsEntityDead недостаточно. После первого вызова это чтение из памяти.

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

medical.isDead(): boolean

Lua-аналога нет: вызывайте exports['ai-core']:IsDead() и слушайте локальное событие ai-core:client:dead (dead).

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

boolean: true, если медицинский слой ai-core говорит, что игрок без сознания, или пед мёртв с точки зрения игры.

ПримерCopy Anchor Link

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

RegisterCommand(
  "phone",
  () => {
    if (medical.isDead()) return notify("You cannot use the phone now", "error");
    SetNuiFocus(true, true);
  },
  false,
);

medical.onChangeCopy Anchor Link

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

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

medical.onChange(fn: (dead: boolean) => void): void

Lua-аналога нет: AddEventHandler('ai-core:client:dead', function(dead) end).

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

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

void.

ПримерCopy Anchor Link

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

const points = new Points();
medical.onChange(() => points.refresh()); // точки, canShow которых читает medical.isDead()

appearanceCopy Anchor Link

Внешность педов через слой внешности ai-core, какой бы скрипт одежды ни был запущен.

appearance.applyCopy Anchor Link

Надевает сохранённую внешность на педа модели этой внешности. Получите внешность на сервере через appearance.get(charId), создайте педа с look.model, затем примените. На собственном педе игрока это меняет его одежду.

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

appearance.apply(ped: number, look: CharacterAppearance): boolean

local ok = aiLib.appearance.apply(ped, look)

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

Тип: CharacterAppearance.

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

boolean: false, если педа нет, модель отличается или не запущен скрипт одежды.

ПримерCopy Anchor Link

import { appearance, LocalPed, triggerServerCallback } from "@aicore-fivem/lib/client";
import type { CharacterAppearance } from "@aicore-fivem/shared";

// Спящая копия персонажа, одетая как он.
export async function showSleeper(charId: number): Promise<void> {
  const look = (await triggerServerCallback("mysleep:look", [charId]).catch(() => null)) as CharacterAppearance | null;
  if (!look) return;
  new LocalPed({
    model: look.model,
    coords: { x: 151.2, y: -1004.6, z: 29.4, heading: 90 },
    onSpawn: (ped) => appearance.apply(ped, look),
  });
}

appearance.readCopy Anchor Link

Внешность, которая сейчас на педе.

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

appearance.read(ped: number): CharacterAppearance | null

local look = aiLib.appearance.read(ped) -- таблица или nil

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

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

CharacterAppearance | null: внешность или null (nil в Lua), если скрипт одежды не может сказать или никакой не запущен.

ПримерCopy Anchor Link

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

const before = appearance.read(cache.ped); // позже верните её через appearance.apply

appearance.openMenuCopy Anchor Link

Открывает для игрока магазин одежды, парикмахерскую или сохранённые наряды скрипта одежды.

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

appearance.openMenu(menu: ClothingMenu): boolean

local ok = aiLib.appearance.openMenu(menu)

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

Тип: ClothingMenu.

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

boolean: false, если в скрипте одежды нет такого меню или никакой не запущен.

ПримерCopy Anchor Link

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

const points = new Points();
points.add("barber", {
  coords: { x: -814.3, y: -183.8, z: 37.6 },
  label: "Barber",
  onPressed: () => appearance.openMenu("barber"),
});

appearance.wearOutfitCopy Anchor Link

Надевает на игрока рабочий наряд (униформу) до вызова reloadSkin. Он не сохраняется: переподключение или reloadSkin возвращает игроку его собственную одежду. Меняются только перечисленные части.

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

appearance.wearOutfit(outfit: JobOutfit): boolean

local ok = aiLib.appearance.wearOutfit(outfit)

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

Типы: JobOutfit и OutfitPiece.

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

boolean: false, если это невозможно (нет скрипта одежды, модель, которую он не поддерживает).

ПримерCopy Anchor Link

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

appearance.wearOutfit({
  components: [
    { id: 11, collection: "", index: 55, texture: 0 },
    { id: 4, collection: "", index: 35, texture: 0 },
  ],
  props: [{ id: 0, collection: "", index: -1, texture: 0 }],
});

appearance.reloadSkinCopy Anchor Link

Возвращает на игрока его сохранённую внешность (снимает рабочий наряд).

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

appearance.reloadSkin(): boolean

local ok = aiLib.appearance.reloadSkin()

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

boolean: false без скрипта одежды.

ПримерCopy Anchor Link

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

RegisterCommand("offduty", () => appearance.reloadSkin(), false);

gesturesCopy Anchor Link

Поднятые руки, указание и эмоции того скрипта эмоций, который запущен, через ai-core.

gestures.isHandsUpCopy Anchor Link

Подняты ли руки у локального игрока.

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

gestures.isHandsUp(): boolean

local up = aiLib.gestures.isHandsUp()

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

boolean: true, пока руки подняты в запущенном скрипте эмоций.

ПримерCopy Anchor Link

import { gestures, onServerCallback } from "@aicore-fivem/lib/client";

// Сервер перед ограблением спрашивает, сдалась ли жертва.
onServerCallback("myrob:surrendered", () => gestures.isHandsUp());

gestures.isPointingCopy Anchor Link

Указывает ли локальный игрок пальцем.

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

gestures.isPointing(): boolean

local pointing = aiLib.gestures.isPointing()

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

boolean: true, пока игрок указывает.

ПримерCopy Anchor Link

if (gestures.isPointing()) return; // не запускаем эмоцию поверх указания

gestures.providerCopy Anchor Link

Скрипт эмоций, который отвечает за поднятые руки и указание.

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

gestures.provider(): string | null

local name = aiLib.gestures.provider()

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

string | null: имя его ресурса или null (nil), если никакой не запущен.

ПримерCopy Anchor Link

console.log(`hands up from ${gestures.provider() ?? "nothing"}`);

gestures.playEmoteCopy Anchor Link

Проигрывает эмоцию по имени её команды (то, что игроки вводят после e) в запущенном скрипте эмоций.

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

gestures.playEmote(name: string): boolean

local ok = aiLib.gestures.playEmote(name)

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

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

boolean: false без скрипта эмоций.

ПримерCopy Anchor Link

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

RegisterCommand("hi", () => gestures.playEmote("wave"), false);

gestures.cancelEmoteCopy Anchor Link

Останавливает эмоцию, которую проигрывает игрок (надели наручники, сбили с ног).

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

gestures.cancelEmote(): boolean

local ok = aiLib.gestures.cancelEmote()

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

boolean: false без скрипта эмоций.

ПримерCopy Anchor Link

onServerEvent("mypolice:cuffed", () => gestures.cancelEmote());

gestures.emoteProviderCopy Anchor Link

Скрипт эмоций, который проигрывает эмоции (он может отличаться от того, что отвечает за поднятые руки).

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

gestures.emoteProvider(): string | null

local name = aiLib.gestures.emoteProvider()

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

string | null: имя его ресурса или null (nil), если никакой не запущен.

ПримерCopy Anchor Link

if (gestures.emoteProvider() === null) console.log("no emote script: skipping the emote");

seatbeltCopy Anchor Link

Ремень безопасности локального игрока через ai-core, какой бы скрипт ремня ни был запущен.

seatbelt.isOnCopy Anchor Link

Пристёгнут ли ремень. Спрашивайте по необходимости, не каждый кадр.

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

seatbelt.isOn(): boolean | null

local worn = aiLib.seatbelt.isOn() -- boolean или nil

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

boolean | null: true или false; null (nil), если не отвечает ни один скрипт ремня.

ПримерCopy Anchor Link

import { cache, notify, onCache, seatbelt } from "@aicore-fivem/lib/client";

onCache("vehicle", (vehicle) => {
  if (vehicle !== false && seatbelt.isOn() === false) notify("Buckle up", "warning");
});

seatbelt.onChangeCopy Anchor Link

Запускает обработчик, когда меняется состояние ремня. Его вызывают только скрипты ремня, которые сообщают об изменениях.

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

seatbelt.onChange(fn: (worn: boolean | null) => void): void

aiLib.seatbelt.onChange(function(worn) end)

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

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

void.

ПримерCopy Anchor Link

seatbelt.onChange((worn) => SendNUIMessage({ action: "belt", data: worn === true }));

seatbelt.providerCopy Anchor Link

Скрипт ремня, который отвечает.

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

seatbelt.provider(): string | null

local name = aiLib.seatbelt.provider()

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

string | null: имя его ресурса или null (nil), если никакой не отвечает.

ПримерCopy Anchor Link

if (seatbelt.provider() === null) console.log("no seat belt script runs");

fuelCopy Anchor Link

fuel.getCopy Anchor Link

Уровень топлива транспорта. Сервер держит state bag fuel для каждого транспорта, какой бы скрипт топлива ни был запущен, поэтому это чтение из памяти; без этого bag это уровень бака в игре.

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

fuel.get(vehicle: number): number

Lua-аналога нет: читайте Entity(vehicle).state.fuel. Задать топливо можно только на сервере (fuel.set на странице Транспорт).

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

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

number: 0-100.

ПримерCopy Anchor Link

import { cache, every, fuel } from "@aicore-fivem/lib/client";

every(1000, () => {
  if (cache.vehicle !== false) SendNUIMessage({ action: "fuel", data: Math.round(fuel.get(cache.vehicle)) });
});

mdtCopy Anchor Link

mdt.openCopy Anchor Link

Открывает активный полицейский MDT для локального игрока. MDT сам проверяет работу.

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

mdt.open(): boolean

local ok = aiLib.mdt.open()

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

boolean: false, если MDT не запущен или его нельзя открыть извне.

ПримерCopy Anchor Link

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

RegisterCommand("mdt", () => {
  if (!mdt.open()) notify("No MDT available", "error");
}, false);

radialCopy Anchor Link

Пункты того радиального меню, которое запущено (ai-radialmenu или другое через радиальный слой ai-core). ai-core сохраняет их при перезапусках радиального меню и удаляет, когда ваш ресурс останавливается: добавляйте один раз при старте.

radial.addCopy Anchor Link

Добавляет пункт в колесо или заменяет пункт с тем же id.

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

radial.add(item: RadialItem): void

aiLib.radial.add(item)

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

RadialItemCopy Anchor Link

Тип: RadialItem.

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

void.

ПримерCopy Anchor Link

import { cache, createLocale, hasJob, radial } from "@aicore-fivem/lib/client";
import { RADIAL_VEHICLE } from "@aicore-fivem/shared";

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

radial.add({
  id: "myscript:engine",
  label: Locale("ENGINE"),
  icon: "power-off",
  parent: RADIAL_VEHICLE,
  keepOpen: true,
  canShow: () => cache.seat === -1,
  onPressed: () => {
    if (cache.vehicle === false) return;
    SetVehicleEngineOn(cache.vehicle, !GetIsVehicleEngineRunning(cache.vehicle), false, true);
  },
});

radial.add({
  id: "myscript:police",
  label: Locale("POLICE"),
  icon: "shield-halved",
  canShow: () => hasJob(["police"]),
  items: [
    { id: "myscript:cuff", label: Locale("CUFF"), icon: "handcuffs", onPressed: () => emitNet("mypolice:cuff") },
  ],
});

radial.removeCopy Anchor Link

Удаляет один из ваших пунктов. Неизвестный id ничего не делает.

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

radial.remove(id: string): void

aiLib.radial.remove(id)

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

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

void.

ПримерCopy Anchor Link

radial.remove("myscript:engine");

radial.refreshCopy Anchor Link

Заново читает все canShow открытого колеса. Вызывайте после того, как изменилось то, что они читают, пока колесо может быть открыто.

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

radial.refresh(): void

aiLib.radial.refresh()

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

void.

ПримерCopy Anchor Link

onMembershipChange(() => radial.refresh());

worldCopy Anchor Link

Синхронизация погоды и времени того скрипта погоды, который запущен, приостановленная, пока действует причина.

world.pauseSyncCopy Anchor Link

Приостанавливает синхронизацию погоды и времени по причине: внутри интерьера, во время сцены или пока ваш скрипт задаёт собственную погоду.

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

world.pauseSync(reason: string): void

aiLib.world.pauseSync(reason)

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

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

void.

ПримерCopy Anchor Link

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

export function enterApartment(): void {
  world.pauseSync("apartment");
  NetworkOverrideClockTime(12, 0, 0);
  SetWeatherTypeNowPersist("EXTRASUNNY");
}

export function leaveApartment(): void {
  world.resumeSync("apartment");
}

world.resumeSyncCopy Anchor Link

Убирает одну причину паузы; синхронизация снова работает, когда не осталось ни одной причины.

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

world.resumeSync(reason: string): void

aiLib.world.resumeSync(reason)

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

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

void. См. пример world.pauseSync.

inventoryCopy Anchor Link

Инвентарь локального игрока через слой инвентаря ai-core: отвечает инвентарь, выбранный на сервере. Выдавать и забирать предметы можно только на сервере (Предметы).

inventory.openInventoryCopy Anchor Link

Открывает экран собственного инвентаря игрока.

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

inventory.openInventory(): void

aiLib.inventory.openInventory()

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

void.

ПримерCopy Anchor Link

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

RegisterCommand("bag", () => inventory.openInventory(), false);

inventory.hasItemCopy Anchor Link

Есть ли у игрока не меньше count единиц предмета. Используйте в canShow, чтобы игрок видел только то, что может сделать; сервер проверит снова.

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

inventory.hasItem(item: string, count?: number): boolean

local has = aiLib.inventory.hasItem(item, count)

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

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

boolean: true, если у игрока достаточно.

ПримерCopy Anchor Link

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

const points = new Points();
points.addVehicle("lockpick", {
  label: "Lockpick",
  icon: "unlock",
  canShow: (vehicle) => GetVehicleDoorLockStatus(vehicle) >= 2 && inventory.hasItem("lockpick"),
  onPressed: (vehicle) => emitNet("mykeys:lockpick", NetworkGetNetworkIdFromEntity(vehicle)),
});

inventory.currentWeaponCopy Anchor Link

Предмет оружия в руке игрока: его название, подпись и картинка.

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

inventory.currentWeapon(): HeldWeapon | null

local weapon = aiLib.inventory.currentWeapon() -- таблица или nil

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

HeldWeapon { name: string; label: string; image?: string } (name вида WEAPON_PISTOL, image это URL nui://, если он есть у инвентаря) или null (nil), если рука пуста.

ПримерCopy Anchor Link

import { inventory, onCache } from "@aicore-fivem/lib/client";

// Читайте при смене оружия, никогда не каждый кадр.
onCache("weapon", () => SendNUIMessage({ action: "weapon", data: inventory.currentWeapon() }));