[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 /obj/handlers/co_ordinate_handler.c</h2>
This is the handler for co-ordinates.  Finds and sets co-ordinates for
outside rooms.  It works from specific fixed co-ordinate locations and
finds the rooms as a web of relative connections for there.<p>Written by Pinkfish<p>Started Mon Nov  3 13:57:58 PST 2003
<h2>Includes</h2>
This class includes the following files /include/dirs.h<h2>Class Index</h2>
<ul><li><a href="#class_room_data">room_data</a>
</ul><h2>Method index</h2>
<ul>
<li><a href="#look_for_deletions">look_for_deletions</a>()<br/>
This is a function which runs through and finds old outdated rooms
and removes them.
<li><a href="#query_fixed_rooms">query_fixed_rooms</a>()<br/>
Returns the list of fixed rooms.
<li><a href="#query_room_based_of">query_room_based_of</a>(string)<br/>
This returns the room the co-ordinates for this room as based off.
<li><a href="#query_room_co_ords">query_room_co_ords</a>(string)<br/>
Find the room's co-ordinates.
<li><a href="#query_room_direction">query_room_direction</a>(string)<br/>
This returns the direction the co-ordinates for this room as based off.
<li><a href="#query_rooms">query_rooms</a>()<br/>
Returns the current list of stored rooms.
<li><a href="#remove_room">remove_room</a>(string)<br/>
This removes a specific path from the list of remembered rooms.
<li><a href="#setup_fixed_room">setup_fixed_room</a>(string, int *)<br/>
Sets up the specific co-ordinates for the specific room.
<li><a href="#setup_room">setup_room</a>(string)<br/>
Sets up the room, based on a room with a known co-ordinate and an
exit direction.
</ul>
<h2>Public Functions</h2>
These are functions that everyone can access.<p>
<dl>
<dt class="autodocfuncname"><a name="look_for_deletions">
look_for_deletions</a><pre class="autodocfuncdef">
void look_for_deletions()
</pre><dd><br />
This is a function which runs through and finds old outdated rooms
and removes them.  It looks for rooms that have been deleted etc.
<br />

<dt class="autodocfuncname"><a name="query_fixed_rooms">
query_fixed_rooms</a><pre class="autodocfuncdef">
string * query_fixed_rooms()
</pre><dd><br />
Returns the list of fixed rooms.
<br />

<dt class="autodocfuncname"><a name="query_room_based_of">
query_room_based_of</a><pre class="autodocfuncdef">
string query_room_based_of(string path)
</pre><dd><br />
This returns the room the co-ordinates for this room as based off.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
path - the path the co-ordinates are based off<br />
<br />
<dd><b>Returns:</b>
<br />the path
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_room_co_ords">
query_room_co_ords</a><pre class="autodocfuncdef">
int * query_room_co_ords(string path)
</pre><dd><br />
Find the room's co-ordinates.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
room - the room to lookup<br />
<br />
<dd><b>Returns:</b>
<br />the co-ordinates
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_room_direction">
query_room_direction</a><pre class="autodocfuncdef">
string query_room_direction(string path)
</pre><dd><br />
This returns the direction the co-ordinates for this room as based off.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
path - the path the co-ordinates are based off<br />
<br />
<dd><b>Returns:</b>
<br />the direction
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_rooms">
query_rooms</a><pre class="autodocfuncdef">
mapping query_rooms()
</pre><dd><br />
Returns the current list of stored rooms.
<br />

<dt class="autodocfuncname"><a name="remove_room">
remove_room</a><pre class="autodocfuncdef">
void remove_room(string path)
</pre><dd><br />
This removes a specific path from the list of remembered rooms.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
path - the path to remove
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="setup_fixed_room">
setup_fixed_room</a><pre class="autodocfuncdef">
int setup_fixed_room(string path,
                     int * coords)
</pre><dd><br />
Sets up the specific co-ordinates for the specific room.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
path - the path for the main room<br />
coords - the coordinates to set
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="setup_room">
setup_room</a><pre class="autodocfuncdef">
int setup_room(string path)
</pre><dd><br />
Sets up the room, based on a room with a known co-ordinate and an
exit direction.  We search around to try and find a fixed co-ordinate
room.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
path - the room being setup
<br />
<br />
<br /></dl>

</dl>
<h2>Classes</h2>
These are nice data types for dealing with...  Data!<p>
<ul>
<li><a name="class_room_data">
room_data</a><pre>
class room_data {
                  string other;
                  string direction;
                  int * coords;
                  int last_update;
                  string * refs;
}

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

