<?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="15,17,89,65" href="Command.html" alt="Command
">
</map>
<img src="../dot/f_8.png" usemap="#map" border=0 alt="TopLevel">
</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="#M000145">load</a>
<a href="#M000142">load</a>
<a href="#M000141">new</a>
<a href="#M000144">new</a>
<a href="#M000143">options</a>
<a href="#M000146">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-M000145" class="method-detail">
<a name="M000145"></a>
<div class="method-heading">
<a href="Command.src/M000145.html" target="Code" class="method-signature"
onclick="popupCode('Command.src/M000145.html');return false;">
<span class="method-name">load</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
load 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>
</div>
</div>
<div id="method-M000142" class="method-detail">
<a name="M000142"></a>
<div class="method-heading">
<a href="Command.src/M000142.html" target="Code" class="method-signature"
onclick="popupCode('Command.src/M000142.html');return false;">
<span class="method-name">load</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
load 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>
</div>
</div>
<div id="method-M000141" class="method-detail">
<a name="M000141"></a>
<div class="method-heading">
<a href="Command.src/M000141.html" target="Code" class="method-signature"
onclick="popupCode('Command.src/M000141.html');return false;">
<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>
</div>
</div>
<div id="method-M000144" class="method-detail">
<a name="M000144"></a>
<div class="method-heading">
<a href="Command.src/M000144.html" target="Code" class="method-signature"
onclick="popupCode('Command.src/M000144.html');return false;">
<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>
</div>
</div>
<div id="method-M000143" class="method-detail">
<a name="M000143"></a>
<div class="method-heading">
<a href="Command.src/M000143.html" target="Code" class="method-signature"
onclick="popupCode('Command.src/M000143.html');return false;">
<span class="method-name">options</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
We need options at class level
</p>
</div>
</div>
<div id="method-M000146" class="method-detail">
<a name="M000146"></a>
<div class="method-heading">
<a href="Command.src/M000146.html" target="Code" class="method-signature"
onclick="popupCode('Command.src/M000146.html');return false;">
<span class="method-name">options</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
We need options at class level
</p>
</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>
