[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/basic/club_listing.c</h2>
This is an inheritable for printing out different sorts of club
listings.<p><b>See also:</b><br><a href="obj.handlers.club_handler.c.shtml">/obj/handlers/club_handler.c</a> and /std/room/club_control_room.c
<p>Written by Pinkfish<p>Started Sat Oct 24 02:28:04 EDT 1998<h2>Includes</h2>
This class includes the following files <a href="include.clubs.h.shtml">/include/clubs.h</a>, <a href="include.broadcaster.h.shtml">/include/broadcaster.h</a>, <a href="include.am_time.h.shtml">/include/am_time.h</a> and <a href="include.player_handler.h.shtml">/include/player_handler.h</a><h2>Method index</h2>
<dl><ul>
<li><a href="#club_info">club_info</a>(string, int, string)<br/>
This method prints out the information associated with the club.
<li><a href="#club_info_string">club_info_string</a>(string, int, string)<br/>
This method returns the club information as a string.
<li><a href="#club_list">club_list</a>(string, int, function)<br/>
This method prints out a list of the current clubs.
<li><a href="#club_members">club_members</a>(string, int, string)<br/>
This method prints out all the members of the club, or all the members
of the club online.
<li><a href="#family_info">family_info</a>(string, string)<br/>
This method prints out the information associated with the family.
<li><a href="#family_info_string">family_info_string</a>(string, string)<br/>
This method returns the family information as a string.
<li><a href="#htmlify">htmlify</a>(string)<li><a href="#person_in_control">person_in_control</a>(object)<br/>
This method returns the player in control of the item.
<li><a href="#player_relationships_string">player_relationships_string</a>(string)<br/>
This method returns the relations that the specified player
has as a string.
<li><a href="#sort_and_capitalise">sort_and_capitalise</a>(string *)<br/>
This method will sort and capitalise the array of strings sent into
the method.
<li><a href="#www_club_info_string">www_club_info_string</a>(string, int, string)<br/>
This method returns the club information as a html string.
<li><a href="#www_club_list">www_club_list</a>(string, int, int, int)<br/>
This method prints out a list of the current clubs into html.
<li><a href="#www_family_info_string">www_family_info_string</a>(string, string)<br/>
This method returns the family information as a string.
<li><a href="#www_finger_name">www_finger_name</a>(string)<br/>
This method turns a name into a fingerable name.
</ul><h2>Public Functions</h2>
These are functions that everyone can access.<p>
.<ul><a name="htmlify">
htmlify</a><pre>
string htmlify(string str)
</pre>
<ul><a name="player_relationships_string">
player_relationships_string</a><pre>
string player_relationships_string(string player)
</pre></br>
This method returns the relations that the specified player
has as a string.  It will return a blank string if the player
has no relationships.
<br/><ul>
<li><b>Parameters:</b>
<br/>player - the player to check relationships for

</dl>


<h2>Protected Functions</h2>
These are functions that only objects inheriting the class can access.<p>
<ul><a name="club_info">
club_info</a><pre>
int club_info(string name,
              int show_election,
              string person)
</pre></br>
This method prints out the information associated with the club.
The stuff printed out here is directly lifted from the club control room.
This method is designed to work with add_command().
<br/><ul>
<li><b>Parameters:</b>
<br/>name - the name of the club to show the information about
<br/>show_election - if non-zero show the election information
<br/>person - the person who is showing the information
<li><b>Returns:</b>
<br/>1 on success, 0 on failure

</dl>

<ul><a name="club_info_string">
club_info_string</a><pre>
string club_info_string(string name,
                        int show_election,
                        string person)
</pre></br>
This method returns the club information as a string.
<br/><ul>
<li><b>Parameters:</b>
<br/>name - the name of the club to show the information about
<br/>show_election - if non-zero show the election information
<br/>person - the person who is showing the information
<li><b>Returns:</b>
<br/>the club information string, 0 if no information
<li><b>See also:</b>
<br/><a href="#club_info">club_info()
</a></dl>

<ul><a name="club_list">
club_list</a><pre>
int club_list(string person,
              int print_families,
              function check_list)
</pre></br>
This method prints out a list of the current clubs.
<br/><ul>
<li><b>Parameters:</b>
<br/>person - the person who is doing the listing
<br/>print_families - 1 print the families, 0 print the clubs
<br/>check_list - this function is called to see if the club should be listed
<li><b>Returns:</b>
<br/>0 on failure and 1 for success
<li><b>See also:</b>
<br/><a href="#club_info">club_info()</a>, <a href="#club_members">club_members()</a>, <a href="#www_club_list">www_club_list()</a> and <a href="#www_club_info">www_club_info()
</a></dl>

<ul><a name="club_members">
club_members</a><pre>
int club_members(string club,
                 int online,
                 string person)
</pre></br>
This method prints out all the members of the club, or all the members
of the club online.  This method is designed to work with
add_command().
<br/><ul>
<li><b>Parameters:</b>
<br/>club_name - the name of the club to print the members of
<br/>online - print only the online members, 0 not online, 1 online, 2 online
 and listening to the club channel
<li><b>Returns:</b>
<br/>1 if successful, 0 if not

</dl>

<ul><a name="family_info">
family_info</a><pre>
int family_info(string name,
                string person)
</pre></br>
This method prints out the information associated with the family.
The stuff printed out here is directly lifted from the family control room.
This method is designed to work with add_command().
<br/><ul>
<li><b>Parameters:</b>
<br/>name - the name of the family to show the information about
<br/>show_election - if non-zero show the election information
<br/>person - the person who is showing the information
<li><b>Returns:</b>
<br/>1 on success, 0 on failure

</dl>

<ul><a name="family_info_string">
family_info_string</a><pre>
string family_info_string(string name,
                          string person)
</pre></br>
This method returns the family information as a string.
<br/><ul>
<li><b>Parameters:</b>
<br/>name - the name of the family to show the information about
<br/>show_election - if non-zero show the election information
<br/>person - the person who is showing the information
<li><b>Returns:</b>
<br/>the family information string, 0 if no information
<li><b>See also:</b>
<br/><a href="#family_info">family_info()
</a></dl>

<ul><a name="person_in_control">
person_in_control</a><pre>
object person_in_control(object ob)
</pre></br>
This method returns the player in control of the item.
<br/><ul>
<li><b>Parameters:</b>
<br/>ob - the item
<li><b>Returns:</b>
<br/>the player in control
<li><b>See also:</b>
<br/><a href="#club_members">club_members()
</a></dl>

<ul><a name="sort_and_capitalise">
sort_and_capitalise</a><pre>
string sort_and_capitalise(string * arr)
</pre></br>
This method will sort and capitalise the array of strings sent into
the method.
<br/><ul>
<li><b>Parameters:</b>
<br/>arr - the array to sort and capitalise
<li><b>Returns:</b>
<br/>the sorted and capitalised string
<li><b>See also:</b>
<br/><a href="#club_members">club_members()
</a></dl>

<ul><a name="www_club_info_string">
www_club_info_string</a><pre>
string www_club_info_string(string name,
                            int show_election,
                            string person)
</pre></br>
This method returns the club information as a html string.
<br/><ul>
<li><b>Parameters:</b>
<br/>name - the name of the club to show the information about
<br/>show_election - if non-zero show the election information
<br/>person - the person who is showing the information
<li><b>Returns:</b>
<br/>the club information string, 0 if no information
<li><b>See also:</b>
<br/><a href="#club_info">club_info()
</a></dl>

<ul><a name="www_club_list">
www_club_list</a><pre>
string www_club_list(string person,
                     int print_families,
                     int start,
                     int show)
</pre></br>
This method prints out a list of the current clubs into html.
<br/><ul>
<li><b>Parameters:</b>
<br/>person - the person who is doing the listing
<br/>print_families - 1 print the families, 0 print the clubs
<br/>start - the index to start from
<br/>show - how many to show
<li><b>Returns:</b>
<br/>the club listing string
<li><b>See also:</b>
<br/><a href="#club_info">club_info()</a>, <a href="#club_members">club_members()</a>, <a href="#www_club_list">www_club_list()</a> and <a href="#www_club_info">www_club_info()
</a></dl>

<ul><a name="www_family_info_string">
www_family_info_string</a><pre>
string www_family_info_string(string name,
                              string person)
</pre></br>
This method returns the family information as a string.
<br/><ul>
<li><b>Parameters:</b>
<br/>name - the name of the family to show the information about
<br/>show_election - if non-zero show the election information
<br/>person - the person who is showing the information
<li><b>Returns:</b>
<br/>the family information string, 0 if no information
<li><b>See also:</b>
<br/><a href="#family_info">family_info()
</a></dl>

<ul><a name="www_finger_name">
www_finger_name</a><pre>
string www_finger_name(string name)
</pre></br>
This method turns a name into a fingerable name.
<br/><ul>
<li><b>Parameters:</b>
<br/>name - the name to make fingerable
<li><b>Returns:</b>
<br/>the htmlised name string

</dl>


[an error occurred while processing this directive]