Factures

Les factures passent par ai-core, jamais par les exports ou événements propres à un script de factures. ai-core envoie chaque facture au script de factures actif : celui que choisit le réglage Billing script du panneau, ou le premier qui tourne. Sans script, ce sont les propres factures d’ai-core qui la prennent : le joueur voit à l’écran une liste de factures ouvertes et l’argent bouge quand il paie. Une facture ne se perd jamais.

Une facture vient d’un métier (le compte bank du métier reçoit le paiement : amendes de police, frais d’un mécanicien) ou d’un joueur (ce joueur reçoit le paiement).

Les propres factures d’ai-core en bref : les factures ouvertes sont stockées par personnage (personnages hors ligne compris), 20 factures ouvertes au plus par personnage, et le paiement prend l’argent sur bank, puis sur cash, en une seule transaction avec la suppression de la facture.

GetBillingSystemCopy Anchor Link

Où vont les factures.

Côté : Serveur · Attend : non · Lib : billing.provider()

GetBillingSystem(): string | null

local system = exports['ai-core']:GetBillingSystem() -- 'ai-core' ou un nom de script

ParamètresCopy Anchor Link

Aucun.

RetourCopy Anchor Link

string | null : le nom de ressource du script de factures, ou "ai-core" pour les propres factures d’ai-core. Comme les propres factures d’ai-core sont toujours disponibles, ce n’est pas null en pratique.

ExempleCopy Anchor Link

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

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

/** Bills to offline characters only work with ai-core's own bills. */
export function canBillOffline(): boolean {
  return core.GetBillingSystem() === "ai-core";
}

SendBillCopy Anchor Link

Envoie une facture à un joueur.

Côté : Serveur · Attend : non · Lib : billing.send

SendBill(bill: BillRequest): boolean

local sent = exports['ai-core']:SendBill({ to = target, amount = 250, label = 'Speeding', from = source, job = 'police' })

ParamètresCopy Anchor Link

BillRequestCopy Anchor Link

Voir BillRequest.

RetourCopy Anchor Link

boolean : true quand la facture a été envoyée. false quand :

• la facture est invalide : to et toCitizenid tous deux ou aucun des deux, pas de label, amount qui n’est pas un nombre entier de 1 à 10 000 000, ni job ni from, ou from égal au destinataire ;
• from est donné mais n’a pas de personnage chargé, ou job n’existe pas ;
• le destinataire est hors ligne et les factures vont à un script de factures (seules les propres factures d’ai-core atteignent les personnages hors ligne) ;
• le script de factures l’a refusée, ou le destinataire a déjà 20 factures ouvertes avec les propres factures d’ai-core.

Une facture hors ligne avec les propres factures d’ai-core répond true dès qu’elle est valide ; la base de données peut encore la refuser (citizen id inconnu, 20 factures ouvertes), ce qui est enregistré dans le log.

ExempleCopy Anchor Link

import { onClientCallback, coordsOf, isNear, resourceExport } from "@aicore-fivem/lib/server";
import { fail, readId, readInt } from "@aicore-fivem/lib/shared";
import { Locale } from "common";

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

// Un agent met une amende au joueur devant lui ; le compte de la police reçoit l’argent.
onClientCallback(
  "myscript:fine",
  {
    args: ([target, amount]) => {
      const t = readId(target);
      const a = readInt(amount, 1, 50_000);
      return t === null || a === null ? null : [t, a];
    },
  },
  (source, target, amount) => {
    if (core.GetDutyJob(source) !== "police") return fail("NOT_POLICE");
    if (!isNear(target, coordsOf(source), 3)) return fail("TOO_FAR");
    const sent = core.SendBill({ to: target, amount, label: Locale("BILL_FINE"), from: source, job: "police" });
    return sent ? { ok: true } : fail("BILL_FAILED");
  },
);

GetUnpaidBillsCopy Anchor Link

Les factures ouvertes (impayées) d’un joueur.

Côté : Serveur · Attend : non (répond via done) · Lib : billing.unpaid(source) renvoie une Promise

GetUnpaidBills(source: number, done: (bills: UnpaidBill[] | null) => void): void

exports['ai-core']:GetUnpaidBills(source, function(bills) end) -- liste ou nil

ParamètresCopy Anchor Link

RetourCopy Anchor Link

Rien. done reçoit une entrée par facture ouverte avec id (l’id du script de factures), label, amount (ce qui reste dû) et sender (libellé du métier ou nom du joueur) (UnpaidBill), ou null quand le joueur n’a pas de personnage chargé ou que le script de factures ne sait pas lister les factures. Sans fonction comme done, l’appel ne fait rien.

ExempleCopy Anchor Link

import { onClientCallback, resourceExport } from "@aicore-fivem/lib/server";
import { fail } from "@aicore-fivem/lib/shared";
import type { UnpaidBill } from "@aicore-fivem/shared";

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

// Un guichet de mairie montre ce que doit le joueur.
onClientCallback("myscript:myBills", async (source) => {
  const bills = await new Promise<UnpaidBill[] | null>((resolve) => core.GetUnpaidBills(source, resolve));
  if (!bills) return fail("BILLS_UNAVAILABLE");
  return { ok: true, bills, total: bills.reduce((sum, b) => sum + b.amount, 0) };
});

PayBillCopy Anchor Link

Le joueur paie l’une de ses factures ouvertes.

Côté : Serveur · Attend : non · Lib : billing.pay

PayBill(source: number, id: string): boolean

local paid = exports['ai-core']:PayBill(source, billId)

ParamètresCopy Anchor Link

RetourCopy Anchor Link

boolean : true quand la facture a été payée. false quand le joueur n’a pas de personnage chargé, que la facture n’est pas la sienne ou a disparu, qu’il ne peut pas la payer, que le script de factures a refusé ou n’accepte les paiements que dans son propre écran. Avec les propres factures d’ai-core, une facture personnelle exige aussi que l’émetteur soit en ligne (l’argent va sur sa banque).

ExempleCopy Anchor Link

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

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

onClientCallback(
  "myscript:payBill",
  { args: ([id]) => { const v = readText(id, 64); return v ? [v] : null; }, lock: true },
  (source, id) => (core.PayBill(source, id) ? { ok: true } : fail("BILL_NOT_PAID")),
);