[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 /std/room/punishments/fine.c</h2>
This is the method for fining someone in am.  This handles keeping
track fo the fines and the setup of fines.  This punihshment needs to
be inherited to work correctly.<p>Written by Pinkfish<p>Started Thu Sep 21 14:35:32 PDT 2000
<h2>Inherits</h2>
This class inherits the following classes <a href="std.room.inherit.punishment_inherit.c.shtml">/std/room/inherit/punishment_inherit.c</a><h2>Includes</h2>
This class includes the following files <a href="include.money.h.shtml">/include/money.h</a>, /include/shops/bank.h, <a href="include.player_handler.h.shtml">/include/player_handler.h</a> and <a href="include.nomic_system.h.shtml">/include/nomic_system.h</a><h2>Class Index</h2>
<ul><li><a href="#class_fine_type">fine_type</a>
</ul><h2>Method index</h2>
<dl><ul>
<li><a href="#pay_fine">pay_fine</a>(string, int)<br/>
This method pays a fine.
<li><a href="#query_current_fine">query_current_fine</a>(string)<br/>
This method figures out the current fine for the person.
<li><a href="#query_money_area">query_money_area</a>()<br/>
This method returns the money area of the fine.
<li><a href="#query_people_with_fines">query_people_with_fines</a>()<br/>
This method returns the list of players that have outstanding fines
in the fine handler.
<li><a href="#query_save_file">query_save_file</a>()<br/>
This method returns the save file of the fines.
<li><a href="#query_total_fine">query_total_fine</a>(string)<br/>
This method figures out the current total fine for the person.
<li><a href="#query_total_payments">query_total_payments</a>(string)<br/>
This method figures out the current total fine for the person.
<li><a href="#remove_old_fines">remove_old_fines</a>()<br/>
This method nips through the list of fines and removes any fines that
are either for people that do not exist any more, or totals that are
old.
<li><a href="#set_money_area">set_money_area</a>(string)<br/>
This method sets the money area of the fine.
<li><a href="#set_save_file">set_save_file</a>(string)<br/>
This method sets the save file of the fines.
</ul><h2>Public Functions</h2>
These are functions that everyone can access.<p>
.<ul><a name="pay_fine">
pay_fine</a><pre>
int pay_fine(string person,
             int amount)
</pre></br>
This method pays a fine.
<br/><ul>
<li><b>Parameters:</b>
<br/>person - the person doing the payment
<br/>amount - the amount being paid
<li><b>Returns:</b>
<br/>1 on success, 0 on failure

</dl>

<ul><a name="query_current_fine">
query_current_fine</a><pre>
int query_current_fine(string person)
</pre></br>
This method figures out the current fine for the person.
<br/><ul>
<li><b>Parameters:</b>
<br/>person - the person to get the fine for
<li><b>Returns:</b>
<br/>the currently outstanding fines

</dl>

<ul><a name="query_money_area">
query_money_area</a><pre>
string query_money_area()
</pre></br>
This method returns the money area of the fine.
<br/><ul>
<li><b>Returns:</b>
<br/>the money area

</dl>

<ul><a name="query_people_with_fines">
query_people_with_fines</a><pre>
string * query_people_with_fines()
</pre></br>
This method returns the list of players that have outstanding fines
in the fine handler.
<br/><ul>
<li><b>Returns:</b>
<br/>the list of players

</dl>

<ul><a name="query_save_file">
query_save_file</a><pre>
string query_save_file()
</pre></br>
This method returns the save file of the fines.
<br/><ul>
<li><b>Returns:</b>
<br/>the save file name

</dl>

<ul><a name="query_total_fine">
query_total_fine</a><pre>
int query_total_fine(string person)
</pre></br>
This method figures out the current total fine for the person.
<br/><ul>
<li><b>Parameters:</b>
<br/>person - the person to get the fine for
<li><b>Returns:</b>
<br/>the currently outstanding fines

</dl>

<ul><a name="query_total_payments">
query_total_payments</a><pre>
int query_total_payments(string person)
</pre></br>
This method figures out the current total fine for the person.
<br/><ul>
<li><b>Parameters:</b>
<br/>person - the person to get the fine for
<li><b>Returns:</b>
<br/>the currently outstanding fines

</dl>

<ul><a name="remove_old_fines">
remove_old_fines</a><pre>
void remove_old_fines()
</pre></br>
This method nips through the list of fines and removes any fines that
are either for people that do not exist any more, or totals that are
old.


<ul><a name="set_money_area">
set_money_area</a><pre>
void set_money_area(string area)
</pre></br>
This method sets the money area of the fine.
<br/><ul>
<li><b>Parameters:</b>
<br/>area - the money area

</dl>

<ul><a name="set_save_file">
set_save_file</a><pre>
void set_save_file(string fname)
</pre></br>
This method sets the save file of the fines.
<br/><ul>
<li><b>Parameters:</b>
<br/>fname - the save file name

</dl>


<h2>Classes</h2>
These are nice data types for dealing with...  Data!<p>
<ul>
<li><a name="class_fine_type">
fine_type</a><pre>
class fine_type {
                  int paid;
                  int fines;
                  int last_touched;
}

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