[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_insignia.c</h2>
The club insignia inheritable thingy.<p>Written by Pinkfish<p>Started Sun Oct  4 04:23:52 EDT 1998
<h2>Inherits</h2>
This class inherits the following classes <a href="std.basic.club_listing.c.shtml">/std/basic/club_listing.c</a> and <a href="std.basic.club_discuss.c.shtml">/std/basic/club_discuss.c</a><h2>Includes</h2>
This class includes the following files <a href="include.am_time.h.shtml">/include/am_time.h</a>, <a href="include.broadcaster.h.shtml">/include/broadcaster.h</a> and <a href="include.clubs.h.shtml">/include/clubs.h</a><h2>Method index</h2>
<dl><ul>
<li><a href="#add_club_commands">add_club_commands</a>(object)<br/>
This method will add the club commands from the player.
<li><a href="#add_elected_commands">add_elected_commands</a>(object)<br/>
This method will add the club commands from the player.
<li><a href="#club_chat">club_chat</a>(string, int)<br/>
The says something wonderful and exciting to all the other club members.
<li><a href="#confirm_disbar">confirm_disbar</a>(string, string)<br/>
THis method confirms the disbar request from the player.
<li><a href="#confirm_resign">confirm_resign</a>(string, string)<br/>
This method checks to make sure they really wish to resign.
<li><a href="#do_announcement">do_announcement</a>()<br/>
This method will print out any announcements associated with the club.
<li><a href="#do_brief_mode">do_brief_mode</a>(int)<br/>
This method sets the brief mode of the badge.
<li><a href="#do_brief_string">do_brief_string</a>(string)<br/>
This method sets the brief message to use for the channel messages.
<li><a href="#do_channel_off">do_channel_off</a>(int)<br/>
This method handles setting the flag and printing all the happy success
messages.
<li><a href="#do_disbar">do_disbar</a>(string)<br/>
This method allows the founders and presidents/vice presidents to disbar
people from the club.
<li><a href="#do_history">do_history</a>()<br/>
This method prints out the history of the channel.
<li><a href="#do_recruit">do_recruit</a>(object *, string)<br/>
This is the method to use when recruiting people.
<li><a href="#do_resign">do_resign</a>()<br/>
This method starts the resignation process.
<li><a href="#do_resign_position">do_resign_position</a>(string)<br/>
This method resigns as a position in the club.
<li><a href="#event_channel_message">event_channel_message</a>(object, string, mixed *)<br/>
The method is called when the channel is triggered.
<li><a href="#event_club_changed">event_club_changed</a>(object, string)<br/>
This method is called when the club type is changed.
<li><a href="#event_joined_club">event_joined_club</a>(object, string)<br/>
This is the event generated when the person joins the club.
<li><a href="#query_brief_mode">query_brief_mode</a>()<br/>
This method tells us if the badge is in brief mode or not.
<li><a href="#query_brief_string">query_brief_string</a>()<br/>
This method returns the short name for the channel string.
<li><a href="#query_channel_off">query_channel_off</a>()<br/>
This method returns the status of the channel off flag.
<li><a href="#query_club">query_club</a>()<br/>
This method returns the club associated with the badge.
<li><a href="#set_club">set_club</a>(string)<br/>
This method sets the club associated with the badge.
</ul><h2>Public Functions</h2>
These are functions that everyone can access.<p>
.<ul><a name="event_channel_message">
event_channel_message</a><pre>
void event_channel_message(object ob,
                           string channel,
                           mixed * data)
</pre></br>
The method is called when the channel is triggered.
<br/><ul>
<li><b>Parameters:</b>
<br/>ob - the person who talked
<br/>channel - the name of the channel
<br/>message - the pmessage top print
<li><b>See also:</b>
<br/><a href="#club_chat">club_chat()</a> and <a href="#do_history">do_history()
</a></dl>

<ul><a name="event_club_changed">
event_club_changed</a><pre>
void event_club_changed(object person,
                        string club_name)
</pre></br>
This method is called when the club type is changed.  It will add on
the elected club commands, if that is what we have changed too.


<ul><a name="event_joined_club">
event_joined_club</a><pre>
void event_joined_club(object person,
                       string club_name)
</pre></br>
This is the event generated when the person joins the club.
<br/><ul>
<li><b>Parameters:</b>
<br/>person - the person doing the joining
<br/>club_name - the name of the club being joined

</dl>

<ul><a name="query_brief_mode">
query_brief_mode</a><pre>
int query_brief_mode()
</pre></br>
This method tells us if the badge is in brief mode or not.
<br/><ul>
<li><b>Returns:</b>
<br/>the current brief mode

</dl>

<ul><a name="query_brief_string">
query_brief_string</a><pre>
string query_brief_string()
</pre></br>
This method returns the short name for the channel string.
<br/><ul>
<li><b>Returns:</b>
<br/>the short name for the channel

</dl>

<ul><a name="query_channel_off">
query_channel_off</a><pre>
int query_channel_off()
</pre></br>
This method returns the status of the channel off flag.
<br/><ul>
<li><b>Returns:</b>
<br/>the current value of the channel off flag
<li><b>See also:</b>
<br/><a href="#club_chat">club_chat()</a> and <a href="#event_channel_message">event_channel_message()
</a></dl>

<ul><a name="query_club">
query_club</a><pre>
string query_club()
</pre></br>
This method returns the club associated with the badge.
<br/><ul>
<li><b>Returns:</b>
<br/>the club associated with the badge
<li><b>See also:</b>
<br/><a href="#set_club">set_club()
</a></dl>

<ul><a name="set_club">
set_club</a><pre>
void set_club(string club)
</pre></br>
This method sets the club associated with the badge.
<br/><ul>
<li><b>Parameters:</b>
<br/>club - the name of the club
<li><b>See also:</b>
<br/><a href="#query_club">query_club()
</a></dl>


<h2>Protected Functions</h2>
These are functions that only objects inheriting the class can access.<p>
<ul><a name="add_club_commands">
add_club_commands</a><pre>
void add_club_commands(object per)
</pre></br>
This method will add the club commands from the player.


<ul><a name="add_elected_commands">
add_elected_commands</a><pre>
void add_elected_commands(object per)
</pre></br>
This method will add the club commands from the player.


<ul><a name="club_chat">
club_chat</a><pre>
int club_chat(string str,
              int emote)
</pre></br>
The says something wonderful and exciting to all the other club members.
<br/><ul>
<li><b>Parameters:</b>
<br/>str - the exciting comment I know they will say

</dl>

<ul><a name="confirm_disbar">
confirm_disbar</a><pre>
void confirm_disbar(string str,
                    string name)
</pre></br>
THis method confirms the disbar request from the player.
<br/><ul>
<li><b>Parameters:</b>
<br/>str - the response string
<br/>name - the name of the person to disbar
<li><b>See also:</b>
<br/><a href="#do_disbar">do_disbar()
</a></dl>

<ul><a name="confirm_resign">
confirm_resign</a><pre>
void confirm_resign(string str,
                    string position)
</pre></br>
This method checks to make sure they really wish to resign.
<br/><ul>
<li><b>Parameters:</b>
<br/>str - the response
<li><b>See also:</b>
<br/><a href="#do_resign">do_resign()
</a></dl>

<ul><a name="do_announcement">
do_announcement</a><pre>
int do_announcement()
</pre></br>
This method will print out any announcements associated with the club.
<br/><ul>
<li><b>Returns:</b>
<br/>1 on success

</dl>

<ul><a name="do_brief_mode">
do_brief_mode</a><pre>
int do_brief_mode(int mode)
</pre></br>
This method sets the brief mode of the badge.
<br/><ul>
<li><b>Parameters:</b>
<br/>mode - the brief mode]
<li><b>Returns:</b>
<br/>1 on success, 0 on failure

</dl>

<ul><a name="do_brief_string">
do_brief_string</a><pre>
int do_brief_string(string str)
</pre></br>
This method sets the brief message to use for the channel messages.
<br/><ul>
<li><b>Parameters:</b>
<br/>str - the channel message short
<li><b>Returns:</b>
<br/>1 on success, 0 on failure

</dl>

<ul><a name="do_channel_off">
do_channel_off</a><pre>
int do_channel_off(int flag)
</pre></br>
This method handles setting the flag and printing all the happy success
messages.
<br/><ul>
<li><b>Parameters:</b>
<br/>flag - the new flag

</dl>

<ul><a name="do_disbar">
do_disbar</a><pre>
int do_disbar(string name)
</pre></br>
This method allows the founders and presidents/vice presidents to disbar
people from the club.
<br/><ul>
<li><b>Parameters:</b>
<br/>name - the name of the person to disbar

</dl>

<ul><a name="do_history">
do_history</a><pre>
int do_history()
</pre></br>
This method prints out the history of the channel.
<br/><ul>
<li><b>See also:</b>
<br/><a href="#club_chat">club_chat()</a> and <a href="#event_channel_message">event_channel_message()
</a></dl>

<ul><a name="do_recruit">
do_recruit</a><pre>
int do_recruit(object * obs,
               string club)
</pre></br>
This is the method to use when recruiting people.
<br/><ul>
<li><b>Parameters:</b>
<br/>obs - the people to recruit
<li><b>Returns:</b>
<br/>1 on success, 0 on failure
<li><b>See also:</b>
<br/>/obj/handlers/club_handler.c
</dl>

<ul><a name="do_resign">
do_resign</a><pre>
int do_resign()
</pre></br>
This method starts the resignation process.
<br/><ul>
<li><b>Returns:</b>
<br/>1 on succes, 0 on failure
<li><b>See also:</b>
<br/><a href="#confirm_resign">confirm_resign()
</a></dl>

<ul><a name="do_resign_position">
do_resign_position</a><pre>
int do_resign_position(string position)
</pre></br>
This method resigns as a position in the club.
<br/><ul>
<li><b>Returns:</b>
<br/>1 on succes, 0 on failure
<li><b>See also:</b>
<br/><a href="#confirm_resign">confirm_resign()
</a></dl>


[an error occurred while processing this directive]