Eksporty między zasobami

Eksport to funkcja, którą jeden zasób udostępnia, a inne zasoby wywołują (exports["ai-core"].GetMoney(...)). Te funkcje rejestrują eksporty w obu stylach nazw, dają typowany dostęp do innych zasobów i pozwalają twojemu kodowi przetrwać zasób, który nie działa.

import { registerExport, resourceExport, optionalExport, callExport, provideExport, isResourceStarted } from "@aicore-fivem/lib/fivem";
// W pliku klienta lub serwera te same nazwy są też dostępne z "@aicore-fivem/lib/client" albo "@aicore-fivem/lib/server".

registerExportCopy Anchor Link

Udostępnia funkcję innym zasobom pod nazwą name oraz pod tą samą nazwą z zamienioną wielkością pierwszej litery (GetPrice i getPrice), więc skrypty napisane w każdym ze stylów ją znajdą. Używaj jej zamiast exports(name, fn) z FiveM.

Strona: Klient i serwer · Czeka: nie

registerExport(name: string, handler: (...args: any[]) => unknown): void

Lua: brak odpowiednika; użyj własnego exports('GetPrice', function(...) end) z FiveM.

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

void.

PrzykładCopy Anchor Link

import { registerExport } from "@aicore-fivem/lib/server";
import { readText } from "@aicore-fivem/lib/shared";

const prices = new Map<string, number>([["water", 5], ["bread", 3]]);

// Inne zasoby: exports["my-shop"].GetPrice("water") albo exports["my-shop"].getPrice("water")
registerExport("GetPrice", (item: unknown) => {
  const name = readText(item, 64);
  return name === null ? null : (prices.get(name) ?? null);
});

resourceExportCopy Anchor Link

Typowany dostęp do eksportów innego zasobu. Typy pochodzą z CitizenExports w @aicore-fivem/shared (ai-core, ai-lib, ai-target, ai-vehicles, ai-inventory i inne skrypty ai-* z eksportami), więc twój edytor zna każdy eksport, jego argumenty i typ zwracany.

Strona: Klient i serwer · Czeka: nie

resourceExport<K extends keyof CitizenExports & string>(resource: K): CitizenExports[K]

Lua: brak odpowiednika; użyj exports['ai-core']:GetMoney(source, 'cash').

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

Obiekt eksportów zasobu. Wywołanie metody wywołuje eksport.

PrzykładCopy Anchor Link

import { resourceExport } from "@aicore-fivem/lib/server";

// Jeden uchwyt na plik, na górze.
const core = resourceExport("ai-core");

export function payBonus(source: number): boolean {
  return core.AddMoney(source, "bank", 500, "Bonus");
}

optionalExportCopy Anchor Link

Te same typowane eksporty co resourceExport, ale null, dopóki zasób nie jest uruchomiony. Używaj go dla opcjonalnej zależności: twój skrypt działa dalej, gdy serwer nie uruchamia tego zasobu.

Strona: Klient i serwer · Czeka: nie

optionalExport<K extends keyof CitizenExports & string>(resource: K): CitizenExports[K] | null

Lua: brak odpowiednika; przed wywołaniem sprawdź GetResourceState('ai-vehicles') == 'started'.

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

Obiekt eksportów, gdy zasób jest uruchomiony, w przeciwnym razie null.

PrzykładCopy Anchor Link

import { optionalExport } from "@aicore-fivem/lib/server";

function plateOfVehicleId(vehicleId: number): string | null {
  // Pytaj za każdym razem: ai-vehicles może się uruchomić albo zatrzymać w trakcie działania serwera.
  return optionalExport("ai-vehicles")?.GetVehicle(vehicleId)?.plate ?? null;
}

callExportCopy Anchor Link

Wywołuje eksport zasobu, który nie ma typów w CitizenExports (skrypt zewnętrzny). Wynik to unknown: sprawdź jego kształt, zanim go użyjesz.

Strona: Klient i serwer · Czeka: nie

callExport(resource: string, name: string, ...args: unknown[]): unknown

Lua: brak odpowiednika; użyj exports[resource][name](nil, ...) albo exports[resource]:Name(...).

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

unknown: cokolwiek zwrócił eksport.

PrzykładCopy Anchor Link

import { callExport, isResourceStarted } from "@aicore-fivem/lib/client";

function otherHudVisible(): boolean {
  if (!isResourceStarted("some-hud")) return true;
  const visible = callExport("some-hud", "IsVisible");
  return typeof visible === "boolean" ? visible : true;
}

provideExportCopy Anchor Link

Odpowiada na exports["<resource>"].<name> dla nazwy zasobu, którą twój zasób zastępuje przez provide w swoim fxmanifest.lua. provide z FiveM sprawia, że nazwa istnieje (więc linie dependency przechodzą), ale nie przekazuje jej eksportów; ta funkcja odpowiada na jeden eksport tej nazwy. ai-banking używa jej, żeby odpowiadać na wywołania qb-banking i Renewed-Banking.

Strona: Klient i serwer · Czeka: nie

provideExport(resource: string, name: string, fn: (...args: any[]) => unknown): void

Lua: brak odpowiednika.

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

void.

PrzykładCopy Anchor Link

provide 'old-banking'

import { provideExport, resourceExport } from "@aicore-fivem/lib/server";
import { readText } from "@aicore-fivem/lib/shared";

const core = resourceExport("ai-core");

// Skrypty napisane dla old-banking działają dalej: exports["old-banking"].GetAccountBalance("police")
provideExport("old-banking", "GetAccountBalance", (job: unknown) => {
  const name = readText(job, 32);
  return name === null ? 0 : (core.GetSharedMoney("job", name, "bank") ?? 0);
});

isResourceStartedCopy Anchor Link

Czy zasób działa w tej chwili (jego stan to "started").

Strona: Klient i serwer · Czeka: nie

isResourceStarted(resource: string): boolean

Lua: brak odpowiednika; użyj GetResourceState(resource) == 'started'.

ParametryCopy Anchor Link

Zwracana wartośćCopy Anchor Link

true, gdy zasób jest uruchomiony. false, gdy jest zatrzymany, uruchamia się, zatrzymuje albo nie jest zainstalowany.

PrzykładCopy Anchor Link

import { isResourceStarted } from "@aicore-fivem/lib/server";

if (!isResourceStarted("ai-inventory")) console.warn("ai-inventory is not running: shop items will not work.");