<?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: Command</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">Command</td> </tr> <tr class="top-aligned-row"> <td><strong>In:</strong></td> <td> <a href="../files/lib/command_rb.html"> lib/command.rb </a> <br /> <a href="../files/lib/command_rb.html"> lib/command.rb </a> <br /> </td> </tr> <tr class="top-aligned-row"> <td><strong>Parent:</strong></td> <td> Object </td> </tr> </table> </div> <!-- banner header --> <div id="bodyContent"> <div id="contextContent"> <div id="diagram"> <map id="map" name="map"> <area shape="rect" coords="5,5,85,53" href="Command.html" alt="Command " /> </map> <img src="../dot/f_7.png" usemap="#map" border="0" alt="dot/f_7.png"> </div> <div id="description"> <p> The <a href="Command.html">Command</a> class encapsulates a TeensyMud command </p> </div> </div> <div id="method-list"> <h3 class="section-bar">Methods</h3> <div class="name-list"> <a href="#M000063">load</a> <a href="#M000060">load</a> <a href="#M000059">new</a> <a href="#M000062">new</a> <a href="#M000061">options</a> <a href="#M000064">options</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">cmd</td> <td class="context-item-value"> [R] </td> <td class="context-item-desc"></td> </tr> <tr class="top-aligned-row context-row"> <td class="context-item-name">cmd</td> <td class="context-item-value"> [R] </td> <td class="context-item-desc"></td> </tr> <tr class="top-aligned-row context-row"> <td class="context-item-name">help</td> <td class="context-item-value"> [R] </td> <td class="context-item-desc"></td> </tr> <tr class="top-aligned-row context-row"> <td class="context-item-name">help</td> <td class="context-item-value"> [R] </td> <td class="context-item-desc"></td> </tr> <tr class="top-aligned-row context-row"> <td class="context-item-name">name</td> <td class="context-item-value"> [R] </td> <td class="context-item-desc"></td> </tr> <tr class="top-aligned-row context-row"> <td class="context-item-name">name</td> <td class="context-item-value"> [R] </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-M000063" class="method-detail"> <a name="M000063"></a> <div class="method-heading"> <a href="#M000063" class="method-signature"> <span class="method-name">load</span><span class="method-args">()</span> </a> </div> <div class="method-description"> <p> <a href="Command.html#M000060">load</a> builds a command lookup trie from the commands listed in a yaml config file and in the and then defines/redefines them on the <a href="GameObject.html">GameObject</a> classes. </p> <dl> <dt><tt>return</tt></dt><dd>A trie of commands (see <a href="TernaryTrie.html">TernaryTrie</a> class) </dd> </dl> <p><a class="source-toggle" href="#" onclick="toggleCode('M000063-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000063-source"> <pre> <span class="ruby-comment cmt"># File lib/command.rb, line 37</span> <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">load</span> <span class="ruby-ivar">@log</span>.<span class="ruby-identifier">info</span> <span class="ruby-value str">"Loading commands..."</span> <span class="ruby-comment cmt"># first load the commands for objects</span> <span class="ruby-identifier">ocmdtable</span> = <span class="ruby-constant">TernaryTrie</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value str">'object_interface'</span>] <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-identifier">options</span>[<span class="ruby-value str">'object_interface'</span>].<span class="ruby-identifier">empty?</span> <span class="ruby-identifier">options</span>[<span class="ruby-value str">'object_interface'</span>].<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span> <span class="ruby-identifier">cmds</span> = <span class="ruby-constant">YAML</span><span class="ruby-operator">::</span><span class="ruby-identifier">load_file</span>(<span class="ruby-node">"cmd/#{i}.yaml"</span>) <span class="ruby-identifier">cmds</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span> <span class="ruby-constant">Kernel</span><span class="ruby-operator">::</span><span class="ruby-identifier">load</span>(<span class="ruby-node">"cmd/#{i}/#{c.cmd}.rb"</span>) <span class="ruby-identifier">ocmdtable</span>.<span class="ruby-identifier">insert</span>(<span class="ruby-identifier">c</span>.<span class="ruby-identifier">name</span>, <span class="ruby-identifier">c</span>) <span class="ruby-keyword kw">end</span> <span class="ruby-constant">GameObject</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">:include</span>,<span class="ruby-constant">ObjCmd</span>) <span class="ruby-keyword kw">end</span> <span class="ruby-keyword kw">else</span> <span class="ruby-ivar">@log</span>.<span class="ruby-identifier">warn</span> <span class="ruby-value str">"No command interfaces for GameObject"</span> <span class="ruby-keyword kw">end</span> <span class="ruby-comment cmt"># now load the commands for characters</span> <span class="ruby-identifier">cmdtable</span> = <span class="ruby-constant">TernaryTrie</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value str">'character_interface'</span>] <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-identifier">options</span>[<span class="ruby-value str">'character_interface'</span>].<span class="ruby-identifier">empty?</span> <span class="ruby-identifier">options</span>[<span class="ruby-value str">'character_interface'</span>].<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span> <span class="ruby-identifier">cmds</span> = <span class="ruby-constant">YAML</span><span class="ruby-operator">::</span><span class="ruby-identifier">load_file</span>(<span class="ruby-node">"cmd/#{i}.yaml"</span>) <span class="ruby-identifier">cmds</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span> <span class="ruby-constant">Kernel</span><span class="ruby-operator">::</span><span class="ruby-identifier">load</span>(<span class="ruby-node">"cmd/#{i}/#{c.cmd}.rb"</span>) <span class="ruby-identifier">cmdtable</span>.<span class="ruby-identifier">insert</span>(<span class="ruby-identifier">c</span>.<span class="ruby-identifier">name</span>, <span class="ruby-identifier">c</span>) <span class="ruby-keyword kw">end</span> <span class="ruby-constant">Character</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">:include</span>,<span class="ruby-constant">Cmd</span>) <span class="ruby-keyword kw">end</span> <span class="ruby-keyword kw">else</span> <span class="ruby-ivar">@log</span>.<span class="ruby-identifier">error</span> <span class="ruby-value str">"No command interfaces for Character"</span> <span class="ruby-keyword kw">end</span> <span class="ruby-ivar">@log</span>.<span class="ruby-identifier">info</span> <span class="ruby-value str">"Done."</span> <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">cmdtable</span>, <span class="ruby-identifier">ocmdtable</span> <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-ivar">@log</span>.<span class="ruby-identifier">error</span> <span class="ruby-identifier">$!</span> <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <div id="method-M000060" class="method-detail"> <a name="M000060"></a> <div class="method-heading"> <a href="#M000060" class="method-signature"> <span class="method-name">load</span><span class="method-args">()</span> </a> </div> <div class="method-description"> <p> <a href="Command.html#M000060">load</a> builds a command lookup trie from the commands listed in a yaml config file and in the and then defines/redefines them on the <a href="GameObject.html">GameObject</a> classes. </p> <dl> <dt><tt>return</tt></dt><dd>A trie of commands (see <a href="TernaryTrie.html">TernaryTrie</a> class) </dd> </dl> <p><a class="source-toggle" href="#" onclick="toggleCode('M000060-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000060-source"> <pre> <span class="ruby-comment cmt"># File lib/command.rb, line 37</span> <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">load</span> <span class="ruby-ivar">@log</span>.<span class="ruby-identifier">info</span> <span class="ruby-value str">"Loading commands..."</span> <span class="ruby-comment cmt"># first load the commands for objects</span> <span class="ruby-identifier">ocmdtable</span> = <span class="ruby-constant">TernaryTrie</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value str">'object_interface'</span>] <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-identifier">options</span>[<span class="ruby-value str">'object_interface'</span>].<span class="ruby-identifier">empty?</span> <span class="ruby-identifier">options</span>[<span class="ruby-value str">'object_interface'</span>].<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span> <span class="ruby-identifier">cmds</span> = <span class="ruby-constant">YAML</span><span class="ruby-operator">::</span><span class="ruby-identifier">load_file</span>(<span class="ruby-node">"cmd/#{i}.yaml"</span>) <span class="ruby-identifier">cmds</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span> <span class="ruby-constant">Kernel</span><span class="ruby-operator">::</span><span class="ruby-identifier">load</span>(<span class="ruby-node">"cmd/#{i}/#{c.cmd}.rb"</span>) <span class="ruby-identifier">ocmdtable</span>.<span class="ruby-identifier">insert</span>(<span class="ruby-identifier">c</span>.<span class="ruby-identifier">name</span>, <span class="ruby-identifier">c</span>) <span class="ruby-keyword kw">end</span> <span class="ruby-constant">GameObject</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">:include</span>,<span class="ruby-constant">ObjCmd</span>) <span class="ruby-keyword kw">end</span> <span class="ruby-keyword kw">else</span> <span class="ruby-ivar">@log</span>.<span class="ruby-identifier">warn</span> <span class="ruby-value str">"No command interfaces for GameObject"</span> <span class="ruby-keyword kw">end</span> <span class="ruby-comment cmt"># now load the commands for characters</span> <span class="ruby-identifier">cmdtable</span> = <span class="ruby-constant">TernaryTrie</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value str">'character_interface'</span>] <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-identifier">options</span>[<span class="ruby-value str">'character_interface'</span>].<span class="ruby-identifier">empty?</span> <span class="ruby-identifier">options</span>[<span class="ruby-value str">'character_interface'</span>].<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span> <span class="ruby-identifier">cmds</span> = <span class="ruby-constant">YAML</span><span class="ruby-operator">::</span><span class="ruby-identifier">load_file</span>(<span class="ruby-node">"cmd/#{i}.yaml"</span>) <span class="ruby-identifier">cmds</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span> <span class="ruby-constant">Kernel</span><span class="ruby-operator">::</span><span class="ruby-identifier">load</span>(<span class="ruby-node">"cmd/#{i}/#{c.cmd}.rb"</span>) <span class="ruby-identifier">cmdtable</span>.<span class="ruby-identifier">insert</span>(<span class="ruby-identifier">c</span>.<span class="ruby-identifier">name</span>, <span class="ruby-identifier">c</span>) <span class="ruby-keyword kw">end</span> <span class="ruby-constant">Character</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">:include</span>,<span class="ruby-constant">Cmd</span>) <span class="ruby-keyword kw">end</span> <span class="ruby-keyword kw">else</span> <span class="ruby-ivar">@log</span>.<span class="ruby-identifier">error</span> <span class="ruby-value str">"No command interfaces for Character"</span> <span class="ruby-keyword kw">end</span> <span class="ruby-ivar">@log</span>.<span class="ruby-identifier">info</span> <span class="ruby-value str">"Done."</span> <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">cmdtable</span>, <span class="ruby-identifier">ocmdtable</span> <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-ivar">@log</span>.<span class="ruby-identifier">error</span> <span class="ruby-identifier">$!</span> <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <div id="method-M000059" class="method-detail"> <a name="M000059"></a> <div class="method-heading"> <a href="#M000059" class="method-signature"> <span class="method-name">new</span><span class="method-args">(cmd, name, help)</span> </a> </div> <div class="method-description"> <p> Create a command </p> <p><a class="source-toggle" href="#" onclick="toggleCode('M000059-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000059-source"> <pre> <span class="ruby-comment cmt"># File lib/command.rb, line 29</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">cmd</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">help</span>) <span class="ruby-ivar">@cmd</span>,<span class="ruby-ivar">@name</span>,<span class="ruby-ivar">@help</span>=<span class="ruby-identifier">cmd</span>,<span class="ruby-identifier">name</span>,<span class="ruby-identifier">help</span> <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <div id="method-M000062" class="method-detail"> <a name="M000062"></a> <div class="method-heading"> <a href="#M000062" class="method-signature"> <span class="method-name">new</span><span class="method-args">(cmd, name, help)</span> </a> </div> <div class="method-description"> <p> Create a command </p> <p><a class="source-toggle" href="#" onclick="toggleCode('M000062-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000062-source"> <pre> <span class="ruby-comment cmt"># File lib/command.rb, line 29</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">cmd</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">help</span>) <span class="ruby-ivar">@cmd</span>,<span class="ruby-ivar">@name</span>,<span class="ruby-ivar">@help</span>=<span class="ruby-identifier">cmd</span>,<span class="ruby-identifier">name</span>,<span class="ruby-identifier">help</span> <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <div id="method-M000061" class="method-detail"> <a name="M000061"></a> <div class="method-heading"> <a href="#M000061" class="method-signature"> <span class="method-name">options</span><span class="method-args">()</span> </a> </div> <div class="method-description"> <p> We need <a href="Command.html#M000061">options</a> at class level </p> <p><a class="source-toggle" href="#" onclick="toggleCode('M000061-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000061-source"> <pre> <span class="ruby-comment cmt"># File lib/command.rb, line 77</span> <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">options</span> <span class="ruby-constant">Configuration</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">options</span> <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <div id="method-M000064" class="method-detail"> <a name="M000064"></a> <div class="method-heading"> <a href="#M000064" class="method-signature"> <span class="method-name">options</span><span class="method-args">()</span> </a> </div> <div class="method-description"> <p> We need <a href="Command.html#M000061">options</a> at class level </p> <p><a class="source-toggle" href="#" onclick="toggleCode('M000064-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000064-source"> <pre> <span class="ruby-comment cmt"># File lib/command.rb, line 77</span> <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">options</span> <span class="ruby-constant">Configuration</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">options</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>