Exports entre ressources

Un export est une fonction qu’une ressource propose et que d’autres ressources appellent (exports["ai-core"].GetMoney(...)). Ces utilitaires enregistrent les exports sous les deux styles de nom, vous donnent un accès typé aux autres ressources et permettent à votre code de survivre à une ressource qui ne tourne pas.

import { registerExport, resourceExport, optionalExport, callExport, provideExport, isResourceStarted } from "@aicore-fivem/lib/fivem";
// Dans un fichier client ou serveur, les mêmes noms viennent aussi de "@aicore-fivem/lib/client" ou "@aicore-fivem/lib/server".

registerExportCopy Anchor Link

Propose une fonction aux autres ressources sous name, et aussi sous le même nom avec la casse de la première lettre inversée (GetPrice et getPrice), pour que les scripts écrits dans l’un ou l’autre style la trouvent. Utilisez-le à la place de exports(name, fn) de FiveM.

Côté : client et serveur · Attend : non

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

Lua : pas d’équivalent ; utilisez le exports('GetPrice', function(...) end) propre à FiveM.

ParamètresCopy Anchor Link

RetourCopy Anchor Link

void.

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

// Autres ressources : exports["my-shop"].GetPrice("water") ou 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

Un accès typé aux exports d’une autre ressource. Les types viennent de CitizenExports dans @aicore-fivem/shared (ai-core, ai-lib, ai-target, ai-vehicles, ai-inventory et les autres scripts ai-* qui ont des exports), donc votre éditeur connaît chaque export, ses arguments et son type de retour.

Côté : client et serveur · Attend : non

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

Lua : pas d’équivalent ; utilisez exports['ai-core']:GetMoney(source, 'cash').

ParamètresCopy Anchor Link

RetourCopy Anchor Link

L’objet des exports de la ressource. Appeler une méthode appelle l’export.

ExempleCopy Anchor Link

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

// Un handle par fichier, en haut.
const core = resourceExport("ai-core");

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

optionalExportCopy Anchor Link

Les mêmes exports typés que resourceExport, mais null tant que la ressource n’est pas démarrée. Utilisez-le pour une dépendance facultative : votre script continue de fonctionner quand le serveur ne fait pas tourner cette ressource.

Côté : client et serveur · Attend : non

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

Lua : pas d’équivalent ; vérifiez GetResourceState('ai-vehicles') == 'started' avant l’appel.

ParamètresCopy Anchor Link

RetourCopy Anchor Link

L’objet des exports tant que la ressource est démarrée, null sinon.

ExempleCopy Anchor Link

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

function plateOfVehicleId(vehicleId: number): string | null {
  // Redemander à chaque fois : ai-vehicles peut démarrer ou s’arrêter pendant que le serveur tourne.
  return optionalExport("ai-vehicles")?.GetVehicle(vehicleId)?.plate ?? null;
}

callExportCopy Anchor Link

Appelle un export d’une ressource qui n’a pas de types dans CitizenExports (un script tiers). Le résultat est unknown : vérifiez sa forme avant de l’utiliser.

Côté : client et serveur · Attend : non

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

Lua : pas d’équivalent ; utilisez exports[resource][name](nil, ...) ou exports[resource]:Name(...).

ParamètresCopy Anchor Link

RetourCopy Anchor Link

unknown : ce que l’export a renvoyé.

ExempleCopy 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

Répond à exports["<resource>"].<name> pour un nom de ressource que votre ressource remplace avec provide dans son fxmanifest.lua. Le provide de FiveM fait exister le nom (les lignes dependency passent donc) mais ne transmet pas ses exports ; cet utilitaire répond à un export de ce nom. ai-banking s’en sert pour répondre aux appels de qb-banking et Renewed-Banking.

Côté : client et serveur · Attend : non

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

Lua : pas d’équivalent.

ParamètresCopy Anchor Link

RetourCopy Anchor Link

void.

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

// Les scripts écrits pour old-banking continuent de fonctionner : 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

Indique si une ressource tourne en ce moment (son état est "started").

Côté : client et serveur · Attend : non

isResourceStarted(resource: string): boolean

Lua : pas d’équivalent ; utilisez GetResourceState(resource) == 'started'.

ParamètresCopy Anchor Link

RetourCopy Anchor Link

true tant que la ressource est démarrée. false quand elle est arrêtée, en cours de démarrage, en cours d’arrêt ou pas installée.

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