<?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: GameObject</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">GameObject</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../files/lib/core/gameobject_rb.html">
lib/core/gameobject.rb
</a>
<br />
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Parent:</strong></td>
<td>
<a href="Root.html">
Root
</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="25,113,113,161" href="GameObject.html" alt="GameObject
">
<area shape="RECT" coords="33,17,105,65" href="Root.html" alt="Root
">
</map>
<img src="../dot/f_12.png" usemap="#map" border=0 alt="TopLevel">
</div>
<div id="description">
<p>
The <a href="GameObject.html">GameObject</a> class is no longer the mother
of all objects.
</p>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000170">add_contents</a>
<a href="#M000173">add_trigger</a>
<a href="#M000178">characters</a>
<a href="#M000171">delete_contents</a>
<a href="#M000174">delete_trigger</a>
<a href="#M000180">describe</a>
<a href="#M000182">drop</a>
<a href="#M000181">get</a>
<a href="#M000172">get_contents</a>
<a href="#M000175">get_trigger</a>
<a href="#M000176">get_triggers</a>
<a href="#M000169">new</a>
<a href="#M000177">objects</a>
<a href="#M000179">parse</a>
<a href="#M000183">timer</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-M000169" class="method-detail">
<a name="M000169"></a>
<div class="method-heading">
<a href="GameObject.src/M000169.html" target="Code" class="method-signature"
onclick="popupCode('GameObject.src/M000169.html');return false;">
<span class="method-name">new</span><span class="method-args">(name, owner, location=nil)</span>
</a>
</div>
<div class="method-description">
<p>
Create a new Object
</p>
<dl>
<dt><tt>name</tt></dt><dd>Every object needs a name
</dd>
<dt><tt>owner</tt></dt><dd>The owner id of this object
</dd>
<dt><tt>location</tt></dt><dd>The object id containing this object or nil.
</dd>
<dt><tt>return</tt></dt><dd>A handle to the new Object
</dd>
</dl>
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000170" class="method-detail">
<a name="M000170"></a>
<div class="method-heading">
<a href="GameObject.src/M000170.html" target="Code" class="method-signature"
onclick="popupCode('GameObject.src/M000170.html');return false;">
<span class="method-name">add_contents</span><span class="method-args">(oid)</span>
</a>
</div>
<div class="method-description">
<p>
Add an object to the contents of this object
</p>
<dl>
<dt><tt>oid</tt></dt><dd>The object id to add
</dd>
</dl>
</div>
</div>
<div id="method-M000173" class="method-detail">
<a name="M000173"></a>
<div class="method-heading">
<a href="GameObject.src/M000173.html" target="Code" class="method-signature"
onclick="popupCode('GameObject.src/M000173.html');return false;">
<span class="method-name">add_trigger</span><span class="method-args">(event, sid)</span>
</a>
</div>
<div class="method-description">
<p>
Add a trigger script to this object
</p>
<dl>
<dt><tt>s</tt></dt><dd>The script to add
</dd>
</dl>
</div>
</div>
<div id="method-M000178" class="method-detail">
<a name="M000178"></a>
<div class="method-heading">
<a href="GameObject.src/M000178.html" target="Code" class="method-signature"
onclick="popupCode('GameObject.src/M000178.html');return false;">
<span class="method-name">characters</span><span class="method-args">(exempt=nil)</span>
</a>
</div>
<div class="method-description">
<p>
Finds all the characters contained in this object except the passed
character.
</p>
<dl>
<dt><tt>exempt</tt></dt><dd>The character id exempted from the list.
</dd>
<dt><tt>return</tt></dt><dd>Handle to a list of the <a href="Character.html">Character</a> objects.
</dd>
</dl>
</div>
</div>
<div id="method-M000171" class="method-detail">
<a name="M000171"></a>
<div class="method-heading">
<a href="GameObject.src/M000171.html" target="Code" class="method-signature"
onclick="popupCode('GameObject.src/M000171.html');return false;">
<span class="method-name">delete_contents</span><span class="method-args">(oid)</span>
</a>
</div>
<div class="method-description">
<p>
Deletes an object from the contents of this object
</p>
<dl>
<dt><tt>oid</tt></dt><dd>The object id to delete
</dd>
</dl>
</div>
</div>
<div id="method-M000174" class="method-detail">
<a name="M000174"></a>
<div class="method-heading">
<a href="GameObject.src/M000174.html" target="Code" class="method-signature"
onclick="popupCode('GameObject.src/M000174.html');return false;">
<span class="method-name">delete_trigger</span><span class="method-args">(event)</span>
</a>
</div>
<div class="method-description">
<p>
Deletes a trigger script from this object
</p>
<dl>
<dt><tt>event</tt></dt><dd>The trigger event type to delete
</dd>
</dl>
</div>
</div>
<div id="method-M000180" class="method-detail">
<a name="M000180"></a>
<div class="method-heading">
<a href="GameObject.src/M000180.html" target="Code" class="method-signature"
onclick="popupCode('GameObject.src/M000180.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-M000182" class="method-detail">
<a name="M000182"></a>
<div class="method-heading">
<a href="GameObject.src/M000182.html" target="Code" class="method-signature"
onclick="popupCode('GameObject.src/M000182.html');return false;">
<span class="method-name">drop</span><span class="method-args">(e)</span>
</a>
</div>
<div class="method-description">
<p>
<a href="Event.html">Event</a> :drop
</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-M000181" class="method-detail">
<a name="M000181"></a>
<div class="method-heading">
<a href="GameObject.src/M000181.html" target="Code" class="method-signature"
onclick="popupCode('GameObject.src/M000181.html');return false;">
<span class="method-name">get</span><span class="method-args">(e)</span>
</a>
</div>
<div class="method-description">
<p>
<a href="Event.html">Event</a> :get
</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-M000172" class="method-detail">
<a name="M000172"></a>
<div class="method-heading">
<a href="GameObject.src/M000172.html" target="Code" class="method-signature"
onclick="popupCode('GameObject.src/M000172.html');return false;">
<span class="method-name">get_contents</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Returns the contents of the object
</p>
<dl>
<dt><tt>return</tt></dt><dd>An array of object ids
</dd>
</dl>
</div>
</div>
<div id="method-M000175" class="method-detail">
<a name="M000175"></a>
<div class="method-heading">
<a href="GameObject.src/M000175.html" target="Code" class="method-signature"
onclick="popupCode('GameObject.src/M000175.html');return false;">
<span class="method-name">get_trigger</span><span class="method-args">(event)</span>
</a>
</div>
<div class="method-description">
<p>
Returns a specific trigger script from the object
</p>
<dl>
<dt><tt>event</tt></dt><dd>The trigger event type to retrieve
</dd>
<dt><tt>return</tt></dt><dd>A trigger or nil
</dd>
</dl>
</div>
</div>
<div id="method-M000176" class="method-detail">
<a name="M000176"></a>
<div class="method-heading">
<a href="GameObject.src/M000176.html" target="Code" class="method-signature"
onclick="popupCode('GameObject.src/M000176.html');return false;">
<span class="method-name">get_triggers</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Returns the trigger scripts on the object
</p>
<dl>
<dt><tt>return</tt></dt><dd>An array of trigger scripts
</dd>
</dl>
</div>
</div>
<div id="method-M000177" class="method-detail">
<a name="M000177"></a>
<div class="method-heading">
<a href="GameObject.src/M000177.html" target="Code" class="method-signature"
onclick="popupCode('GameObject.src/M000177.html');return false;">
<span class="method-name">objects</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Finds all objects contained in this object
</p>
<dl>
<dt><tt>return</tt></dt><dd>Handle to a array of the objects.
</dd>
</dl>
</div>
</div>
<div id="method-M000179" class="method-detail">
<a name="M000179"></a>
<div class="method-heading">
<a href="GameObject.src/M000179.html" target="Code" class="method-signature"
onclick="popupCode('GameObject.src/M000179.html');return false;">
<span class="method-name">parse</span><span class="method-args">(m)</span>
</a>
</div>
<div class="method-description">
<p>
All command input routed through here and parsed.
</p>
<dl>
<dt><tt>m</tt></dt><dd>The input message to be parsed
</dd>
<dt><tt>return</tt></dt><dd>false or true depending on whether command succeeded.
</dd>
</dl>
</div>
</div>
<div id="method-M000183" class="method-detail">
<a name="M000183"></a>
<div class="method-heading">
<a href="GameObject.src/M000183.html" target="Code" class="method-signature"
onclick="popupCode('GameObject.src/M000183.html');return false;">
<span class="method-name">timer</span><span class="method-args">(e)</span>
</a>
</div>
<div class="method-description">
<p>
<a href="Event.html">Event</a> :timer
</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>
