TorqueEngine
/
Torque2D
зеркало из https://github.com/TorqueGameEngines/Torque2D.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308
							<!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>TorqueScript Reference: Event Scheduling</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="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">TorqueScript Reference
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<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('',false,false,'search.php','Search');
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">Event Scheduling<div class="ingroups"><a class="el" href="group__TorqueScriptFunctions.html">Function Categories</a></div></div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga45d07b5f39fce7a2785d9484fee492e5" id="r_ga45d07b5f39fce7a2785d9484fee492e5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__EventScheduleFunctions.html#ga45d07b5f39fce7a2785d9484fee492e5">cancel</a> (eventID)</td></tr>
<tr class="separator:ga45d07b5f39fce7a2785d9484fee492e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafa4740388e01b5f22bf79e24961ed10f" id="r_gafa4740388e01b5f22bf79e24961ed10f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__EventScheduleFunctions.html#gafa4740388e01b5f22bf79e24961ed10f">getEventTimeLeft</a> (eventID)</td></tr>
<tr class="separator:gafa4740388e01b5f22bf79e24961ed10f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1ea66b9000ca07f9b48a1f7ee0ec84a6" id="r_ga1ea66b9000ca07f9b48a1f7ee0ec84a6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__EventScheduleFunctions.html#ga1ea66b9000ca07f9b48a1f7ee0ec84a6">getScheduleDuration</a> (eventID)</td></tr>
<tr class="separator:ga1ea66b9000ca07f9b48a1f7ee0ec84a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga28987bb6b28966266b0cc82744b195ee" id="r_ga28987bb6b28966266b0cc82744b195ee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__EventScheduleFunctions.html#ga28987bb6b28966266b0cc82744b195ee">getSimTime</a> ()</td></tr>
<tr class="separator:ga28987bb6b28966266b0cc82744b195ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga663ada5c862019fd8e797661c6e5e46a" id="r_ga663ada5c862019fd8e797661c6e5e46a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__EventScheduleFunctions.html#ga663ada5c862019fd8e797661c6e5e46a">getTimeSinceStart</a> (eventID)</td></tr>
<tr class="separator:ga663ada5c862019fd8e797661c6e5e46a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaea8a1151b57a3b4e0d9af78fd8b8418b" id="r_gaea8a1151b57a3b4e0d9af78fd8b8418b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__EventScheduleFunctions.html#gaea8a1151b57a3b4e0d9af78fd8b8418b">isEventPending</a> (eventID)</td></tr>
<tr class="separator:gaea8a1151b57a3b4e0d9af78fd8b8418b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab457aa4a88b4d9fad6fc4ef1e79dd6c2" id="r_gab457aa4a88b4d9fad6fc4ef1e79dd6c2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__EventScheduleFunctions.html#gab457aa4a88b4d9fad6fc4ef1e79dd6c2">schedule</a> (t, objID||0, functionName, arg0,..., argN)</td></tr>
<tr class="separator:gab457aa4a88b4d9fad6fc4ef1e79dd6c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga45d07b5f39fce7a2785d9484fee492e5" name="ga45d07b5f39fce7a2785d9484fee492e5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga45d07b5f39fce7a2785d9484fee492e5">&#9670;&#160;</a></span>cancel()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> cancel </td>
          <td>(</td>
          <td class="paramtype">eventID&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>cancel a previously scheduled event</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">eventID</td><td>The numeric ID of a previously scheduled event. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__EventScheduleFunctions.html#gafa4740388e01b5f22bf79e24961ed10f">getEventTimeLeft</a>, <a class="el" href="group__EventScheduleFunctions.html#ga1ea66b9000ca07f9b48a1f7ee0ec84a6">getScheduleDuration</a>, <a class="el" href="group__EventScheduleFunctions.html#ga663ada5c862019fd8e797661c6e5e46a">getTimeSinceStart</a>, <a class="el" href="group__EventScheduleFunctions.html#gaea8a1151b57a3b4e0d9af78fd8b8418b">isEventPending</a>, <a class="el" href="group__EventScheduleFunctions.html#gab457aa4a88b4d9fad6fc4ef1e79dd6c2">schedule</a>, <a class="el" href="classSimObject.html#a16d537cd7a1c438045bb756fe1e22d2d">SimObject::schedule</a></dd></dl>
<dl class="section user"><dt>See Engine Function/Method</dt><dd>Sim::cancelEvent </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getEventTimeLeft </td>
          <td>(</td>
          <td class="paramtype">eventID&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Determines how much time remains until the event specified by eventID occurs.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">eventID</td><td>The numeric ID of a previously scheduled event. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a non-zero integer value equal to the milliseconds until the event specified by eventID will occur. However, if eventID is invalid, or the event has passed, this function will return zero. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__EventScheduleFunctions.html#ga45d07b5f39fce7a2785d9484fee492e5">cancel</a>, <a class="el" href="group__EventScheduleFunctions.html#ga1ea66b9000ca07f9b48a1f7ee0ec84a6">getScheduleDuration</a>, <a class="el" href="group__EventScheduleFunctions.html#ga663ada5c862019fd8e797661c6e5e46a">getTimeSinceStart</a>, <a class="el" href="group__EventScheduleFunctions.html#gaea8a1151b57a3b4e0d9af78fd8b8418b">isEventPending</a>, <a class="el" href="group__EventScheduleFunctions.html#gab457aa4a88b4d9fad6fc4ef1e79dd6c2">schedule</a>, <a class="el" href="classSimObject.html#a16d537cd7a1c438045bb756fe1e22d2d">SimObject::schedule</a></dd></dl>
<dl class="section user"><dt>See Engine Function/Method</dt><dd>Sim::getEventTimeLeft </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getScheduleDuration </td>
          <td>(</td>
          <td class="paramtype">eventID&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Determines how long the event associated with eventID was scheduled for.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">eventID</td><td>The numeric ID of a previously scheduled event. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a non-zero integer value equal to the milliseconds used in the schedule call that created this event. However, if eventID is invalid, this function will return zero. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__EventScheduleFunctions.html#ga45d07b5f39fce7a2785d9484fee492e5">cancel</a>, <a class="el" href="group__EventScheduleFunctions.html#gafa4740388e01b5f22bf79e24961ed10f">getEventTimeLeft</a>, <a class="el" href="group__EventScheduleFunctions.html#ga663ada5c862019fd8e797661c6e5e46a">getTimeSinceStart</a>, <a class="el" href="group__EventScheduleFunctions.html#gaea8a1151b57a3b4e0d9af78fd8b8418b">isEventPending</a>, <a class="el" href="group__EventScheduleFunctions.html#gab457aa4a88b4d9fad6fc4ef1e79dd6c2">schedule</a>, <a class="el" href="classSimObject.html#a16d537cd7a1c438045bb756fe1e22d2d">SimObject::schedule</a></dd></dl>
<dl class="section user"><dt>See Engine Function/Method</dt><dd>Sim::getScheduleDuration </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getSimTime </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>get the time, in ticks, that has elapsed since the engine started executing.</p>
<dl class="section return"><dt>Returns</dt><dd>the time in ticks since the engine was started. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__PlatformFunctions.html#gac1309f3a6aa01dddaf0f3fc69341b6ba">getRealTime</a></dd></dl>
<dl class="section user"><dt>See Engine Function/Method</dt><dd>Sim::getCurrentTime </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getTimeSinceStart </td>
          <td>(</td>
          <td class="paramtype">eventID&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Determines how much time has passed since the event specified by eventID was scheduled.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">eventID</td><td>The numeric ID of a previously scheduled event. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a non-zero integer value equal to the milliseconds that have passed since this event was scheduled. However, if eventID is invalid, or the event has passed, this function will return zero. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__EventScheduleFunctions.html#ga45d07b5f39fce7a2785d9484fee492e5">cancel</a>, <a class="el" href="group__EventScheduleFunctions.html#gafa4740388e01b5f22bf79e24961ed10f">getEventTimeLeft</a>, <a class="el" href="group__EventScheduleFunctions.html#ga1ea66b9000ca07f9b48a1f7ee0ec84a6">getScheduleDuration</a>, <a class="el" href="group__EventScheduleFunctions.html#gaea8a1151b57a3b4e0d9af78fd8b8418b">isEventPending</a>, <a class="el" href="group__EventScheduleFunctions.html#gab457aa4a88b4d9fad6fc4ef1e79dd6c2">schedule</a>, <a class="el" href="classSimObject.html#a16d537cd7a1c438045bb756fe1e22d2d">SimObject::schedule</a></dd></dl>
<dl class="section user"><dt>See Engine Function/Method</dt><dd>Sim::getTimeSinceStart </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> isEventPending </td>
          <td>(</td>
          <td class="paramtype">eventID&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>See if the event associated with eventID is still pending.</p>
<p>When an event passes, the eventID is removed from the event queue, becoming invalid, so there is no discnerable difference between a completed event and a bad event ID. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">eventID</td><td>The numeric ID of a previously scheduled event. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if this event is still outstanding and false if it has passed or eventID is invalid.</dd></dl>
<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line">$Game::Schedule = <a class="code hl_function" href="group__EventScheduleFunctions.html#gab457aa4a88b4d9fad6fc4ef1e79dd6c2">schedule</a>($Game::EndGamePause * 1000, 0, <span class="stringliteral">&quot;onCyclePauseEnd&quot;</span>);</div>
<div class="line"><span class="keywordflow">if</span>( <a class="code hl_function" href="group__EventScheduleFunctions.html#gaea8a1151b57a3b4e0d9af78fd8b8418b">isEventPending</a>($Game::Schedule) )  <a class="code hl_function" href="group__ConsoleOutput.html#gadc918a80dc292eeae84dcca04998faba">echo</a>(<span class="stringliteral">&quot;got a pending event&quot;</span>);</div>
<div class="ttc" id="agroup__ConsoleOutput_html_gadc918a80dc292eeae84dcca04998faba"><div class="ttname"><a href="group__ConsoleOutput.html#gadc918a80dc292eeae84dcca04998faba">echo</a></div><div class="ttdeci">void echo(text, [...] *)</div><div class="ttdef"><b>Definition</b> output_ScriptBinding.h:36</div></div>
<div class="ttc" id="agroup__EventScheduleFunctions_html_gab457aa4a88b4d9fad6fc4ef1e79dd6c2"><div class="ttname"><a href="group__EventScheduleFunctions.html#gab457aa4a88b4d9fad6fc4ef1e79dd6c2">schedule</a></div><div class="ttdeci">Integer schedule(t, objID||0, functionName, arg0,..., argN)</div><div class="ttdef"><b>Definition</b> simBase_ScriptBinding.h:153</div></div>
<div class="ttc" id="agroup__EventScheduleFunctions_html_gaea8a1151b57a3b4e0d9af78fd8b8418b"><div class="ttname"><a href="group__EventScheduleFunctions.html#gaea8a1151b57a3b4e0d9af78fd8b8418b">isEventPending</a></div><div class="ttdeci">Boolean isEventPending(eventID)</div><div class="ttdef"><b>Definition</b> simBase_ScriptBinding.h:81</div></div>
</div><!-- fragment --></dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__EventScheduleFunctions.html#ga45d07b5f39fce7a2785d9484fee492e5">cancel</a>, <a class="el" href="group__EventScheduleFunctions.html#gafa4740388e01b5f22bf79e24961ed10f">getEventTimeLeft</a>, <a class="el" href="group__EventScheduleFunctions.html#ga1ea66b9000ca07f9b48a1f7ee0ec84a6">getScheduleDuration</a>, <a class="el" href="group__EventScheduleFunctions.html#ga663ada5c862019fd8e797661c6e5e46a">getTimeSinceStart</a>, <a class="el" href="group__EventScheduleFunctions.html#gab457aa4a88b4d9fad6fc4ef1e79dd6c2">schedule</a>, <a class="el" href="classSimObject.html#a16d537cd7a1c438045bb756fe1e22d2d">SimObject::schedule</a></dd></dl>
<dl class="section user"><dt>See Engine Function/Method</dt><dd>Sim::isEventPending </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> schedule </td>
          <td>(</td>
          <td class="paramtype">t&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">objID||&#160;</td>
          <td class="paramname"><em>0</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">functionName&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">arg0&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>...</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">argN&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Schedule "functionName" to be executed with optional arguments at time t (specified in milliseconds) in the future.</p>
<p>This function may be associated with an object ID or not. If it is associated with an object ID and the object is deleted prior to this event occurring, the event is automatically canceled. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">t</td><td>The time to wait (in milliseconds) before executing functionName. </td></tr>
    <tr><td class="paramname">objID</td><td>An optional ID to associate this event with. </td></tr>
    <tr><td class="paramname">functionName</td><td>An unadorned (flat) function name. </td></tr>
    <tr><td class="paramname">arg0,..,argN</td><td>- Any number of optional arguments to be passed to functionName. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a non-zero integer representing the event ID for the scheduled event.</dd></dl>
<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line">$Game::Schedule = <a class="code hl_function" href="group__EventScheduleFunctions.html#gab457aa4a88b4d9fad6fc4ef1e79dd6c2">schedule</a>($Game::EndGamePause * 1000, 0, <span class="stringliteral">&quot;onCyclePauseEnd&quot;</span>);</div>
</div><!-- fragment --></dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__EventScheduleFunctions.html#ga45d07b5f39fce7a2785d9484fee492e5">cancel</a>, <a class="el" href="group__EventScheduleFunctions.html#gafa4740388e01b5f22bf79e24961ed10f">getEventTimeLeft</a>, <a class="el" href="group__EventScheduleFunctions.html#ga1ea66b9000ca07f9b48a1f7ee0ec84a6">getScheduleDuration</a>, <a class="el" href="group__EventScheduleFunctions.html#ga663ada5c862019fd8e797661c6e5e46a">getTimeSinceStart</a>, <a class="el" href="group__EventScheduleFunctions.html#gaea8a1151b57a3b4e0d9af78fd8b8418b">isEventPending</a>, <a class="el" href="classSimObject.html#a16d537cd7a1c438045bb756fe1e22d2d">SimObject::schedule</a></dd></dl>
<dl class="section user"><dt>See Engine Function/Method</dt><dd>Sim::postEvent </dd></dl>

</div>
</div>
</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>