[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/controller/club_room_controller.c</h2>
THis is the controller object to deal with the club rooms.  It
keeps track of which club owns the room, if the club room has
a board and any ownership issues that are needed.<p>Written by Pinkfish<p>Started May 16th
<h2>Inherits</h2>
This class inherits the following classes <a href="std.basic.setup.c.shtml">/std/basic/setup.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.clubs.h.shtml">/include/clubs.h</a> and <a href="include.room.club_room.h.shtml">/include/room/club_room.h</a><h2>Class Index</h2>
<ul><li><a href="#class_ownership">ownership</a>
</ul><h2>Method index</h2>
<dl><ul>
<li><a href="#add_controlled_ownership">add_controlled_ownership</a>(string, int, int, mixed)<br/>
This method adds an item to have ownership.
<li><a href="#discuss_elect_ownership">discuss_elect_ownership</a>(string, string, class discussion_idea, string, string)<br/>
This is the function used for electing whoever gets to have the 
nice owned room.
<li><a href="#discuss_nominate_ownership">discuss_nominate_ownership</a>(string, string, class discussion_idea, string, string)<br/>
This is the function used for nominating someone exciting the the
owned position of the club rooms.
<li><a href="#is_option">is_option</a>(string)<br/>
This method checks to see if there is an option associated with the
club room.
<li><a href="#load_me">load_me</a>()<br/>
This method loads all the data from the save file.
<li><a href="#query_board_associated">query_board_associated</a>()<br/>
This method queries to see if there is a board associated or not
<li><a href="#query_club">query_club</a>()<br/>
This method queries the club that currently owns the set of rooms.
<li><a href="#query_option">query_option</a>(string)<br/>
This method queries and option associated with the club room.
<li><a href="#query_room_save_file_name">query_room_save_file_name</a>(mixed)<br/>
This method returns the save file name to use for the room.
<li><a href="#query_save_directory">query_save_directory</a>()<br/>
This method returns the save file for the club room controller.
<li><a href="#remove_option">remove_option</a>(string)<br/>
This remove removes an option associated with the club room.
<li><a href="#save_me">save_me</a>()<br/>
This method saves all the data to the save file.
<li><a href="#set_board_associated">set_board_associated</a>(int)<br/>
This method sets if a board is associated with the club room set or
not.
<li><a href="#set_club">set_club</a>(string)<br/>
This method sets the club that currently owns the set of rooms.
<li><a href="#set_controlled_ownership_owner">set_controlled_ownership_owner</a>(string, string, int)<br/>
This method sets the owner of the controlled ownership type.
<li><a href="#set_option">set_option</a>(string, mixed)<br/>
This method sets the value of the option associated with the club room.
<li><a href="#set_save_directory">set_save_directory</a>(string)<br/>
This method sets the save directory for the club room controller.
</ul><h2>Public Functions</h2>
These are functions that everyone can access.<p>
.<ul><a name="add_controlled_ownership">
add_controlled_ownership</a><pre>
int add_controlled_ownership(string name,
                             int type,
                             int default_type,
                             mixed default_name)
</pre></br>
This method adds an item to have ownership.  If a function pointer
is set as the default name, then the method will be evaluated each
time the club changes.  The first arguement will be the name of the
owned item being changed and the second argument will be the new
club name.
<br/><ul>
<li><b>Parameters:</b>
<br/>name - the name of the option that needs ownership control
<br/>type - the type of controlled ownership
<br/>default_type - the default ownership of the item
<br/>default_name - the default name of the owner
<li><b>Returns:</b>
<br/>1 on success, 0 on failure

</dl>

<ul><a name="discuss_elect_ownership">
discuss_elect_ownership</a><pre>
mixed discuss_elect_ownership(string message,
                              string club_name,
                              class discussion_idea frog,
                              string arg1,
                              string arg2)
</pre></br>
This is the function used for electing whoever gets to have the 
nice owned room.
<br/><ul>
<li><b>Parameters:</b>
<br/>message - the message being sent
<br/>club_name - the name of the club
<br/>frog - the discussion item
<br/>arg1 - the first argument
<br/>arg2 - the second argument

</dl>

<ul><a name="discuss_nominate_ownership">
discuss_nominate_ownership</a><pre>
mixed discuss_nominate_ownership(string message,
                                 string club_name,
                                 class discussion_idea frog,
                                 string arg1,
                                 string arg2)
</pre></br>
This is the function used for nominating someone exciting the the
owned position of the club rooms.
<br/><ul>
<li><b>Parameters:</b>
<br/>message - the message being sent
<br/>club_name - the name of the club
<br/>frog - the discussion item
<br/>arg1 - the first argument
<br/>arg2 - the second argument

</dl>

<ul><a name="is_option">
is_option</a><pre>
int is_option(string name)
</pre></br>
This method checks to see if there is an option associated with the
club room.
<br/><ul>
<li><b>Parameters:</b>
<br/>name - the name of the optionto check
<li><b>Returns:</b>
<br/>1 if there is, 0 if not

</dl>

<ul><a name="load_me">
load_me</a><pre>
void load_me()
</pre></br>
This method loads all the data from the save file.


<ul><a name="query_board_associated">
query_board_associated</a><pre>
int query_board_associated()
</pre></br>
This method queries to see if there is a board associated or not
<br/><ul>
<li><b>Returns:</b>
<br/>1 if there is aboard associated with this club room set

</dl>

<ul><a name="query_club">
query_club</a><pre>
string query_club()
</pre></br>
This method queries the club that currently owns the set of rooms.
<br/><ul>
<li><b>Returns:</b>
<br/>the club that owns the rooms

</dl>

<ul><a name="query_option">
query_option</a><pre>
mixed query_option(string name)
</pre></br>
This method queries and option associated with the club room.
<br/><ul>
<li><b>Parameters:</b>
<br/>name - the name of the option
<li><b>Returns:</b>
<br/>the value of the option

</dl>

<ul><a name="query_room_save_file_name">
query_room_save_file_name</a><pre>
string query_room_save_file_name(mixed fname)
</pre></br>
This method returns the save file name to use for the room.
<br/><ul>
<li><b>Parameters:</b>
<br/>fname - the file name to use for the room
<li><b>Returns:</b>
<br/>the save file name to use

</dl>

<ul><a name="query_save_directory">
query_save_directory</a><pre>
string query_save_directory()
</pre></br>
This method returns the save file for the club room controller.
<br/><ul>
<li><b>Returns:</b>
<br/>the save file for the club room controller

</dl>

<ul><a name="remove_option">
remove_option</a><pre>
int remove_option(string name)
</pre></br>
This remove removes an option associated with the club room.
<br/><ul>
<li><b>Parameters:</b>
<br/>name - the name of the optoin
<li><b>Returns:</b>
<br/>1 on success, 0 on failure

</dl>

<ul><a name="save_me">
save_me</a><pre>
void save_me()
</pre></br>
This method saves all the data to the save file.


<ul><a name="set_board_associated">
set_board_associated</a><pre>
void set_board_associated(int board_associated)
</pre></br>
This method sets if a board is associated with the club room set or
not.

<ul><a name="set_club">
set_club</a><pre>
int set_club(string club)
</pre></br>
This method sets the club that currently owns the set of rooms.
<br/><ul>
<li><b>Parameters:</b>
<br/>club - the club that owns the rooms
<li><b>Returns:</b>
<br/>1 on success, 0 on failure

</dl>

<ul><a name="set_controlled_ownership_owner">
set_controlled_ownership_owner</a><pre>
int set_controlled_ownership_owner(string controlled,
                                   string owner,
                                   int type)
</pre></br>
This method sets the owner of the controlled ownership type.
<br/><ul>
<li><b>Parameters:</b>
<br/>controlled - the item being controlled
<br/>owner - the owner of the item
<br/>type - the type of the owner
<li><b>Returns:</b>
<br/>1 on success, 0 on failure

</dl>

<ul><a name="set_option">
set_option</a><pre>
int set_option(string name,
               mixed value)
</pre></br>
This method sets the value of the option associated with the club room.
<br/><ul>
<li><b>Parameters:</b>
<br/>name - the name of the option
<br/>value - the new value for the option
<li><b>Returns:</b>
<br/>1 on success, 0 on failure

</dl>

<ul><a name="set_save_directory">
set_save_directory</a><pre>
void set_save_directory(string save_directory)
</pre></br>
This method sets the save directory for the club room controller.
<br/><ul>
<li><b>Parameters:</b>
<br/>save_file - the new save file

</dl>


<h2>Classes</h2>
These are nice data types for dealing with...  Data!<p>
<ul>
<li><a name="class_ownership">
ownership</a><pre>
class ownership {
                  string name;
                  int type;
                  int control_type;
}

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