Exports

These let your own scripts read the same figures the panel shows — a payday script that checks the money supply first, a Discord bot, a dashboard of your own.

Server side

Anything that reads a total returns nil until the first pass has finished, so check isReady — or just check what came back — before using it.

isReady

Tells you whether the figures are ready yet.

Takes no arguments. Returns boolean.

exports.REC_Economy:isReady()

getStatus

Tells you what it is still waiting for.

Takes no arguments. Returns Status:

exports.REC_Economy:getStatus()

getMoneys

Gives you the total of each currency.

Takes no arguments. Returns table<MoneyTypes, MetaData>?:

exports.REC_Economy:getMoneys()

RegisterCommand("supply", function()
    if exports.REC_Economy:isReady() == false then
        return
    end

    for moneyType, meta in pairs(exports.REC_Economy:getMoneys()) do
        print(("%s: %d"):format(moneyType, meta.value))
    end
end, true)

getSocieties

Gives you every group account.

Takes no arguments. Returns table<string, SocietyMetaData>?:

exports.REC_Economy:getSocieties()

getSnapshot

Gives you everything the dashboard opens with, in one call.

Takes no arguments. Returns Snapshot?:

exports.REC_Economy:getSnapshot()

getDistribution

Gives you how evenly money is spread across your players.

Takes no arguments. Returns Distribution?:

exports.REC_Economy:getDistribution()

getHistory

Gives you the saved totals, oldest first.

Returns HistoryRow[]:

exports.REC_Economy:getHistory(days)

getLastSnapshotAt

Tells you when the last snapshot was saved.

Takes no arguments. Returns integer?.

exports.REC_Economy:getLastSnapshotAt()

refresh

Rebuilds everything now.

Takes no arguments. Returns boolean — false if a rebuild is already running.

exports.REC_Economy:refresh()

getPlayers

Gives you character balances, filtered before they reach you.

Returns PlayersResult? — players (citizenId, name, online, moneys, total) plus matched, total, truncated and targetDays.

exports.REC_Economy:getPlayers(search, limit)

getPlayerMoneys

Gives you one character's balances, whether they are online or not.

Returns table<MoneyTypes, integer>?, and their name as a second value.

exports.REC_Economy:getPlayerMoneys(citizenId)

getFlows

Gives you what created and destroyed money, by reason and by job.

Returns Flows?:

exports.REC_Economy:getFlows(days)

getRecentFlows

Gives you money movements since you last asked, oldest first.

Returns FlowPush? — the next cursor, the events, how many dropped off the end, and the not-yet-saved totals.

exports.REC_Economy:getRecentFlows(since)

getAlerts

Gives you what tripped, newest first.

Returns Alert[]:

exports.REC_Economy:getAlerts(days)

getSocietyHistory

Gives you one group's balance over time, oldest first.

Returns a list of { money, takenAt }.

exports.REC_Economy:getSocietyHistory(name, days)

getWatchlist

Gives you who is currently being recorded.

Takes no arguments. Returns WatchEntry[]? — citizenId, label, note, addedBy, expiresAt, createdAt, expired.

exports.REC_Economy:getWatchlist()

addWatch

Starts recording everything one character does with money.

Returns boolean, plus an error message when it failed.

exports.REC_Economy:addWatch(citizenId, note, addedBy, days)

removeWatch

Stops recording one character.

Returns boolean.

exports.REC_Economy:removeWatch(citizenId)

getWatchEvents

Gives you everything one watched character did, newest first.

Returns WatchEvent[] — reason, moneyType, amount, isRemove, at.

exports.REC_Economy:getWatchEvents(citizenId, days)

getNotes

Gives you the notes marked on the charts, oldest first.

Returns Note[] — id, text, author, at.

exports.REC_Economy:getNotes(days)

addNote

Marks a note on the charts.

Returns boolean.

exports.REC_Economy:addNote(text, author)

deleteNote

Removes one note.

Returns boolean.

exports.REC_Economy:deleteNote(id)

beginActivity

Start an activity with an ID unique within the calling resource and its participants. Staff and duplicate participants are rejected.

recordActivityMoney

Add non-negative earned/spent amounts to an active session.

endActivity

Finish an activity and store its outcome, participant-time and money totals.

recordPurchase

Record a positive quantity and non-negative total payment. paid is the total, not the unit price.

getAnalysis

Return analysis for a period (default 7 days, range 1–30) and Unix timestamp anchor. Returns nil before initialization.