[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/inherit/club_basic.c</h2>
This is the handler for all things clubby, a club being a group of
players.  Each club must have a unique name.  It also handles elections
for various club positions.<p>Written by Pinkfish<p>Started Sun Sep 27 03:35:42 EDT 1998
<h2>Includes</h2>
This class includes the following files /include/player_handler.h, /include/am_time.h, /include/broadcaster.h and /include/clubs.h<h2>Class Index</h2>
<ul><li><a href="#class_club_info">club_info</a>
<br/>
The basic club information class.
</ul><h2>Method index</h2>
<ul>
<li><a href="#add_member">add_member</a>(string, string)<br/>
This method adds a member to the club.
<li><a href="#add_money">add_money</a>(string, int, int, string, string)<br/>
This method will pay a certain amount of money to club.
<li><a href="#add_observer">add_observer</a>(string)<br/>
Adds an objec to the list to be informed of changes about the
clubs.
<li><a href="#add_recruiter">add_recruiter</a>(string, string)<br/>
This method adds a recruiter to the club.
<li><a href="#change_club_cap_name">change_club_cap_name</a>(string)<br/>
this method changes the capitalization of a clubs name.
<li><a href="#change_club_type">change_club_type</a>(string, int)<br/>
This method changes the type of the club.
<li><a href="#check_extra_information">check_extra_information</a>(string, string, int)<li><a href="#create_account">create_account</a>(string, string)<br/>
This method creates an account in the club.
<li><a href="#create_club">create_club</a>(string, string, int, string)<br/>
This method creates a club.
<li><a href="#create_extra_data">create_extra_data</a>(string)<li><a href="#disband_club">disband_club</a>(string)<br/>
This method disbands the club.
<li><a href="#is_account_of">is_account_of</a>(string, string)<br/>
This method checks to see if the account exists for the club.
<li><a href="#is_club">is_club</a>(string)<br/>
This method checks to see if the specified club exists.
<li><a href="#is_creator_club">is_creator_club</a>(string)<br/>
This method determines if the club is a creator club or not.
<li><a href="#is_elected_club">is_elected_club</a>(string)<br/>
This method checks to see if the specified club exists and is an
elected club.
<li><a href="#is_family">is_family</a>(string)<br/>
This method checks to see if the club type is actually a family.
<li><a href="#is_founder_of">is_founder_of</a>(string, string)<br/>
This method will determine if the specified person is the founder of
the club.
<li><a href="#is_member_of">is_member_of</a>(string, string)<br/>
This method will determine if the specified person is a member of the
club.
<li><a href="#is_observer">is_observer</a>(string)<br/>
This method checks to see if the specified thingy is an observer.
<li><a href="#is_personal_club">is_personal_club</a>(string)<br/>
This method checks to see if the specified club exists and is an
personal club.
<li><a href="#is_recruiter_of">is_recruiter_of</a>(string, string)<br/>
This method will determine if the specified person is a recruiter of the
club.
<li><a href="#load_main">load_main</a>()<br/>
This method loads the data from the disk.
<li><a href="#normalise_name">normalise_name</a>(string)<br/>
This method normalises the name for lookups so that we don't
get names too confused.
<li><a href="#query_account_names">query_account_names</a>(string)<br/>
This method returns the names of all the accounts in the club.
<li><a href="#query_balance">query_balance</a>(string, string)<br/>
This method returns the balance of the club.
<li><a href="#query_club_cost_per_period">query_club_cost_per_period</a>(string)<br/>
This method determines how much the club will cost to run each
pay period.
<li><a href="#query_club_description">query_club_description</a>(string, int)<br/>
This method returns the description of the club.
<li><a href="#query_club_info">query_club_info</a>(string)<br/>
This method either loads the data into the cache or it
reads it from the cache.
<li><a href="#query_club_name">query_club_name</a>(string)<br/>
This method returns the capitalised and un messed name of the club.
<li><a href="#query_club_office">query_club_office</a>(string)<br/>
This method returns the name of the office from which mails should
be sent about club fees and the like based on its region of origin.
<li><a href="#query_club_office_signatory">query_club_office_signatory</a>(string)<br/>
This method returns the name of the signatory on the bottom of mails
from the club office.
<li><a href="#query_club_region">query_club_region</a>(string)<br/>
This method returns the region of the club.
<li><a href="#query_club_secret">query_club_secret</a>(string)<br/>
This method checks to see if the club is secret or not.
<li><a href="#query_club_type">query_club_type</a>(string)<br/>
This method returns the club type of the club.
<li><a href="#query_clubs">query_clubs</a>()<br/>
This method returns the names of all the clubs currently in the list
of clubs.
<li><a href="#query_founder">query_founder</a>(string)<br/>
This method returns the founder of the club.
<li><a href="#query_insignia_path">query_insignia_path</a>(string)<br/>
This method returns the insignia object associated with the club.
<li><a href="#query_members">query_members</a>(string)<br/>
This method returns the members of the club.
<li><a href="#query_observers">query_observers</a>()<br/>
This method returns the current list of observers.
<li><a href="#query_recruiters">query_recruiters</a>(string)<br/>
This method returns the recruiters of the club.
<li><a href="#query_time_fees_due">query_time_fees_due</a>(string, int)<br/>
This method returns the time at which the club dues are again due.
<li><a href="#remove_account">remove_account</a>(string, string)<br/>
This method removes an account in the club.
<li><a href="#remove_member">remove_member</a>(string, string)<br/>
This method removes a member from the club.
<li><a href="#remove_money">remove_money</a>(string, int, int, string, string)<br/>
This method removes money from the account.
<li><a href="#remove_observer">remove_observer</a>(string)<br/>
This method removes an observer.
<li><a href="#remove_recruiter">remove_recruiter</a>(string, string)<br/>
This method removes a recruiter from the club.
<li><a href="#reset_club_secret">reset_club_secret</a>(string)<br/>
This method makes a clubs membership open.
<li><a href="#save_cache">save_cache</a>()<br/>
This method checks the cache and then saves anything changed to the
disk.
<li><a href="#save_club">save_club</a>(string)<br/>
This method saves the data to the disk.
<li><a href="#save_main">save_main</a>()<br/>
This method loads the data from the disk.
<li><a href="#send_broadcast_message">send_broadcast_message</a>(string, string)<br/>
This method sends a broadcast to the clubs talker channel.
<li><a href="#send_observer_event">send_observer_event</a>(string, string * args)<br/>
This method calls a function on all the observers to tell them
when an event has taken place.
<li><a href="#set_club_changed">set_club_changed</a>(string)<br/>
This method marks the club as being changed.
<li><a href="#set_club_description">set_club_description</a>(string, string, int)<br/>
This method sets the description of the club.
<li><a href="#set_club_secret">set_club_secret</a>(string)<br/>
This method makes a clubs membership secret.
<li><a href="#set_creator_club">set_creator_club</a>(string, int)<br/>
This function should only be called for changing the creator_club status
of a club due to people going creator or being dismissed.
<li><a href="#set_founder">set_founder</a>(string, string)<br/>
Creator called function only.
<li><a href="#touch_club">touch_club</a>(string)<br/>
This method touches the club and resets the timeout date.
<li><a href="#try_load_club">try_load_club</a>(string)<br/>
Purely for debugging: Try to force-load a club that isn't loading.
</ul>
<h2>Public Functions</h2>
These are functions that everyone can access.<p>
<dl>
<dt class="autodocfuncname"><a name="add_member">
add_member</a><pre class="autodocfuncdef">
int add_member(string name,
               string member)
</pre><dd><br />
This method adds a member to the club.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name of the club to add the recruiter to<br />
member - the member of the club to add<br />
<br />
<dd><b>Returns:</b>
<br />1 on success, 0 on failure<br /><br />
<dd><b>See also:</b>
<br /><a href="#add_recruiter">add_recruiter()</a>, <a href="#query_recruiters">query_recruiters()</a>, <a href="#query_members">query_members()</a> and <a href="#remove_member">remove_member()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="add_money">
add_money</a><pre class="autodocfuncdef">
int add_money(string name,
              int amount,
              int type,
              string person,
              string account)
</pre><dd><br />
This method will pay a certain amount of money to club.  This will be
how long the club is payed until.  The club will cost a certain
amount for each member as well as a base cost.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name of the club<br />
amount - the amount to change the balance by<br />
type - the tyope of the transaction<br />
person - the person removeing the money<br />
account - the account the money is coming from<br />
<br />
<dd><b>Returns:</b>
<br />the amount of money not able to be placed in the account<br /><br />
<dd><b>See also:</b>
<br /><a href="#remove_money">remove_money()</a>, <a href="#query_balance">query_balance()</a> and <a href="#query_transactions">query_transactions()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="add_observer">
add_observer</a><pre class="autodocfuncdef">
int add_observer(string obs)
</pre><dd><br />
Adds an objec to the list to be informed of changes about the
clubs.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
obs - the name of the object to inform of changes<br />
<br />
<dd><b>Returns:</b>
<br />1 on success, 0 on failure
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="add_recruiter">
add_recruiter</a><pre class="autodocfuncdef">
int add_recruiter(string name,
                  string recruiter)
</pre><dd><br />
This method adds a recruiter to the club.  A recruiter can only be added if
they are already a member.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the club name to add the recruiter to<br />
recruiter - the recruiter of the club to add<br />
<br />
<dd><b>Returns:</b>
<br />1 on success, 0 on failure<br /><br />
<dd><b>See also:</b>
<br /><a href="#remove_recruiter">remove_recruiter()</a>, <a href="#query_recruiters">query_recruiters()</a> and <a href="#add_member">add_member()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="change_club_cap_name">
change_club_cap_name</a><pre class="autodocfuncdef">
int change_club_cap_name(string club_name)
</pre><dd><br />
this method changes the capitalization of a clubs name.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
the - new capitalization for the name<br />
<br />
<dd><b>Returns:</b>
<br />1 on success, 0 on failure

<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="change_club_type">
change_club_type</a><pre class="autodocfuncdef">
int change_club_type(string name,
                     int type)
</pre><dd><br />
This method changes the type of the club.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name of the club to change<br />
type - the new type of the club<br />
<br />
<dd><b>Returns:</b>
<br />1 on success, 0 on failure<br /><br />
<dd><b>See also:</b>
<br /><a href="#create_club">create_club()</a>, <a href="#disband_club">disband_club()</a> and <a href="#query_club_type">query_club_type()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="check_extra_information">
check_extra_information</a><pre class="autodocfuncdef">
void check_extra_information(string club_name,
                             string member,
                             int login)
</pre>
<dt class="autodocfuncname"><a name="create_account">
create_account</a><pre class="autodocfuncdef">
int create_account(string name,
                   string account)
</pre><dd><br />
This method creates an account in the club.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name of the club<br />
account - the name of the account
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="create_club">
create_club</a><pre class="autodocfuncdef">
int create_club(string name,
                string founder,
                int type,
                string region)
</pre><dd><br />
This method creates a club.  The founder and the recruiter set is
initialy set to the founder.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name of the club<br />
founder - the founder of the club<br />
region - the region of the club<br />
<br />
<dd><b>Returns:</b>
<br />1 was able to create the club, 0 if unable to create the club<br /><br />
<dd><b>See also:</b>
<br /><a href="#disband_club">disband_club()</a> and <a href="#change_club_type">change_club_type()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="disband_club">
disband_club</a><pre class="autodocfuncdef">
int disband_club(string name)
</pre><dd><br />
This method disbands the club.  The club will be totaly zapped and
everything about it efficently munched.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name of the club to disband<br />
<br />
<dd><b>Returns:</b>
<br />1 on success, 0 on failure<br /><br />
<dd><b>See also:</b>
<br /><a href="#create_club">create_club()</a> and <a href="#check_extra_infromation">check_extra_infromation()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="is_account_of">
is_account_of</a><pre class="autodocfuncdef">
int is_account_of(string club_name,
                  string account)
</pre><dd><br />
This method checks to see if the account exists for the club.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
club_name - the name of the name<br />
account - the name of the account to checlk<br />
<br />
<dd><b>Returns:</b>
<br />1 if it exists, 0 if it does not
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="is_club">
is_club</a><pre class="autodocfuncdef">
int is_club(string name)
</pre><dd><br />
This method checks to see if the specified club exists.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name of the club to check for existance<br />
<br />
<dd><b>Returns:</b>
<br />1 if it is a club, 0 if not<br /><br />
<dd><b>See also:</b>
<br /><a href="#query_club_name">query_club_name()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="is_creator_club">
is_creator_club</a><pre class="autodocfuncdef">
int is_creator_club(string club_name)
</pre><dd><br />
This method determines if the club is a creator club or not.  A
club is considered a creator club if the founder was a creator when they 
founded it.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
<br />
<dd><b>Returns:</b>
<br />1 if is a creator club, 0 if not
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="is_elected_club">
is_elected_club</a><pre class="autodocfuncdef">
int is_elected_club(string name)
</pre><dd><br />
This method checks to see if the specified club exists and is an
elected club.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name of the club to check to see for an elected type<br />
<br />
<dd><b>Returns:</b>
<br />1 if the club is an elected type
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="is_family">
is_family</a><pre class="autodocfuncdef">
int is_family(string name)
</pre><dd><br />
This method checks to see if the club type is actually a family.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name of the family to check<br />
<br />
<dd><b>Returns:</b>
<br />1 if the club is a family
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="is_founder_of">
is_founder_of</a><pre class="autodocfuncdef">
int is_founder_of(string name,
                  string founder)
</pre><dd><br />
This method will determine if the specified person is the founder of
the club.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name of the club to check the founder of<br />
founder - the person to check for being the founder<br />
<br />
<dd><b>Returns:</b>
<br />1 if they are in the position, 0 if not<br /><br />
<dd><b>See also:</b>
<br /><a href="#create_club">create_club()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="is_member_of">
is_member_of</a><pre class="autodocfuncdef">
int is_member_of(string name,
                 string member)
</pre><dd><br />
This method will determine if the specified person is a member of the
club.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name of the club to find the member of<br />
member - the member to check for the existance of<br />
<br />
<dd><b>Returns:</b>
<br />1 if they are a member, 0 if they are not
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="is_observer">
is_observer</a><pre class="autodocfuncdef">
int is_observer(string obs)
</pre><dd><br />
This method checks to see if the specified thingy is an observer.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
obs - the observer to check<br />
<br />
<dd><b>Returns:</b>
<br />1 on success, 0 on failure
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="is_personal_club">
is_personal_club</a><pre class="autodocfuncdef">
int is_personal_club(string name)
</pre><dd><br />
This method checks to see if the specified club exists and is an
personal club.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name of the club to check to see for an personal type<br />
<br />
<dd><b>Returns:</b>
<br />1 if the club is an personal type
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="is_recruiter_of">
is_recruiter_of</a><pre class="autodocfuncdef">
int is_recruiter_of(string name,
                    string recruiter)
</pre><dd><br />
This method will determine if the specified person is a recruiter of the
club.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name of the club to find the recruiter of<br />
recruiter - the person is check for the recruiter<br />
<br />
<dd><b>Returns:</b>
<br />1 if they are a recruiter, 0 if they are not<br /><br />
<dd><b>See also:</b>
<br /><a href="#add_recruiter">add_recruiter()</a> and <a href="#remove_recruiter">remove_recruiter()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="normalise_name">
normalise_name</a><pre class="autodocfuncdef">
string normalise_name(string name)
</pre><dd><br />
This method normalises the name for lookups so that we don't
get names too confused.  Thanks to Terano for this idea.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name to normalise<br />
<br />
<dd><b>Returns:</b>
<br />the normalised name
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_account_names">
query_account_names</a><pre class="autodocfuncdef">
string * query_account_names(string name)
</pre><dd><br />
This method returns the names of all the accounts in the club.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
club_name - the name of the club<br />
<br />
<dd><b>Returns:</b>
<br />the names of all the accounts
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_balance">
query_balance</a><pre class="autodocfuncdef">
int query_balance(string name,
                  string account)
</pre><dd><br />
This method returns the balance of the club.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name of the club<br />
account - the name of the account<br />
<br />
<dd><b>Returns:</b>
<br />the current balance of the club<br /><br />
<dd><b>See also:</b>
<br /><a href="#pay_money">pay_money()</a> and <a href="#remove_money">remove_money()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="query_club_cost_per_period">
query_club_cost_per_period</a><pre class="autodocfuncdef">
int query_club_cost_per_period(string club_name)
</pre><dd><br />
This method determines how much the club will cost to run each
pay period.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
club_name - the name of the club to get the fees for<br />
<br />
<dd><b>Returns:</b>
<br />the amount the club will cost in the next pay period<br /><br />
<dd><b>See also:</b>
<br /><a href="#query_time_fees_due">query_time_fees_due()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="query_club_description">
query_club_description</a><pre class="autodocfuncdef">
string query_club_description(string club_name,
                              int public_info)
</pre><dd><br />
This method returns the description of the club.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
club_name - the name of the club to get the description of<br />
public_info - 1 if we want the public info of secret clubs<br />
<br />
<dd><b>Returns:</b>
<br />the club description, 0 if the club is not found<br /><br />
<dd><b>See also:</b>
<br /><a href="#query_club_name">query_club_name()</a>, <a href="#create_club">create_club()</a> and <a href="#set_club_description">set_club_description()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="query_club_name">
query_club_name</a><pre class="autodocfuncdef">
string query_club_name(string club_name)
</pre><dd><br />
This method returns the capitalised and un messed name of the club.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
club_name - the name of the club<br />
<br />
<dd><b>Returns:</b>
<br />the un messed name of the club<br /><br />
<dd><b>See also:</b>
<br /><a href="#is_club">is_club()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="query_club_office">
query_club_office</a><pre class="autodocfuncdef">
string query_club_office(string club_name)
</pre><dd><br />
This method returns the name of the office from which mails should
be sent about club fees and the like based on its region of origin.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
club - the name of the club
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_club_office_signatory">
query_club_office_signatory</a><pre class="autodocfuncdef">
string query_club_office_signatory(string club_name)
</pre><dd><br />
This method returns the name of the signatory on the bottom of mails
from the club office.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
club - the name of the club
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_club_region">
query_club_region</a><pre class="autodocfuncdef">
string query_club_region(string name)
</pre><dd><br />
This method returns the region of the club.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name of the club to check<br />
<br />
<dd><b>Returns:</b>
<br />the club name
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_club_secret">
query_club_secret</a><pre class="autodocfuncdef">
int query_club_secret(string name)
</pre><dd><br />
This method checks to see if the club is secret or not.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name of the club to check for secrecy<br />
<br />
<dd><b>Returns:</b>
<br />1 if the club is secret, 0 if not<br /><br />
<dd><b>See also:</b>
<br /><a href="#set_club_secret">set_club_secret()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="query_club_type">
query_club_type</a><pre class="autodocfuncdef">
int query_club_type(string name)
</pre><dd><br />
This method returns the club type of the club.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name of the club to get the type of<br />
<br />
<dd><b>Returns:</b>
<br />the type of the club<br /><br />
<dd><b>See also:</b>
<br /><a href="#change_club_type">change_club_type()</a> and <a href="#create_club">create_club()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="query_clubs">
query_clubs</a><pre class="autodocfuncdef">
string * query_clubs()
</pre><dd><br />
This method returns the names of all the clubs currently in the list
of clubs.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />the list of current clubs<br /><br />
<dd><b>See also:</b>
<br /><a href="#create_club">create_club()</a> and <a href="#disband_club">disband_club()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="query_founder">
query_founder</a><pre class="autodocfuncdef">
string query_founder(string name)
</pre><dd><br />
This method returns the founder of the club.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the club name to get the founder of<br />
<br />
<dd><b>Returns:</b>
<br />the founder of the club<br /><br />
<dd><b>See also:</b>
<br /><a href="#create_club">create_club()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="query_insignia_path">
query_insignia_path</a><pre class="autodocfuncdef">
string query_insignia_path(string name)
</pre><dd><br />
This method returns the insignia object associated with the club.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name of the club for the insignia object<br />
<br />
<dd><b>Returns:</b>
<br />the path of the club insignia object<br /><br />
<dd><b>See also:</b>
<br /><a href="#create_club">create_club()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="query_members">
query_members</a><pre class="autodocfuncdef">
string * query_members(string name)
</pre><dd><br />
This method returns the members of the club.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the members of the club<br />
<br />
<dd><b>Returns:</b>
<br />the members of the club<br /><br />
<dd><b>See also:</b>
<br /><a href="#add_member">add_member()</a> and <a href="#remove_member">remove_member()
</a><br /><br /><br /></dl>

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

<dt class="autodocfuncname"><a name="query_recruiters">
query_recruiters</a><pre class="autodocfuncdef">
string * query_recruiters(string name)
</pre><dd><br />
This method returns the recruiters of the club.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the club name to get the recruiters of<br />
<br />
<dd><b>Returns:</b>
<br />the recruiters of the club<br /><br />
<dd><b>See also:</b>
<br /><a href="#add_recruiter">add_recruiter()</a> and <a href="#remove_recruiter">remove_recruiter()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="query_time_fees_due">
query_time_fees_due</a><pre class="autodocfuncdef">
int query_time_fees_due(string club_name,
                        int period)
</pre><dd><br />
This method returns the time at which the club dues are again due.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
club_name - the name of the club to get the date for<br />
period - the number of periods ahead to look, 0 means the current one<br />
<br />
<dd><b>See also:</b>
<br /><a href="#check_clubs">check_clubs()</a> and <a href="#query_club_cost_per_period">query_club_cost_per_period()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="remove_account">
remove_account</a><pre class="autodocfuncdef">
int remove_account(string name,
                   string account)
</pre><dd><br />
This method removes an account in the club.  It moves all the money from
the special account into the default one.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name of the club<br />
account - the name of the account
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="remove_member">
remove_member</a><pre class="autodocfuncdef">
int remove_member(string name,
                  string member)
</pre><dd><br />
This method removes a member from the club.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name of the club to remove a member from<br />
member - the members name to remove<br />
<br />
<dd><b>Returns:</b>
<br />1 on success, 0 on failure<br /><br />
<dd><b>See also:</b>
<br /><a href="#query_members">query_members()</a>, <a href="#add_member">add_member()</a> and <a href="#remove_member">remove_member()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="remove_money">
remove_money</a><pre class="autodocfuncdef">
int remove_money(string name,
                 int amount,
                 int type,
                 string person,
                 string account)
</pre><dd><br />
This method removes money from the account.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name of the club<br />
amount - the amount to change the balance by<br />
type - the tyope of the transaction<br />
person - the person removeing the money<br />
account - the account the money is coming from<br />
<br />
<dd><b>Returns:</b>
<br />1 if the removal is a success<br /><br />
<dd><b>See also:</b>
<br /><a href="#pay_money">pay_money()</a>, <a href="#query_balance">query_balance()</a> and <a href="#query_transactions">query_transactions()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="remove_observer">
remove_observer</a><pre class="autodocfuncdef">
int remove_observer(string obs)
</pre><dd><br />
This method removes an observer.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
obs - the obeserver to remove<br />
<br />
<dd><b>Returns:</b>
<br />1 on success, 0 on failure
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="remove_recruiter">
remove_recruiter</a><pre class="autodocfuncdef">
int remove_recruiter(string name,
                     string recruiter)
</pre><dd><br />
This method removes a recruiter from the club.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name of the club to remove the member from<br />
recruiter - the recruiter to remove<br />
<br />
<dd><b>Returns:</b>
<br />1 on success, 0 on failure<br /><br />
<dd><b>See also:</b>
<br /><a href="#add_recruiter">add_recruiter()</a>, <a href="#query_recruiters">query_recruiters()</a> and <a href="#add_member">add_member()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="reset_club_secret">
reset_club_secret</a><pre class="autodocfuncdef">
int reset_club_secret(string name)
</pre><dd><br />
This method makes a clubs membership open.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name of the club to make open<br />
<br />
<dd><b>Returns:</b>
<br />1 on success, 0 on failure<br /><br />
<dd><b>See also:</b>
<br /><a href="#query_club_secret">query_club_secret()</a> and <a href="#set_club_secret">set_club_secret()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="set_club_description">
set_club_description</a><pre class="autodocfuncdef">
int set_club_description(string club_name,
                         string description,
                         int public_info)
</pre><dd><br />
This method sets the description of the club.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
club_name - the name of the club to set the description of<br />
description - the new description of the club<br />
public_info - 1 if the public info of secret clubs should be set<br />
<br />
<dd><b>Returns:</b>
<br />1 on success, 0 on failure<br /><br />
<dd><b>See also:</b>
<br /><a href="#query_club_description">query_club_description()</a> and <a href="#create_club">create_club()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="set_club_secret">
set_club_secret</a><pre class="autodocfuncdef">
int set_club_secret(string name)
</pre><dd><br />
This method makes a clubs membership secret.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name of the club to make secret<br />
<br />
<dd><b>Returns:</b>
<br />1 on success, 0 on failure<br /><br />
<dd><b>See also:</b>
<br /><a href="#query_club_secret">query_club_secret()</a> and <a href="#reset_club_secret">reset_club_secret()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="set_creator_club">
set_creator_club</a><pre class="autodocfuncdef">
int set_creator_club(string club,
                     int flag)
</pre><dd><br />
This function should only be called for changing the creator_club status
of a club due to people going creator or being dismissed.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
club - Name of the club<br />
flag - 1 for creator clubs, 0 for normal clubs<br />
<br />
<dd><b>Returns:</b>
<br />1 if it was updated, 0 if the club does not exist
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_founder">
set_founder</a><pre class="autodocfuncdef">
int set_founder(string club,
                string new_founder)
</pre><dd><br />
Creator called function only.  Changes the founder of a club/family,
although there is no real reason to do so (possible exception is if
a non-elected club doesn't get deleted when the founder is deleted
and someone takes over the old name... but you should probably just
delete the club).  If you are worried about the status of a player
club after the founder goes cre, it's all taken care of.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
club - Name of the club/family<br />
new_founder - New founder of the club/family. 
Please make it be a member of the club/family.<br />
<br />
<dd><b>Returns:</b>
<br />1 if it was updated, 0 if the club does not exist.
<br /><br />
<dd><b>See also:</b>
<br />is_creator_club.c and set_creator_club.c<br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="touch_club">
touch_club</a><pre class="autodocfuncdef">
void touch_club(string name)
</pre><dd><br />
This method touches the club and resets the timeout date.  This should
be done now and then by the club to make sure it does not timeout.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
name - the name of the club to reset the timeout for<br />
<br />
<dd><b>See also:</b>
<br /><a href="#check_clubs">check_clubs()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="try_load_club">
try_load_club</a><pre class="autodocfuncdef">
int try_load_club(string name)
</pre><dd><br />
Purely for debugging: Try to force-load a club that isn't loading.<br />
<br /><dl>
<dd><b>Returns:</b>
<br />2 if the club was already in the controller,
1 it was force loaded,
0 if it couldn't be loaded
<br /><br />
<br /></dl>

</dl>
<h2>Protected Functions</h2>
These are functions that only objects inheriting the class can access.<p>
<dl>
<dt class="autodocfuncname"><a name="create_extra_data">
create_extra_data</a><pre class="autodocfuncdef">
void create_extra_data(string name)
</pre>
<dt class="autodocfuncname"><a name="load_main">
load_main</a><pre class="autodocfuncdef">
void load_main()
</pre><dd><br />
This method loads the data from the disk.
<br />

<dt class="autodocfuncname"><a name="query_club_info">
query_club_info</a><pre class="autodocfuncdef">
class club_info query_club_info(string name)
</pre><dd><br />
This method either loads the data into the cache or it
reads it from the cache.
<br />

<dt class="autodocfuncname"><a name="save_cache">
save_cache</a><pre class="autodocfuncdef">
void save_cache()
</pre><dd><br />
This method checks the cache and then saves anything changed to the
disk...
<br />

<dt class="autodocfuncname"><a name="save_club">
save_club</a><pre class="autodocfuncdef">
void save_club(string name)
</pre><dd><br />
This method saves the data to the disk.
<br />

<dt class="autodocfuncname"><a name="save_main">
save_main</a><pre class="autodocfuncdef">
void save_main()
</pre><dd><br />
This method loads the data from the disk.
<br />

<dt class="autodocfuncname"><a name="send_broadcast_message">
send_broadcast_message</a><pre class="autodocfuncdef">
void send_broadcast_message(string club,
                            string message)
</pre><dd><br />
This method sends a broadcast to the clubs talker channel.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
club - the name of the club to send the message to<br />
mess - the message to send
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="send_observer_event">
send_observer_event</a><pre class="autodocfuncdef">
void send_observer_event(string event_name,
                         string * args ...)
</pre><dd><br />
This method calls a function on all the observers to tell them
when an event has taken place.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
event_name - the name of the event<br />
args - the arguments to the event
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="set_club_changed">
set_club_changed</a><pre class="autodocfuncdef">
void set_club_changed(string name)
</pre><dd><br />
This method marks the club as being changed.
<br />

</dl>
<h2>Classes</h2>
These are nice data types for dealing with...  Data!<p>
<ul>
<li><a name="class_club_info">
club_info</a><pre>
class club_info {
                  string actual_name;
                  string founder;
                  string * recruiters;
                  string * members;
                  int type;
                  mapping accounts;
                  int last_paid;
                  int last_touched;
                  mixed extra_data;
                  string description;
                  string region;
                  int is_creator_club;
}

</pre><br/>
The basic club information class.<p>
<dl>
<dt><b>Members:</b>
<br />actual_name - the actual name of the club<br />
<br />founder - the founder of the club<br />
<br />recruiters - the people who can recruit for the club<br />
<br />members - the members of the club<br />
<br />type - the type of the club<br />
<br />accounts - the accounts in the club<br />
<br />last_paid - when the balance was last paid<br />
<br />last_touched - when the club was last touched<br />
<br />extra_data - specific data for each type of club<br />
<br />region - the region the club is in
<br />
</dl>

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