Członkostwo i dane gracza

ai-core wypycha własne dane lokalnego gracza do jego klienta: jedna migawka, gdy postać się wczyta, potem tylko wartości, które się zmieniają. Te funkcje czytają tę kopię, więc sprawdzenie kosztuje odczyt z pamięci i nigdy nie pyta serwera.

Używaj ich do tego, co gracz widzi (canShow punktu, pozycja menu radialnego, wiersz menu). Serwer decyduje, co gracz może zrobić, na podstawie tych samych danych (online na stronie Gracze i postacie): sprawdzenie na kliencie nigdy nie jest dowodem.

Dane graczaCopy Anchor Link

Wartości, które trzyma ai-core, według klucza (AiPlayerData):

Typy składowych to CharacterInfo, JobMembership i GangMembership.

getPlayerDataCopy Anchor Link

Ostatnia wartość jednego klucza. Przy pierwszym użyciu w twoim zasobie czyta też wszystko, co ai-core już wypchnął (z eksportu GetPlayerData ai-core), więc zasób zrestartowany po wczytaniu gracza od razu ma wartości.

Strona: Klient · Czeka: nie

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

local value = aiLib.playerData.get(key)

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

AiPlayerData[K] | undefined: wartość albo undefined (nil w Lua), gdy nic jeszcze nie przyszło (żadna postać nie jest wczytana, ai-core nie wystartował).

PrzykładCopy 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

Uruchamia handler za każdym razem, gdy ai-core wypycha klucz dla tego gracza.

Strona: Klient · Czeka: nie

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

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

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

TypeScript: () => void, funkcja, która usuwa handler. Lua nic nie zwraca.

PrzykładCopy 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(), gdy HUD zamyka się na dobre

seedPlayerDataCopy Anchor Link

Wypełnia wartości ręcznie. Klucze, które już mają wartość, są zachowywane. Nie potrzebujesz tego: lib sam się wypełnia z ai-core przy pierwszym użyciu.

Strona: Klient · Czeka: nie

seedPlayerData(data: Partial<AiPlayerData>): void

Brak odpowiednika w Lua.

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

void.

PrzykładCopy Anchor Link

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

// Środowisko testowe bez ai-core.
seedPlayerData({ jobs: [{ job: "police", grade: 3 }], duty: "police" });

Sprawdzanie członkostwaCopy Anchor Link

hasJobCopy Anchor Link

Czy gracz ma jedną z prac od minimalnego stopnia, na służbie czy nie.

Strona: Klient · Czeka: nie

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

Brak odpowiednika w Lua: przejdź po aiLib.playerData.get('jobs') (zobacz przykład Lua w points.add).

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

boolean: true, gdy lista jest pusta albo gracz ma jedną z jobs na stopniu minGrade lub wyższym.

PrzykładCopy 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

Czy gracz jest w jednym z gangów od minimalnego stopnia.

Strona: Klient · Czeka: nie

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

Brak odpowiednika w Lua: przejdź po aiLib.playerData.get('gangs').

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

boolean: true, gdy lista jest pusta albo gracz jest w jednym z gangs na stopniu minGrade lub wyższym.

PrzykładCopy 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

Czy gracz jest na służbie w jednej z prac.

Strona: Klient · Czeka: nie

onDutyIn(jobs: readonly string[]): boolean

Brak odpowiednika w Lua: aiLib.playerData.get('duty') to praca na służbie.

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

boolean: true, gdy praca, w której gracz jest na służbie, jest w jobs.

PrzykładCopy 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

Uruchamia funkcję, gdy zmienią się prace, służba albo gangi gracza. Używaj jej do odświeżania punktów i blipów, których canShow je czyta.

Strona: Klient · Czeka: nie

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

Brak odpowiednika w Lua: aiLib.playerData.onChange dla jobs, duty i gangs.

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

void.

PrzykładCopy Anchor Link

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

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

allowsCopy Anchor Link

Czy lokalny gracz może korzystać z miejsca z regułą dostępu. Serwerowe online.allows(source, rule) decyduje według tej samej reguły, więc to, co widzi gracz, jest dokładnie tym, z czego serwer pozwala mu korzystać. Odczytaj regułę z rekordu panelu przez readAccess(record) (@aicore-fivem/lib/shared).

Strona: Klient · Czeka: nie

allows(rule: AccessRule): boolean

Brak odpowiednika w Lua.

ParametryCopy Anchor Link

AccessRuleCopy Anchor Link

Typ to AccessRule.

Zwracana wartośćCopy Anchor Link

boolean: true, gdy obie listy są puste (wszyscy); gdy gracz jest w jednym z gangs od jego minimalnego stopnia; albo gdy gracz ma jedną z jobs od jej minimalnego stopnia (i jest w niej na służbie przy onDuty). W przeciwnym razie false.

PrzykładCopy 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());