UgCore.Accounts

Server Client Optional module. Requires characters. Balances belong to the loaded character. Every change writes a ledger row in the same transaction. Accounts are defined in config/accounts.lua:

config/accounts.lua

return {
    accounts = {
        cash = { label = 'Cash', startingBalance = 500, allowNegative = false },
        bank = { label = 'Bank', startingBalance = 5000, allowNegative = false },
        crypto = { label = 'Crypto', startingBalance = 0, allowNegative = false },
    },
}

Server

GetBalance / GetAll

UgCore.Accounts.GetBalance(source, account) -> integer?
UgCore.Accounts.GetAll(source) -> table<string, integer>?

nil when no character is loaded.

Add / Remove / Set

UgCore.Accounts.Add(source, account, amount, reason?) -> ok, balance, errorCode
UgCore.Accounts.Remove(source, account, amount, reason?) -> ok, balance, errorCode
UgCore.Accounts.Set(source, account, balance, reason?) -> ok, balance, errorCode

integer

required

Positive.

string

Stored in the ledger.

integer?

The new balance.

UgErrorCode?

not_loaded without a character, insufficient_funds unless the account allows negative balances, no_permission when a hook cancelled.

Set records the difference in the ledger. Add and Remove run the Accounts:BeforeAdd and Accounts:BeforeRemove hooks.

Transfer

UgCore.Accounts.Transfer(source, targetCharacterId, account, amount, reason?) -> ok, balance, errorCode

Moves money to another character, online or offline, in one transaction. Both ledgers get a row. balance is the sender’s. Runs Accounts:BeforeTransfer.

GetLedger

UgCore.Accounts.GetLedger(source, account, limit?) -> ok, entries, errorCode

integer

default:"25"

1 to 100.

UgLedgerEntry[]

Newest first.

Show fields

integer

Signed change.

integer

string?

The other side of a transfer.

integer

Unix seconds.

Client

UgCore.Accounts.GetBalance(account) -> integer?
UgCore.Accounts.GetAll() -> table<string, integer>

The local player’s balances, pushed by the server on every change.

Example

local ok, balance, err = UgCore.Accounts.Remove(source, 'cash', price, 'shop:water')

if not ok then
    return err -- 'insufficient_funds'
end

Listen to ug-core:Accounts:Changed with (source, account, balance, delta, reason) to update a HUD.

Overview

Core

Networking and security

Modules

Reference

UgCore.Accounts

Server

GetBalance / GetAll

Add / Remove / Set

Transfer

GetLedger

Client

Example

​Server

​GetBalance / GetAll

​Add / Remove / Set

​Transfer

​GetLedger

​Client

​Example

Server

GetBalance / GetAll

Add / Remove / Set

Transfer

GetLedger

Client

Example