AI Core
Справочник APILib: сервер

Деньги и банк

money.transfer между двумя счетами, банковский скрипт через ai-core и счета через тот скрипт счетов, который запущен.

TypeScript
import { money, banking, billing } from "@aicore8/lib/server";

money - это любой баланс на сервере: счета загруженного игрока, общий счёт работы или банды, перевод, который двигает деньги одной транзакцией, и журнал. Персонаж, который не подключён, идёт через characters. banking и billing - слои для банковского и счётного скриптов сервера.

money

money.get

Баланс загруженного игрока на одном счёте.

Сторона: Сервер · Ждёт: нет

Сигнатура
money.get(source: number, account: string): number | null
Lua
local balance = aiLib.money.get(source, account)

Параметры

Prop

Type

Возвращает

number | null: баланс или null, если у игрока нет загруженного персонажа либо такого типа счёта не существует. Балансы сохранённого персонажа берутся из characters.get.

Пример

import { money, notify } from "@aicore8/lib/server";

export function tellBalance(source: number): void {
  const bank = money.get(source, "bank");
  notify(source, bank === null ? "Нет персонажа" : `Банк: $${bank}`, bank === null ? "error" : "inform");
}

money.add, money.remove and money.set

Меняет один счёт загруженного игрока, со строкой журнала. Это вызовы для награды, цены, зарплаты, которую платит ваш скрипт.

Сторона: Сервер · Ждёт: нет

Сигнатура
money.add(source: number, account: string, amount: number, reason?: string): boolean
money.remove(source: number, account: string, amount: number, reason?: string): boolean
money.set(source: number, account: string, amount: number, reason?: string): boolean
Lua
local ok = aiLib.money.add(source, account, amount, reason)
local ok = aiLib.money.remove(source, account, amount, reason)
local ok = aiLib.money.set(source, account, amount, reason)

Параметры

Prop

Type

Возвращает

boolean: true, когда изменение прошло. false, если у игрока нет загруженного персонажа, счёта не существует, сумма не целая больше 0, либо - у remove - баланс не может заплатить (если тип счёта не разрешает уходить ниже нуля).

Пример

import { money, onClientCallback } from "@aicore8/lib/server";
import { fail } from "@aicore8/lib/shared";

onClientCallback("myshop:buyTools", { lock: true }, (source) => {
  if (!money.remove(source, "cash", 150, "shop:tools")) return fail("NOT_ENOUGH_CASH");
  // здесь выдайте предмет
  return { ok: true };
});

Оплата одного игрока другому - это не remove плюс add: сбой на середине создал бы или уничтожил деньги. Берите money.transfer, это одна транзакция базы.

money.sharedGet

Баланс счёта работы или банды - bank это то, что другие фреймворки называют деньгами организации.

Сторона: Сервер · Ждёт: нет

Сигнатура
money.sharedGet(type: "job" | "gang", id: string, account: string): number | null
Lua
local balance = aiLib.money.sharedGet(type, id, account)

Параметры

Prop

Type

Возвращает

number | null: баланс или null, если у этой работы либо банды нет такого счёта (неизвестная работа или тип счёта, которого нет на сервере).

money.sharedAdd and money.sharedRemove

Меняет счёт работы или банды, со строкой журнала - доходы и расходы компании.

Сторона: Сервер · Ждёт: нет

Сигнатура
money.sharedAdd(type: "job" | "gang", id: string, account: string, amount: number, reason?: string): boolean
money.sharedRemove(type: "job" | "gang", id: string, account: string, amount: number, reason?: string): boolean
Lua
local ok = aiLib.money.sharedAdd(type, id, account, amount, reason)
local ok = aiLib.money.sharedRemove(type, id, account, amount, reason)

Возвращает

boolean: true, когда изменение прошло, false при неизвестной работе или банде, отсутствующем счёте, неверной сумме либо счёте, который не может заплатить.

Пример

import { money } from "@aicore8/lib/server";

/** Городской контракт, который зарабатывает мастерская, и плата за запчасти. */
export function contractDone(job: string, pay: number, parts: number): boolean {
  if (!money.sharedAdd("job", job, "bank", pay, "city contract")) return false;
  return money.sharedRemove("job", job, "bank", parts, "parts");
}

money.transfer

Переводит деньги с одного счёта на другой в одной транзакции базы данных, с записью в журнале на обеих сторонах. Используйте для всего, где деньги не должны появиться или исчезнуть на полпути: оплата другому игроку, премия от работы, сбор.

Сторона: Сервер · Ждёт: нет

Сигнатура
money.transfer(from: MoneyRef, to: MoneyRef, amount: number, reason?: string, fee?: number): boolean
Lua
local ok = aiLib.money.transfer(from, to, amount, reason, fee)

Параметры

Prop

Type

Возвращает

boolean: true, если обе строки записаны. false, если сумма не является целым числом, счёт отсутствует, оба счёта совпадают или from не может заплатить amount плюс fee.

Пример

import { onClientCallback, money, nearestPlayerTo, notify } from "@aicore8/lib/server";
import { fail, oneArg, readInt } from "@aicore8/lib/shared";

onClientCallback("my-cash:give", { args: oneArg((v) => readInt(v, 1, 100_000)), lock: true }, (source, amount) => {
  const target = nearestPlayerTo(source, 2);
  if (target === null) return fail("NOBODY_NEAR");
  if (!money.transfer({ source, account: "cash" }, { source: target, account: "cash" }, amount, "give:cash"))
    return fail("NOT_ENOUGH_CASH");
  notify(target, `You received $${amount}`, "success");
  return { ok: true };
});

money.history

Строки журнала счёта, самые новые первыми: что сдвинулось, баланс после, причина, кто это сделал и когда. Работает для счёта игрока, счёта работы или банды и счёта сохранённого персонажа.

Сторона: Сервер · Ждёт: да

Сигнатура
money.history(account: LedgerRef, query?: LedgerQuery): Promise<LedgerPage>
Lua
local page = aiLib.money.history(account, query)

Параметры

Prop

Type

Возвращает

LedgerPage: rows и next, который вы передаёте как before (null на последней странице). ai-core пишет строку через мгновение после изменения, так что самая новая может отставать от баланса на несколько миллисекунд.

Пример

import { money } from "@aicore8/lib/server";

/** Последние 20 банковских строк сохранённого персонажа. */
export async function statement(charId: number) {
  const page = await money.history({ owner: "character", id: String(charId), account: "bank" }, { limit: 20 });
  return page.rows.map((r) => `${r.at}: ${r.amount} (${r.reason})`);
}

banking

banking общается с банковским скриптом через банковский слой ai-core. Сами деньги работы всегда перемещаются через money или экспорты ai-core.

banking.open

Открывает экран банковского скрипта для игрока.

Сторона: Сервер · Ждёт: нет

Сигнатура
banking.open(source: number): boolean
Lua
local ok = aiLib.banking.open(source)

Возвращает true, если открыт. false, если скрипт нельзя открыть извне или никакой не запущен.

onClientCallback("my-atm:open", (source) => (banking.open(source) ? { ok: true } : fail("BANK_UNAVAILABLE")));

banking.societyBalance

Баланс общества работы, для отображения. В режиме счёта core ai-core это счёт работы в ai-core; в режиме own собственный счёт банковского скрипта.

Сторона: Сервер · Ждёт: нет

Сигнатура
banking.societyBalance(job: string): number | null
Lua
local balance = aiLib.banking.societyBalance(job) -- number или nil

Возвращает баланс или null (в Lua nil), если никакой скрипт не запущен или скрипт его не хранит.

const balance = banking.societyBalance("mechanic") ?? 0;

banking.provider

Сторона: Сервер · Ждёт: нет

Сигнатура
banking.provider(): string | null
Lua
local name = aiLib.banking.provider()

Возвращает банковский скрипт, который использует слой, или null.

console.log(`banking through ${banking.provider() ?? "nothing"}`);

billing

billing отправляет счета через тот скрипт счетов, который запущен; без него используются собственные счета ai-core (игрок платит из списка на экране, деньги перемещаются при оплате). Тексты уже переведены.

billing.send

Отправляет счёт от работы (штрафы, плата за услуги) или от игрока.

Сторона: Сервер · Ждёт: нет

Сигнатура
billing.send(bill: BillRequest): boolean
Lua
local ok = aiLib.billing.send(bill)

BillRequest

Prop

Type

Возвращает

boolean: true, если отправлен, false, если неверный или отклонён.

Пример

import { billing, nearestPlayerTo, online } from "@aicore8/lib/server";
import { fail } from "@aicore8/lib/shared";

function fine(officer: number, amount: number) {
  if (!online.onDutyIn(officer, ["police"])) return fail("NOT_ON_DUTY");
  const target = nearestPlayerTo(officer, 3);
  if (target === null) return fail("NOBODY_NEAR");
  return billing.send({ to: target, amount, label: "Speeding", from: officer, job: "police" })
    ? { ok: true }
    : fail("BILL_FAILED");
}

billing.unpaid

Неоплаченные счета игрока.

Сторона: Сервер · Ждёт: да (Promise в TypeScript, в Lua приостанавливает поток)

Сигнатура
billing.unpaid(source: number): Promise<UnpaidBill[] | null>
Lua
local bills = aiLib.billing.unpaid(source) -- table[] или nil, вызывайте внутри потока

Возвращает UnpaidBill[] (id, label, ещё не оплаченная amount, sender) или null, если скрипт счетов не умеет их перечислять.

const bills = await billing.unpaid(source);
const owed = bills?.reduce((sum, bill) => sum + bill.amount, 0) ?? 0;

billing.pay

Игрок оплачивает один из своих неоплаченных счетов.

Сторона: Сервер · Ждёт: нет

Сигнатура
billing.pay(source: number, id: string): boolean
Lua
local ok = aiLib.billing.pay(source, id)

Prop

Type

Возвращает true, если оплачен. false, если отклонено (не хватает денег, неизвестный счёт) или скрипт счетов принимает оплату только на своём экране.

if (!billing.pay(source, billId)) return fail("PAY_FAILED");

billing.provider

Сторона: Сервер · Ждёт: нет

Сигнатура
billing.provider(): string | null
Lua
local name = aiLib.billing.provider()

Возвращает скрипт счетов, в который уходят счета, "ai-core" для собственных счетов ai-core.

if (billing.provider() === "ai-core") console.log("using ai-core's own bills");

На этой странице