Warstwy przez ai-core

Te obiekty nigdy nie rozmawiają z konkretnym skryptem. Pytają ai-core, a ai-core przekazuje wywołanie do skryptu, którego serwer używa do tego zadania: ai-death albo inny skrypt śmierci, ai-appearance albo tgiann-clothing, dowolny obsługiwany skrypt emotek albo menu radialnego. Twój skrypt działa dalej, gdy właściciel któryś wymieni. Jak działają warstwy, opisuje strona Warstwy i most.

Gdy nie działa żaden skrypt danego rodzaju, wywołania odpowiadają false, null albo własną wartością gry, jak mówi każdy wpis.

medicalCopy Anchor Link

medical.isDeadCopy Anchor Link

Czy lokalny gracz jest powalony (martwy albo w last stand), w dowolnym działającym skrypcie śmierci. Skrypty śmierci trzymają powalonego peda przy życiu, żeby go animować, więc samo IsEntityDead ich nie wykrywa. Po pierwszym wywołaniu to odczyt z pamięci.

Strona: Klient · Czeka: nie

medical.isDead(): boolean

Brak odpowiednika w Lua: wywołaj exports['ai-core']:IsDead() i nasłuchuj lokalnego zdarzenia ai-core:client:dead (dead).

Zwracana wartośćCopy Anchor Link

boolean: true, gdy warstwa medyczna ai-core mówi, że gracz jest powalony, albo ped jest martwy dla gry.

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

Uruchamia handler, gdy lokalny gracz zostanie powalony albo wstanie.

Strona: Klient · Czeka: nie

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

Brak odpowiednika w Lua: AddEventHandler('ai-core:client:dead', function(dead) end).

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

void.

PrzykładCopy Anchor Link

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

const points = new Points();
medical.onChange(() => points.refresh()); // punkty, których canShow czyta medical.isDead()

appearanceCopy Anchor Link

Wygląd pedów przez warstwę wyglądu ai-core, niezależnie od tego, jaki skrypt ubrań działa.

appearance.applyCopy Anchor Link

Nakłada zapisany wygląd na peda o modelu tego wyglądu. Pobierz wygląd na serwerze przez appearance.get(charId), utwórz peda z look.model, potem nałóż. Na własnym pedzie gracza zmienia jego ubrania.

Strona: Klient · Czeka: nie

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

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

ParametryCopy Anchor Link

Typ to CharacterAppearance.

Zwracana wartośćCopy Anchor Link

boolean: false, gdy peda już nie ma, model się różni albo nie działa żaden skrypt ubrań.

PrzykładCopy Anchor Link

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

// Śpiąca kopia postaci, ubrana jak ona.
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

Wygląd, który ped nosi teraz.

Strona: Klient · Czeka: nie

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

local look = aiLib.appearance.read(ped) -- tabela albo nil

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

CharacterAppearance | null: wygląd albo null (nil w Lua), gdy skrypt ubrań nie potrafi tego stwierdzić albo żaden nie działa.

PrzykładCopy Anchor Link

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

const before = appearance.read(cache.ped); // załóż go z powrotem później przez appearance.apply

appearance.openMenuCopy Anchor Link

Otwiera sklep z ubraniami, fryzjera albo zapisane stroje skryptu ubrań dla gracza.

Strona: Klient · Czeka: nie

appearance.openMenu(menu: ClothingMenu): boolean

local ok = aiLib.appearance.openMenu(menu)

ParametryCopy Anchor Link

Typ to ClothingMenu.

Zwracana wartośćCopy Anchor Link

boolean: false, gdy skrypt ubrań nie ma takiego menu albo żaden nie działa.

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

Zakłada graczowi strój pracy (mundur) aż do reloadSkin. Nie jest zapisywany: ponowne połączenie albo reloadSkin przywraca graczowi jego ubrania. Zmieniają się tylko wymienione części.

Strona: Klient · Czeka: nie

appearance.wearOutfit(outfit: JobOutfit): boolean

local ok = aiLib.appearance.wearOutfit(outfit)

ParametryCopy Anchor Link

Typy to JobOutfit i OutfitPiece.

Zwracana wartośćCopy Anchor Link

boolean: false, gdy nie może (brak skryptu ubrań, model, którego nie obsługuje).

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

Zakłada graczowi z powrotem jego zapisany wygląd (zdejmuje strój pracy).

Strona: Klient · Czeka: nie

appearance.reloadSkin(): boolean

local ok = aiLib.appearance.reloadSkin()

Zwracana wartośćCopy Anchor Link

boolean: false bez skryptu ubrań.

PrzykładCopy Anchor Link

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

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

gesturesCopy Anchor Link

Ręce w górze, wskazywanie i emotki dowolnego działającego skryptu emotek, przez ai-core.

gestures.isHandsUpCopy Anchor Link

Czy lokalny gracz ma ręce w górze.

Strona: Klient · Czeka: nie

gestures.isHandsUp(): boolean

local up = aiLib.gestures.isHandsUp()

Zwracana wartośćCopy Anchor Link

boolean: true, dopóki ręce są w górze w działającym skrypcie emotek.

PrzykładCopy Anchor Link

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

// Serwer pyta przed napadem, czy ofiara się poddała.
onServerCallback("myrob:surrendered", () => gestures.isHandsUp());

gestures.isPointingCopy Anchor Link

Czy lokalny gracz wskazuje.

Strona: Klient · Czeka: nie

gestures.isPointing(): boolean

local pointing = aiLib.gestures.isPointing()

Zwracana wartośćCopy Anchor Link

boolean: true, dopóki wskazuje.

PrzykładCopy Anchor Link

if (gestures.isPointing()) return; // nie zaczynaj emotki w trakcie wskazywania

gestures.providerCopy Anchor Link

Skrypt emotek, który odpowiada na ręce w górze i wskazywanie.

Strona: Klient · Czeka: nie

gestures.provider(): string | null

local name = aiLib.gestures.provider()

Zwracana wartośćCopy Anchor Link

string | null: nazwa jego zasobu albo null (nil), gdy żaden nie działa.

PrzykładCopy Anchor Link

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

gestures.playEmoteCopy Anchor Link

Odtwarza emotkę według nazwy komendy (tego, co gracze wpisują po e) w działającym skrypcie emotek.

Strona: Klient · Czeka: nie

gestures.playEmote(name: string): boolean

local ok = aiLib.gestures.playEmote(name)

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

boolean: false bez skryptu emotek.

PrzykładCopy Anchor Link

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

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

gestures.cancelEmoteCopy Anchor Link

Zatrzymuje emotkę, którą odtwarza gracz (skuty, powalony).

Strona: Klient · Czeka: nie

gestures.cancelEmote(): boolean

local ok = aiLib.gestures.cancelEmote()

Zwracana wartośćCopy Anchor Link

boolean: false bez skryptu emotek.

PrzykładCopy Anchor Link

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

gestures.emoteProviderCopy Anchor Link

Skrypt emotek, który odtwarza emotki (może się różnić od tego, który odpowiada na ręce w górze).

Strona: Klient · Czeka: nie

gestures.emoteProvider(): string | null

local name = aiLib.gestures.emoteProvider()

Zwracana wartośćCopy Anchor Link

string | null: nazwa jego zasobu albo null (nil), gdy żaden nie działa.

PrzykładCopy Anchor Link

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

seatbeltCopy Anchor Link

Pas bezpieczeństwa lokalnego gracza przez ai-core, niezależnie od tego, jaki skrypt pasów działa.

seatbelt.isOnCopy Anchor Link

Czy pas jest zapięty. Pytaj na żądanie, nie co klatkę.

Strona: Klient · Czeka: nie

seatbelt.isOn(): boolean | null

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

Zwracana wartośćCopy Anchor Link

boolean | null: true albo false; null (nil), gdy nie odpowiada żaden skrypt pasów.

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

Uruchamia handler, gdy zmieni się pas. Wyzwalają go tylko skrypty pasów, które zgłaszają zmiany.

Strona: Klient · Czeka: nie

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

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

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

void.

PrzykładCopy Anchor Link

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

seatbelt.providerCopy Anchor Link

Skrypt pasów, który odpowiada.

Strona: Klient · Czeka: nie

seatbelt.provider(): string | null

local name = aiLib.seatbelt.provider()

Zwracana wartośćCopy Anchor Link

string | null: nazwa jego zasobu albo null (nil), gdy żaden nie odpowiada.

PrzykładCopy Anchor Link

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

fuelCopy Anchor Link

fuel.getCopy Anchor Link

Poziom paliwa pojazdu. Serwer trzyma state bag fuel dla każdego pojazdu niezależnie od skryptu paliwa, więc to odczyt z pamięci; bez tego bagu to poziom zbiornika z gry.

Strona: Klient · Czeka: nie

fuel.get(vehicle: number): number

Brak odpowiednika w Lua: czytaj Entity(vehicle).state.fuel. Ustawianie paliwa jest tylko na serwerze (fuel.set na stronie Pojazdy).

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

number: 0-100.

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

Otwiera aktywne policyjne MDT dla lokalnego gracza. MDT samo sprawdza pracę.

Strona: Klient · Czeka: nie

mdt.open(): boolean

local ok = aiLib.mdt.open()

Zwracana wartośćCopy Anchor Link

boolean: false, gdy nie działa żadne MDT albo nie da się go otworzyć z zewnątrz.

PrzykładCopy Anchor Link

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

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

radialCopy Anchor Link

Pozycje w dowolnym działającym menu radialnym (ai-radialmenu albo inne przez warstwę radialną ai-core). ai-core trzyma je przez restarty menu radialnego i usuwa, gdy twój zasób się zatrzyma: dodaj raz przy starcie.

radial.addCopy Anchor Link

Dodaje pozycję do koła albo zastępuje pozycję o tym samym id.

Strona: Klient · Czeka: nie

radial.add(item: RadialItem): void

aiLib.radial.add(item)

ParametryCopy Anchor Link

RadialItemCopy Anchor Link

Typ to RadialItem.

Zwracana wartośćCopy Anchor Link

void.

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

Usuwa jedną z twoich pozycji. Nieznane id nic nie robi.

Strona: Klient · Czeka: nie

radial.remove(id: string): void

aiLib.radial.remove(id)

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

void.

PrzykładCopy Anchor Link

radial.remove("myscript:engine");

radial.refreshCopy Anchor Link

Ponownie czyta każde canShow otwartego koła. Wywołaj ją po zmianie czegoś, co czytają, gdy koło może być otwarte.

Strona: Klient · Czeka: nie

radial.refresh(): void

aiLib.radial.refresh()

Zwracana wartośćCopy Anchor Link

void.

PrzykładCopy Anchor Link

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

worldCopy Anchor Link

Synchronizacja pogody i czasu dowolnego działającego skryptu pogody, wstrzymywana, dopóki obowiązuje powód.

world.pauseSyncCopy Anchor Link

Wstrzymuje synchronizację pogody i czasu z powodu: wewnątrz wnętrza, w czasie sceny albo gdy twój skrypt ustawia własną pogodę.

Strona: Klient · Czeka: nie

world.pauseSync(reason: string): void

aiLib.world.pauseSync(reason)

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

void.

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

Usuwa jeden powód wstrzymania; synchronizacja znów działa, gdy nie zostaje żaden powód.

Strona: Klient · Czeka: nie

world.resumeSync(reason: string): void

aiLib.world.resumeSync(reason)

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

void. Zobacz przykład world.pauseSync.

inventoryCopy Anchor Link

Ekwipunek lokalnego gracza przez warstwę ekwipunku ai-core: odpowiada ekwipunek wybrany przez serwer. Dawanie i zabieranie przedmiotów jest tylko na serwerze (Przedmioty).

inventory.openInventoryCopy Anchor Link

Otwiera ekran własnego ekwipunku gracza.

Strona: Klient · Czeka: nie

inventory.openInventory(): void

aiLib.inventory.openInventory()

Zwracana wartośćCopy Anchor Link

void.

PrzykładCopy Anchor Link

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

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

inventory.hasItemCopy Anchor Link

Czy gracz ma co najmniej count sztuk przedmiotu. Używaj jej w canShow, żeby gracz widział tylko to, co może zrobić; serwer sprawdza ponownie.

Strona: Klient · Czeka: nie

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

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

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

boolean: true, gdy gracz ma wystarczająco.

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

Przedmiot broni w ręku gracza: jego nazwa, etykieta i obrazek.

Strona: Klient · Czeka: nie

inventory.currentWeapon(): HeldWeapon | null

local weapon = aiLib.inventory.currentWeapon() -- tabela albo nil

Zwracana wartośćCopy Anchor Link

HeldWeapon { name: string; label: string; image?: string } (name jak WEAPON_PISTOL, image to adres nui://, gdy ekwipunek go ma) albo null (nil), gdy ręka jest pusta.

PrzykładCopy Anchor Link

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

// Czytaj ją, gdy zmienia się broń, nigdy co klatkę.
onCache("weapon", () => SendNUIMessage({ action: "weapon", data: inventory.currentWeapon() }));