TorqueEngine
/
Torque2D
cermin dari https://github.com/TorqueGameEngines/Torque2D.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Torque2D Reference: SimObjectTimerEvent Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Torque2D Reference
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_sim_object_timer_event-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">SimObjectTimerEvent Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;simObjectTimerEvent.h&gt;</code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for SimObjectTimerEvent:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
 <div class="center">
  <img src="class_sim_object_timer_event.png" usemap="#SimObjectTimerEvent_map" alt=""/>
  <map id="SimObjectTimerEvent_map" name="SimObjectTimerEvent_map">
<area href="class_sim_event.html" alt="SimEvent" shape="rect" coords="0,0,132,24"/>
  </map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a350ffaac2616d1fec8cf9df86f9f7c63" id="r_a350ffaac2616d1fec8cf9df86f9f7c63"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object_timer_event.html#a350ffaac2616d1fec8cf9df86f9f7c63">SimObjectTimerEvent</a> (StringTableEntry callbackFunction, const U32 period, const U32 repeat=0)</td></tr>
<tr class="separator:a350ffaac2616d1fec8cf9df86f9f7c63"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9845b5b7e195e9f68f0f61788f4ad18a" id="r_a9845b5b7e195e9f68f0f61788f4ad18a"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object_timer_event.html#a9845b5b7e195e9f68f0f61788f4ad18a">~SimObjectTimerEvent</a> ()</td></tr>
<tr class="separator:a9845b5b7e195e9f68f0f61788f4ad18a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a59e79c3567700d5b56ac1ffd10dd765b" id="r_a59e79c3567700d5b56ac1ffd10dd765b"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_object_timer_event.html#a59e79c3567700d5b56ac1ffd10dd765b">process</a> (<a class="el" href="class_sim_object.html">SimObject</a> *object)</td></tr>
<tr class="separator:a59e79c3567700d5b56ac1ffd10dd765b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_sim_event"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_sim_event')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_sim_event.html">SimEvent</a></td></tr>
<tr class="memitem:ad00bbc4a9f34d9f78f6494b9d2a11d32 inherit pub_methods_class_sim_event" id="r_ad00bbc4a9f34d9f78f6494b9d2a11d32"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_event.html#ad00bbc4a9f34d9f78f6494b9d2a11d32">SimEvent</a> ()</td></tr>
<tr class="separator:ad00bbc4a9f34d9f78f6494b9d2a11d32 inherit pub_methods_class_sim_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a755c3dee95a3a5eaf55d0644e0aa152e inherit pub_methods_class_sim_event" id="r_a755c3dee95a3a5eaf55d0644e0aa152e"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_event.html#a755c3dee95a3a5eaf55d0644e0aa152e">~SimEvent</a> ()</td></tr>
<tr class="separator:a755c3dee95a3a5eaf55d0644e0aa152e inherit pub_methods_class_sim_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_attribs_class_sim_event"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_class_sim_event')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="class_sim_event.html">SimEvent</a></td></tr>
<tr class="memitem:a7dfde9d929ac106599ccdf14b181756d inherit pub_attribs_class_sim_event" id="r_a7dfde9d929ac106599ccdf14b181756d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_sim_event.html">SimEvent</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_event.html#a7dfde9d929ac106599ccdf14b181756d">nextEvent</a></td></tr>
<tr class="memdesc:a7dfde9d929ac106599ccdf14b181756d inherit pub_attribs_class_sim_event"><td class="mdescLeft">&#160;</td><td class="mdescRight">Linked list details - pointer to next item in the list.  <br /></td></tr>
<tr class="separator:a7dfde9d929ac106599ccdf14b181756d inherit pub_attribs_class_sim_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a658c63d9f75be037991cd739dab7b445 inherit pub_attribs_class_sim_event" id="r_a658c63d9f75be037991cd739dab7b445"><td class="memItemLeft" align="right" valign="top">SimTime&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_event.html#a658c63d9f75be037991cd739dab7b445">startTime</a></td></tr>
<tr class="memdesc:a658c63d9f75be037991cd739dab7b445 inherit pub_attribs_class_sim_event"><td class="mdescLeft">&#160;</td><td class="mdescRight">When the event was posted.  <br /></td></tr>
<tr class="separator:a658c63d9f75be037991cd739dab7b445 inherit pub_attribs_class_sim_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5993109c2472e2a9abedd1a23400f6a5 inherit pub_attribs_class_sim_event" id="r_a5993109c2472e2a9abedd1a23400f6a5"><td class="memItemLeft" align="right" valign="top">SimTime&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_event.html#a5993109c2472e2a9abedd1a23400f6a5">time</a></td></tr>
<tr class="memdesc:a5993109c2472e2a9abedd1a23400f6a5 inherit pub_attribs_class_sim_event"><td class="mdescLeft">&#160;</td><td class="mdescRight">When the event is scheduled to occur.  <br /></td></tr>
<tr class="separator:a5993109c2472e2a9abedd1a23400f6a5 inherit pub_attribs_class_sim_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5092acb84f5d9019e306137ac358f17d inherit pub_attribs_class_sim_event" id="r_a5092acb84f5d9019e306137ac358f17d"><td class="memItemLeft" align="right" valign="top">U32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_event.html#a5092acb84f5d9019e306137ac358f17d">sequenceCount</a></td></tr>
<tr class="separator:a5092acb84f5d9019e306137ac358f17d inherit pub_attribs_class_sim_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af859306407b8598f2bfce9dd8e37a7e5 inherit pub_attribs_class_sim_event" id="r_af859306407b8598f2bfce9dd8e37a7e5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_sim_object.html">SimObject</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_event.html#af859306407b8598f2bfce9dd8e37a7e5">destObject</a></td></tr>
<tr class="memdesc:af859306407b8598f2bfce9dd8e37a7e5 inherit pub_attribs_class_sim_event"><td class="mdescLeft">&#160;</td><td class="mdescRight">Object on which this event will be applied.  <br /></td></tr>
<tr class="separator:af859306407b8598f2bfce9dd8e37a7e5 inherit pub_attribs_class_sim_event"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a350ffaac2616d1fec8cf9df86f9f7c63" name="a350ffaac2616d1fec8cf9df86f9f7c63"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a350ffaac2616d1fec8cf9df86f9f7c63">&#9670;&#160;</a></span>SimObjectTimerEvent()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_sim_object_timer_event.html">SimObjectTimerEvent</a> </td>
          <td>(</td>
          <td class="paramtype">StringTableEntry&#160;</td>
          <td class="paramname"><em>callbackFunction</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const U32&#160;</td>
          <td class="paramname"><em>period</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const U32&#160;</td>
          <td class="paramname"><em>repeat</em> = <code>0</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a9845b5b7e195e9f68f0f61788f4ad18a" name="a9845b5b7e195e9f68f0f61788f4ad18a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9845b5b7e195e9f68f0f61788f4ad18a">&#9670;&#160;</a></span>~SimObjectTimerEvent()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual ~<a class="el" href="class_sim_object_timer_event.html">SimObjectTimerEvent</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a59e79c3567700d5b56ac1ffd10dd765b" name="a59e79c3567700d5b56ac1ffd10dd765b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a59e79c3567700d5b56ac1ffd10dd765b">&#9670;&#160;</a></span>process()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void process </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_sim_object.html">SimObject</a> *&#160;</td>
          <td class="paramname"><em>object</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Function called when event occurs.</p>
<p>This is where the meat of your event's implementation goes.</p>
<p>See any of the subclasses for ideas of what goes in here.</p>
<p>The event is deleted immediately after processing. If the object referenced in destObject is deleted, then the event is not called. The even will be executed unconditionally if the object referenced is NULL.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">object</td><td>Object stored in destObject. </td></tr>
  </table>
  </dd>
</dl>

<p>Implements <a class="el" href="class_sim_event.html#a5898b9095c9863604fcd32747fc988be">SimEvent</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>sim/<b>simObjectTimerEvent.h</b></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>