Bank

Every player has a bank box, as in ModernUO: a container worn on the bank layer, which the client never draws. A banker opens it when the player asks; the player then reaches what is inside until he moves away.

Opening the bank

Say bank near a banker. The client turns the word into the speech keyword SpeechKeywordType.Bank in its own language, so banca on an Italian client works the same; the shipped banker.lua also reads the plain word, for a client that sends no keywords. The bank box opens with a line over the player:

Bank container has 3 items.

The first time, the bank box is made (template bank_box of templates/items/bank.toml, a metal chest graphic) and saved, then shown. The banker templates banker, m_banker, f_banker, gypsybanker, m_gypsybanker and f_gypsybanker use the script, so every banker of the spawns answers.

A banker also offers Open Bank Box in its context menu, from the same 12 tiles: it opens the box as the word does, and a criminal gets the same refusal.

While it is open

The bank stays open while the player stands where it opened: a step, a teleport, a map change or a new login closes it, and coming back to the spot does not open it again. Turning in place does not close it.

Its owner lifts, drops and uses what is inside only while it is open: a closed bank refuses the lift, bounces what is dropped into it and opens nothing.
Nobody else reaches it; game masters and administrators reach their own even while it is closed.
The bank box itself never leaves the bank layer, and world.carries does not look in it: a key in the bank does not open a door.

Gold by speech

Within 12 tiles of a banker, with the box open or not:

Say	The banker	It answers
balance	tells the gold in your bank	`Thy current bank balance is 1,234 gold.`
withdraw 500	moves 500 coins from the bank to your backpack	`Thou hast withdrawn gold from thy account.`
deposit 500	moves 500 coins from your backpack to the bank	`500 gold was deposited in your account.`
check 5000	writes a bank check for 5000 coins of the bank	`Into your bank box I have placed a check in the amount of: 5,000`

balance, withdraw and check are speech keywords of the client, like bank: they work in the language of the client. deposit is an English word only, because the client has no keyword for it.
The amount is the first number of the sentence: withdraw 500, I wish to withdraw 500 gold and 500 withdraw are the same. A sentence with no number, or with 0, moves nothing and gets no answer. Separators are not read: 5,000 is 5.
The balance counts the coins and the worth of the checks anywhere in the bank box, bags included.
A withdrawal is at most max_withdraw coins. When the coins of the bank are not enough the checks give the rest: a check that is used up is gone, the last one keeps what is left of it. They join a gold pile of your backpack when it has the room, a pile holding 60000 at most, and make a new pile otherwise.
A deposit takes coins from the backpack and its bags; in the bank they top up the piles of the box, then make piles of 60000.
Gold weighs, a coin 0.02 stones: as in ModernUO the banker hands out what you ask even when it is more than you can carry, and you walk away overloaded. Only a backpack already at its weight takes nothing.
Both are all or nothing: a refusal moves no coin.
The banker’s lines are the client’s own texts, so every player reads them in its language.
When several bankers hear you, one answers and the gold moves once.

The banker says	Why
`Thou art a criminal and cannot access thy bank box.`	A criminal said bank.
`I will not do business with a criminal!`	A criminal asked for anything else.
`Thou canst not withdraw so much at one time!`	More than `max_withdraw`.
`Ah, art thou trying to fool me? Thou hast not so much gold!`	The bank, or the backpack for a deposit, has less than that.
`Your backpack can't hold anything else.`	The backpack is already at its weight, or has no room for a new pile.
`Your bank box is full.`	The deposit needs a new pile and the box holds its limit of items.
`We cannot create checks for such a paltry amount of gold!`	A check below `min_check`.
`Our policies prevent us from creating checks worth that much!`	A check above `max_check`.
`There's not enough room in your bankbox for the check!`	The box is full and the coins that pay the check use up no pile.

A player who says deposit before ever opening its bank gets the box made and shown instead, and asks again.

Gold handed to the banker

Drop a pile of gold or a bank check on a banker, from 2 tiles or closer, and it goes into your bank (from farther you read That is too far away.; the staff gives from any distance): the banker says 1,250 gold was deposited in your account., with the worth of a check.

Gold tops up the gold piles of the box, and what is left is a pile of its own; a check goes in as it is. All or nothing: a refusal gives the item back to where you lifted it from.
The box need not be open.
This is the script’s on_drag_drop (mobile scripts), over bank.deposit_item.

The banker says	Why
`I will not do business with a criminal!`	A criminal handed it.
`Your bank box is full.`	The gold or the check needs a place and the box holds its limit of items.
`I am not interested in this.`	It is neither gold nor a bank check.

A player who never opened its bank gets the box made and shown, and hands the gold again.

Bank checks

A check is gold on paper: one item that weighs a stone, whatever it is worth. Say check 5000 to a banker and it takes 5000 coins of your bank and puts a check in your bank box.

A check is worth from min_check to max_check coins, 5000 to 1,000,000 unless the shard says otherwise.
It is paid with the coins of the bank: another check does not pay a check.
Its tooltip reads value: 5,000. It is blessed, and it does not stack.
To cash it, double click it inside your open bank box, in the box or in a bag of it: it becomes coins of the box, topping up the gold piles there and then making piles of 60000, and you read 5,000 gold was deposited in your account.
A box with room for part of the gold takes what fits and the check keeps the rest; with room for nothing you read Your bank box is full.
One cashing makes 125 piles at most, 7,500,000 coins: a check worth more keeps the rest, and another double click goes on.
Anywhere else a double click says That must be in your bank box to use it.

A game master makes a check of any worth with create_check, and gives gold to a mobile with add_gold.

A check is the item template bank_check of templates/items/bank.toml, with its worth in the prop bank.worth; its script is scripts/items/bank_check.lua. The name it shows is the client’s own, A bank check.

How much it holds

A bank box holds max_items items, 125 unless the shard says otherwise, counted with everything inside its bags: a bag with ten things in it is eleven. A drop that would go past the limit bounces back and you read That container cannot hold more items.

Putting coins or anything that stacks onto a pile already there adds no item.
An item dropped into a bag that is inside the bank box counts against the box too.
Game masters and above are exempt.
The box has no limit of weight, and what is in it weighs nothing on its owner.

The same rule holds for any container whose item template sets max_items; a template that says nothing has no limit. The gift of a script (item.give) into a backpack with no room gives nothing.

Settings

[ultima.bank]
max_items = 125        # Items in a bank box, bags included; 0 for no limit.
max_withdraw = 60000   # Coins a banker hands out at one time.
min_check = 5000       # The smallest check a banker writes.
max_check = 1000000    # The largest.

max_items goes from 0 to 10000, max_withdraw from 1 to 60000 (one pile), min_check from 1 to max_check, max_check up to 2,000,000,000.

The banker script

scripts/mobiles/banker.lua holds the rules above: which word is which command, the distance, the criminal, the amount, and which text of the client answers what. It is yours to change. It stands on these functions:

function banker.on_speech(serial, speaker, text, keywords)
    -- One banker serves when several hear the words.
    if not bank.attend(speaker) then
        return
    end

    if mobile.criminal(speaker) then
        npc.say_cliloc(serial, 500389) -- I will not do business with a criminal!
        return
    end

    -- A banker never walks: it turns to who asks.
    npc.look_at(serial, speaker)

    if bank.withdraw(speaker, 500) == BankResultType.Ok then
        npc.say_cliloc(serial, 1010005) -- Thou hast withdrawn gold from thy account.
    end
end

The banker turns to who asks (npc.look_at): an NPC is born facing south, and a banker never walks, so without it every banker of a bank would face the same way for ever.

on_speech gets the speech keywords the client found as a fourth argument, an array of numbers; SpeechKeywordType names the bank’s (Withdraw, Balance, Bank, Check).

Function	What
`bank.open(player)`, `bank.is_open(player)`	Opens the bank box; whether it is open.
`bank.balance(player)`	The gold in the bank; 0 for a player who never opened it.
`bank.withdraw(player, amount)`	Coins to the backpack; a `BankResultType`.
`bank.deposit(player, amount)`	Coins from the backpack; a `BankResultType`.
`bank.check(player, amount)`	Writes a check paid with the coins of the bank; a `BankResultType`.
`bank.cash(player, check)`	Turns a check inside the bank box into coins; a `BankResultType`.
`bank.worth(item)`	What a check is worth; nil for anything else.
`bank.deposit_item(player, item)`	Puts a gold pile or a check, as dropped on a banker, into the bank box; a `BankResultType`.
`bank.attend(player)`	True for the first banker that asks in the same moment.
`npc.say_cliloc(npc, cliloc [, args [, affix]])`	The NPC says a text of the client, each player in its language; `affix` is written after it.

BankResultType is Ok, NotEnoughGold, TooMuch, BackpackFull, BankFull, BadAmount, NoPlayer, NoBank (the player never opened its bank), Busy (try again in a moment), CheckTooSmall, CheckTooBig, NotInBank (not a check, or not inside the player’s bank box) or NotMoney (bank.deposit_item was given something that is not gold or a check). The module does not check where the player stands nor who it is: the script does. See the bank module.