[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/map_helper.c</h2>
This is the map helper object.  It contains all the current information
about the files.  It stores the current directory and keeps track of
if things have changed so it does not save or load excessively.<p>Written by Wodan
<h2>Includes</h2>
This class includes the following files /include/map_handler.h<h2>Method index</h2>
<ul>
<li><a href="#change_changetimes">change_changetimes</a>(string, string, int)<br/>
This method changes the time at which the specified room was last
changed.
<li><a href="#change_clusters">change_clusters</a>(string, string, int)<br/>
This method will change the cluster for the specified room.
<li><a href="#change_co_ords">change_co_ords</a>(string, string, int *)<br/>
This method changes the coordinates for the specified room/.
<li><a href="#change_map">change_map</a>(string, string, string *)<br/>
This method will change the destination direction array for the
given room.
<li><a href="#change_movezones">change_movezones</a>(string, string, string *)<br/>
This method changes the move zones for the specified room.
<li><a href="#change_shorts">change_shorts</a>(string, string, string)<br/>
This method changes the short for the specified directory and room.
<li><a href="#change_sizes">change_sizes</a>(string, string, int)<br/>
This method changes the roomsize for the specified room.
<li><a href="#check_dir">check_dir</a>(string)<br/>
This method attempts to load in the save file information for
the specified directory.
<li><a href="#del">del</a>(string, string)<br/>
This method deletes the specified room from the directory.
<li><a href="#query_changetimes">query_changetimes</a>(string)<br/>
This method returns the mapping of rooms to last modified dates.
<li><a href="#query_clusters">query_clusters</a>(string)<br/>
This method returns the cluster mapping for the specified directory.
<li><a href="#query_co_ords">query_co_ords</a>(string)<br/>
This method returns the mapping of coordinates to rooms.
<li><a href="#query_map">query_map</a>(string)<br/>
This method returns the current destination direction mapping for
the given directory.
<li><a href="#query_movezones">query_movezones</a>(string)<br/>
This method returns the mapping of move zones for the specified
room.
<li><a href="#query_shorts">query_shorts</a>(string)<br/>
This method returns the mapping containing all the shorts for the
specified directory.
<li><a href="#query_sizes">query_sizes</a>(string)<br/>
This method returns the mapping of sizes for rooms.
<li><a href="#save_dir">save_dir</a>()<br/>
This method saves the state of the currently loaded directory.
</ul>
<h2>Public Functions</h2>
These are functions that everyone can access.<p>
<dl>
<dt class="autodocfuncname"><a name="change_changetimes">
change_changetimes</a><pre class="autodocfuncdef">
void change_changetimes(string dir,
                        string room,
                        int time)
</pre><dd><br />
This method changes the time at which the specified room was last
changed.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
dir - the directory to change the last modified date for<br />
room - the room to set the modied time for<br />
time - the new time
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="change_clusters">
change_clusters</a><pre class="autodocfuncdef">
void change_clusters(string dir,
                     string room,
                     int cluster)
</pre><dd><br />
This method will change the cluster for the specified room.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
dir - the directory to change the cluster for<br />
room - the room to change the cluster for<br />
cluster - the new cluster number
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="change_co_ords">
change_co_ords</a><pre class="autodocfuncdef">
void change_co_ords(string dir,
                    string room,
                    int * coord)
</pre><dd><br />
This method changes the coordinates for the specified room/.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
dir - the directory to change the room in<br />
room - the room to change in the directory<br />
coord - the new coordinate
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="change_map">
change_map</a><pre class="autodocfuncdef">
void change_map(string dir,
                string room,
                string * dd)
</pre><dd><br />
This method will change the destination direction array for the
given room.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
dir - the directory to change<br />
room - the room to change<br />
dd - the new destination directory
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="change_movezones">
change_movezones</a><pre class="autodocfuncdef">
void change_movezones(string dir,
                      string room,
                      string * zones)
</pre><dd><br />
This method changes the move zones for the specified room.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
dir - the directory to change the move zones in<br />
room - the room to change the move zones in<br />
zones - the new move zones
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="change_shorts">
change_shorts</a><pre class="autodocfuncdef">
void change_shorts(string dir,
                   string room,
                   string sh)
</pre><dd><br />
This method changes the short for the specified directory and room.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
dir - the directory to change the short for<br />
room - the room the change the short for<br />
sh - the new short for the room
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="change_sizes">
change_sizes</a><pre class="autodocfuncdef">
void change_sizes(string dir,
                  string room,
                  int size)
</pre><dd><br />
This method changes the roomsize for the specified room.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
dir - the directory to change the room in<br />
room - the room to change in the directory<br />
coord - the new size;
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="check_dir">
check_dir</a><pre class="autodocfuncdef">
void check_dir(string dir)
</pre><dd><br />
This method attempts to load in the save file information for
the specified directory.  If the directory has no save file
then the mappings will all be initialised to empty.  It will cause
the previous directory to be saved if this is attempting to load a
different one.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
dir - the directory to load the save information for<br />
<br />
<dd><b>See also:</b>
<br /><a href="#save_dir">save_dir()
</a><br /><br /><br /></dl>

<dt class="autodocfuncname"><a name="del">
del</a><pre class="autodocfuncdef">
void del(string dir,
         string room)
</pre><dd><br />
This method deletes the specified room from the directory.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
dir - the directory to remove the room from<br />
room - the room to remove
<br />
<br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_changetimes">
query_changetimes</a><pre class="autodocfuncdef">
mapping query_changetimes(string dir)
</pre><dd><br />
This method returns the mapping of rooms to last modified dates.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
dir - the directory to return the mapping for<br />
<br />
<dd><b>Returns:</b>
<br />the mapping of last modified dates
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_clusters">
query_clusters</a><pre class="autodocfuncdef">
mapping query_clusters(string dir)
</pre><dd><br />
This method returns the cluster mapping for the specified directory.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
dir - the directory to return the cluster mapping for<br />
<br />
<dd><b>Returns:</b>
<br />the cluster mapping for the directory
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_co_ords">
query_co_ords</a><pre class="autodocfuncdef">
mapping query_co_ords(string dir)
</pre><dd><br />
This method returns the mapping of coordinates to rooms.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
dir - the directory to return the mapping for<br />
<br />
<dd><b>Returns:</b>
<br />the mapping of coordinates to rooms
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_map">
query_map</a><pre class="autodocfuncdef">
mapping query_map(string dir)
</pre><dd><br />
This method returns the current destination direction mapping for
the given directory.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
dir - the directory to return the mapping for<br />
<br />
<dd><b>Returns:</b>
<br />the destination direction mapping
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_movezones">
query_movezones</a><pre class="autodocfuncdef">
mapping query_movezones(string dir)
</pre><dd><br />
This method returns the mapping of move zones for the specified
room.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
dir - the directory to return the move zones for<br />
<br />
<dd><b>Returns:</b>
<br />the move zone mapping
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_shorts">
query_shorts</a><pre class="autodocfuncdef">
mapping query_shorts(string dir)
</pre><dd><br />
This method returns the mapping containing all the shorts for the
specified directory.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
dir - the directory to return the shorts for<br />
<br />
<dd><b>Returns:</b>
<br />the mapping of short descriptions
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="query_sizes">
query_sizes</a><pre class="autodocfuncdef">
mapping query_sizes(string dir)
</pre><dd><br />
This method returns the mapping of sizes for rooms.<br />
<br /><dl>
<dd><b>Parameters:</b><br />
dir - the directory to return the mapping for<br />
<br />
<dd><b>Returns:</b>
<br />the mapping of sizes for rooms.
<br /><br />
<br /></dl>

<dt class="autodocfuncname"><a name="save_dir">
save_dir</a><pre class="autodocfuncdef">
void save_dir()
</pre><dd><br />
This method saves the state of the currently loaded directory.<br />
<br /><dl>
<dd><b>See also:</b>
<br /><a href="#check_dir">check_dir()
</a><br /><br /><br /></dl>

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