Exports zwischen Ressourcen

Ein Export ist eine Funktion, die eine Ressource anbietet und andere Ressourcen aufrufen (exports["ai-core"].GetMoney(...)). Diese Helfer registrieren Exports in beiden Namensstilen, geben dir typisierten Zugriff auf andere Ressourcen und lassen deinen Code eine Ressource überstehen, die nicht läuft.

import { registerExport, resourceExport, optionalExport, callExport, provideExport, isResourceStarted } from "@aicore-fivem/lib/fivem";
// In einer Client- oder Server-Datei kommen dieselben Namen auch aus "@aicore-fivem/lib/client" oder "@aicore-fivem/lib/server".

registerExportCopy Anchor Link

Bietet anderen Ressourcen eine Funktion unter name an, und auch unter demselben Namen mit vertauschter Groß-/Kleinschreibung des ersten Buchstabens (GetPrice und getPrice), damit Skripte in beiden Stilen sie finden. Nutze es statt exports(name, fn) von FiveM.

Seite: Client und Server · Wartet: nein

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

Lua: kein Zwilling; nutze das eigene exports('GetPrice', function(...) end) von FiveM.

ParameterCopy Anchor Link

RückgabewertCopy Anchor Link

void.

BeispielCopy 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]]);

// Andere Ressourcen: exports["my-shop"].GetPrice("water") oder 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

Typisierter Zugriff auf die Exports einer anderen Ressource. Die Typen kommen aus CitizenExports in @aicore-fivem/shared (ai-core, ai-lib, ai-target, ai-vehicles, ai-inventory und die anderen ai-*-Skripte mit Exports), daher kennt dein Editor jeden Export, seine Argumente und seinen Rückgabetyp.

Seite: Client und Server · Wartet: nein

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

Lua: kein Zwilling; nutze exports['ai-core']:GetMoney(source, 'cash').

ParameterCopy Anchor Link

RückgabewertCopy Anchor Link

Das Exports-Objekt der Ressource. Eine Methode aufzurufen ruft den Export auf.

BeispielCopy Anchor Link

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

// Ein Handle pro Datei, ganz oben.
const core = resourceExport("ai-core");

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

optionalExportCopy Anchor Link

Dieselben typisierten Exports wie resourceExport, aber null, solange die Ressource nicht gestartet ist. Nutze es für eine optionale Abhängigkeit: Dein Skript funktioniert weiter, wenn der Server diese Ressource nicht betreibt.

Seite: Client und Server · Wartet: nein

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

Lua: kein Zwilling; prüfe GetResourceState('ai-vehicles') == 'started' vor dem Aufruf.

ParameterCopy Anchor Link

RückgabewertCopy Anchor Link

Das Exports-Objekt, solange die Ressource gestartet ist, sonst null.

BeispielCopy Anchor Link

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

function plateOfVehicleId(vehicleId: number): string | null {
  // Jedes Mal neu fragen: ai-vehicles kann starten oder stoppen, während der Server läuft.
  return optionalExport("ai-vehicles")?.GetVehicle(vehicleId)?.plate ?? null;
}

callExportCopy Anchor Link

Ruft einen Export einer Ressource auf, die keine Typen in CitizenExports hat (ein Skript von Drittanbietern). Das Ergebnis ist unknown: Prüfe seine Form, bevor du es nutzt.

Seite: Client und Server · Wartet: nein

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

Lua: kein Zwilling; nutze exports[resource][name](nil, ...) oder exports[resource]:Name(...).

ParameterCopy Anchor Link

RückgabewertCopy Anchor Link

unknown: was auch immer der Export zurückgegeben hat.

BeispielCopy 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

Beantwortet exports["<resource>"].<name> für einen Ressourcennamen, für den deine Ressource mit provide in ihrer fxmanifest.lua einspringt. FiveMs provide lässt den Namen existieren (sodass dependency-Zeilen durchgehen), leitet aber seine Exports nicht weiter; dieser Helfer beantwortet einen Export dieses Namens. ai-banking nutzt ihn, um Aufrufe von qb-banking und Renewed-Banking zu beantworten.

Seite: Client und Server · Wartet: nein

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

Lua: kein Zwilling.

ParameterCopy Anchor Link

RückgabewertCopy Anchor Link

void.

BeispielCopy 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");

// Skripte, die für old-banking geschrieben wurden, funktionieren weiter: 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

Ob eine Ressource gerade läuft (ihr Zustand ist "started").

Seite: Client und Server · Wartet: nein

isResourceStarted(resource: string): boolean

Lua: kein Zwilling; nutze GetResourceState(resource) == 'started'.

ParameterCopy Anchor Link

RückgabewertCopy Anchor Link

true, solange die Ressource gestartet ist. false, wenn sie gestoppt ist, startet, stoppt oder nicht installiert ist.

BeispielCopy 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.");