[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/inherit/club_discuss.c</h2>
This file is for adding discussion items to clubs.  It should be included
into the main club control room.<p><b>See also:</b><br>/obj/handlers/club_handler.c
<p>Written by Pinkfish<p>Started April 21st 1999<h2>Includes</h2>
This class includes the following files <a href="include.clubs.h.shtml">/include/clubs.h</a> and <a href="include.am_time.h.shtml">/include/am_time.h</a><h2>Class Index</h2>
<ul><li><a href="#class_memo_item">memo_item</a>
<br/>
This class is used by the memo discussion item addition code.
</ul><h2>Method index</h2>
<dl><ul>
<li><a href="#change_position">change_position</a>(string, int, string)<br/>
Figure out which of the choices the player wishes to change.
<li><a href="#change_position_new_name">change_position_new_name</a>(string, string, int, string)<br/>
This method checks to make sure that the entered name to change the
position to is valid.
<li><a href="#description_confirm">description_confirm</a>(string, string, int, string)<br/>
This method confirms the description typed in is correct.
<li><a href="#discuss_memo_menu">discuss_memo_menu</a>(class memo_item)<br/>
This method runs the menu for the memo discussion item.
<li><a href="#discussion_add_name">discussion_add_name</a>(string, int, string)<br/>
This method checks to make sure that the entered position name is
valid.
<li><a href="#discussion_finish_information">discussion_finish_information</a>(string, mixed *)<br/>
This method is the return from the editing for the information
bit and will now try and confirm this.
<li><a href="#do_discuss">do_discuss</a>(int, string, string)<br/>
The main entry point for all the discussion item types.
<li><a href="#do_discuss_add_position">do_discuss_add_position</a>(int, string)<br/>
This is the method used to start the discussion of an add position
discussion item.
<li><a href="#do_discuss_change_position_name">do_discuss_change_position_name</a>(int, string)<br/>
This is the main entry point for setting up a discussion item to 
change a position name in the club.
<li><a href="#do_discuss_create_account">do_discuss_create_account</a>(int, string)<br/>
This is the main entry point for setting up a discussion item to 
remove a position from the club.
<li><a href="#do_discuss_description">do_discuss_description</a>(int, string)<br/>
This is the entry point for setting up a discussion on changing
the description of the club.
<li><a href="#do_discuss_memo">do_discuss_memo</a>(int, string)<br/>
This is the main entry point for setting up a memo discussion type.
<li><a href="#do_discuss_no_confidence">do_discuss_no_confidence</a>(int, string)<br/>
This is the main entry point for the no confidence discussion votes.
<li><a href="#do_discuss_remove_account">do_discuss_remove_account</a>(int, string)<br/>
This is the main entry point for setting up a discussion item to 
remove an account from the club.
<li><a href="#do_discuss_remove_member">do_discuss_remove_member</a>(int, string)<br/>
This is the main entry point for the function to setup a discussion item
to remove a member from the club.
<li><a href="#do_discuss_remove_position">do_discuss_remove_position</a>(int, string)<br/>
This is the main entry point for setting up a discussion item to 
remove a position from the club.
<li><a href="#do_discuss_secret">do_discuss_secret</a>(int, string)<br/>
This method is the main entry point to adding a discussion type to make
the club secret.
</ul><h2>Public Functions</h2>
These are functions that everyone can access.<p>
.<ul><a name="do_discuss">
do_discuss</a><pre>
int do_discuss(int open,
               string type,
               string club_name)
</pre></br>
The main entry point for all the discussion item types.  Figures out
which discussion item it is and calls the correct method to start the
ball rolling.
<br/><ul>
<li><b>Parameters:</b>
<br/>type - the type of the discussion item
<li><b>Returns:</b>
<br/>1 on success, 0 on failure
<li><b>See also:</b>
<br/><a href="obj.handlers.club_handler.c.shtml">/obj/handlers/club_handler.c</a>, <a href="#do_discuss_description">do_discuss_description()</a>, <a href="#do_discuss_add_position">do_discuss_add_position()</a>, <a href="#do_discuss_change_position_name">do_discuss_change_position_name()</a> and <a href="#do_discuss_memo">do_discuss_memo()
</a></dl>


<h2>Protected Functions</h2>
These are functions that only objects inheriting the class can access.<p>
<ul><a name="change_position">
change_position</a><pre>
void change_position(string str,
                     int open,
                     string club_name)
</pre></br>
Figure out which of the choices the player wishes to change.
<br/><ul>
<li><b>Parameters:</b>
<br/>str - the name of the position to be changed
<li><b>See also:</b>
<br/><a href="#do_discuss_change_position_name">do_discuss_change_position_name()</a>, <a href="#change_position_new_name">change_position_new_name()</a> and <a href="#change_position_new_name_confirm">change_position_new_name_confirm()
</a></dl>

<ul><a name="change_position_new_name">
change_position_new_name</a><pre>
void change_position_new_name(string str,
                              string position,
                              int open,
                              string club_name)
</pre></br>
This method checks to make sure that the entered name to change the
position to is valid.
<br/><ul>
<li><b>Parameters:</b>
<br/>str - the new name for the position
<br/>position - the position to change
<li><b>See also:</b>
<br/><a href="#change_position">change_position()</a>, <a href="#do_discuss_change_position_name">do_discuss_change_position_name()</a> and <a href="#change_position_new_name_confirm">change_position_new_name_confirm()
</a></dl>

<ul><a name="description_confirm">
description_confirm</a><pre>
void description_confirm(string confirm,
                         string str,
                         int open,
                         string club_name)
</pre></br>
This method confirms the description typed in is correct.
<br/><ul>
<li><b>Parameters:</b>
<br/>confirm - the string the used typed to confirm the description
<br/>str - the description
<li><b>See also:</b>
<br/><a href="#do_discuss_description">do_discuss_description()
</a></dl>

<ul><a name="discuss_memo_menu">
discuss_memo_menu</a><pre>
void discuss_memo_menu(class memo_item memo)
</pre></br>
This method runs the menu for the memo discussion item.
<br/><ul>
<li><b>Parameters:</b>
<br/>memo - the memo item to be used in the menu

</dl>

<ul><a name="discussion_add_name">
discussion_add_name</a><pre>
void discussion_add_name(string str,
                         int open,
                         string club_name)
</pre></br>
This method checks to make sure that the entered position name is
valid.
<br/><ul>
<li><b>Parameters:</b>
<br/>str - the position to check
<li><b>See also:</b>
<br/><a href="#do_discuss_add_position">do_discuss_add_position()</a> and <a href="#discussion_add_name_confirm">discussion_add_name_confirm()
</a></dl>

<ul><a name="discussion_finish_information">
discussion_finish_information</a><pre>
void discussion_finish_information(string info,
                                   mixed * data)
</pre></br>
This method is the return from the editing for the information
bit and will now try and confirm this.
<br/><ul>
<li><b>Parameters:</b>
<br/>str - the confirmation string
<br/>data - the passed in data
<li><b>See also:</b>
<br/><a href="#discussion_add_name">discussion_add_name()</a> and <a href="#do_discuss_add_position">do_discuss_add_position()
</a></dl>

<ul><a name="do_discuss_add_position">
do_discuss_add_position</a><pre>
int do_discuss_add_position(int open,
                            string club_name)
</pre></br>
This is the method used to start the discussion of an add position
discussion item.
<br/><ul>
<li><b>Returns:</b>
<br/>1 on success, 0 on failure
<li><b>See also:</b>
<br/><a href="#do_discuss">do_discuss()</a>, <a href="#discussion_add_name">discussion_add_name()</a> and <a href="#discussion_add_name_confirm">discussion_add_name_confirm()
</a></dl>

<ul><a name="do_discuss_change_position_name">
do_discuss_change_position_name</a><pre>
int do_discuss_change_position_name(int open,
                                    string club_name)
</pre></br>
This is the main entry point for setting up a discussion item to 
change a position name in the club.
<br/><ul>
<li><b>Returns:</b>
<br/>1 on success, 0 on failure
<li><b>See also:</b>
<br/><a href="#change_position">change_position()</a>, <a href="#change_position_new_name">change_position_new_name()</a>, <a href="#change_position_new_name_confirm">change_position_new_name_confirm()</a> and <a href="#do_discuss">do_discuss()
</a></dl>

<ul><a name="do_discuss_create_account">
do_discuss_create_account</a><pre>
int do_discuss_create_account(int open,
                              string club_name)
</pre></br>
This is the main entry point for setting up a discussion item to 
remove a position from the club.
<br/><ul>
<li><b>Returns:</b>
<br/>1 on success, 0 on failure
<li><b>See also:</b>
<br/><a href="#do_discuss">do_discuss()
</a></dl>

<ul><a name="do_discuss_description">
do_discuss_description</a><pre>
int do_discuss_description(int open,
                           string club_name)
</pre></br>
This is the entry point for setting up a discussion on changing
the description of the club.
<br/><ul>
<li><b>See also:</b>
<br/><a href="#description_confirm">description_confirm()
</a></dl>

<ul><a name="do_discuss_memo">
do_discuss_memo</a><pre>
int do_discuss_memo(int op,
                    string club_name)
</pre></br>
This is the main entry point for setting up a memo discussion type.
A memo is a user run discussion item which has no effect on any
real game mechanics.
<br/><ul>
<li><b>See also:</b>
<br/><a href="#do_discuss">do_discuss()
</a></dl>

<ul><a name="do_discuss_no_confidence">
do_discuss_no_confidence</a><pre>
int do_discuss_no_confidence(int open,
                             string club_name)
</pre></br>
This is the main entry point for the no confidence discussion votes.
<br/><ul>
<li><b>Parameters:</b>
<br/>open - the open flag
<li><b>Returns:</b>
<br/>1 on success, 0 on failure
<li><b>See also:</b>
<br/><a href="#do_discuss">do_discuss()
</a></dl>

<ul><a name="do_discuss_remove_account">
do_discuss_remove_account</a><pre>
int do_discuss_remove_account(int open,
                              string club_name)
</pre></br>
This is the main entry point for setting up a discussion item to 
remove an account from the club.
<br/><ul>
<li><b>Returns:</b>
<br/>1 on success, 0 on failure
<li><b>See also:</b>
<br/><a href="#do_discuss">do_discuss()
</a></dl>

<ul><a name="do_discuss_remove_member">
do_discuss_remove_member</a><pre>
int do_discuss_remove_member(int open,
                             string club_name)
</pre></br>
This is the main entry point for the function to setup a discussion item
to remove a member from the club.
<br/><ul>
<li><b>Parameters:</b>
<br/>open - the open flag

</dl>

<ul><a name="do_discuss_remove_position">
do_discuss_remove_position</a><pre>
int do_discuss_remove_position(int open,
                               string club_name)
</pre></br>
This is the main entry point for setting up a discussion item to 
remove a position from the club.
<br/><ul>
<li><b>Returns:</b>
<br/>1 on success, 0 on failure
<li><b>See also:</b>
<br/><a href="#do_discuss">do_discuss()
</a></dl>

<ul><a name="do_discuss_secret">
do_discuss_secret</a><pre>
int do_discuss_secret(int open,
                      string club_name)
</pre></br>
This method is the main entry point to adding a discussion type to make
the club secret.
<br/><ul>
<li><b>Parameters:</b>
<br/>open - if the item is being added as an open item

</dl>


<h2>Classes</h2>
These are nice data types for dealing with...  Data!<p>
<ul>
<li><a name="class_memo_item">
memo_item</a><pre>
class memo_item {
                  string club_name;
                  string subject;
                  string description;
                  string * choices;
                  int timeout;
                  int open;
}

</pre><br/>
This class is used by the memo discussion item addition code.<p>

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