Exports entre recursos

Um export é uma função que um recurso oferece e outros recursos chamam (exports["ai-core"].GetMoney(...)). Estes helpers registram exports com os dois estilos de nome, dão acesso tipado aos exports de outros recursos, e deixam o seu código sobreviver a um recurso que não está rodando.

import { registerExport, resourceExport, optionalExport, callExport, provideExport, isResourceStarted } from "@aicore-fivem/lib/fivem";
// Em um arquivo de cliente ou de servidor, os mesmos nomes também vêm de "@aicore-fivem/lib/client" ou "@aicore-fivem/lib/server".

registerExportCopy Anchor Link

Oferece uma função a outros recursos sob name, e também sob o mesmo nome com a primeira letra trocada entre maiúscula e minúscula (GetPrice e getPrice), para que scripts escritos em qualquer um dos estilos a encontrem. Use em vez do exports(name, fn) do FiveM.

Lado: Cliente e servidor · Espera: não

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

Lua: sem equivalente; use o próprio exports('GetPrice', function(...) end) do FiveM.

ParâmetrosCopy Anchor Link

RetornoCopy Anchor Link

void.

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

// Outros recursos: 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

Acesso tipado aos exports de outro recurso. Os tipos vêm de CitizenExports em @aicore-fivem/shared (ai-core, ai-lib, ai-target, ai-vehicles, ai-inventory e os outros scripts ai-* com exports), então o seu editor conhece todo export, os argumentos dele e o tipo de retorno.

Lado: Cliente e servidor · Espera: não

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

Lua: sem equivalente; use exports['ai-core']:GetMoney(source, 'cash').

ParâmetrosCopy Anchor Link

RetornoCopy Anchor Link

O objeto de exports do recurso. Chamar um método chama o export.

ExemploCopy Anchor Link

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

// Um handle por arquivo, no topo.
const core = resourceExport("ai-core");

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

optionalExportCopy Anchor Link

Os mesmos exports tipados de resourceExport, mas null enquanto o recurso não está iniciado. Use para uma dependência opcional: o seu script continua funcionando quando o servidor não roda esse recurso.

Lado: Cliente e servidor · Espera: não

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

Lua: sem equivalente; verifique GetResourceState('ai-vehicles') == 'started' antes de chamar.

ParâmetrosCopy Anchor Link

RetornoCopy Anchor Link

O objeto de exports enquanto o recurso está iniciado, null caso contrário.

ExemploCopy Anchor Link

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

function plateOfVehicleId(vehicleId: number): string | null {
  // Pergunte de novo toda vez: o ai-vehicles pode iniciar ou parar enquanto o servidor roda.
  return optionalExport("ai-vehicles")?.GetVehicle(vehicleId)?.plate ?? null;
}

callExportCopy Anchor Link

Chama um export de um recurso que não tem tipos em CitizenExports (um script de terceiros). O resultado é unknown: verifique o formato antes de usar.

Lado: Cliente e servidor · Espera: não

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

Lua: sem equivalente; use exports[resource][name](nil, ...) ou exports[resource]:Name(...).

ParâmetrosCopy Anchor Link

RetornoCopy Anchor Link

unknown: o que quer que o export tenha retornado.

ExemploCopy 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

Responde exports["<resource>"].<name> para um nome de recurso que o seu recurso substitui com provide no fxmanifest.lua dele. O provide do FiveM faz o nome existir (para que as linhas dependency passem), mas não encaminha os exports dele; este helper responde um export desse nome. O ai-banking o usa para responder chamadas de qb-banking e Renewed-Banking.

Lado: Cliente e servidor · Espera: não

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

Lua: sem equivalente.

ParâmetrosCopy Anchor Link

RetornoCopy Anchor Link

void.

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

// Scripts escritos para old-banking continuam funcionando: 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

Se um recurso está rodando agora (o estado dele é "started").

Lado: Cliente e servidor · Espera: não

isResourceStarted(resource: string): boolean

Lua: sem equivalente; use GetResourceState(resource) == 'started'.

ParâmetrosCopy Anchor Link

RetornoCopy Anchor Link

true enquanto o recurso está iniciado. false quando está parado, iniciando, parando ou não instalado.

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