struct_event.html 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.9.8"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Torque2D Reference: Event Struct Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <table cellspacing="0" cellpadding="0">
  22. <tbody>
  23. <tr id="projectrow">
  24. <td id="projectalign">
  25. <div id="projectname">Torque2D Reference
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.9.8 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  36. var searchBox = new SearchBox("searchBox", "search/",'.html');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */
  48. </script>
  49. <div id="main-nav"></div>
  50. <!-- window showing the filter options -->
  51. <div id="MSearchSelectWindow"
  52. onmouseover="return searchBox.OnSearchSelectShow()"
  53. onmouseout="return searchBox.OnSearchSelectHide()"
  54. onkeydown="return searchBox.OnSearchSelectKey(event)">
  55. </div>
  56. <!-- iframe showing the search results (closed by default) -->
  57. <div id="MSearchResultsWindow">
  58. <div id="MSearchResults">
  59. <div class="SRPage">
  60. <div id="SRIndex">
  61. <div id="SRResults"></div>
  62. <div class="SRStatus" id="Loading">Loading...</div>
  63. <div class="SRStatus" id="Searching">Searching...</div>
  64. <div class="SRStatus" id="NoMatches">No Matches</div>
  65. </div>
  66. </div>
  67. </div>
  68. </div>
  69. </div><!-- top -->
  70. <div class="header">
  71. <div class="summary">
  72. <a href="#pub-methods">Public Member Functions</a> &#124;
  73. <a href="#pub-attribs">Public Attributes</a> &#124;
  74. <a href="struct_event-members.html">List of all members</a> </div>
  75. <div class="headertitle"><div class="title">Event Struct Reference</div></div>
  76. </div><!--header-->
  77. <div class="contents">
  78. <p>Base event structure (also used for FrameEvent and QuitEvent)
  79. <a href="struct_event.html#details">More...</a></p>
  80. <p><code>#include &lt;event.h&gt;</code></p>
  81. <div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  82. <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for Event:</div>
  83. <div id="dynsection-0-summary" class="dynsummary" style="display:block;">
  84. </div>
  85. <div id="dynsection-0-content" class="dyncontent" style="display:none;">
  86. <div class="center">
  87. <img src="struct_event.png" usemap="#Event_map" alt=""/>
  88. <map id="Event_map" name="Event_map">
  89. <area href="struct_connected_accept_event.html" title="Triggered when we accept a new connection." alt="ConnectedAcceptEvent" shape="rect" coords="161,56,312,80"/>
  90. <area href="struct_connected_notify_event.html" title="Notify simulation of state of a connection." alt="ConnectedNotifyEvent" shape="rect" coords="161,112,312,136"/>
  91. <area href="struct_connected_receive_event.html" title="Triggered when we receive data from a connected entity." alt="ConnectedReceiveEvent" shape="rect" coords="161,168,312,192"/>
  92. <area href="struct_console_event.html" title="Represents a line of console input." alt="ConsoleEvent" shape="rect" coords="161,224,312,248"/>
  93. <area href="struct_input_event.html" title="Generic input event." alt="InputEvent" shape="rect" coords="161,280,312,304"/>
  94. <area href="struct_mouse_move_event.html" title="Mouse input event." alt="MouseMoveEvent" shape="rect" coords="161,336,312,360"/>
  95. <area href="struct_packet_receive_event.html" alt="PacketReceiveEvent" shape="rect" coords="161,392,312,416"/>
  96. <area href="struct_read_event.html" alt="ReadEvent" shape="rect" coords="161,448,312,472"/>
  97. <area href="struct_screen_touch_event.html" alt="ScreenTouchEvent" shape="rect" coords="161,504,312,528"/>
  98. <area href="struct_time_event.html" title="The time event causes the simulation to advance." alt="TimeEvent" shape="rect" coords="161,560,312,584"/>
  99. </map>
  100. </div></div>
  101. <table class="memberdecls">
  102. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  103. Public Member Functions</h2></td></tr>
  104. <tr class="memitem:a85b9e8172cffad1f169d55688e49a72f" id="r_a85b9e8172cffad1f169d55688e49a72f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_event.html#a85b9e8172cffad1f169d55688e49a72f">Event</a> ()</td></tr>
  105. <tr class="separator:a85b9e8172cffad1f169d55688e49a72f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. </table><table class="memberdecls">
  107. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
  108. Public Attributes</h2></td></tr>
  109. <tr class="memitem:a839a5921fd505dfcc828a03bf241b4e0" id="r_a839a5921fd505dfcc828a03bf241b4e0"><td class="memItemLeft" align="right" valign="top">U16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_event.html#a839a5921fd505dfcc828a03bf241b4e0">type</a></td></tr>
  110. <tr class="separator:a839a5921fd505dfcc828a03bf241b4e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:aba179bdf16bf15367217b28c4744745a" id="r_aba179bdf16bf15367217b28c4744745a"><td class="memItemLeft" align="right" valign="top">U16&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_event.html#aba179bdf16bf15367217b28c4744745a">size</a></td></tr>
  112. <tr class="separator:aba179bdf16bf15367217b28c4744745a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. </table>
  114. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  115. <div class="textblock"><p>Base event structure (also used for FrameEvent and QuitEvent) </p>
  116. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  117. <a id="a85b9e8172cffad1f169d55688e49a72f" name="a85b9e8172cffad1f169d55688e49a72f"></a>
  118. <h2 class="memtitle"><span class="permalink"><a href="#a85b9e8172cffad1f169d55688e49a72f">&#9670;&#160;</a></span>Event()</h2>
  119. <div class="memitem">
  120. <div class="memproto">
  121. <table class="mlabels">
  122. <tr>
  123. <td class="mlabels-left">
  124. <table class="memname">
  125. <tr>
  126. <td class="memname"><a class="el" href="struct_event.html">Event</a> </td>
  127. <td>(</td>
  128. <td class="paramname"></td><td>)</td>
  129. <td></td>
  130. </tr>
  131. </table>
  132. </td>
  133. <td class="mlabels-right">
  134. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  135. </tr>
  136. </table>
  137. </div><div class="memdoc">
  138. </div>
  139. </div>
  140. <h2 class="groupheader">Member Data Documentation</h2>
  141. <a id="aba179bdf16bf15367217b28c4744745a" name="aba179bdf16bf15367217b28c4744745a"></a>
  142. <h2 class="memtitle"><span class="permalink"><a href="#aba179bdf16bf15367217b28c4744745a">&#9670;&#160;</a></span>size</h2>
  143. <div class="memitem">
  144. <div class="memproto">
  145. <table class="memname">
  146. <tr>
  147. <td class="memname">U16 size</td>
  148. </tr>
  149. </table>
  150. </div><div class="memdoc">
  151. </div>
  152. </div>
  153. <a id="a839a5921fd505dfcc828a03bf241b4e0" name="a839a5921fd505dfcc828a03bf241b4e0"></a>
  154. <h2 class="memtitle"><span class="permalink"><a href="#a839a5921fd505dfcc828a03bf241b4e0">&#9670;&#160;</a></span>type</h2>
  155. <div class="memitem">
  156. <div class="memproto">
  157. <table class="memname">
  158. <tr>
  159. <td class="memname">U16 type</td>
  160. </tr>
  161. </table>
  162. </div><div class="memdoc">
  163. </div>
  164. </div>
  165. <hr/>The documentation for this struct was generated from the following file:<ul>
  166. <li>platform/<b>event.h</b></li>
  167. </ul>
  168. </div><!-- contents -->
  169. <!-- start footer part -->
  170. <hr class="footer"/><address class="footer"><small>
  171. 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
  172. </small></address>
  173. </body>
  174. </html>