<!DOCTYPE html> <html> <head> <meta content="text/html; charset=UTF-8" http-equiv="Content-Type"> <title>class Character - TeensyMUD 3.0.0 Mud Server</title> <link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> <script type="text/javascript"> var rdoc_rel_prefix = "./"; </script> <script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> <script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> <script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> <script type="text/javascript" charset="utf-8" src="./js/search.js"></script> <script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> <script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> <body id="top" class="class"> <nav id="metadata"> <nav id="home-section" class="section"> <h3 class="section-header"> <a href="./index.html">Home</a> <a href="./table_of_contents.html#classes">Classes</a> <a href="./table_of_contents.html#methods">Methods</a> </h3> </nav> <nav id="search-section" class="section project-section" class="initially-hidden"> <form action="#" method="get" accept-charset="utf-8"> <h3 class="section-header"> <input type="text" name="search" placeholder="Search" id="search-field" title="Type to search, Up and Down to navigate, Enter to load"> </h3> </form> <ul id="search-results" class="initially-hidden"></ul> </nav> <div id="file-metadata"> <nav id="file-list-section" class="section"> <h3 class="section-header">Defined In</h3> <ul> <li>lib/core/character.rb </ul> </nav> </div> <div id="class-metadata"> <nav id="parent-class-section" class="section"> <h3 class="section-header">Parent</h3> <p class="link"><a href="GameObject.html">GameObject</a> </nav> <!-- Method Quickref --> <nav id="method-list-section" class="section"> <h3 class="section-header">Methods</h3> <ul class="link-list"> <li><a href="#method-c-new">::new</a> <li><a href="#method-i-describe">#describe</a> <li><a href="#method-i-parse">#parse</a> <li><a href="#method-i-sendto">#sendto</a> <li><a href="#method-i-show">#show</a> </ul> </nav> </div> <div id="project-metadata"> <nav id="fileindex-section" class="section project-section"> <h3 class="section-header">Pages</h3> <ul> <li class="file"><a href="./README.html">README</a> <li class="file"><a href="./TML.html">TML</a> </ul> </nav> <nav id="classindex-section" class="section project-section"> <h3 class="section-header">Class and Module Index</h3> <ul class="link-list"> <li><a href="./Farts.html">Farts</a> <li><a href="./Farts/AttributeSyntaxNode.html">Farts::AttributeSyntaxNode</a> <li><a href="./Farts/CallSyntaxNode.html">Farts::CallSyntaxNode</a> <li><a href="./Farts/CommandSyntaxNode.html">Farts::CommandSyntaxNode</a> <li><a href="./Farts/CommentSyntaxNode.html">Farts::CommentSyntaxNode</a> <li><a href="./Farts/EndSyntaxNode.html">Farts::EndSyntaxNode</a> <li><a href="./Farts/IfSyntaxNode.html">Farts::IfSyntaxNode</a> <li><a href="./Farts/Interpreter.html">Farts::Interpreter</a> <li><a href="./Farts/Lexer.html">Farts::Lexer</a> <li><a href="./Farts/Lib.html">Farts::Lib</a> <li><a href="./Farts/LiteralSyntaxNode.html">Farts::LiteralSyntaxNode</a> <li><a href="./Farts/LocalVarSyntaxNode.html">Farts::LocalVarSyntaxNode</a> <li><a href="./Farts/Parser.html">Farts::Parser</a> <li><a href="./Farts/ProgramSyntaxNode.html">Farts::ProgramSyntaxNode</a> <li><a href="./Farts/SyntaxNode.html">Farts::SyntaxNode</a> <li><a href="./SQLite.html">SQLite</a> <li><a href="./SQLite3.html">SQLite3</a> <li><a href="./SQLite3/Database.html">SQLite3::Database</a> <li><a href="./SQLite/Database.html">SQLite::Database</a> <li><a href="./TernaryTrie.html">TernaryTrie</a> <li><a href="./TernaryTrie/TNode.html">TernaryTrie::TNode</a> <li><a href="./ASCIICodes.html">ASCIICodes</a> <li><a href="./Acceptor.html">Acceptor</a> <li><a href="./Account.html">Account</a> <li><a href="./BoolExpParser.html">BoolExpParser</a> <li><a href="./CacheEntry.html">CacheEntry</a> <li><a href="./CacheManager.html">CacheManager</a> <li><a href="./CacheStats.html">CacheStats</a> <li><a href="./Character.html">Character</a> <li><a href="./Client.html">Client</a> <li><a href="./Cmd.html">Cmd</a> <li><a href="./ColorFilter.html">ColorFilter</a> <li><a href="./Command.html">Command</a> <li><a href="./Configuration.html">Configuration</a> <li><a href="./Connection.html">Connection</a> <li><a href="./Connector.html">Connector</a> <li><a href="./ConsoleClient.html">ConsoleClient</a> <li><a href="./CursesClient.html">CursesClient</a> <li><a href="./DbmStore.html">DbmStore</a> <li><a href="./DebugFilter.html">DebugFilter</a> <li><a href="./Dumper.html">Dumper</a> <li><a href="./Engine.html">Engine</a> <li><a href="./Event.html">Event</a> <li><a href="./EventManager.html">EventManager</a> <li><a href="./Exit.html">Exit</a> <li><a href="./Filter.html">Filter</a> <li><a href="./GameObject.html">GameObject</a> <li><a href="./GdbmStore.html">GdbmStore</a> <li><a href="./LineIO.html">LineIO</a> <li><a href="./Loader.html">Loader</a> <li><a href="./Log.html">Log</a> <li><a href="./Module.html">Module</a> <li><a href="./Obj.html">Obj</a> <li><a href="./ObjCmd.html">ObjCmd</a> <li><a href="./Object.html">Object</a> <li><a href="./PacketIO.html">PacketIO</a> <li><a href="./ProtocolStack.html">ProtocolStack</a> <li><a href="./Publisher.html">Publisher</a> <li><a href="./Reactor.html">Reactor</a> <li><a href="./Room.html">Room</a> <li><a href="./Root.html">Root</a> <li><a href="./Script.html">Script</a> <li><a href="./SdbmStore.html">SdbmStore</a> <li><a href="./Session.html">Session</a> <li><a href="./SockIO.html">SockIO</a> <li><a href="./Sqlite3Store.html">Sqlite3Store</a> <li><a href="./SqliteStore.html">SqliteStore</a> <li><a href="./Store.html">Store</a> <li><a href="./String.html">String</a> <li><a href="./TelnetCodes.html">TelnetCodes</a> <li><a href="./TelnetFilter.html">TelnetFilter</a> <li><a href="./TerminalFilter.html">TerminalFilter</a> <li><a href="./Timer.html">Timer</a> <li><a href="./Utility.html">Utility</a> <li><a href="./VT100Codes.html">VT100Codes</a> <li><a href="./World.html">World</a> <li><a href="./XmlStore.html">XmlStore</a> <li><a href="./YamlStore.html">YamlStore</a> </ul> </nav> </div> </nav> <div id="documentation"> <h1 class="class">class Character</h1> <div id="description" class="description"> <p>The <a href="Character.html">Character</a> class is the mother of all characters. Who’s their daddy?</p> </div><!-- description --> <section id="5Buntitled-5D" class="documentation-section"> <!-- Attributes --> <section id="attribute-method-details" class="method-section section"> <h3 class="section-header">Attributes</h3> <div id="attribute-i-account" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">account</span><span class="attribute-access-type">[RW]</span> </div> <div class="method-description"> </div> </div> </section><!-- attribute-method-details --> <!-- Methods --> <section id="public-class-5Buntitled-5D-method-details" class="method-section section"> <h3 class="section-header">Public Class Methods</h3> <div id="method-c-new" class="method-detail "> <div class="method-heading"> <span class="method-name">new</span><span class="method-args">(name,acctid)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <p>Create a new <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 class="rdoc-list label-list"><dt><code>name</code> <dd> <p>The displayed name of the character.</p> </dd><dt><code>acctid</code> <dd> <p>The account id this character belongs to.</p> </dd><dt><code>return</code> <dd> <p>A handle to the new <a href="Character.html">Character</a>.</p> </dd></dl> <div class="method-source-code" id="new-source"> <pre><span class="ruby-comment"># File lib/core/character.rb, line 34</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">name</span>,<span class="ruby-identifier">acctid</span>) <span class="ruby-keyword">super</span>(<span class="ruby-identifier">name</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">options</span>[<span class="ruby-string">'home'</span>] <span class="ruby-operator">||</span> <span class="ruby-value">1</span>) <span class="ruby-keyword">self</span>.<span class="ruby-identifier">acctid</span> = <span class="ruby-identifier">acctid</span> <span class="ruby-ivar">@account</span> = <span class="ruby-keyword">nil</span> <span class="ruby-comment"># reference to the Account. If nil this</span> <span class="ruby-comment"># character is not logged in.</span> <span class="ruby-comment"># We could use get_object(acctid) but</span> <span class="ruby-comment"># holding the reference is faster</span> <span class="ruby-keyword">end</span></pre> </div><!-- new-source --> </div> </div><!-- new-method --> </section><!-- public-class-method-details --> <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> <h3 class="section-header">Public Instance Methods</h3> <div id="method-i-describe" class="method-detail "> <div class="method-heading"> <span class="method-name">describe</span><span class="method-args">(e)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <p><a href="Event.html">Event</a> :describe</p> <dl class="rdoc-list label-list"><dt><code>e</code> <dd> <p>The event</p> </dd><dt><code>return</code> <dd> <p>Undefined</p> </dd></dl> <div class="method-source-code" id="describe-source"> <pre><span class="ruby-comment"># File lib/core/character.rb, line 112</span> <span class="ruby-keyword">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-value">:show</span>,<span class="ruby-identifier">msg</span>) <span class="ruby-keyword">end</span></pre> </div><!-- describe-source --> </div> </div><!-- describe-method --> <div id="method-i-parse" class="method-detail "> <div class="method-heading"> <span class="method-name">parse</span><span class="method-args">(m)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <p>All command input routed through here and parsed.</p> <dl class="rdoc-list label-list"><dt><code>m</code> <dd> <p>The input message to be parsed</p> </dd><dt><code>return</code> <dd> <p>Undefined.</p> </dd></dl> <div class="method-source-code" id="parse-source"> <pre><span class="ruby-comment"># File lib/core/character.rb, line 53</span> <span class="ruby-keyword">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"># handle edit mode</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@mode</span> <span class="ruby-operator">==</span> <span class="ruby-value">:edit</span> <span class="ruby-identifier">edit_parser</span> <span class="ruby-identifier">m</span> <span class="ruby-keyword">return</span> <span class="ruby-keyword">end</span> <span class="ruby-comment"># match legal command</span> <span class="ruby-identifier">m</span><span class="ruby-operator">=~</span><span class="ruby-node">%r([A-Za-z0-9_@?"'#!\]\[]+)(.*)/</span> <span class="ruby-identifier">cmd</span>=<span class="ruby-node">$1</span> <span class="ruby-identifier">arg</span>=<span class="ruby-node">$2</span> <span class="ruby-identifier">arg</span>.<span class="ruby-identifier">strip!</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">arg</span> <span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">cmd</span> <span class="ruby-identifier">sendto</span>(<span class="ruby-string">"Huh?"</span>) <span class="ruby-keyword">return</span> <span class="ruby-keyword">end</span> <span class="ruby-comment"># 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"># add any exits to our command list</span> <span class="ruby-comment"># 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">%r\?/</span>,<span class="ruby-string">"\\?"</span>) <span class="ruby-identifier">check</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-regexp">%r\#/</span>,<span class="ruby-node">"\\#"</span>) <span class="ruby-identifier">check</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-regexp">%r\[/</span>,<span class="ruby-string">"\\["</span>) <span class="ruby-identifier">check</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-regexp">%r\]/</span>,<span class="ruby-string">"\\]"</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">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">%r;/</span>).<span class="ruby-identifier">grep</span>(<span class="ruby-node">%r^#{check}/</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword">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-value">:cmd_go</span>,<span class="ruby-node">"go #{ex}"</span>,<span class="ruby-keyword">nil</span>) <span class="ruby-identifier">arg</span> = <span class="ruby-identifier">ex</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">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"># there are three possibilities here</span> <span class="ruby-keyword">case</span> <span class="ruby-identifier">c</span>.<span class="ruby-identifier">size</span> <span class="ruby-keyword">when</span> <span class="ruby-value">0</span> <span class="ruby-comment"># no commands found</span> <span class="ruby-identifier">sendto</span>(<span class="ruby-string">"Huh?"</span>) <span class="ruby-keyword">when</span> <span class="ruby-value">1</span> <span class="ruby-comment"># command found</span> <span class="ruby-keyword">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">else</span> <span class="ruby-comment"># ambiguous command - tell luser about them.</span> <span class="ruby-identifier">ln</span> = <span class="ruby-string">"Which did you mean, "</span> <span class="ruby-identifier">c</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">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-string">"\'"</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-string">"\'"</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-operator">?</span> <span class="ruby-identifier">ln</span> <span class="ruby-operator">+=</span> <span class="ruby-string">"?"</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">ln</span> <span class="ruby-operator">+=</span> <span class="ruby-string">" or "</span> <span class="ruby-keyword">end</span> <span class="ruby-identifier">sendto</span>(<span class="ruby-identifier">ln</span>) <span class="ruby-keyword">end</span> <span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-comment"># 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">end</span></pre> </div><!-- parse-source --> </div> </div><!-- parse-method --> <div id="method-i-sendto" class="method-detail "> <div class="method-heading"> <span class="method-name">sendto</span><span class="method-args">(s)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <p>Sends a message to the character if they are connected.</p> <dl class="rdoc-list label-list"><dt><code>s</code> <dd> <p>The message string</p> </dd><dt><code>return</code> <dd> <p>Undefined.</p> </dd></dl> <div class="method-source-code" id="sendto-source"> <pre><span class="ruby-comment"># File lib/core/character.rb, line 46</span> <span class="ruby-keyword">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-string">"\n"</span>) <span class="ruby-keyword">if</span> <span class="ruby-ivar">@account</span> <span class="ruby-keyword">end</span></pre> </div><!-- sendto-source --> </div> </div><!-- sendto-method --> <div id="method-i-show" class="method-detail "> <div class="method-heading"> <span class="method-name">show</span><span class="method-args">(e)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <p><a href="Event.html">Event</a> :show</p> <dl class="rdoc-list label-list"><dt><code>e</code> <dd> <p>The event</p> </dd><dt><code>return</code> <dd> <p>Undefined</p> </dd></dl> <div class="method-source-code" id="show-source"> <pre><span class="ruby-comment"># File lib/core/character.rb, line 120</span> <span class="ruby-keyword">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">end</span></pre> </div><!-- show-source --> </div> </div><!-- show-method --> </section><!-- public-instance-method-details --> </section><!-- 5Buntitled-5D --> </div><!-- documentation --> <footer id="validator-badges"> <p><a href="http://validator.w3.org/check/referer">[Validate]</a> <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.1. <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. </footer>