Dinheiro e contas

Todo personagem tem um saldo por tipo de conta. Os tipos vêm da lista Accounts do painel de administração; um servidor novo tem cash, bank, black_money e crypto. Cada emprego e gangue também tem uma conta de cada tipo (o dinheiro da sociedade), que começa vazia.

Como o dinheiro funciona no ai-core:

• As quantias são números inteiros (dólares, sem centavos). Uma fração, NaN ou um número além da faixa de inteiros seguros do JavaScript é recusado.
• Uma mudança vale na hora na memória e é gravada no banco de dados em cerca de 50 ms, junto com uma linha no livro-razão (ai_core_transactions). O livro-razão grava o reason que você passa; sem ele, grava o nome do recurso que chamou.
• Um saldo não pode ficar abaixo de 0, a menos que o tipo de conta tenha Can go below zero ligado no painel.
• Cada mudança na conta de um jogador dispara o evento de servidor ai-core:moneyChanged (src, account, balance, delta, reason) e chega ao próprio jogo do jogador. Veja Eventos e estado.

GetMoneyCopy Anchor Link

O saldo de um jogador numa conta.

Lado: Servidor · Espera: não · Lib: nenhuma

GetMoney(src: number, account: string): number | null

local balance = exports['ai-core']:GetMoney(source, 'bank') -- number ou nil

ParâmetrosCopy Anchor Link

RetornoCopy Anchor Link

number | null: o saldo. null quando o jogador não tem personagem carregado ou o tipo de conta não existe.

ExemploCopy Anchor Link

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

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

onClientCallback("myscript:balance", (source) => {
  const bank = core.GetMoney(source, "bank");
  if (bank === null) return fail("NO_CHARACTER");
  return { ok: true, bank };
});

AddMoneyCopy Anchor Link

Adiciona dinheiro à conta de um jogador. Use para recompensas, salários que seu script paga ou receita de vendas.

Lado: Servidor · Espera: não · Lib: nenhuma

AddMoney(src: number, account: string, amount: number, reason?: string): boolean

local ok = exports['ai-core']:AddMoney(source, 'cash', 250, 'fishing_sale')

ParâmetrosCopy Anchor Link

RetornoCopy Anchor Link

boolean: true quando o dinheiro foi adicionado. false quando o jogador não tem personagem carregado, o tipo de conta não existe ou amount não é um número inteiro acima de 0.

ExemploCopy Anchor Link

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

const core = resourceExport("ai-core");
const BUYER = { x: -1845.2, y: -1197.4, z: 14.3 };

onClientCallback("myscript:sellFish", { guards: [near(BUYER, 3)], lock: true }, (source) => {
  const fish = inventory.getItemCount(source, "fish");
  if (fish < 1) return fail("NO_FISH");
  if (!inventory.removeItem(source, "fish", fish)) return fail("SELL_FAILED");
  core.AddMoney(source, "cash", fish * 25, "fishing_sale");
  return { ok: true };
});

RemoveMoneyCopy Anchor Link

Tira dinheiro da conta de um jogador. Use para cobrar por algo.

Lado: Servidor · Espera: não · Lib: nenhuma

RemoveMoney(src: number, account: string, amount: number, reason?: string): boolean

local paid = exports['ai-core']:RemoveMoney(source, 'bank', 500, 'license_fee')

ParâmetrosCopy Anchor Link

RetornoCopy Anchor Link

boolean: true quando o dinheiro foi tirado. false quando o saldo é baixo demais (e o tipo de conta não permite saldo negativo), o jogador não tem personagem carregado, o tipo de conta não existe ou amount não é um número inteiro acima de 0. Com false nada mudou.

ExemploCopy Anchor Link

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

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

onClientCallback("myscript:buyLicense", { lock: true }, (source) => {
  if (!inventory.canCarryItem(source, "driver_license")) return fail("NO_SPACE");
  if (!core.RemoveMoney(source, "bank", PRICE, "license_fee")) return fail("NOT_ENOUGH_MONEY");
  inventory.addItem(source, "driver_license");
  return { ok: true };
});

SetMoneyCopy Anchor Link

Define o saldo de um jogador para um valor exato. Use para ferramentas de admin; recursos do jogo devem adicionar e remover.

Lado: Servidor · Espera: não · Lib: nenhuma

SetMoney(src: number, account: string, amount: number, reason?: string): boolean

local ok = exports['ai-core']:SetMoney(source, 'cash', 0, 'admin_reset')

ParâmetrosCopy Anchor Link

RetornoCopy Anchor Link

boolean: true quando o saldo agora é amount (também quando já era). false quando o jogador não tem personagem carregado, o tipo de conta não existe, amount não é um número inteiro ou está abaixo de 0 numa conta que não permite isso.

ExemploCopy Anchor Link

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

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

addCommand("setcash", {
  help: "Sets a player cash",
  params: [{ name: "id", type: "playerId" }, { name: "amount", type: "number" }],
  restricted: true,
}, (_source, args) => {
  console.log(core.SetMoney(args.id, "cash", args.amount, "admin_set") ? "done" : "refused");
});

GetSharedMoneyCopy Anchor Link

O saldo da conta de um emprego ou de uma gangue (dinheiro da sociedade).

Lado: Servidor · Espera: não · Lib: nenhuma (banking.societyBalance pergunta à camada de banco, que pode ler de um script de banco)

GetSharedMoney(ownerType: "job" | "gang", ownerId: string, account: string): number | null

local balance = exports['ai-core']:GetSharedMoney('job', 'police', 'bank') -- number ou nil

ParâmetrosCopy Anchor Link

RetornoCopy Anchor Link

number | null: o saldo. null quando o emprego, a gangue ou o tipo de conta não existe (ou as contas dele ainda não foram carregadas).

ExemploCopy Anchor Link

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

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

// Um menu de chefe mostra o dinheiro do emprego; só membros do emprego podem pedir.
onClientCallback("myscript:societyBalance", (source) => {
  const job = online.dutyJob(source);
  if (!job) return fail("NOT_ON_DUTY");
  return { ok: true, balance: core.GetSharedMoney("job", job, "bank") ?? 0 };
});

AddSharedMoneyCopy Anchor Link

Adiciona dinheiro à conta de um emprego ou de uma gangue.

Lado: Servidor · Espera: não · Lib: nenhuma

AddSharedMoney(
  ownerType: "job" | "gang",
  ownerId: string,
  account: string,
  amount: number,
  reason?: string,
): boolean

local ok = exports['ai-core']:AddSharedMoney('job', 'mechanic', 'bank', 300, 'repair_fee')

ParâmetrosCopy Anchor Link

RetornoCopy Anchor Link

boolean: true quando o dinheiro foi adicionado. false quando o emprego, a gangue ou a conta não existe ou amount não é um número inteiro acima de 0.

ExemploCopy Anchor Link

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

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

/** A sale made by an NPC customer goes into the restaurant's account. */
export function restaurantSale(job: string, price: number): void {
  if (!core.AddSharedMoney("job", job, "bank", price, "npc_sale"))
    console.log(`job ${job} has no bank account`);
}

RemoveSharedMoneyCopy Anchor Link

Tira dinheiro da conta de um emprego ou de uma gangue.

Lado: Servidor · Espera: não · Lib: nenhuma

RemoveSharedMoney(
  ownerType: "job" | "gang",
  ownerId: string,
  account: string,
  amount: number,
  reason?: string,
): boolean

local ok = exports['ai-core']:RemoveSharedMoney('job', 'police', 'bank', 2000, 'equipment')

ParâmetrosCopy Anchor Link

RetornoCopy Anchor Link

boolean: true quando o dinheiro foi tirado. false quando o saldo é baixo demais (e saldos negativos não são permitidos), o emprego, a gangue ou a conta não existe ou amount não é um número inteiro acima de 0.

ExemploCopy Anchor Link

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

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

// Um emprego encomenda suprimentos com a própria conta.
onClientCallback("myscript:orderSupplies", { lock: true }, (source) => {
  const job = online.dutyJob(source);
  if (!job) return fail("NOT_ON_DUTY");
  if (!core.RemoveSharedMoney("job", job, "bank", 1500, "supplies")) return fail("SOCIETY_NO_MONEY");
  return { ok: true };
});

TransferMoneyCopy Anchor Link

Move dinheiro de uma conta para outra em uma só transação no banco de dados, com as duas linhas no livro-razão. Cada lado pode ser a conta de um jogador carregado ou a conta de um emprego ou gangue. Use para todo pagamento entre duas contas: um jogador pagando um negócio, uma transferência bancária, um depósito na sociedade.

Lado: Servidor · Espera: não · Lib: money.transfer

TransferMoney(from: MoneyRef, to: MoneyRef, amount: number, reason?: string, fee?: number): boolean

local ok = exports['ai-core']:TransferMoney(
  { source = source, account = 'bank' },
  { owner = 'job', id = 'mechanic', account = 'bank' },
  750, 'repair', 0)

ParâmetrosCopy Anchor Link

MoneyRef é { source, account } para a conta de um jogador carregado, ou { owner, id, account } para a conta de um emprego ou gangue. Veja MoneyRef.

RetornoCopy Anchor Link

boolean: true quando from pagou amount + fee e to recebeu amount. false quando falta uma conta (jogador não carregado, emprego desconhecido, tipo de conta desconhecido), os dois lados são a mesma conta, from não consegue pagar amount + fee, amount não é um número inteiro acima de 0 ou fee não é um número inteiro de 0 ou mais. Com false nada mudou.

ExemploCopy Anchor Link

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

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

// Um depósito no caixa eletrônico na conta da própria gangue do jogador, com taxa de 2%.
onClientCallback(
  "myscript:gangDeposit",
  { args: ([amount]) => { const n = readInt(amount, 1, 1_000_000); return n === null ? null : [n]; }, lock: true },
  (source, amount) => {
    const gang = core.GetActiveGang(source);
    if (!gang) return fail("NO_GANG");
    const fee = Math.ceil(amount * 0.02);
    const ok = core.TransferMoney(
      { source, account: "bank" },
      { owner: "gang", id: gang, account: "bank" },
      amount, "gang_deposit", fee,
    );
    return ok ? { ok: true } : fail("NOT_ENOUGH_MONEY");
  },
);

GetAccountTypesCopy Anchor Link

Cada tipo de conta da lista Accounts do painel, com o rótulo, a quantia inicial e se pode ficar negativo. Use para montar um menu de contas ou verificar um nome.

Lado: Servidor · Espera: não · Lib: nenhuma

GetAccountTypes(): Record<string, AccountTypeDefinition>

local types = exports['ai-core']:GetAccountTypes() -- table indexada pelo nome da conta

ParâmetrosCopy Anchor Link

Nenhum.

RetornoCopy Anchor Link

Record<string, AccountTypeDefinition>: uma cópia indexada pelo nome da conta (cash, bank...). Cada valor tem label (mostrado aos jogadores), start (o que um personagem novo recebe) e allowNegative. Veja AccountTypeDefinition.

ExemploCopy Anchor Link

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

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

// A tela da carteira lista cada conta com o rótulo e o saldo.
onClientCallback("myscript:wallet", (source) => {
  const rows = Object.entries(core.GetAccountTypes()).map(([name, type]) => ({
    name,
    label: type.label,
    balance: core.GetMoney(source, name) ?? 0,
  }));
  return { ok: true, rows };
});