<?xml version="1.0" encoding="iso-8859-1"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <title>Class: Account</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> <meta http-equiv="Content-Script-Type" content="text/javascript" /> <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" /> <script type="text/javascript"> // <![CDATA[ function popupCode( url ) { window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400") } function toggleCode( id ) { if ( document.getElementById ) elem = document.getElementById( id ); else if ( document.all ) elem = eval( "document.all." + id ); else return false; elemStyle = elem.style; if ( elemStyle.display != "block" ) { elemStyle.display = "block" } else { elemStyle.display = "none" } return true; } // Make codeblocks hidden by default document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" ) // ]]> </script> </head> <body> <div id="classHeader"> <table class="header-table"> <tr class="top-aligned-row"> <td><strong>Class</strong></td> <td class="class-name-in-header">Account</td> </tr> <tr class="top-aligned-row"> <td><strong>In:</strong></td> <td> <a href="../files/lib/core/account_rb.html"> lib/core/account.rb </a> <br /> </td> </tr> <tr class="top-aligned-row"> <td><strong>Parent:</strong></td> <td> <a href="Root.html"> Root </a> </td> </tr> </table> </div> <!-- banner header --> <div id="bodyContent"> <div id="contextContent"> <div id="diagram"> <map id="map" name="map"> <area shape="RECT" coords="55,113,127,161" href="Account.html" alt="Account "> <area shape="RECT" coords="7,17,79,65" href="Publisher.html" alt="Publisher "> <area shape="RECT" coords="103,17,175,65" href="Root.html" alt="Root "> </map> <img src="../dot/f_9.png" usemap="#map" border=0 alt="TopLevel"> </div> <div id="description"> <p> The <a href="Account.html">Account</a> class handles connection login and passes them to character. </p> </div> </div> <div id="method-list"> <h3 class="section-bar">Methods</h3> <div class="name-list"> <a href="#M000188">append_echo</a> <a href="#M000194">character_menu</a> <a href="#M000193">disconnect</a> <a href="#M000195">login_menu</a> <a href="#M000184">new</a> <a href="#M000187">parse_menu</a> <a href="#M000186">parse_messages</a> <a href="#M000190">prompt</a> <a href="#M000189">sendmsg</a> <a href="#M000191">status_rept</a> <a href="#M000192">toggle_color</a> <a href="#M000185">update</a> <a href="#M000196">vtsupport?</a> </div> </div> </div> <!-- if includes --> <div id="includes"> <h3 class="section-bar">Included Modules</h3> <div id="includes-list"> <span class="include-name"><a href="Publisher.html">Publisher</a></span> </div> </div> <div id="section"> <div id="attribute-list"> <h3 class="section-bar">Attributes</h3> <div class="name-list"> <table> <tr class="top-aligned-row context-row"> <td class="context-item-name">character</td> <td class="context-item-value"> [RW] </td> <td class="context-item-desc"></td> </tr> <tr class="top-aligned-row context-row"> <td class="context-item-name">conn</td> <td class="context-item-value"> [RW] </td> <td class="context-item-desc"></td> </tr> <tr class="top-aligned-row context-row"> <td class="context-item-name">echo</td> <td class="context-item-value"> [RW] </td> <td class="context-item-desc"></td> </tr> <tr class="top-aligned-row context-row"> <td class="context-item-name">mode</td> <td class="context-item-value"> [RW] </td> <td class="context-item-desc"></td> </tr> <tr class="top-aligned-row context-row"> <td class="context-item-name">terminal</td> <td class="context-item-value"> [RW] </td> <td class="context-item-desc"></td> </tr> <tr class="top-aligned-row context-row"> <td class="context-item-name">termsize</td> <td class="context-item-value"> [RW] </td> <td class="context-item-desc"></td> </tr> </table> </div> </div> <!-- if method_list --> <div id="methods"> <h3 class="section-bar">Public Class methods</h3> <div id="method-M000184" class="method-detail"> <a name="M000184"></a> <div class="method-heading"> <a href="Account.src/M000184.html" target="Code" class="method-signature" onclick="popupCode('Account.src/M000184.html');return false;"> <span class="method-name">new</span><span class="method-args">(conn)</span> </a> </div> <div class="method-description"> <p> Create an <a href="Account.html">Account</a> connection. This is a temporary object that handles login for character and gets them connected. </p> <dl> <dt><tt>conn</tt></dt><dd>The session associated with this <a href="Account.html">Account</a> connection. </dd> <dt><tt>return</tt></dt><dd>A handle to the <a href="Account.html">Account</a> object. </dd> </dl> </div> </div> <h3 class="section-bar">Public Instance methods</h3> <div id="method-M000188" class="method-detail"> <a name="M000188"></a> <div class="method-heading"> <a href="Account.src/M000188.html" target="Code" class="method-signature" onclick="popupCode('Account.src/M000188.html');return false;"> <span class="method-name">append_echo</span><span class="method-args">(msg)</span> </a> </div> <div class="method-description"> <p> If echo hasn’t been negotiated, we want to leave the cursor after the message prompt, so we prepend linefeeds in front of messages. This is hackish. </p> </div> </div> <div id="method-M000194" class="method-detail"> <a name="M000194"></a> <div class="method-heading"> <a href="Account.src/M000194.html" target="Code" class="method-signature" onclick="popupCode('Account.src/M000194.html');return false;"> <span class="method-name">character_menu</span><span class="method-args">()</span> </a> </div> <div class="method-description"> </div> </div> <div id="method-M000193" class="method-detail"> <a name="M000193"></a> <div class="method-heading"> <a href="Account.src/M000193.html" target="Code" class="method-signature" onclick="popupCode('Account.src/M000193.html');return false;"> <span class="method-name">disconnect</span><span class="method-args">(msg=nil)</span> </a> </div> <div class="method-description"> <p> Disconnects this account </p> </div> </div> <div id="method-M000195" class="method-detail"> <a name="M000195"></a> <div class="method-heading"> <a href="Account.src/M000195.html" target="Code" class="method-signature" onclick="popupCode('Account.src/M000195.html');return false;"> <span class="method-name">login_menu</span><span class="method-args">()</span> </a> </div> <div class="method-description"> </div> </div> <div id="method-M000187" class="method-detail"> <a name="M000187"></a> <div class="method-heading"> <a href="Account.src/M000187.html" target="Code" class="method-signature" onclick="popupCode('Account.src/M000187.html');return false;"> <span class="method-name">parse_menu</span><span class="method-args">(msg)</span> </a> </div> <div class="method-description"> <p> Handles message while in the login menu - called by <a href="Account.html#M000186">parse_messages</a>. This was refactored out of <a href="Account.html#M000186">Account#parse_messages</a> for length reasons. </p> <dl> <dt><tt>msg</tt></dt><dd>The message string </dd> </dl> <p> @mode tracks the state changes, This routine is entered by any @modes staring with :menu. </p> <p> The following state transition diagram illustrates the possible transitions. </p> <p> :menu -> :menucr Create a character </p> <pre> -> :menupl Play a character </pre> <p> :menucr -> :playing Get character name, create character and play </p> </div> </div> <div id="method-M000186" class="method-detail"> <a name="M000186"></a> <div class="method-heading"> <a href="Account.src/M000186.html" target="Code" class="method-signature" onclick="popupCode('Account.src/M000186.html');return false;"> <span class="method-name">parse_messages</span><span class="method-args">(msg)</span> </a> </div> <div class="method-description"> <p> Handles <a href="String.html">String</a> messages from <a href="Connection.html">Connection</a> - called by update. This was refactored out of <a href="Account.html#M000185">Account#update</a> for length reasons. </p> <dl> <dt><tt>msg</tt></dt><dd>The message string </dd> </dl> <p> @mode tracks the state changes, The <a href="Account.html">Account</a> is created with the initial state of :initialize. The following state transition diagram illustrates the possible transitions. </p> <p> :intialize -> :name Set when <a href="Account.html">Account</a>:update receives :initdone msg :name -> :password Sets @login_name and finds @account </p> <pre> :playing Creates a new character if Guest account </pre> <p> :password -> :newacct Sets @login_passwd </p> <pre> -> :menu Good passwd, switches account, if account_system option on goes to menu -> :playing Good passwd, switches account, loads character -> :name Bad passwd -> disconnect Bad passwd, exceeds @check attempts (see Account#disconnect) </pre> <p> :newacct -> :menu If account_system option on goes to menu </p> <pre> -> :playing Creates new character, adds account </pre> <p> :menu -> <a href="Account.html#M000187">parse_menu</a> Redirect message (see <a href="Account.html#M000187">Account#parse_menu</a>) :playing -> @character Redirect message (see <a href="Character.html#M000303">Character#parse</a>) </p> </div> </div> <div id="method-M000190" class="method-detail"> <a name="M000190"></a> <div class="method-heading"> <a href="Account.src/M000190.html" target="Code" class="method-signature" onclick="popupCode('Account.src/M000190.html');return false;"> <span class="method-name">prompt</span><span class="method-args">()</span> </a> </div> <div class="method-description"> </div> </div> <div id="method-M000189" class="method-detail"> <a name="M000189"></a> <div class="method-heading"> <a href="Account.src/M000189.html" target="Code" class="method-signature" onclick="popupCode('Account.src/M000189.html');return false;"> <span class="method-name">sendmsg</span><span class="method-args">(msg)</span> </a> </div> <div class="method-description"> </div> </div> <div id="method-M000191" class="method-detail"> <a name="M000191"></a> <div class="method-heading"> <a href="Account.src/M000191.html" target="Code" class="method-signature" onclick="popupCode('Account.src/M000191.html');return false;"> <span class="method-name">status_rept</span><span class="method-args">()</span> </a> </div> <div class="method-description"> </div> </div> <div id="method-M000192" class="method-detail"> <a name="M000192"></a> <div class="method-heading"> <a href="Account.src/M000192.html" target="Code" class="method-signature" onclick="popupCode('Account.src/M000192.html');return false;"> <span class="method-name">toggle_color</span><span class="method-args">()</span> </a> </div> <div class="method-description"> </div> </div> <div id="method-M000185" class="method-detail"> <a name="M000185"></a> <div class="method-heading"> <a href="Account.src/M000185.html" target="Code" class="method-signature" onclick="popupCode('Account.src/M000185.html');return false;"> <span class="method-name">update</span><span class="method-args">(msg)</span> </a> </div> <div class="method-description"> <p> Receives messages from a <a href="Connection.html">Connection</a> being observed and handles login state. </p> <dl> <dt><tt>msg</tt></dt><dd>The message string </dd> </dl> <p> This supports the following: </p> <dl> <dt>:disconnected</dt><dd>- This symbol from the server informs us that the <a href="Connection.html">Connection</a> has disconnected. </dd> <dt>:initdone</dt><dd>- This symbol from the server indicates that the <a href="Connection.html">Connection</a> <pre> is done setting up and done negotiating an initial state. It triggers us to start sending output and parsing input. </pre> </dd> <dt>:termsize</dt><dd>- This is sent everytime the terminal size changes (NAWS) </dd> <dt><a href="String.html">String</a></dt><dd>- A <a href="String.html">String</a> is assumed to be input from the <a href="Session.html">Session</a> and we <pre> send it to parse_messages. </pre> </dd> </dl> </div> </div> <div id="method-M000196" class="method-detail"> <a name="M000196"></a> <div class="method-heading"> <a href="Account.src/M000196.html" target="Code" class="method-signature" onclick="popupCode('Account.src/M000196.html');return false;"> <span class="method-name">vtsupport?</span><span class="method-args">()</span> </a> </div> <div class="method-description"> </div> </div> </div> </div> <div id="validator-badges"> <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p> </div> </body> </html>