[an error occurred while processing this directive]
[<a href="index.shtml">Package Index</a></code> | <a href="index_std.shtml">Mudlib Index</a></code> | <a href="index_eff.shtml">Effect Index</a></code>]<br><h2>File /obj/handlers/bank_handler.c</h2>
Keep track of each banks data.<h2>Class Index</h2>
<ul><li><a href="#class_bank_data">bank_data</a>
<li><a href="#class_franchise">franchise</a>
</ul><h2>Method index</h2>
<ul>
<li><a href="#add_new_franchise">add_new_franchise</a>(string, string)<br/>
This method adds a new franchise to the operation.
<li><a href="#add_total_ban">add_total_ban</a>(string)<br/>
Add a player as banned from using banks totally.
<li><a href="#add_withdraw_ban">add_withdraw_ban</a>(string)<li><a href="#adjust_account">adjust_account</a>(string, string, int)<br/>
Change the amount of money a player has at a given bank.
<li><a href="#create_new_bank">create_new_bank</a>(string, string)<br/>
THis method creates a new bank.
<li><a href="#do_cheat_check">do_cheat_check</a>(string, string, int, string, int)<li><a href="#get_data_file">get_data_file</a>(string)<br/>
Start up the system by restoreing the players data.
<li><a href="#is_player_banned">is_player_banned</a>(string, int, string)<br/>
Test to see if the player is banned from using the banks.
<li><a href="#query_account">query_account</a>(string, string)<br/>
Find out how much a player has at a given bank.
<li><a href="#query_accounts">query_accounts</a>(string)<br/>
Query the accounts a player has.
<li><a href="#query_bank_data">query_bank_data</a>(string)<br/>
This method is to be used for testing.
<li><a href="#query_bank_default_cost_per_month">query_bank_default_cost_per_month</a>(string)<br/>
This method returns the new cost for opening a franchise for the bank.
<li><a href="#query_bank_default_cost_per_new_account">query_bank_default_cost_per_new_account</a>(string)<br/>
This method returns the new cost for opening a franchise for the bank.
<li><a href="#query_bank_default_cost_to_open">query_bank_default_cost_to_open</a>(string)<br/>
This method returns the new cost for opening a franchise for the bank.
<li><a href="#query_bank_franchise_cost_per_month">query_bank_franchise_cost_per_month</a>(string, string)<br/>
This method returns the new cost for opening a franchise for the bank.
<li><a href="#query_bank_franchise_cost_per_new_account">query_bank_franchise_cost_per_new_account</a>(string, string)<br/>
This method returns the new cost for opening a franchise for the bank.
<li><a href="#query_bank_master_office">query_bank_master_office</a>(string)<br/>
This method returns the master office of the bank.
<li><a href="#query_banks">query_banks</a>()<br/>
This method returns the current list of banks.
<li><a href="#query_bans">query_bans</a>()<br/>
Query a copy of the current bank gits.
<li><a href="#query_franchises">query_franchises</a>(string)<br/>
This method returns the franchises for the specified bank.
<li><a href="#remove_ban">remove_ban</a>(string)<br/>
Totally remove someone as banned from banking.
<li><a href="#remove_bank">remove_bank</a>(string)<br/>
This method removes a bank from the current list ofbanks.
<li><a href="#remove_franchise">remove_franchise</a>(string, string)<br/>
Remove an associated franchise from a bank.
<li><a href="#set_account">set_account</a>(string, string, int)<br/>
Sets the balance at a certain bank to the specificed amount.
<li><a href="#set_bank_default_cost_per_month">set_bank_default_cost_per_month</a>(string, int)<br/>
This method sets the new cost for opening a franchise for the bank.
<li><a href="#set_bank_default_cost_per_new_account">set_bank_default_cost_per_new_account</a>(string, int)<br/>
This method sets the new cost for opening a franchise for the bank.
<li><a href="#set_bank_default_cost_to_open">set_bank_default_cost_to_open</a>(string, int)<br/>
This method sets the new cost for opening a franchise for the bank.
<li><a href="#set_bank_franchise_cost_per_month">set_bank_franchise_cost_per_month</a>(string, string, int)<br/>
This method sets the new cost for opening a franchise for the bank.
<li><a href="#set_bank_franchise_cost_per_new_account">set_bank_franchise_cost_per_new_account</a>(string, int)<br/>
This method sets the new cost for opening a franchise for the bank.
<li><a href="#set_bank_master_office">set_bank_master_office</a>(string, string)<br/>
This method set the master office of the bank.
</ul>
<h2>Public Functions</h2>
These are functions that everyone can access.<p>
<dl>
<dt class="autodocfuncname"><a name="add_new_franchise">
add_new_franchise</a><pre class="autodocfuncdef">
void add_new_franchise(string name,
                       string franchise_office)
</pre><dd><br />
This method adds a new franchise to the operation.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name of the bank set<br />
franchise_office - the new franchise to add
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="add_total_ban">
add_total_ban</a><pre class="autodocfuncdef">
int add_total_ban(string player)
</pre><dd><br />
Add a player as banned from using banks totally.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
player - player name to ban<br />
<br />
<dd><b>Returns:</b>
<br />1 if the ban was added, 0 if not
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="add_withdraw_ban">
add_withdraw_ban</a><pre class="autodocfuncdef">
int add_withdraw_ban(string player)
</pre>
<dt class="autodocfuncname"><a name="adjust_account">
adjust_account</a><pre class="autodocfuncdef">
void adjust_account(string name,
                    string bank_name,
                    int amount)
</pre><dd><br />
Change the amount of money a player has at a given bank.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name of the player<br />
bank_name - the name of the bank<br />
amount - the amount to change the balance by
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="create_new_bank">
create_new_bank</a><pre class="autodocfuncdef">
void create_new_bank(string name,
                     string master)
</pre><dd><br />
THis method creates a new bank.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name of the bank<br />
master - the location of the master bank
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="do_cheat_check">
do_cheat_check</a><pre class="autodocfuncdef">
void do_cheat_check(string name,
                    string bank_name,
                    int amount,
                    string str,
                    int after)
</pre>
<dt class="autodocfuncname"><a name="get_data_file">
get_data_file</a><pre class="autodocfuncdef">
int get_data_file(string name)
</pre><dd><br />
Start up the system by restoreing the players data.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
word - the name of the player being restored
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="is_player_banned">
is_player_banned</a><pre class="autodocfuncdef">
int is_player_banned(string name,
                     int amount,
                     string bank_name)
</pre><dd><br />
Test to see if the player is banned from using the banks.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - Name of player<br />
amount - Amount they're trying to access<br />
bank_name - Name of bank they're trying to access<br />
<br />
<dd><b>Returns:</b>
<br />0 for good to go, 1 for banned.
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_account">
query_account</a><pre class="autodocfuncdef">
int query_account(string word,
                  string bank_name)
</pre><dd><br />
Find out how much a player has at a given bank.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
word - the name of the player<br />
bank_name - the name of the bank<br />
<br />
<dd><b>Returns:</b>
<br />the current balance, -1 on failure
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_accounts">
query_accounts</a><pre class="autodocfuncdef">
string * query_accounts(string player)
</pre><dd><br />
Query the accounts a player has.
<br />
<br /><dl>
<dd><b>Parameters:</b><br />
player - the name of the player
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_bank_data">
query_bank_data</a><pre class="autodocfuncdef">
class bank_data query_bank_data(string name)
</pre><dd><br />
This method is to be used for testing.
<br />

<dt class="autodocfuncname"><a name="query_bank_default_cost_per_month">
query_bank_default_cost_per_month</a><pre class="autodocfuncdef">
int query_bank_default_cost_per_month(string name)
</pre><dd><br />
This method returns the new cost for opening a franchise for the bank.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
bank - the bank to change the cost for<br />
amount - the new amount to charge to open
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_bank_default_cost_per_new_account">
query_bank_default_cost_per_new_account</a><pre class="autodocfuncdef">
int query_bank_default_cost_per_new_account(string name)
</pre><dd><br />
This method returns the new cost for opening a franchise for the bank.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
bank - the bank to change the cost for<br />
amount - the new amount to charge to open
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_bank_default_cost_to_open">
query_bank_default_cost_to_open</a><pre class="autodocfuncdef">
int query_bank_default_cost_to_open(string name)
</pre><dd><br />
This method returns the new cost for opening a franchise for the bank.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
bank - the bank to change the cost for<br />
amount - the new amount to charge to open
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_bank_franchise_cost_per_month">
query_bank_franchise_cost_per_month</a><pre class="autodocfuncdef">
int query_bank_franchise_cost_per_month(string name,
                                        string franchise_office)
</pre><dd><br />
This method returns the new cost for opening a franchise for the bank.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
bank - the bank to change the cost for<br />
franchise - the franchise to change the amounts for<br />
amount - the new amount to charge to open
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_bank_franchise_cost_per_new_account">
query_bank_franchise_cost_per_new_account</a><pre class="autodocfuncdef">
int query_bank_franchise_cost_per_new_account(string name,
                                              string franchise_office)
</pre><dd><br />
This method returns the new cost for opening a franchise for the bank.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
bank - the bank to change the cost for<br />
amount - the new amount to charge to open
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_bank_master_office">
query_bank_master_office</a><pre class="autodocfuncdef">
string query_bank_master_office(string name)
</pre><dd><br />
This method returns the master office of the bank.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the bank name to check in<br />
<br />
<dd><b>Returns:</b>
<br />the master office of the bank
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_banks">
query_banks</a><pre class="autodocfuncdef">
string * query_banks()
</pre><dd><br />
This method returns the current list of banks.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />the current list of banks
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_bans">
query_bans</a><pre class="autodocfuncdef">
mapping query_bans()
</pre><dd><br />
Query a copy of the current bank gits.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />The current gits.
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_franchises">
query_franchises</a><pre class="autodocfuncdef">
string * query_franchises(string bank)
</pre><dd><br />
This method returns the franchises for the specified bank.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
bank - the bank to get the franchises of<br />
<br />
<dd><b>Returns:</b>
<br />the list of franchises
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="remove_ban">
remove_ban</a><pre class="autodocfuncdef">
int remove_ban(string name)
</pre><dd><br />
Totally remove someone as banned from banking.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - Name of player to clear as a git<br />
<br />
<dd><b>Returns:</b>
<br />Number of git removals performed (0 = not a git)
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="remove_bank">
remove_bank</a><pre class="autodocfuncdef">
void remove_bank(string name)
</pre><dd><br />
This method removes a bank from the current list ofbanks.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name of the bank to remove
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="remove_franchise">
remove_franchise</a><pre class="autodocfuncdef">
void remove_franchise(string bank_name,
                      string franchise_location)
</pre><dd><br />
Remove an associated franchise from a bank.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
bank_name - The friendly name of the bank<br />
franchise_location - base_name of the franchise room
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_account">
set_account</a><pre class="autodocfuncdef">
void set_account(string name,
                 string bank_name,
                 int amount)
</pre><dd><br />
Sets the balance at a certain bank to the specificed amount.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name of the player<br />
bank_name - the name of the bank<br />
amount - the amount to set the bank to.
Query the accounts a player has.
<br />
player - the name of the player
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_bank_default_cost_per_month">
set_bank_default_cost_per_month</a><pre class="autodocfuncdef">
void set_bank_default_cost_per_month(string name,
                                     int amount)
</pre><dd><br />
This method sets the new cost for opening a franchise for the bank.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
bank - the bank to change the cost for<br />
amount - the new amount to charge to open
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_bank_default_cost_per_new_account">
set_bank_default_cost_per_new_account</a><pre class="autodocfuncdef">
void set_bank_default_cost_per_new_account(string name,
                                           int amount)
</pre><dd><br />
This method sets the new cost for opening a franchise for the bank.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
bank - the bank to change the cost for<br />
amount - the new amount to charge to open
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_bank_default_cost_to_open">
set_bank_default_cost_to_open</a><pre class="autodocfuncdef">
void set_bank_default_cost_to_open(string name,
                                   int amount)
</pre><dd><br />
This method sets the new cost for opening a franchise for the bank.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
bank - the bank to change the cost for<br />
amount - the new amount to charge to open
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_bank_franchise_cost_per_month">
set_bank_franchise_cost_per_month</a><pre class="autodocfuncdef">
void set_bank_franchise_cost_per_month(string name,
                                       string franchise_office,
                                       int amount)
</pre><dd><br />
This method sets the new cost for opening a franchise for the bank.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
bank - the bank to change the cost for<br />
franchise - the franchise to change the amounts for<br />
amount - the new amount to charge to open
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_bank_franchise_cost_per_new_account">
set_bank_franchise_cost_per_new_account</a><pre class="autodocfuncdef">
void set_bank_franchise_cost_per_new_account(string name,
                                             int amount)
</pre><dd><br />
This method sets the new cost for opening a franchise for the bank.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
bank - the bank to change the cost for<br />
amount - the new amount to charge to open
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_bank_master_office">
set_bank_master_office</a><pre class="autodocfuncdef">
void set_bank_master_office(string name,
                            string master)
</pre><dd><br />
This method set the master office of the bank.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the bank name to check in<br />
master - the master office of the bank
<br />
<br />
<br /></dl>

</dl>
<h2>Classes</h2>
These are nice data types for dealing with...  Data!<p>
<ul>
<li><a name="class_bank_data">
bank_data</a><pre>
class bank_data {
                  string master_office;
                  class franchise * franchises;
                  int cost_to_start;
                  int default_cost_per_month;
                  int default_cost_per_new_account;
}

</pre>
<li><a name="class_franchise">
franchise</a><pre>
class franchise {
                  string office;
                  int cost_per_month;
                  int cost_per_new_account;
}

</pre>
</ul>
[an error occurred while processing this directive]