<?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: Room</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">Room</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../files/lib/core/room_rb.html">
lib/core/room.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="17,101,89,149" href="Room.html" alt="Room
" />
<area shape="rect" coords="5,5,101,53" href="GameObject.html" alt="GameObject
" />
</map>
<img src="../dot/f_13.png" usemap="#map" border="0" alt="dot/f_13.png">
</div>
<div id="description">
<p>
The <a href="Room.html">Room</a> class is the mother of all rooms.
</p>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000179">arrive</a>
<a href="#M000177">describe</a>
<a href="#M000178">describe_exits</a>
<a href="#M000176">new</a>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Class methods</h3>
<div id="method-M000176" class="method-detail">
<a name="M000176"></a>
<div class="method-heading">
<a href="#M000176" class="method-signature">
<span class="method-name">new</span><span class="method-args">(name, owner)</span>
</a>
</div>
<div class="method-description">
<p>
Create a <a href="Room.html#M000176">new</a> <a href="Room.html">Room</a>
object
</p>
<dl>
<dt><tt>name</tt></dt><dd>The displayed name of the room
</dd>
<dt><tt>owner</tt></dt><dd>The owner id of this room
</dd>
<dt><tt>return</tt></dt><dd>A handle to the <a href="Room.html#M000176">new</a> <a
href="Room.html">Room</a>.
</dd>
</dl>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000176-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000176-source">
<pre>
<span class="ruby-comment cmt"># File lib/core/room.rb, line 28</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">owner</span>)
<span class="ruby-keyword kw">super</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">owner</span>)
<span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">exits</span>=[] <span class="ruby-comment cmt"># The list of exits for this room.</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000179" class="method-detail">
<a name="M000179"></a>
<div class="method-heading">
<a href="#M000179" class="method-signature">
<span class="method-name">arrive</span><span class="method-args">(e)</span>
</a>
</div>
<div class="method-description">
<p>
<a href="Event.html">Event</a> :<a href="Room.html#M000179">arrive</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('M000179-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000179-source">
<pre>
<span class="ruby-comment cmt"># File lib/core/room.rb, line 71</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">arrive</span>(<span class="ruby-identifier">e</span>)
<span class="ruby-identifier">ch</span> = <span class="ruby-identifier">get_object</span>(<span class="ruby-identifier">e</span>.<span class="ruby-identifier">msg</span>)
<span class="ruby-comment cmt"># add character</span>
<span class="ruby-identifier">add_contents</span>(<span class="ruby-identifier">ch</span>.<span class="ruby-identifier">id</span>)
<span class="ruby-identifier">ch</span>.<span class="ruby-identifier">location</span> = <span class="ruby-identifier">id</span>
<span class="ruby-identifier">characters</span>(<span class="ruby-identifier">e</span>.<span class="ruby-identifier">msg</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">add_event</span>(<span class="ruby-identifier">id</span>,<span class="ruby-identifier">x</span>.<span class="ruby-identifier">id</span>,<span class="ruby-identifier">:show</span>, <span class="ruby-identifier">ch</span>.<span class="ruby-identifier">name</span><span class="ruby-operator">+</span><span class="ruby-value str">" has arrived."</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">x</span>.<span class="ruby-identifier">account</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-identifier">ch</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-value str">'look'</span>)
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000177" class="method-detail">
<a name="M000177"></a>
<div class="method-heading">
<a href="#M000177" 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="Room.html#M000177">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('M000177-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000177-source">
<pre>
<span class="ruby-comment cmt"># File lib/core/room.rb, line 36</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 Green](#{id.to_s}) #{name}[/COLOR]\n#{desc}\n"</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-M000178" class="method-detail">
<a name="M000178"></a>
<div class="method-heading">
<a href="#M000178" class="method-signature">
<span class="method-name">describe_exits</span><span class="method-args">(e)</span>
</a>
</div>
<div class="method-description">
<p>
<a href="Event.html">Event</a> :<a
href="Room.html#M000178">describe_exits</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('M000178-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000178-source">
<pre>
<span class="ruby-comment cmt"># File lib/core/room.rb, line 44</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">describe_exits</span>(<span class="ruby-identifier">e</span>)
<span class="ruby-identifier">msg</span> = <span class="ruby-value str">"[COLOR Red]Exits:\n"</span>
<span class="ruby-identifier">s</span> = <span class="ruby-identifier">exits</span>.<span class="ruby-identifier">size</span>
<span class="ruby-keyword kw">if</span> <span class="ruby-identifier">s</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
<span class="ruby-identifier">msg</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">"None.[/COLOR]"</span>
<span class="ruby-keyword kw">else</span>
<span class="ruby-identifier">i</span> = <span class="ruby-value">0</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">ex</span> = <span class="ruby-identifier">get_object</span>(<span class="ruby-identifier">exid</span>)
<span class="ruby-identifier">key</span> = <span class="ruby-identifier">ex</span>.<span class="ruby-identifier">name</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp re">/;/</span>).<span class="ruby-identifier">first</span>
<span class="ruby-identifier">msg</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">key</span>
<span class="ruby-identifier">i</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
<span class="ruby-keyword kw">case</span> <span class="ruby-identifier">s</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">i</span>
<span class="ruby-keyword kw">when</span> <span class="ruby-value">1</span> <span class="ruby-keyword kw">then</span> <span class="ruby-identifier">s</span> <span class="ruby-operator">></span> <span class="ruby-value">2</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">msg</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">", and "</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">msg</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">" and "</span>
<span class="ruby-keyword kw">when</span> <span class="ruby-value">0</span> <span class="ruby-keyword kw">then</span> <span class="ruby-identifier">msg</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">"."</span>
<span class="ruby-keyword kw">else</span>
<span class="ruby-identifier">msg</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">", "</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-identifier">msg</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">"[/COLOR]"</span>
<span class="ruby-keyword kw">end</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>
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>
</body>
</html>
