classClass_1_1Trigger.html 9.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.3.1"/>
  7. <title>TorqueScript Reference: Trigger Class Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12. </head>
  13. <body>
  14. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  15. <div id="titlearea">
  16. <table cellspacing="0" cellpadding="0">
  17. <tbody>
  18. <tr style="height: 56px;">
  19. <td style="padding-left: 0.5em;">
  20. <div id="projectname">TorqueScript Reference
  21. </div>
  22. </td>
  23. </tr>
  24. </tbody>
  25. </table>
  26. </div>
  27. <!-- end header part -->
  28. <!-- Generated by Doxygen 1.8.3.1 -->
  29. <div id="navrow1" class="tabs">
  30. <ul class="tablist">
  31. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  32. <li><a href="namespaceFunctions.html"><span>Functions</span></a></li>
  33. <li><a href="usergroup0.html"><span>Classes</span></a></li>
  34. </ul>
  35. </div>
  36. <div id="navrow2" class="tabs2">
  37. <ul class="tablist">
  38. <li><a href="classes.html"><span>Classes&#160;A-Z</span></a></li>
  39. </ul>
  40. </div>
  41. <div id="nav-path" class="navpath">
  42. <ul>
  43. <li class="navelem"><a class="el" href="namespaceClass.html">Class</a></li><li class="navelem"><a class="el" href="classClass_1_1Trigger.html">Trigger</a></li> </ul>
  44. </div>
  45. </div><!-- top -->
  46. <div class="header">
  47. <div class="summary">
  48. <a href="#pub-methods">Methods</a> &#124;
  49. <a href="classClass_1_1Trigger-members.html">List of all members</a> </div>
  50. <div class="headertitle">
  51. <div class="title">Trigger Class Reference</div> </div>
  52. </div><!--header-->
  53. <div class="contents">
  54. <table class="memberdecls">
  55. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  56. Methods</h2></td></tr>
  57. <tr class="memitem:a0ca4ba4574ee8837db0ae3b008f28fb8"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classClass_1_1Trigger.html#a0ca4ba4574ee8837db0ae3b008f28fb8">Trigger::getEnterCallback</a> ()</td></tr>
  58. <tr class="separator:a0ca4ba4574ee8837db0ae3b008f28fb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  59. <tr class="memitem:a3392332aa39b47796c801d43e3625330"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classClass_1_1Trigger.html#a3392332aa39b47796c801d43e3625330">Trigger::getLeaveCallback</a> ()</td></tr>
  60. <tr class="separator:a3392332aa39b47796c801d43e3625330"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61. <tr class="memitem:a75f4e4beea7e3d241149a4782093b4fe"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classClass_1_1Trigger.html#a75f4e4beea7e3d241149a4782093b4fe">Trigger::getStayCallback</a> ()</td></tr>
  62. <tr class="separator:a75f4e4beea7e3d241149a4782093b4fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63. <tr class="memitem:a003b429fb317d5f97624aa8f73f46a91"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classClass_1_1Trigger.html#a003b429fb317d5f97624aa8f73f46a91">Trigger::setEnterCallback</a> ([setting])</td></tr>
  64. <tr class="separator:a003b429fb317d5f97624aa8f73f46a91"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65. <tr class="memitem:a3d2fa904473e3d54439c55423a1acbd2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classClass_1_1Trigger.html#a3d2fa904473e3d54439c55423a1acbd2">Trigger::setLeaveCallback</a> ([setting])</td></tr>
  66. <tr class="separator:a3d2fa904473e3d54439c55423a1acbd2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67. <tr class="memitem:a19102a9abc440453b15b3f6ce3e6b052"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classClass_1_1Trigger.html#a19102a9abc440453b15b3f6ce3e6b052">Trigger::setStayCallback</a> ([setting])</td></tr>
  68. <tr class="separator:a19102a9abc440453b15b3f6ce3e6b052"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69. </table>
  70. <h2 class="groupheader">Methods</h2>
  71. <a class="anchor" id="a0ca4ba4574ee8837db0ae3b008f28fb8"></a>
  72. <div class="memitem">
  73. <div class="memproto">
  74. <table class="memname">
  75. <tr>
  76. <td class="memname">bool <a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/class_trigger.html#aec4a905d9883093f38e57035f990bdec">Trigger::getEnterCallback</a> </td>
  77. <td>(</td>
  78. <td class="paramname"></td><td>)</td>
  79. <td></td>
  80. </tr>
  81. </table>
  82. </div><div class="memdoc">
  83. <dl class="section return"><dt>Returns</dt><dd>Returns whether trigger checks onEnter events </dd></dl>
  84. </div>
  85. </div>
  86. <a class="anchor" id="a3392332aa39b47796c801d43e3625330"></a>
  87. <div class="memitem">
  88. <div class="memproto">
  89. <table class="memname">
  90. <tr>
  91. <td class="memname">bool <a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/class_trigger.html#a712ed1294211c2d27132d8ac833f8dc5">Trigger::getLeaveCallback</a> </td>
  92. <td>(</td>
  93. <td class="paramname"></td><td>)</td>
  94. <td></td>
  95. </tr>
  96. </table>
  97. </div><div class="memdoc">
  98. <dl class="section return"><dt>Returns</dt><dd>Returns whether trigger checks onLeave events </dd></dl>
  99. </div>
  100. </div>
  101. <a class="anchor" id="a75f4e4beea7e3d241149a4782093b4fe"></a>
  102. <div class="memitem">
  103. <div class="memproto">
  104. <table class="memname">
  105. <tr>
  106. <td class="memname">bool <a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/class_trigger.html#aa208e7bfcc8d705a54df5df41331d200">Trigger::getStayCallback</a> </td>
  107. <td>(</td>
  108. <td class="paramname"></td><td>)</td>
  109. <td></td>
  110. </tr>
  111. </table>
  112. </div><div class="memdoc">
  113. <dl class="section return"><dt>Returns</dt><dd>Returns whether trigger checks onStay events </dd></dl>
  114. </div>
  115. </div>
  116. <a class="anchor" id="a003b429fb317d5f97624aa8f73f46a91"></a>
  117. <div class="memitem">
  118. <div class="memproto">
  119. <table class="memname">
  120. <tr>
  121. <td class="memname">void <a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/class_trigger.html#a459fbc22dd7ca41c70e0ba2e1373cf94">Trigger::setEnterCallback</a> </td>
  122. <td>(</td>
  123. <td class="paramname"></td><td>)</td>
  124. <td></td>
  125. </tr>
  126. </table>
  127. </div><div class="memdoc">
  128. <p>Set whether trigger checks onEnter events </p>
  129. <dl class="params"><dt>Parameters</dt><dd>
  130. <table class="params">
  131. <tr><td class="paramname">setting</td><td>Default is true. </td></tr>
  132. </table>
  133. </dd>
  134. </dl>
  135. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  136. </div>
  137. </div>
  138. <a class="anchor" id="a3d2fa904473e3d54439c55423a1acbd2"></a>
  139. <div class="memitem">
  140. <div class="memproto">
  141. <table class="memname">
  142. <tr>
  143. <td class="memname">void <a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/class_trigger.html#a9c49da38a8c8ecf273bfefa95f8ce41d">Trigger::setLeaveCallback</a> </td>
  144. <td>(</td>
  145. <td class="paramname"></td><td>)</td>
  146. <td></td>
  147. </tr>
  148. </table>
  149. </div><div class="memdoc">
  150. <p>Set whether trigger checks onLeave events </p>
  151. <dl class="params"><dt>Parameters</dt><dd>
  152. <table class="params">
  153. <tr><td class="paramname">setting</td><td>Default is true. </td></tr>
  154. </table>
  155. </dd>
  156. </dl>
  157. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  158. </div>
  159. </div>
  160. <a class="anchor" id="a19102a9abc440453b15b3f6ce3e6b052"></a>
  161. <div class="memitem">
  162. <div class="memproto">
  163. <table class="memname">
  164. <tr>
  165. <td class="memname">void <a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/class_trigger.html#a15be47daaf8bed54be07cd60ed841b76">Trigger::setStayCallback</a> </td>
  166. <td>(</td>
  167. <td class="paramname"></td><td>)</td>
  168. <td></td>
  169. </tr>
  170. </table>
  171. </div><div class="memdoc">
  172. <p>Set whether trigger checks onStay events </p>
  173. <dl class="params"><dt>Parameters</dt><dd>
  174. <table class="params">
  175. <tr><td class="paramname">setting</td><td>Default is true. </td></tr>
  176. </table>
  177. </dd>
  178. </dl>
  179. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  180. </div>
  181. </div>
  182. </div><!-- contents -->
  183. <!-- start footer part -->
  184. <hr class="footer"/><address class="footer"><small>
  185. Generated on Mon Apr 15 2013 10:42:56 for TorqueScript Reference by &#160;<a href="http://www.doxygen.org/index.html">
  186. <img class="footer" src="doxygen.png" alt="doxygen"/>
  187. </a> 1.8.3.1
  188. </small></address>
  189. </body>
  190. </html>