[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/owned_room.c</h2>
This is an owned room inherit.  It allows controllable entrance and
things like 'allow' and 'throwout' and stuff.  Make sure the create on
this is called after the create in the basic room.<p>Written by Pinkfish<p>Started 30th of June
<h2>Includes</h2>
This class includes the following files <a href="include.room.h.shtml">/include/room.h</a><h2>Method index</h2>
<dl><ul>
<li><a href="#do_allow">do_allow</a>(string)<br/>
This the main entry point for the allow command.
<li><a href="#do_disallow">do_disallow</a>(string)<br/>
This the main entry point for the disallow command.
<li><a href="#do_throwout">do_throwout</a>(object *)<br/>
This is the main entry point for the throwout command.
<li><a href="#is_allowed">is_allowed</a>(string)<br/>
This method tests to see if the person in question is either the owner
or is allowed.
<li><a href="#is_allowed_in">is_allowed_in</a>(string)<br/>
This method checks to see if they are allowed in.
<li><a href="#load_room">load_room</a>()<br/>
This method loads the room setup.
<li><a href="#query_allowed">query_allowed</a>()<br/>
This method returns the current allowed list on the room.
<li><a href="#query_front_door">query_front_door</a>()<br/>
This method queries the current front door.
<li><a href="#query_owner">query_owner</a>()<br/>
This method returns the owner of the room.
<li><a href="#query_save_file">query_save_file</a>()<br/>
This method returns the save file the owned room.
<li><a href="#save_room">save_room</a>()<br/>
This method saves the room setup.
<li><a href="#set_allowed">set_allowed</a>(string *)<br/>
This method sets the allowed array for the room.
<li><a href="#set_front_door">set_front_door</a>(string)<br/>
This method sets the exit that is the front door.
<li><a href="#set_owner">set_owner</a>(string)<br/>
This method sets the owner of the room.
<li><a href="#set_save_file">set_save_file</a>(string)<br/>
This method sets the save file for the owned room.
</ul><h2>Public Functions</h2>
These are functions that everyone can access.<p>
.<ul><a name="is_allowed">
is_allowed</a><pre>
int is_allowed(string person)
</pre></br>
This method tests to see if the person in question is either the owner
or is allowed.
<br/><ul>
<li><b>Parameters:</b>
<br/>person - the person to check

</dl>

<ul><a name="is_allowed_in">
is_allowed_in</a><pre>
int is_allowed_in(string person)
</pre></br>
This method checks to see if they are allowed in.  Allow anyone in
if the room is not locked.
<br/><ul>
<li><b>Parameters:</b>
<br/>person - the person to check
<li><b>Returns:</b>
<br/>1 if they are allowed in, 0 if not

</dl>

<ul><a name="load_room">
load_room</a><pre>
void load_room()
</pre></br>
This method loads the room setup.


<ul><a name="query_allowed">
query_allowed</a><pre>
string * query_allowed()
</pre></br>
This method returns the current allowed list on the room.
<br/><ul>
<li><b>Returns:</b>
<br/>the current allowed array

</dl>

<ul><a name="query_front_door">
query_front_door</a><pre>
string query_front_door()
</pre></br>
This method queries the current front door.
<br/><ul>
<li><b>Returns:</b>
<br/>the current front door

</dl>

<ul><a name="query_owner">
query_owner</a><pre>
string query_owner()
</pre></br>
This method returns the owner of the room.
<br/><ul>
<li><b>Returns:</b>
<br/>the owner of the room

</dl>

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

</dl>

<ul><a name="save_room">
save_room</a><pre>
void save_room()
</pre></br>
This method saves the room setup.


<ul><a name="set_front_door">
set_front_door</a><pre>
void set_front_door(string exit)
</pre></br>
This method sets the exit that is the front door.
<br/><ul>
<li><b>Parameters:</b>
<br/>exit - the exit to use as the front door

</dl>

<ul><a name="set_owner">
set_owner</a><pre>
void set_owner(string owner)
</pre></br>
This method sets the owner of the room.
<br/><ul>
<li><b>Parameters:</b>
<br/>owner - the new owner of the room

</dl>

<ul><a name="set_save_file">
set_save_file</a><pre>
void set_save_file(string name)
</pre></br>
This method sets the save file for the owned room.
<br/><ul>
<li><b>Parameters:</b>
<br/>save_file - the name of the save file

</dl>


<h2>Protected Functions</h2>
These are functions that only objects inheriting the class can access.<p>
<ul><a name="do_allow">
do_allow</a><pre>
int do_allow(string name)
</pre></br>
This the main entry point for the allow command.

<ul><a name="do_disallow">
do_disallow</a><pre>
int do_disallow(string name)
</pre></br>
This the main entry point for the disallow command.
<br/><ul>
<li><b>Returns:</b>
<br/>1 on succes, 0 on failure

</dl>

<ul><a name="do_throwout">
do_throwout</a><pre>
int do_throwout(object * people)
</pre></br>
This is the main entry point for the throwout command.
<br/><ul>
<li><b>Parameters:</b>
<br/>name - the name of the person to throwout
<li><b>Returns:</b>
<br/>1 on success, 0 on failure

</dl>

<ul><a name="set_allowed">
set_allowed</a><pre>
void set_allowed(string * allowed)
</pre></br>
This method sets the allowed array for the room.
<br/><ul>
<li><b>Parameters:</b>
<br/>allowed - the new allowed array.

</dl>


[an error occurred while processing this directive]