[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/carriage/handler.c</h2>
Pinkfish's rewrite of the carriages.  March 2002.<p>Written by Pinkfish<p>Started Mon Mar  4 23:34:31 PST 2002
<h2>Includes</h2>
This class includes the following files <a href="include.room.h.shtml">/include/room.h</a>, <a href="include.room.carriage.h.shtml">/include/room/carriage.h</a> and <a href="include.data.h.shtml">/include/data.h</a><h2>Method index</h2>
<dl><ul>
<li><a href="#delete_route">delete_route</a>(string)<br/>
Delete a route from the handler.
<li><a href="#load_data">load_data</a>()<li><a href="#query_carriage_on_route">query_carriage_on_route</a>(string)<br/>
This method returns the carriage object on the specified route.
<li><a href="#query_route_actual">query_route_actual</a>()<br/>
This method returns all the actual actual routes and where they are.
<li><a href="#query_route_details">query_route_details</a>()<br/>
Query the details of the route.
<li><a href="#query_route_names">query_route_names</a>()<br/>
This method returns all the names of all the different routes in the
system.
<li><a href="#query_route_stops">query_route_stops</a>(string)<br/>
This method returns the list of stops associated with the
route.
<li><a href="#query_stop_delay">query_stop_delay</a>(string)<br/>
This method returns the delay of the stop, the actual room.
<li><a href="#query_stop_location">query_stop_location</a>(string)<br/>
This method returns the location of the stop, the actual room.
<li><a href="#query_stop_name">query_stop_name</a>(string)<br/>
This method returns the name of the stop, the actual room.
<li><a href="#scan_for_new_data">scan_for_new_data</a>()<br/>
This method scans through all the files and sees if anything has
changed.
<li><a href="#setup_carriage">setup_carriage</a>(string, string, string, string, string)<br/>
This method sets up the carriage handler stuff.
</ul><h2>Public Functions</h2>
These are functions that everyone can access.<p>
.<ul><a name="delete_route">
delete_route</a><pre>
int delete_route(string route)
</pre></br>
Delete a route from the handler.
<br/><ul>
<li><b>Parameters:</b>
<br/>route - the route name to delete
<li><b>Returns:</b>
<br/>1 if successful

</dl>

<ul><a name="load_data">
load_data</a><pre>
void load_data()
</pre>
<ul><a name="query_carriage_on_route">
query_carriage_on_route</a><pre>
object query_carriage_on_route(string route)
</pre></br>
This method returns the carriage object on the specified route.
<br/><ul>
<li><b>Parameters:</b>
<br/>route - the route to look for the carriage on
<li><b>Returns:</b>
<br/>the carriage on the route

</dl>

<ul><a name="query_route_actual">
query_route_actual</a><pre>
mapping query_route_actual()
</pre></br>
This method returns all the actual actual routes and where they are.
This should only be used for debugging purposes.
<br/><ul>
<li><b>Returns:</b>
<br/>the actual route details

</dl>

<ul><a name="query_route_details">
query_route_details</a><pre>
mapping query_route_details()
</pre></br>
Query the details of the route.  This returns everything about the
details and should not be used.
<br/><ul>
<li><b>Returns:</b>
<br/>all the route details

</dl>

<ul><a name="query_route_names">
query_route_names</a><pre>
string * query_route_names()
</pre></br>
This method returns all the names of all the different routes in the
system.
<br/><ul>
<li><b>Returns:</b>
<br/>the route names

</dl>

<ul><a name="query_route_stops">
query_route_stops</a><pre>
class stop_list_details * query_route_stops(string route)
</pre></br>
This method returns the list of stops associated with the
route.
<br/><ul>
<li><b>Parameters:</b>
<br/>route - the name of the route
<li><b>Returns:</b>
<br/>the stops on the route

</dl>

<ul><a name="query_stop_delay">
query_stop_delay</a><pre>
int query_stop_delay(string name)
</pre></br>
This method returns the delay of the stop, the actual room.
<br/><ul>
<li><b>Parameters:</b>
<br/>name - the name of the stop
<li><b>Returns:</b>
<br/>the delay of the stop

</dl>

<ul><a name="query_stop_location">
query_stop_location</a><pre>
string query_stop_location(string name)
</pre></br>
This method returns the location of the stop, the actual room.
<br/><ul>
<li><b>Parameters:</b>
<br/>name - the name of the stop
<li><b>Returns:</b>
<br/>the location of the stop

</dl>

<ul><a name="query_stop_name">
query_stop_name</a><pre>
string query_stop_name(string name)
</pre></br>
This method returns the name of the stop, the actual room.
<br/><ul>
<li><b>Parameters:</b>
<br/>name - the name of the stop
<li><b>Returns:</b>
<br/>the name of the stop

</dl>

<ul><a name="scan_for_new_data">
scan_for_new_data</a><pre>
void scan_for_new_data()
</pre></br>
This method scans through all the files and sees if anything has
changed.


<ul><a name="setup_carriage">
setup_carriage</a><pre>
void setup_carriage(string dir,
                    string base_dir,
                    string carriage,
                    string pole,
                    string save_file)
</pre></br>
This method sets up the carriage handler stuff.  It sets up the pole
and the carriage items.
<br/><ul>
<li><b>Parameters:</b>
<br/>dir - the directory of the data files
<br/>base_dir - the base directory to use on the front of paths
<br/>carriage - what to clone for the carriage
<br/>pole - what to clone for a pole
<br/>save_file - where to save the data

</dl>


[an error occurred while processing this directive]