<?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: Character</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">Character</td> </tr> <tr class="top-aligned-row"> <td><strong>In:</strong></td> <td> <a href="../files/lib/core/character_rb.html"> lib/core/character.rb </a> <br /> </td> </tr> <tr class="top-aligned-row"> <td><strong>Parent:</strong></td> <td> <a href="GameObject.html"> GameObject </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="12,101,95,149" href="Character.html" alt="Character " /> <area shape="rect" coords="5,5,101,53" href="GameObject.html" alt="GameObject " /> </map> <img src="../dot/f_10.png" usemap="#map" border="0" alt="dot/f_10.png"> </div> <div id="description"> <p> The <a href="Character.html">Character</a> class is the mother of all characters. Who‘s their daddy? </p> </div> </div> <div id="method-list"> <h3 class="section-bar">Methods</h3> <div class="name-list"> <a href="#M000012">describe</a> <a href="#M000009">new</a> <a href="#M000011">parse</a> <a href="#M000010">sendto</a> <a href="#M000013">show</a> </div> </div> </div> <!-- if includes --> <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">account</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-M000009" class="method-detail"> <a name="M000009"></a> <div class="method-heading"> <a href="#M000009" class="method-signature"> <span class="method-name">new</span><span class="method-args">(name,acctid)</span> </a> </div> <div class="method-description"> <p> Create a <a href="Character.html#M000009">new</a> <a href="Character.html">Character</a> object IMPORTANT :<a href="Character.html">Character</a> objects must be marked nonswappable while connected!!! </p> <pre> Otherwise we risk losing the contants of @account </pre> <dl> <dt><tt>name</tt></dt><dd>The displayed name of the character. </dd> <dt><tt>acctid</tt></dt><dd>The account id this character belongs to. </dd> <dt><tt>return</tt></dt><dd>A handle to the <a href="Character.html#M000009">new</a> <a href="Character.html">Character</a>. </dd> </dl> <p><a class="source-toggle" href="#" onclick="toggleCode('M000009-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000009-source"> <pre> <span class="ruby-comment cmt"># File lib/core/character.rb, line 34</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">name</span>,<span class="ruby-identifier">acctid</span>) <span class="ruby-keyword kw">super</span>(<span class="ruby-identifier">name</span>, <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">options</span>[<span class="ruby-value str">'home'</span>] <span class="ruby-operator">||</span> <span class="ruby-value">1</span>) <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">acctid</span> = <span class="ruby-identifier">acctid</span> <span class="ruby-ivar">@account</span> = <span class="ruby-keyword kw">nil</span> <span class="ruby-comment cmt"># reference to the Account. If nil this</span> <span class="ruby-comment cmt"># character is not logged in.</span> <span class="ruby-comment cmt"># We could use get_object(acctid) but</span> <span class="ruby-comment cmt"># holding the reference is faster</span> <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <h3 class="section-bar">Public Instance methods</h3> <div id="method-M000012" class="method-detail"> <a name="M000012"></a> <div class="method-heading"> <a href="#M000012" class="method-signature"> <span class="method-name">describe</span><span class="method-args">(e)</span> </a> </div> <div class="method-description"> <p> <a href="Event.html">Event</a> :<a href="Character.html#M000012">describe</a> </p> <dl> <dt><tt>e</tt></dt><dd>The event </dd> <dt><tt>return</tt></dt><dd>Undefined </dd> </dl> <p><a class="source-toggle" href="#" onclick="toggleCode('M000012-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000012-source"> <pre> <span class="ruby-comment cmt"># File lib/core/character.rb, line 112</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">describe</span>(<span class="ruby-identifier">e</span>) <span class="ruby-identifier">msg</span> = <span class="ruby-node">"[COLOR Cyan]#{name} is here.[/COLOR]"</span> <span class="ruby-identifier">add_event</span>(<span class="ruby-identifier">id</span>,<span class="ruby-identifier">e</span>.<span class="ruby-identifier">from</span>,<span class="ruby-identifier">:show</span>,<span class="ruby-identifier">msg</span>) <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <div id="method-M000011" class="method-detail"> <a name="M000011"></a> <div class="method-heading"> <a href="#M000011" class="method-signature"> <span class="method-name">parse</span><span class="method-args">(m)</span> </a> </div> <div class="method-description"> <p> All command input routed through here and parsed. </p> <dl> <dt><tt>m</tt></dt><dd>The input message to be parsed </dd> <dt><tt>return</tt></dt><dd>Undefined. </dd> </dl> <p><a class="source-toggle" href="#" onclick="toggleCode('M000011-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000011-source"> <pre> <span class="ruby-comment cmt"># File lib/core/character.rb, line 53</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">parse</span>(<span class="ruby-identifier">m</span>) <span class="ruby-ivar">@account</span>.<span class="ruby-identifier">prompt</span> <span class="ruby-comment cmt"># handle edit mode</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@mode</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">:edit</span> <span class="ruby-identifier">edit_parser</span> <span class="ruby-identifier">m</span> <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">end</span> <span class="ruby-comment cmt"># match legal command</span> <span class="ruby-identifier">m</span><span class="ruby-operator">=~</span><span class="ruby-regexp re">/([A-Za-z0-9_@?"'#!\]\[]+)(.*)/</span> <span class="ruby-identifier">cmd</span>=<span class="ruby-identifier">$1</span> <span class="ruby-identifier">arg</span>=<span class="ruby-identifier">$2</span> <span class="ruby-identifier">arg</span>.<span class="ruby-identifier">strip!</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">arg</span> <span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">cmd</span> <span class="ruby-identifier">sendto</span>(<span class="ruby-value str">"Huh?"</span>) <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">end</span> <span class="ruby-comment cmt"># look for a command in our spanking new table</span> <span class="ruby-identifier">c</span> = <span class="ruby-identifier">world</span>.<span class="ruby-identifier">cmds</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">cmd</span>) <span class="ruby-comment cmt"># add any exits to our command list</span> <span class="ruby-comment cmt"># escape certain characters in cmd</span> <span class="ruby-identifier">check</span> = <span class="ruby-identifier">cmd</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/\?/</span>,<span class="ruby-value str">"\\?"</span>) <span class="ruby-identifier">check</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-regexp re">/\#/</span>,<span class="ruby-value str">"\\#"</span>) <span class="ruby-identifier">check</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-regexp re">/\[/</span>,<span class="ruby-value str">"\\["</span>) <span class="ruby-identifier">check</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-regexp re">/\]/</span>,<span class="ruby-value str">"\\]"</span>) <span class="ruby-identifier">get_object</span>(<span class="ruby-identifier">location</span>).<span class="ruby-identifier">exits</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">exid</span><span class="ruby-operator">|</span> <span class="ruby-identifier">ext</span> = <span class="ruby-identifier">get_object</span>(<span class="ruby-identifier">exid</span>) <span class="ruby-identifier">ext</span>.<span class="ruby-identifier">name</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp re">/;/</span>).<span class="ruby-identifier">grep</span>(<span class="ruby-node">/^#{check}/</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ex</span><span class="ruby-operator">|</span> <span class="ruby-identifier">c</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">Command</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">:cmd_go</span>,<span class="ruby-node">"go #{ex}"</span>,<span class="ruby-keyword kw">nil</span>) <span class="ruby-identifier">arg</span> = <span class="ruby-identifier">ex</span> <span class="ruby-keyword kw">end</span> <span class="ruby-keyword kw">end</span> <span class="ruby-identifier">log</span>.<span class="ruby-identifier">debug</span> <span class="ruby-node">"parse commands - '#{c.inspect}', arguments - '#{arg}', check - '#{check}'"</span> <span class="ruby-comment cmt"># there are three possibilities here</span> <span class="ruby-keyword kw">case</span> <span class="ruby-identifier">c</span>.<span class="ruby-identifier">size</span> <span class="ruby-keyword kw">when</span> <span class="ruby-value">0</span> <span class="ruby-comment cmt"># no commands found</span> <span class="ruby-identifier">sendto</span>(<span class="ruby-value str">"Huh?"</span>) <span class="ruby-keyword kw">when</span> <span class="ruby-value">1</span> <span class="ruby-comment cmt"># command found</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">c</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">cmd</span>, <span class="ruby-identifier">arg</span>) <span class="ruby-keyword kw">else</span> <span class="ruby-comment cmt"># ambiguous command - tell luser about them.</span> <span class="ruby-identifier">ln</span> = <span class="ruby-value str">"Which did you mean, "</span> <span class="ruby-identifier">c</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">x</span><span class="ruby-operator">|</span> <span class="ruby-identifier">ln</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">"\'"</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">x</span>.<span class="ruby-identifier">name</span> <span class="ruby-operator">+</span> <span class="ruby-value str">"\'"</span> <span class="ruby-identifier">x</span>.<span class="ruby-identifier">name</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">c</span>.<span class="ruby-identifier">last</span>.<span class="ruby-identifier">name</span> <span class="ruby-value">? </span><span class="ruby-identifier">ln</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">"?"</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">ln</span> <span class="ruby-operator">+=</span> <span class="ruby-value str">" or "</span> <span class="ruby-keyword kw">end</span> <span class="ruby-identifier">sendto</span>(<span class="ruby-identifier">ln</span>) <span class="ruby-keyword kw">end</span> <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-comment cmt"># keep character alive after exceptions</span> <span class="ruby-identifier">log</span>.<span class="ruby-identifier">fatal</span> <span class="ruby-identifier">$!</span> <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <div id="method-M000010" class="method-detail"> <a name="M000010"></a> <div class="method-heading"> <a href="#M000010" class="method-signature"> <span class="method-name">sendto</span><span class="method-args">(s)</span> </a> </div> <div class="method-description"> <p> Sends a message to the character if they are connected. </p> <dl> <dt><tt>s</tt></dt><dd>The message string </dd> <dt><tt>return</tt></dt><dd>Undefined. </dd> </dl> <p><a class="source-toggle" href="#" onclick="toggleCode('M000010-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000010-source"> <pre> <span class="ruby-comment cmt"># File lib/core/character.rb, line 46</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">sendto</span>(<span class="ruby-identifier">s</span>) <span class="ruby-ivar">@account</span>.<span class="ruby-identifier">sendmsg</span>(<span class="ruby-identifier">s</span><span class="ruby-operator">+</span><span class="ruby-value str">"\n"</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@account</span> <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <div id="method-M000013" class="method-detail"> <a name="M000013"></a> <div class="method-heading"> <a href="#M000013" class="method-signature"> <span class="method-name">show</span><span class="method-args">(e)</span> </a> </div> <div class="method-description"> <p> <a href="Event.html">Event</a> :<a href="Character.html#M000013">show</a> </p> <dl> <dt><tt>e</tt></dt><dd>The event </dd> <dt><tt>return</tt></dt><dd>Undefined </dd> </dl> <p><a class="source-toggle" href="#" onclick="toggleCode('M000013-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000013-source"> <pre> <span class="ruby-comment cmt"># File lib/core/character.rb, line 120</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">show</span>(<span class="ruby-identifier">e</span>) <span class="ruby-identifier">sendto</span>(<span class="ruby-identifier">e</span>.<span class="ruby-identifier">msg</span>) <span class="ruby-keyword kw">end</span> </pre> </div> </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>