tmud-3.0.0/benchmark/
tmud-3.0.0/cmd/
tmud-3.0.0/cmd/objects/
tmud-3.0.0/cmd/tiny/
tmud-3.0.0/doc/SQLite/
tmud-3.0.0/doc/SQLite3/
tmud-3.0.0/doc/TernaryTrie/
tmud-3.0.0/farts/
tmud-3.0.0/lib/
tmud-3.0.0/lib/engine/
tmud-3.0.0/lib/farts/
tmud-3.0.0/logs/
<!DOCTYPE html>

<html>
<head>
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">

<title>class GameObject - TeensyMUD 3.0.0 Mud Server</title>

<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">

<script type="text/javascript">
  var rdoc_rel_prefix = "./";
</script>

<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>


<body id="top" class="class">
<nav id="metadata">
  <nav id="home-section" class="section">
  <h3 class="section-header">
    <a href="./index.html">Home</a>
    <a href="./table_of_contents.html#classes">Classes</a>
    <a href="./table_of_contents.html#methods">Methods</a>
  </h3>
</nav>


  <nav id="search-section" class="section project-section" class="initially-hidden">
  <form action="#" method="get" accept-charset="utf-8">
    <h3 class="section-header">
      <input type="text" name="search" placeholder="Search" id="search-field"
             title="Type to search, Up and Down to navigate, Enter to load">
    </h3>
  </form>

  <ul id="search-results" class="initially-hidden"></ul>
</nav>


  <div id="file-metadata">
    <nav id="file-list-section" class="section">
  <h3 class="section-header">Defined In</h3>
  <ul>
    <li>lib/core/gameobject.rb
  </ul>
</nav>

    
  </div>

  <div id="class-metadata">
    
    <nav id="parent-class-section" class="section">
  <h3 class="section-header">Parent</h3>
  
  <p class="link"><a href="Root.html">Root</a>
  
</nav>

    
    <!-- Method Quickref -->
<nav id="method-list-section" class="section">
  <h3 class="section-header">Methods</h3>

  <ul class="link-list">
    
    <li><a href="#method-c-new">::new</a>
    
    <li><a href="#method-i-add_contents">#add_contents</a>
    
    <li><a href="#method-i-add_trigger">#add_trigger</a>
    
    <li><a href="#method-i-characters">#characters</a>
    
    <li><a href="#method-i-delete_contents">#delete_contents</a>
    
    <li><a href="#method-i-delete_trigger">#delete_trigger</a>
    
    <li><a href="#method-i-describe">#describe</a>
    
    <li><a href="#method-i-drop">#drop</a>
    
    <li><a href="#method-i-get">#get</a>
    
    <li><a href="#method-i-get_contents">#get_contents</a>
    
    <li><a href="#method-i-get_trigger">#get_trigger</a>
    
    <li><a href="#method-i-get_triggers">#get_triggers</a>
    
    <li><a href="#method-i-objects">#objects</a>
    
    <li><a href="#method-i-parse">#parse</a>
    
    <li><a href="#method-i-timer">#timer</a>
    
  </ul>
</nav>

  </div>

  <div id="project-metadata">
    <nav id="fileindex-section" class="section project-section">
  <h3 class="section-header">Pages</h3>

  <ul>
  
    <li class="file"><a href="./README.html">README</a>
  
    <li class="file"><a href="./TML.html">TML</a>
  
  </ul>
</nav>

    <nav id="classindex-section" class="section project-section">
  <h3 class="section-header">Class and Module Index</h3>

  <ul class="link-list">
  
    <li><a href="./Farts.html">Farts</a>
  
    <li><a href="./Farts/AttributeSyntaxNode.html">Farts::AttributeSyntaxNode</a>
  
    <li><a href="./Farts/CallSyntaxNode.html">Farts::CallSyntaxNode</a>
  
    <li><a href="./Farts/CommandSyntaxNode.html">Farts::CommandSyntaxNode</a>
  
    <li><a href="./Farts/CommentSyntaxNode.html">Farts::CommentSyntaxNode</a>
  
    <li><a href="./Farts/EndSyntaxNode.html">Farts::EndSyntaxNode</a>
  
    <li><a href="./Farts/IfSyntaxNode.html">Farts::IfSyntaxNode</a>
  
    <li><a href="./Farts/Interpreter.html">Farts::Interpreter</a>
  
    <li><a href="./Farts/Lexer.html">Farts::Lexer</a>
  
    <li><a href="./Farts/Lib.html">Farts::Lib</a>
  
    <li><a href="./Farts/LiteralSyntaxNode.html">Farts::LiteralSyntaxNode</a>
  
    <li><a href="./Farts/LocalVarSyntaxNode.html">Farts::LocalVarSyntaxNode</a>
  
    <li><a href="./Farts/Parser.html">Farts::Parser</a>
  
    <li><a href="./Farts/ProgramSyntaxNode.html">Farts::ProgramSyntaxNode</a>
  
    <li><a href="./Farts/SyntaxNode.html">Farts::SyntaxNode</a>
  
    <li><a href="./SQLite.html">SQLite</a>
  
    <li><a href="./SQLite3.html">SQLite3</a>
  
    <li><a href="./SQLite3/Database.html">SQLite3::Database</a>
  
    <li><a href="./SQLite/Database.html">SQLite::Database</a>
  
    <li><a href="./TernaryTrie.html">TernaryTrie</a>
  
    <li><a href="./TernaryTrie/TNode.html">TernaryTrie::TNode</a>
  
    <li><a href="./ASCIICodes.html">ASCIICodes</a>
  
    <li><a href="./Acceptor.html">Acceptor</a>
  
    <li><a href="./Account.html">Account</a>
  
    <li><a href="./BoolExpParser.html">BoolExpParser</a>
  
    <li><a href="./CacheEntry.html">CacheEntry</a>
  
    <li><a href="./CacheManager.html">CacheManager</a>
  
    <li><a href="./CacheStats.html">CacheStats</a>
  
    <li><a href="./Character.html">Character</a>
  
    <li><a href="./Client.html">Client</a>
  
    <li><a href="./Cmd.html">Cmd</a>
  
    <li><a href="./ColorFilter.html">ColorFilter</a>
  
    <li><a href="./Command.html">Command</a>
  
    <li><a href="./Configuration.html">Configuration</a>
  
    <li><a href="./Connection.html">Connection</a>
  
    <li><a href="./Connector.html">Connector</a>
  
    <li><a href="./ConsoleClient.html">ConsoleClient</a>
  
    <li><a href="./CursesClient.html">CursesClient</a>
  
    <li><a href="./DbmStore.html">DbmStore</a>
  
    <li><a href="./DebugFilter.html">DebugFilter</a>
  
    <li><a href="./Dumper.html">Dumper</a>
  
    <li><a href="./Engine.html">Engine</a>
  
    <li><a href="./Event.html">Event</a>
  
    <li><a href="./EventManager.html">EventManager</a>
  
    <li><a href="./Exit.html">Exit</a>
  
    <li><a href="./Filter.html">Filter</a>
  
    <li><a href="./GameObject.html">GameObject</a>
  
    <li><a href="./GdbmStore.html">GdbmStore</a>
  
    <li><a href="./LineIO.html">LineIO</a>
  
    <li><a href="./Loader.html">Loader</a>
  
    <li><a href="./Log.html">Log</a>
  
    <li><a href="./Module.html">Module</a>
  
    <li><a href="./Obj.html">Obj</a>
  
    <li><a href="./ObjCmd.html">ObjCmd</a>
  
    <li><a href="./Object.html">Object</a>
  
    <li><a href="./PacketIO.html">PacketIO</a>
  
    <li><a href="./ProtocolStack.html">ProtocolStack</a>
  
    <li><a href="./Publisher.html">Publisher</a>
  
    <li><a href="./Reactor.html">Reactor</a>
  
    <li><a href="./Room.html">Room</a>
  
    <li><a href="./Root.html">Root</a>
  
    <li><a href="./Script.html">Script</a>
  
    <li><a href="./SdbmStore.html">SdbmStore</a>
  
    <li><a href="./Session.html">Session</a>
  
    <li><a href="./SockIO.html">SockIO</a>
  
    <li><a href="./Sqlite3Store.html">Sqlite3Store</a>
  
    <li><a href="./SqliteStore.html">SqliteStore</a>
  
    <li><a href="./Store.html">Store</a>
  
    <li><a href="./String.html">String</a>
  
    <li><a href="./TelnetCodes.html">TelnetCodes</a>
  
    <li><a href="./TelnetFilter.html">TelnetFilter</a>
  
    <li><a href="./TerminalFilter.html">TerminalFilter</a>
  
    <li><a href="./Timer.html">Timer</a>
  
    <li><a href="./Utility.html">Utility</a>
  
    <li><a href="./VT100Codes.html">VT100Codes</a>
  
    <li><a href="./World.html">World</a>
  
    <li><a href="./XmlStore.html">XmlStore</a>
  
    <li><a href="./YamlStore.html">YamlStore</a>
  
  </ul>
</nav>

  </div>
</nav>

<div id="documentation">
  <h1 class="class">class GameObject</h1>

  <div id="description" class="description">
    
<p>The <a href="GameObject.html">GameObject</a> class is no longer the mother
of all objects.</p>

  </div><!-- description -->

  
  
  
  <section id="5Buntitled-5D" class="documentation-section">
    

    

    

    

    <!-- Methods -->
    
     <section id="public-class-5Buntitled-5D-method-details" class="method-section section">
      <h3 class="section-header">Public Class Methods</h3>

    
      <div id="method-c-new" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">new</span><span
            class="method-args">(name, owner, location=nil)</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          <p>Create a new <a href="Object.html">Object</a></p>
<dl class="rdoc-list label-list"><dt><code>name</code>
<dd>
<p>Every object needs a name</p>
</dd><dt><code>owner</code>
<dd>
<p>The owner id of this object</p>
</dd><dt><code>location</code>
<dd>
<p>The object id containing this object or nil.</p>
</dd><dt><code>return</code>
<dd>
<p>A handle to the new <a href="Object.html">Object</a></p>
</dd></dl>
          

          
          <div class="method-source-code" id="new-source">
            <pre><span class="ruby-comment"># File lib/core/gameobject.rb, line 30</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">owner</span>, <span class="ruby-identifier">location</span>=<span class="ruby-keyword">nil</span>)
  <span class="ruby-keyword">super</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">owner</span>)
  <span class="ruby-keyword">self</span>.<span class="ruby-identifier">location</span> = <span class="ruby-identifier">location</span>    <span class="ruby-comment"># The location of this object or nil if none</span>
  <span class="ruby-keyword">self</span>.<span class="ruby-identifier">contents</span> = []
  <span class="ruby-keyword">self</span>.<span class="ruby-identifier">triggers</span> = {}
  <span class="ruby-keyword">self</span>.<span class="ruby-identifier">msgfail</span> = <span class="ruby-string">''</span>
  <span class="ruby-keyword">self</span>.<span class="ruby-identifier">msgsucc</span> = <span class="ruby-string">''</span>
<span class="ruby-keyword">end</span></pre>
          </div><!-- new-source -->
          
        </div>

        

        
      </div><!-- new-method -->

    
    </section><!-- public-class-method-details -->
  
     <section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
      <h3 class="section-header">Public Instance Methods</h3>

    
      <div id="method-i-add_contents" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">add_contents</span><span
            class="method-args">(oid)</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          <p>Add an object to the contents of this object</p>
<dl class="rdoc-list label-list"><dt><code>oid</code>
<dd>
<p>The object id to add</p>
</dd></dl>
          

          
          <div class="method-source-code" id="add_contents-source">
            <pre><span class="ruby-comment"># File lib/core/gameobject.rb, line 41</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">add_contents</span>(<span class="ruby-identifier">oid</span>)
  <span class="ruby-keyword">if</span> <span class="ruby-identifier">contents</span>.<span class="ruby-identifier">include?</span> <span class="ruby-identifier">oid</span>
    <span class="ruby-identifier">log</span>.<span class="ruby-identifier">error</span> <span class="ruby-node">&quot;Object #{oid} already in contents of #{id}&quot;</span>
  <span class="ruby-keyword">else</span>
    <span class="ruby-identifier">contents</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">oid</span>
  <span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
          </div><!-- add_contents-source -->
          
        </div>

        

        
      </div><!-- add_contents-method -->

    
      <div id="method-i-add_trigger" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">add_trigger</span><span
            class="method-args">(event, sid)</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          <p>Add a trigger script to this object</p>
<dl class="rdoc-list label-list"><dt><code>s</code>
<dd>
<p>The script to add</p>
</dd></dl>
          

          
          <div class="method-source-code" id="add_trigger-source">
            <pre><span class="ruby-comment"># File lib/core/gameobject.rb, line 67</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">add_trigger</span>(<span class="ruby-identifier">event</span>, <span class="ruby-identifier">sid</span>)
  <span class="ruby-identifier">event</span> = <span class="ruby-identifier">event</span>.<span class="ruby-identifier">intern</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">event</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:to_str</span>)
  <span class="ruby-identifier">triggers</span>[<span class="ruby-identifier">event</span>] = <span class="ruby-identifier">sid</span>
<span class="ruby-keyword">end</span></pre>
          </div><!-- add_trigger-source -->
          
        </div>

        

        
      </div><!-- add_trigger-method -->

    
      <div id="method-i-characters" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">characters</span><span
            class="method-args">(exempt=nil)</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          <p>Finds all the characters contained in this object except the passed
character.</p>
<dl class="rdoc-list label-list"><dt><code>exempt</code>
<dd>
<p>The character id exempted from the list.</p>
</dd><dt><code>return</code>
<dd>
<p>Handle to a list of the <a href="Character.html">Character</a> objects.</p>
</dd></dl>
          

          
          <div class="method-source-code" id="characters-source">
            <pre><span class="ruby-comment"># File lib/core/gameobject.rb, line 106</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">characters</span>(<span class="ruby-identifier">exempt</span>=<span class="ruby-keyword">nil</span>)
  <span class="ruby-identifier">ary</span> = <span class="ruby-identifier">contents</span>.<span class="ruby-identifier">collect</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">oid</span><span class="ruby-operator">|</span>
    <span class="ruby-identifier">o</span> = <span class="ruby-identifier">get_object</span>(<span class="ruby-identifier">oid</span>)
    (<span class="ruby-identifier">o</span>.<span class="ruby-identifier">class</span> <span class="ruby-operator">==</span> <span class="ruby-constant">Character</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">oid</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">exempt</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">o</span>.<span class="ruby-identifier">account</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">o</span> <span class="ruby-operator">:</span> <span class="ruby-keyword">nil</span>
  <span class="ruby-keyword">end</span>
  <span class="ruby-identifier">ary</span>.<span class="ruby-identifier">compact</span>
<span class="ruby-keyword">end</span></pre>
          </div><!-- characters-source -->
          
        </div>

        

        
      </div><!-- characters-method -->

    
      <div id="method-i-delete_contents" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">delete_contents</span><span
            class="method-args">(oid)</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          <p>Deletes an object from the contents of this object</p>
<dl class="rdoc-list label-list"><dt><code>oid</code>
<dd>
<p>The object id to delete</p>
</dd></dl>
          

          
          <div class="method-source-code" id="delete_contents-source">
            <pre><span class="ruby-comment"># File lib/core/gameobject.rb, line 51</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">delete_contents</span>(<span class="ruby-identifier">oid</span>)
  <span class="ruby-identifier">d</span> = <span class="ruby-identifier">contents</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">oid</span>)
  <span class="ruby-keyword">if</span> <span class="ruby-identifier">d</span>.<span class="ruby-identifier">nil?</span>
    <span class="ruby-identifier">log</span>.<span class="ruby-identifier">error</span> <span class="ruby-node">&quot;Object #{oid} not in contents of #{id}&quot;</span>
  <span class="ruby-keyword">end</span>
  <span class="ruby-identifier">d</span>
<span class="ruby-keyword">end</span></pre>
          </div><!-- delete_contents-source -->
          
        </div>

        

        
      </div><!-- delete_contents-method -->

    
      <div id="method-i-delete_trigger" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">delete_trigger</span><span
            class="method-args">(event)</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          <p>Deletes a trigger script from this object</p>
<dl class="rdoc-list label-list"><dt><code>event</code>
<dd>
<p>The trigger event type to delete</p>
</dd></dl>
          

          
          <div class="method-source-code" id="delete_trigger-source">
            <pre><span class="ruby-comment"># File lib/core/gameobject.rb, line 74</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">delete_trigger</span>(<span class="ruby-identifier">event</span>)
  <span class="ruby-identifier">event</span> = <span class="ruby-identifier">event</span>.<span class="ruby-identifier">intern</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">event</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:to_str</span>)
  <span class="ruby-identifier">triggers</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">event</span>)
<span class="ruby-keyword">end</span></pre>
          </div><!-- delete_trigger-source -->
          
        </div>

        

        
      </div><!-- delete_trigger-method -->

    
      <div id="method-i-describe" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">describe</span><span
            class="method-args">(e)</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          <p><a href="Event.html">Event</a> :describe</p>
<dl class="rdoc-list label-list"><dt><code>e</code>
<dd>
<p>The event</p>
</dd><dt><code>return</code>
<dd>
<p>Undefined</p>
</dd></dl>
          

          
          <div class="method-source-code" id="describe-source">
            <pre><span class="ruby-comment"># File lib/core/gameobject.rb, line 141</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">describe</span>(<span class="ruby-identifier">e</span>)
  <span class="ruby-identifier">msg</span> = <span class="ruby-node">&quot;[COLOR Yellow]A #{name} is here[/COLOR]&quot;</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-value">:show</span>,<span class="ruby-identifier">msg</span>)
<span class="ruby-keyword">end</span></pre>
          </div><!-- describe-source -->
          
        </div>

        

        
      </div><!-- describe-method -->

    
      <div id="method-i-drop" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">drop</span><span
            class="method-args">(e)</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          <p><a href="Event.html">Event</a> :drop</p>
<dl class="rdoc-list label-list"><dt><code>e</code>
<dd>
<p>The event</p>
</dd><dt><code>return</code>
<dd>
<p>Undefined</p>
</dd></dl>
          

          
          <div class="method-source-code" id="drop-source">
            <pre><span class="ruby-comment"># File lib/core/gameobject.rb, line 163</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">drop</span>(<span class="ruby-identifier">e</span>)
  <span class="ruby-identifier">plyr</span> = <span class="ruby-identifier">get_object</span>(<span class="ruby-identifier">e</span>.<span class="ruby-identifier">from</span>)
  <span class="ruby-identifier">place</span> = <span class="ruby-identifier">get_object</span>(<span class="ruby-identifier">plyr</span>.<span class="ruby-identifier">location</span>)
  <span class="ruby-comment"># remove it</span>
  <span class="ruby-identifier">plyr</span>.<span class="ruby-identifier">delete_contents</span>(<span class="ruby-identifier">id</span>)
  <span class="ruby-comment"># add it</span>
  <span class="ruby-identifier">place</span>.<span class="ruby-identifier">add_contents</span>(<span class="ruby-identifier">id</span>)
  <span class="ruby-keyword">self</span>.<span class="ruby-identifier">location</span> = <span class="ruby-identifier">place</span>.<span class="ruby-identifier">id</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-value">:show</span>,<span class="ruby-node">&quot;You drop the #{name}&quot;</span>)
<span class="ruby-keyword">end</span></pre>
          </div><!-- drop-source -->
          
        </div>

        

        
      </div><!-- drop-method -->

    
      <div id="method-i-get" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">get</span><span
            class="method-args">(e)</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          <p><a href="Event.html">Event</a> :get</p>
<dl class="rdoc-list label-list"><dt><code>e</code>
<dd>
<p>The event</p>
</dd><dt><code>return</code>
<dd>
<p>Undefined</p>
</dd></dl>
          

          
          <div class="method-source-code" id="get-source">
            <pre><span class="ruby-comment"># File lib/core/gameobject.rb, line 149</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">get</span>(<span class="ruby-identifier">e</span>)
  <span class="ruby-identifier">plyr</span> = <span class="ruby-identifier">get_object</span>(<span class="ruby-identifier">e</span>.<span class="ruby-identifier">from</span>)
  <span class="ruby-identifier">place</span> = <span class="ruby-identifier">get_object</span>(<span class="ruby-identifier">location</span>)
  <span class="ruby-comment"># remove it</span>
  <span class="ruby-identifier">place</span>.<span class="ruby-identifier">delete_contents</span>(<span class="ruby-identifier">id</span>)
  <span class="ruby-comment"># add it</span>
  <span class="ruby-identifier">plyr</span>.<span class="ruby-identifier">add_contents</span>(<span class="ruby-identifier">id</span>)
  <span class="ruby-keyword">self</span>.<span class="ruby-identifier">location</span> = <span class="ruby-identifier">plyr</span>.<span class="ruby-identifier">id</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-value">:show</span>,<span class="ruby-node">&quot;You get the #{name}&quot;</span>)
<span class="ruby-keyword">end</span></pre>
          </div><!-- get-source -->
          
        </div>

        

        
      </div><!-- get-method -->

    
      <div id="method-i-get_contents" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">get_contents</span><span
            class="method-args">()</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          <p>Returns the contents of the object</p>
<dl class="rdoc-list label-list"><dt><code>return</code>
<dd>
<p>An array of object ids</p>
</dd></dl>
          

          
          <div class="method-source-code" id="get_contents-source">
            <pre><span class="ruby-comment"># File lib/core/gameobject.rb, line 61</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_contents</span>
  <span class="ruby-identifier">contents</span> <span class="ruby-operator">||</span> []
<span class="ruby-keyword">end</span></pre>
          </div><!-- get_contents-source -->
          
        </div>

        

        
      </div><!-- get_contents-method -->

    
      <div id="method-i-get_trigger" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">get_trigger</span><span
            class="method-args">(event)</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          <p>Returns a specific trigger script from the object</p>
<dl class="rdoc-list label-list"><dt><code>event</code>
<dd>
<p>The trigger event type to retrieve</p>
</dd><dt><code>return</code>
<dd>
<p>A trigger or nil</p>
</dd></dl>
          

          
          <div class="method-source-code" id="get_trigger-source">
            <pre><span class="ruby-comment"># File lib/core/gameobject.rb, line 82</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_trigger</span>(<span class="ruby-identifier">event</span>)
  <span class="ruby-identifier">event</span> = <span class="ruby-identifier">event</span>.<span class="ruby-identifier">intern</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">event</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:to_str</span>)
  <span class="ruby-identifier">triggers</span>[<span class="ruby-identifier">event</span>]
<span class="ruby-keyword">end</span></pre>
          </div><!-- get_trigger-source -->
          
        </div>

        

        
      </div><!-- get_trigger-method -->

    
      <div id="method-i-get_triggers" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">get_triggers</span><span
            class="method-args">()</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          <p>Returns the trigger scripts on the object</p>
<dl class="rdoc-list label-list"><dt><code>return</code>
<dd>
<p>An array of trigger scripts</p>
</dd></dl>
          

          
          <div class="method-source-code" id="get_triggers-source">
            <pre><span class="ruby-comment"># File lib/core/gameobject.rb, line 89</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_triggers</span>
  <span class="ruby-identifier">triggers</span>.<span class="ruby-identifier">values</span>
<span class="ruby-keyword">end</span></pre>
          </div><!-- get_triggers-source -->
          
        </div>

        

        
      </div><!-- get_triggers-method -->

    
      <div id="method-i-objects" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">objects</span><span
            class="method-args">()</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          <p>Finds all objects contained in this object</p>
<dl class="rdoc-list label-list"><dt><code>return</code>
<dd>
<p>Handle to a array of the objects.</p>
</dd></dl>
          

          
          <div class="method-source-code" id="objects-source">
            <pre><span class="ruby-comment"># File lib/core/gameobject.rb, line 95</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">objects</span>
  <span class="ruby-identifier">ary</span> = <span class="ruby-identifier">contents</span>.<span class="ruby-identifier">collect</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">oid</span><span class="ruby-operator">|</span>
    <span class="ruby-identifier">o</span> = <span class="ruby-identifier">get_object</span>(<span class="ruby-identifier">oid</span>)
    <span class="ruby-identifier">o</span>.<span class="ruby-identifier">class</span> <span class="ruby-operator">==</span> <span class="ruby-constant">GameObject</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">o</span> <span class="ruby-operator">:</span> <span class="ruby-keyword">nil</span>
  <span class="ruby-keyword">end</span>
  <span class="ruby-identifier">ary</span>.<span class="ruby-identifier">compact</span>
<span class="ruby-keyword">end</span></pre>
          </div><!-- objects-source -->
          
        </div>

        

        
      </div><!-- objects-method -->

    
      <div id="method-i-parse" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">parse</span><span
            class="method-args">(m)</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          <p>All command input routed through here and parsed.</p>
<dl class="rdoc-list label-list"><dt><code>m</code>
<dd>
<p>The input message to be parsed</p>
</dd><dt><code>return</code>
<dd>
<p>false or true depending on whether command succeeded.</p>
</dd></dl>
          

          
          <div class="method-source-code" id="parse-source">
            <pre><span class="ruby-comment"># File lib/core/gameobject.rb, line 117</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">parse</span>(<span class="ruby-identifier">m</span>)
  <span class="ruby-comment"># match legal command</span>
  <span class="ruby-identifier">m</span><span class="ruby-operator">=~</span><span class="ruby-node">%r([A-Za-z0-9_@?&quot;'#!]+)(.*)/</span>
  <span class="ruby-identifier">cmd</span>=<span class="ruby-node">$1</span>
  <span class="ruby-identifier">arg</span>=<span class="ruby-node">$2</span>
  <span class="ruby-identifier">arg</span>.<span class="ruby-identifier">strip!</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">arg</span>

  <span class="ruby-comment"># look for a command from our table for objects</span>
  <span class="ruby-identifier">c</span> = <span class="ruby-identifier">world</span>.<span class="ruby-identifier">ocmds</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">cmd</span>)

  <span class="ruby-comment"># there are three possibilities here</span>
  <span class="ruby-keyword">case</span> <span class="ruby-identifier">c</span>.<span class="ruby-identifier">size</span>
  <span class="ruby-keyword">when</span> <span class="ruby-value">0</span>   <span class="ruby-comment"># no commands found</span>
    <span class="ruby-keyword">false</span>
  <span class="ruby-keyword">when</span> <span class="ruby-value">1</span>   <span class="ruby-comment"># command found</span>
    <span class="ruby-keyword">return</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">c</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">cmd</span>, <span class="ruby-identifier">arg</span>)
  <span class="ruby-keyword">else</span>     <span class="ruby-comment"># ambiguous command - tell luser about them.</span>
    <span class="ruby-keyword">false</span>
  <span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
          </div><!-- parse-source -->
          
        </div>

        

        
      </div><!-- parse-method -->

    
      <div id="method-i-timer" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">timer</span><span
            class="method-args">(e)</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          <p><a href="Event.html">Event</a> :timer</p>
<dl class="rdoc-list label-list"><dt><code>e</code>
<dd>
<p>The event</p>
</dd><dt><code>return</code>
<dd>
<p>Undefined</p>
</dd></dl>
          

          
          <div class="method-source-code" id="timer-source">
            <pre><span class="ruby-comment"># File lib/core/gameobject.rb, line 177</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">timer</span>(<span class="ruby-identifier">e</span>)
<span class="ruby-keyword">end</span></pre>
          </div><!-- timer-source -->
          
        </div>

        

        
      </div><!-- timer-method -->

    
    </section><!-- public-instance-method-details -->
  
  </section><!-- 5Buntitled-5D -->

</div><!-- documentation -->


<footer id="validator-badges">
  <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
  <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.1.
  <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
</footer>