bank_account

Vars
account_balance	How many credits are currently held in the bank account.
account_debt	Debt. If higher than 0, A portion of the credits is earned (or the whole debt, whichever is lower) will go toward paying it off.
account_holder	Name listed on the account, reflected on the ID card.
account_id	The Unique ID number code associated with the owner's bank account, assigned at round start.
account_job	The job datum of the account owner.
add_to_accounts	Should this ID be added to the global list of accounts? If true, will be subject to station-bound economy effects as well as income.
bank_cards	List of the physical ID card objects that are associated with this bank_account
being_dumped	Is there a CRAB 17 on the station draining funds? Prevents manual fund transfer. pink levels are rising
bitrunning_points	Points for bit runner's vendor. Awarded for completing virtual domains.
bounties	If player is currently picking a civilian bounty to do, these options are held here to prevent soft-resetting through the UI.
bounty_timer	Cooldown timer on replacing a civilain bounty. Bounties can only be replaced once every 5 minutes.
civilian_bounty	Reference to the current civilian bounty that the account is working on.
mining_points	How many mining points (shaft miner credits) is held in the bank account, used for mining vendors.
pay_token	A special semi-tandom token for tranfering money from NT pay app
payday_modifier	If there are things effecting how much income a player will get, it's reflected here 1 is standard for humans.
redeemed_coupons	A lazylist of coupons redeemed with the Coupon Master pda app associated with this account.
replaceable	Can this account be replaced? Set to true for default IDs not recognized by the station.
transaction_history	List with a transaction history for NT pay app
Procs
add_log_to_history	Add log to transactions history. Deletes the oldest log when the history has more than 20 entries. Main format: Category: Reason in Reason. Example: Vending: Machinery Using Arguments:
adjust_money	Adjusts the balance of a bank_account as well as sanitizes the numerical input. Arguments:
bank_card_talk	This sends a local chat message to the owner of a bank account, on all ID cards registered to the bank_account. If not held, sends out a message to all nearby players. Arguments:
bounty_num	Returns the required item count, or required chemical units required to submit a bounty.
bounty_text	Returns a string with the civilian bounty's description on it.
bounty_value	Produces the value of the account's civilian bounty reward, if able.
dumpeet	Sets the bank_account to behave as though a CRAB-17 event is happening.
has_money	Returns TRUE if a bank account has more than or equal to the amount, amt. Otherwise returns false. Arguments:
pay_debt	Called when a portion of a debt is to be paid. It'll return the amount of credits put forwards to extinguish the debt.
payday	This proc handles passive income gain for players, using their job's paycheck value. Funds are taken from the parent department account to hand out to players. This can result in payment brown-outs if too many people are in one department. Arguments:
reset_bounty	Performs house-cleaning on variables when a civilian bounty is replaced, or, when a bounty is claimed.
setup_unique_account_id	Proc guarantees the account_id possesses a unique number. If it doesn't, it tries to find a unique alternative. It then adds it to the `SSeconomy.bank_accounts_by_id` global list.
transfer_money	Performs a transfer of credits to the bank_account datum from another bank account. Arguments:
update_account_job_lists	Proc places this account into the right place in the `SSeconomy.bank_accounts_by_job` list, if needed. If an old job is given, it removes it from its previous place first.

Var Details

var
account_balance
–

How many credits are currently held in the bank account.

var
account_debt
–

Debt. If higher than 0, A portion of the credits is earned (or the whole debt, whichever is lower) will go toward paying it off.

var
account_holder
–

Name listed on the account, reflected on the ID card.

var
account_id
–

The Unique ID number code associated with the owner's bank account, assigned at round start.

var
account_job
– /datum/job

The job datum of the account owner.

var
add_to_accounts
–

Should this ID be added to the global list of accounts? If true, will be subject to station-bound economy effects as well as income.

var
bank_cards
– /list

List of the physical ID card objects that are associated with this bank_account

var
being_dumped
–

Is there a CRAB 17 on the station draining funds? Prevents manual fund transfer. pink levels are rising

var
bitrunning_points
–

Points for bit runner's vendor. Awarded for completing virtual domains.

var
bounties
– /list/datum/bounty

If player is currently picking a civilian bounty to do, these options are held here to prevent soft-resetting through the UI.

var
bounty_timer
–

Cooldown timer on replacing a civilain bounty. Bounties can only be replaced once every 5 minutes.

var
civilian_bounty
– /datum/bounty

Reference to the current civilian bounty that the account is working on.

var
mining_points
–

How many mining points (shaft miner credits) is held in the bank account, used for mining vendors.

var
pay_token
–

A special semi-tandom token for tranfering money from NT pay app

var
payday_modifier
–

If there are things effecting how much income a player will get, it's reflected here 1 is standard for humans.

var
redeemed_coupons
– /list

A lazylist of coupons redeemed with the Coupon Master pda app associated with this account.

var
replaceable
–

Can this account be replaced? Set to true for default IDs not recognized by the station.

var
transaction_history
– /list

List with a transaction history for NT pay app

Proc Details

proc
add_log_to_history
(adjusted_money, reason)

Add log to transactions history. Deletes the oldest log when the history has more than 20 entries. Main format: Category: Reason in Reason. Example: Vending: Machinery Using Arguments:

adjusted_money - How much was added, negative values removing cash.
reason - The reason of interact with balance, for example, "Bought chips" or "Payday".

proc
adjust_money
(amount, reason)

Adjusts the balance of a bank_account as well as sanitizes the numerical input. Arguments:

amount - the quantity of credits that will be written off if the value is negative, or added if it is positive.
reason - the reason for the appearance or loss of money

proc
bank_card_talk
(message, force)

This sends a local chat message to the owner of a bank account, on all ID cards registered to the bank_account. If not held, sends out a message to all nearby players. Arguments:

message - text that will be sent to listeners after the id card icon
force - if TRUE ignore checks on client and client prefernces.

proc
bounty_num
()

Returns the required item count, or required chemical units required to submit a bounty.

proc
bounty_text
()

Returns a string with the civilian bounty's description on it.

proc
bounty_value
()

Produces the value of the account's civilian bounty reward, if able.

proc
dumpeet
()

Sets the bank_account to behave as though a CRAB-17 event is happening.

proc
has_money
(amount)

Returns TRUE if a bank account has more than or equal to the amount, amt. Otherwise returns false. Arguments:

amount - the quantity of credits that will be reconciled with the account balance.

proc
pay_debt
(amount, is_payment)

Called when a portion of a debt is to be paid. It'll return the amount of credits put forwards to extinguish the debt.

proc
payday
(amount_of_paychecks, free)

This proc handles passive income gain for players, using their job's paycheck value. Funds are taken from the parent department account to hand out to players. This can result in payment brown-outs if too many people are in one department. Arguments:

amount_of_paychecks - literally the number of salaries, 1 for issuing one salary, 5 for issuing five salaries.
free - issuance of free funds, if TRUE then takes funds from the void, if FALSE (default) tries to send from the department's account.

proc
reset_bounty
()

Performs house-cleaning on variables when a civilian bounty is replaced, or, when a bounty is claimed.

proc
setup_unique_account_id
()

Proc guarantees the account_id possesses a unique number. If it doesn't, it tries to find a unique alternative. It then adds it to the SSeconomy.bank_accounts_by_id global list.

proc
transfer_money
(/datum/bank_account/from, amount, transfer_reason)

Performs a transfer of credits to the bank_account datum from another bank account. Arguments:

datum/bank_account/from - The bank account that is sending the credits to this bank_account datum.
amount - the quantity of credits that are being moved between bank_account datums.
transfer_reason - override for adjust_money reason. Use if no default reason(Transfer to/from Name Surname).

proc
update_account_job_lists
(/datum/job/new_job, /datum/job/old_job)

Proc places this account into the right place in the SSeconomy.bank_accounts_by_job list, if needed. If an old job is given, it removes it from its previous place first.

bank_account /datum/bank_account

Vars

Procs

Var Details

var account_balance –

var account_debt –

var account_holder –

var account_id –

var account_job – /datum/job

var add_to_accounts –

var bank_cards – /list

var being_dumped –

var bitrunning_points –

var bounties – /list/datum/bounty

var bounty_timer –

var civilian_bounty – /datum/bounty

var mining_points –

var pay_token –

var payday_modifier –

var redeemed_coupons – /list

var replaceable –

var transaction_history – /list