Capitalism Game

• Index

Mods

• audit
• banking
• company
• land
• shop

Articles

• dev_intro

Module banking

Introduces bank accounts and transactions.

Functions

Tables

Class Account

Functions

get_balance (owner)

Gets the balance for a particular account

Parameters:

• owner string Account owner

Returns:

int

add_account (acc)

Adds an account to the local cache

Parameters:

• acc banking.Account

get_by_owner (owner)

Gets account by owner name

Parameters:

• owner string

Returns:

banking.Account

transfer (actor, from, to, amount, reason)

Transfers money between accounts, with permission checking

Parameters:

• actor string User requesting this transfer
• from string From account
• to string Target account
• amount int
• reason string Transaction reason

Returns:

true

Or

1. nil
2. string Error message

Tables

banking

banking table

Class Account

Account:new (obj)

Constructor

Parameters:

• obj A table to construct an object on top of

Returns:

banking.Account

Account:to_table ()

Export to Lua table

Returns:

table

Account:from_table (t)

Import from Lua table

Parameters:

• t table

Returns:

bool true for success

Account:withdraw (amount, to, reason)

Withdraw from account

Parameters:

• amount int
• to string target account
• reason string Transaction message

Returns:

bool Returns false on failure

Account:deposit (amount, from, reason)

Deposit into account

Parameters:

• amount int
• from string from account
• reason string Transaction message