<?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: Timer</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">Timer</td> </tr> <tr class="top-aligned-row"> <td><strong>In:</strong></td> <td> <a href="../files/lib/engine/timer_rb.html"> lib/engine/timer.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="5,5,77,53" href="Timer.html" alt="Timer " /> </map> <img src="../dot/f_20.png" usemap="#map" border="0" alt="dot/f_20.png"> </div> <div id="description"> <p> The <a href="Timer.html">Timer</a> class defines the necessary data to keep track of timers for objects </p> </div> </div> <div id="method-list"> <h3 class="section-bar">Methods</h3> <div class="name-list"> <a href="#M000243">fire?</a> <a href="#M000242">new</a> <a href="#M000244">reset</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">id</td> <td class="context-item-value"> [RW] </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"> [RW] </td> <td class="context-item-desc"></td> </tr> <tr class="top-aligned-row context-row"> <td class="context-item-name">time</td> <td class="context-item-value"> [RW] </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-M000242" class="method-detail"> <a name="M000242"></a> <div class="method-heading"> <a href="#M000242" class="method-signature"> <span class="method-name">new</span><span class="method-args">(id,name,time)</span> </a> </div> <div class="method-description"> <p> Constructor for a <a href="Timer.html">Timer</a> object. </p> <dl> <dt><tt>id</tt></dt><dd>The id of the object </dd> <dt><tt>name</tt></dt><dd>The symbol that defines the kind of timer event. </dd> <dt><tt>time</tt></dt><dd>Optional information needed to process the event. </dd> <dt><tt>return</tt></dt><dd>A reference to the <a href="Timer.html">Timer</a>. </dd> </dl> <p><a class="source-toggle" href="#" onclick="toggleCode('M000242-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000242-source"> <pre> <span class="ruby-comment cmt"># File lib/engine/timer.rb, line 25</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">id</span>,<span class="ruby-identifier">name</span>,<span class="ruby-identifier">time</span>) <span class="ruby-ivar">@id</span>,<span class="ruby-ivar">@name</span>,<span class="ruby-ivar">@time</span>,<span class="ruby-ivar">@counter</span>=<span class="ruby-identifier">id</span>,<span class="ruby-identifier">name</span>,<span class="ruby-identifier">time</span>,<span class="ruby-identifier">time</span> <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <h3 class="section-bar">Public Instance methods</h3> <div id="method-M000243" class="method-detail"> <a name="M000243"></a> <div class="method-heading"> <a href="#M000243" class="method-signature"> <span class="method-name">fire?</span><span class="method-args">()</span> </a> </div> <div class="method-description"> <p><a class="source-toggle" href="#" onclick="toggleCode('M000243-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000243-source"> <pre> <span class="ruby-comment cmt"># File lib/engine/timer.rb, line 29</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">fire?</span> <span class="ruby-ivar">@counter</span> <span class="ruby-operator">-=</span> <span class="ruby-value">1</span> <span class="ruby-ivar">@counter</span> <span class="ruby-operator"><</span> <span class="ruby-value">1</span> <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <div id="method-M000244" class="method-detail"> <a name="M000244"></a> <div class="method-heading"> <a href="#M000244" class="method-signature"> <span class="method-name">reset</span><span class="method-args">()</span> </a> </div> <div class="method-description"> <p><a class="source-toggle" href="#" onclick="toggleCode('M000244-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000244-source"> <pre> <span class="ruby-comment cmt"># File lib/engine/timer.rb, line 34</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">reset</span> <span class="ruby-ivar">@counter</span> = <span class="ruby-ivar">@time</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>