[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 /secure/login.c</h2>
The main login object.
<h2>Includes</h2>
This class includes the following files <a href="include.telnet.h.shtml">/include/telnet.h</a>, <a href="include.access.h.shtml">/include/access.h</a>, <a href="include.mail.h.shtml">/include/mail.h</a>, <a href="include.login.h.shtml">/include/login.h</a>, <a href="include.random_names.h.shtml">/include/random_names.h</a>, <a href="include.player_handler.h.shtml">/include/player_handler.h</a>, <a href="include.playtesters.h.shtml">/include/playtesters.h</a>, <a href="include.data.h.shtml">/include/data.h</a>, <a href="include.playerinfo.h.shtml">/include/playerinfo.h</a> and <a href="include.login_handler.h.shtml">/include/login_handler.h</a><h2>Class Index</h2>
<ul><li><a href="#class_state">state</a>
<br/>
This structure holds a single state.
</ul><h2>Method index</h2>
<dl><ul>
<li><a href="#debug_log">debug_log</a>(string, mixed args)<li><a href="#enter_state">enter_state</a>(string)<li><a href="#main_random_name_menu">main_random_name_menu</a>(string)<li><a href="#mxp_enable">mxp_enable</a>()<li><a href="#query_delete_player_file_name">query_delete_player_file_name</a>(string)<br/>
This method returns the path to the deleted player file.
<li><a href="#query_login_ob">query_login_ob</a>()<br/>
This method determines if the object is a login object.
<li><a href="#query_player_file_name">query_player_file_name</a>(string)<br/>
This method returns the path to the player file.
<li><a href="#quit">quit</a>(string)</ul><h2>Public Functions</h2>
These are functions that everyone can access.<p>
.<ul><a name="debug_log">
debug_log</a><pre>
void debug_log(string fmt,
               mixed args ...)
</pre>
<ul><a name="enter_state">
enter_state</a><pre>
void enter_state(string new_state)
</pre>
<ul><a name="main_random_name_menu">
main_random_name_menu</a><pre>
mixed main_random_name_menu(string event)
</pre>
<ul><a name="mxp_enable">
mxp_enable</a><pre>
void mxp_enable()
</pre>
<ul><a name="query_delete_player_file_name">
query_delete_player_file_name</a><pre>
string query_delete_player_file_name(string name)
</pre></br>
This method returns the path to the deleted player file.
This is the deleted player files actual normal location, it was written to
allow moving the player files aruond easier.
<br/><ul>
<li><b>Parameters:</b>
<br/>name - the name of hte player whose file to find
<li><b>See also:</b>
<br/><a href="#test_user">test_user()</a> and <a href="#query_delete_player_file_name">query_delete_player_file_name()
</a></dl>

<ul><a name="query_login_ob">
query_login_ob</a><pre>
int query_login_ob()
</pre></br>
This method determines if the object is a login object.
<br/><ul>
<li><b>Returns:</b>
<br/>always returns 1

</dl>

<ul><a name="query_player_file_name">
query_player_file_name</a><pre>
string query_player_file_name(string name)
</pre></br>
This method returns the path to the player file.
This is the player files actual normal location, it was written to
allow moving the player files aruond easier.
<br/><ul>
<li><b>Parameters:</b>
<br/>name - the name of hte player whose file to find
<li><b>See also:</b>
<br/><a href="#test_user">test_user()</a> and <a href="#query_delete_player_file_name">query_delete_player_file_name()
</a></dl>

<ul><a name="quit">
quit</a><pre>
mixed quit(string event)
</pre>

<h2>Classes</h2>
These are nice data types for dealing with...  Data!<p>
<ul>
<li><a name="class_state">
state</a><pre>
class state {
              string name;
              string action;
              string write;
              int noecho;
              mapping events;
}

</pre><br/>
This structure holds a single state. A state has a name,
an action or write and a set of events. <br>
The name is used to identify the state and must be unique within the
state table. An action is a function to call while a write is a
string or file to be written to the screen.  The events mapping
is made of event and new-state. The event is the trigger and
new-state is the new state the machine should enter.<p>

An event is a string of the form "type-data" where type is either
"input" or "return" indicating user input or the return from an
action function. Thus "return-ok" would be triggered if the action
function in this state returned "ok" while "input-y" would be
triggered if the user typed in "y". The special event "input" will
trigger on any user input while the event "default" will trigger on
any input or return value.

<p>

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