Членство и данные игрока

ai-core отправляет собственные данные локального игрока на его клиент: один снимок при загрузке персонажа, затем только изменившиеся значения. Эти помощники читают эту копию, поэтому проверка стоит одного чтения из памяти и никогда не спрашивает сервер.

Используйте их для того, что игрок видит (canShow точки, пункт радиального меню, строка меню). Что игрок может делать, решает сервер по тем же данным (online на странице Игроки и персонажи): клиентская проверка никогда не является доказательством.

Данные игрокаCopy Anchor Link

Значения, которые хранит ai-core, по ключу (AiPlayerData):

Типы членов: CharacterInfo, JobMembership и GangMembership.

getPlayerDataCopy Anchor Link

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

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

getPlayerData<K extends keyof AiPlayerData>(key: K): AiPlayerData[K] | undefined

local value = aiLib.playerData.get(key)

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

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

AiPlayerData[K] | undefined: значение или undefined (nil в Lua), если ещё ничего не пришло (персонаж не загружен, ai-core не запущен).

ПримерCopy Anchor Link

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

RegisterCommand(
  "whoami",
  () => {
    const character = getPlayerData("character");
    const job = getPlayerData("job");
    const cash = getPlayerData("money")?.cash ?? 0;
    if (!character) return notify("No character loaded", "error");
    notify(`${job?.job ?? "unemployed"} (${job?.grade ?? 0}), $${cash}`, "info");
  },
  false,
);

onPlayerDataCopy Anchor Link

Запускает обработчик каждый раз, когда ai-core присылает ключ для этого игрока.

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

onPlayerData<K extends keyof AiPlayerData>(key: K, handler: (value: AiPlayerData[K]) => void): () => void

aiLib.playerData.onChange(key, function(value) end)

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

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

TypeScript: () => void, функция, которая удаляет обработчик. Lua ничего не возвращает.

ПримерCopy Anchor Link

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

const stop = onPlayerData("money", (money) => {
  SendNUIMessage({ action: "money", data: { cash: money.cash ?? 0, bank: money.bank ?? 0 } });
});
// stop(), когда HUD закрывается насовсем

seedPlayerDataCopy Anchor Link

Заполняет значения вручную. Ключи, у которых уже есть значение, сохраняются. Вам это не нужно: lib сама заполняется из ai-core при первом использовании.

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

seedPlayerData(data: Partial<AiPlayerData>): void

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

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

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

void.

ПримерCopy Anchor Link

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

// Тестовая обвязка без ai-core.
seedPlayerData({ jobs: [{ job: "police", grade: 3 }], duty: "police" });

Проверки членстваCopy Anchor Link

hasJobCopy Anchor Link

Состоит ли игрок в одной из работ с минимальным рангом, на дежурстве или нет.

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

hasJob(jobs: readonly string[], minGrade?: number): boolean

Lua-аналога нет: переберите aiLib.playerData.get('jobs') (см. пример на Lua для points.add).

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

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

boolean: true, если список пуст или игрок состоит в одной из jobs с рангом minGrade или выше.

ПримерCopy Anchor Link

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

const points = new Points();
points.add("armory", {
  coords: { x: 482.6, y: -995.2, z: 30.7 },
  label: "Armory",
  canShow: () => hasJob(["police", "sheriff"], 1),
  onPressed: () => emitNet("mypolice:armory"),
});
onMembershipChange(() => points.refresh());

inGangCopy Anchor Link

Состоит ли игрок в одной из банд с минимальным рангом.

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

inGang(gangs: readonly string[], minGrade?: number): boolean

Lua-аналога нет: переберите aiLib.playerData.get('gangs').

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

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

boolean: true, если список пуст или игрок состоит в одной из gangs с рангом minGrade или выше.

ПримерCopy Anchor Link

import { inGang, radial } from "@aicore-fivem/lib/client";

radial.add({
  id: "mygang:stash",
  label: "Gang stash",
  icon: "box",
  canShow: () => inGang(["ballas", "vagos"], 2),
  onPressed: () => emitNet("mygang:stash"),
});

onDutyInCopy Anchor Link

На дежурстве ли игрок в одной из работ.

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

onDutyIn(jobs: readonly string[]): boolean

Lua-аналога нет: aiLib.playerData.get('duty') это работа на дежурстве.

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

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

boolean: true, если работа дежурства игрока входит в jobs.

ПримерCopy Anchor Link

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

const points = new Points();
points.addVehicle("mymech:repair", {
  label: "Repair",
  icon: "wrench",
  canShow: () => onDutyIn(["mechanic"]),
  onPressed: (vehicle) => emitNet("mymech:repair", NetworkGetNetworkIdFromEntity(vehicle)),
});

onMembershipChangeCopy Anchor Link

Выполняет функцию, когда меняются работы, дежурство или банды игрока. Используйте, чтобы обновлять точки и блипы, canShow которых их читает.

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

onMembershipChange(fn: () => void): void

Lua-аналога нет: aiLib.playerData.onChange для jobs, duty и gangs.

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

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

void.

ПримерCopy Anchor Link

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

const points = new Points();
onMembershipChange(() => {
  points.refresh();
  radial.refresh();
});

allowsCopy Anchor Link

Может ли локальный игрок пользоваться местом с правилом доступа. Серверный online.allows(source, rule) решает по тому же правилу, поэтому то, что видит игрок, в точности совпадает с тем, чем сервер позволяет пользоваться. Читайте правило из записи панели через readAccess(record) (@aicore-fivem/lib/shared).

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

allows(rule: AccessRule): boolean

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

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

AccessRuleCopy Anchor Link

Тип: AccessRule.

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

boolean: true, если оба списка пусты (все); если игрок состоит в одной из gangs с её минимальным рангом; или если игрок состоит в одной из jobs с её минимальным рангом (и на дежурстве в ней при onDuty). Иначе false.

ПримерCopy Anchor Link

import { AdminWorld, allows, callAction, onMembershipChange, Points } from "@aicore-fivem/lib/client";
import { readAccess, readVec3, RecordObjects, type AccessRule } from "@aicore-fivem/lib/shared";

const world = new AdminWorld(["stashes"]);
const points = new Points();

interface Stash { coords: { x: number; y: number; z: number }; access: AccessRule }
const readStash = (_key: string, raw: Record<string, unknown>): Stash | null => {
  const coords = readVec3(raw.coords);
  return coords ? { coords, access: readAccess(raw) } : null;
};

new RecordObjects(world, "stashes", readStash, (id, stash) => {
  points.add(id, {
    coords: stash.coords,
    label: "Stash",
    canShow: () => allows(stash.access),
    onPressed: () => callAction("mystash:open", [id], { fallback: "STASH_FAILED" }),
  });
  return () => points.remove(id);
});

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