<?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,113,89,161" href="Room.html" alt="Room "> <area shape="RECT" coords="9,17,97,65" href="GameObject.html" alt="GameObject "> </map> <img src="../dot/f_13.png" usemap="#map" border=0 alt="TopLevel"> </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="#M000157">arrive</a> <a href="#M000155">describe</a> <a href="#M000156">describe_exits</a> <a href="#M000154">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-M000154" class="method-detail"> <a name="M000154"></a> <div class="method-heading"> <a href="Room.src/M000154.html" target="Code" class="method-signature" onclick="popupCode('Room.src/M000154.html');return false;"> <span class="method-name">new</span><span class="method-args">(name, owner)</span> </a> </div> <div class="method-description"> <p> Create a new <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 new <a href="Room.html">Room</a>. </dd> </dl> </div> </div> <h3 class="section-bar">Public Instance methods</h3> <div id="method-M000157" class="method-detail"> <a name="M000157"></a> <div class="method-heading"> <a href="Room.src/M000157.html" target="Code" class="method-signature" onclick="popupCode('Room.src/M000157.html');return false;"> <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> :arrive </p> <dl> <dt><tt>e</tt></dt><dd>The event </dd> <dt><tt>return</tt></dt><dd>Undefined </dd> </dl> </div> </div> <div id="method-M000155" class="method-detail"> <a name="M000155"></a> <div class="method-heading"> <a href="Room.src/M000155.html" target="Code" class="method-signature" onclick="popupCode('Room.src/M000155.html');return false;"> <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> :describe </p> <dl> <dt><tt>e</tt></dt><dd>The event </dd> <dt><tt>return</tt></dt><dd>Undefined </dd> </dl> </div> </div> <div id="method-M000156" class="method-detail"> <a name="M000156"></a> <div class="method-heading"> <a href="Room.src/M000156.html" target="Code" class="method-signature" onclick="popupCode('Room.src/M000156.html');return false;"> <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#M000156">describe_exits</a> </p> <dl> <dt><tt>e</tt></dt><dd>The event </dd> <dt><tt>return</tt></dt><dd>Undefined </dd> </dl> </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>