classgameplay_1_1_script_target_1_1_event_registry.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279
  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. <title>gameplay: Main Page</title>
  7. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  8. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  9. <link href="custom.css" rel="stylesheet" type="text/css" />
  10. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  11. <script type="text/javascript" src="jquery.js"></script>
  12. <script type="text/javascript" src="search/search.js"></script>
  13. <script type="text/javascript">
  14. $(document).ready(function() { searchBox.OnSelectItem(0); });
  15. </script>
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div! -->
  19. <table class="header" border="0">
  20. <tbody>
  21. <tr>
  22. <td id="logo"><a href="http://gameplay3d.io/"><img src="images/logo.png" alt="gameplay" border="0" height="64px"/></a></td>
  23. <td width="100%"/>
  24. <td><a href="http://gameplay3d.io/"><span class="button">overview</span></a></td><td width="12px"/>
  25. <td><a href="https://github.com/gameplay3d/GamePlay/wiki"><span class="button">wiki</span></a></td><td width="12px"/>
  26. <td><a href="http://gameplay3d.github.com/GamePlay/api/index.html"><span class="button">api&nbsp;reference</span></a></td><td width="12px"/>
  27. <td><a href="https://github.com/gameplay3d/GamePlay"><span class="button">download</span></a></td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. <!-- Generated by Doxygen 1.7.6.1 -->
  32. <script type="text/javascript">
  33. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  34. </script>
  35. <div id="navrow1" class="tabs">
  36. <ul class="tablist">
  37. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  38. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  39. <li>
  40. <div id="MSearchBox" class="MSearchBoxInactive">
  41. <span class="left">
  42. <img id="MSearchSelect" src="search/mag_sel.png"
  43. onmouseover="return searchBox.OnSearchSelectShow()"
  44. onmouseout="return searchBox.OnSearchSelectHide()"
  45. alt=""/>
  46. <input type="text" id="MSearchField" value="Search" accesskey="S"
  47. onfocus="searchBox.OnSearchFieldFocus(true)"
  48. onblur="searchBox.OnSearchFieldFocus(false)"
  49. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  50. </span><span class="right">
  51. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  52. </span>
  53. </div>
  54. </li>
  55. </ul>
  56. </div>
  57. <div id="navrow2" class="tabs2">
  58. <ul class="tablist">
  59. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  60. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  61. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  62. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  63. </ul>
  64. </div>
  65. <!-- window showing the filter options -->
  66. <div id="MSearchSelectWindow"
  67. onmouseover="return searchBox.OnSearchSelectShow()"
  68. onmouseout="return searchBox.OnSearchSelectHide()"
  69. onkeydown="return searchBox.OnSearchSelectKey(event)">
  70. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a></div>
  71. <!-- iframe showing the search results (closed by default) -->
  72. <div id="MSearchResultsWindow">
  73. <iframe src="javascript:void(0)" frameborder="0"
  74. name="MSearchResults" id="MSearchResults">
  75. </iframe>
  76. </div>
  77. <div id="nav-path" class="navpath">
  78. <ul>
  79. <li class="navelem"><b>gameplay</b> </li>
  80. <li class="navelem"><a class="el" href="classgameplay_1_1_script_target.html">ScriptTarget</a> </li>
  81. <li class="navelem"><a class="el" href="classgameplay_1_1_script_target_1_1_event_registry.html">EventRegistry</a> </li>
  82. </ul>
  83. </div>
  84. </div>
  85. <div class="header">
  86. <div class="summary">
  87. <a href="#pub-methods">Public Member Functions</a> </div>
  88. <div class="headertitle">
  89. <div class="title">gameplay::ScriptTarget::EventRegistry Class Reference</div> </div>
  90. </div><!--header-->
  91. <div class="contents">
  92. <!-- doxytag: class="gameplay::ScriptTarget::EventRegistry" -->
  93. <p><code>#include &lt;ScriptTarget.h&gt;</code></p>
  94. <p><a href="classgameplay_1_1_script_target_1_1_event_registry-members.html">List of all members.</a></p>
  95. <table class="memberdecls">
  96. <tr><td colspan="2"><h2><a name="pub-methods"></a>
  97. Public Member Functions</h2></td></tr>
  98. <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_script_target_1_1_event_registry.html#a471018e3cca45ff9b50d794c140e13fd">EventRegistry</a> ()</td></tr>
  99. <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_script_target_1_1_event_registry.html#af7f541403ca12160587760f81a25b5ef">~EventRegistry</a> ()</td></tr>
  100. <tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classgameplay_1_1_script_target_1_1_event.html">Event</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_script_target_1_1_event_registry.html#a20ff0d90606b639ddb78d37235811a83">addEvent</a> (const char *name, const char *args=NULL)</td></tr>
  101. <tr><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_script_target_1_1_event_registry.html#a65e9c3ab0c0f4d472cd75a3fd1fed596">getEventCount</a> () const </td></tr>
  102. <tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classgameplay_1_1_script_target_1_1_event.html">Event</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_script_target_1_1_event_registry.html#a0d3db724c808bd987acdc7bfec4c930e">getEvent</a> (unsigned int index) const </td></tr>
  103. <tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classgameplay_1_1_script_target_1_1_event.html">Event</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_script_target_1_1_event_registry.html#a1fac259e18fa24cf4cde3e4d8f1823f4">getEvent</a> (const char *name) const </td></tr>
  104. </table>
  105. <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
  106. <div class="textblock"><p><a class="el" href="classgameplay_1_1_script.html">Script</a> event registry that defines the supported script events for a <a class="el" href="classgameplay_1_1_script_target.html">ScriptTarget</a>.</p>
  107. <p>This class should generally only be used via the GP_REGISTER_SCRIPT_EVENTS macro. </p>
  108. </div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
  109. <a class="anchor" id="a471018e3cca45ff9b50d794c140e13fd"></a><!-- doxytag: member="gameplay::ScriptTarget::EventRegistry::EventRegistry" ref="a471018e3cca45ff9b50d794c140e13fd" args="()" -->
  110. <div class="memitem">
  111. <div class="memproto">
  112. <table class="memname">
  113. <tr>
  114. <td class="memname"><a class="el" href="classgameplay_1_1_script_target_1_1_event_registry.html#a471018e3cca45ff9b50d794c140e13fd">gameplay::ScriptTarget::EventRegistry::EventRegistry</a> </td>
  115. <td>(</td>
  116. <td class="paramname"></td><td>)</td>
  117. <td></td>
  118. </tr>
  119. </table>
  120. </div>
  121. <div class="memdoc">
  122. <p>Constructor. </p>
  123. </div>
  124. </div>
  125. <a class="anchor" id="af7f541403ca12160587760f81a25b5ef"></a><!-- doxytag: member="gameplay::ScriptTarget::EventRegistry::~EventRegistry" ref="af7f541403ca12160587760f81a25b5ef" args="()" -->
  126. <div class="memitem">
  127. <div class="memproto">
  128. <table class="memname">
  129. <tr>
  130. <td class="memname"><a class="el" href="classgameplay_1_1_script_target_1_1_event_registry.html#af7f541403ca12160587760f81a25b5ef">gameplay::ScriptTarget::EventRegistry::~EventRegistry</a> </td>
  131. <td>(</td>
  132. <td class="paramname"></td><td>)</td>
  133. <td></td>
  134. </tr>
  135. </table>
  136. </div>
  137. <div class="memdoc">
  138. <p>Destructor. </p>
  139. </div>
  140. </div>
  141. <hr/><h2>Member Function Documentation</h2>
  142. <a class="anchor" id="a20ff0d90606b639ddb78d37235811a83"></a><!-- doxytag: member="gameplay::ScriptTarget::EventRegistry::addEvent" ref="a20ff0d90606b639ddb78d37235811a83" args="(const char *name, const char *args=NULL)" -->
  143. <div class="memitem">
  144. <div class="memproto">
  145. <table class="memname">
  146. <tr>
  147. <td class="memname">const <a class="el" href="classgameplay_1_1_script_target_1_1_event.html">Event</a>* <a class="el" href="classgameplay_1_1_script_target_1_1_event_registry.html#a20ff0d90606b639ddb78d37235811a83">gameplay::ScriptTarget::EventRegistry::addEvent</a> </td>
  148. <td>(</td>
  149. <td class="paramtype">const char *&#160;</td>
  150. <td class="paramname"><em>name</em>, </td>
  151. </tr>
  152. <tr>
  153. <td class="paramkey"></td>
  154. <td></td>
  155. <td class="paramtype">const char *&#160;</td>
  156. <td class="paramname"><em>args</em> = <code>NULL</code>&#160;</td>
  157. </tr>
  158. <tr>
  159. <td></td>
  160. <td>)</td>
  161. <td></td><td></td>
  162. </tr>
  163. </table>
  164. </div>
  165. <div class="memdoc">
  166. <p>Adds a registered event to the registry.</p>
  167. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  168. <table class="params">
  169. <tr><td class="paramname">name</td><td>The name of the script event. </td></tr>
  170. <tr><td class="paramname">args</td><td>The argument string for the event.</td></tr>
  171. </table>
  172. </dd>
  173. </dl>
  174. <dl class="return"><dt><b>Returns:</b></dt><dd>The added event. </dd></dl>
  175. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classgameplay_1_1_script_controller.html#acb739b7fa547e0c17ec2c83003a142b2">ScriptController::executeFunction</a> </dd></dl>
  176. </div>
  177. </div>
  178. <a class="anchor" id="a0d3db724c808bd987acdc7bfec4c930e"></a><!-- doxytag: member="gameplay::ScriptTarget::EventRegistry::getEvent" ref="a0d3db724c808bd987acdc7bfec4c930e" args="(unsigned int index) const " -->
  179. <div class="memitem">
  180. <div class="memproto">
  181. <table class="memname">
  182. <tr>
  183. <td class="memname">const <a class="el" href="classgameplay_1_1_script_target_1_1_event.html">Event</a>* <a class="el" href="classgameplay_1_1_script_target_1_1_event_registry.html#a0d3db724c808bd987acdc7bfec4c930e">gameplay::ScriptTarget::EventRegistry::getEvent</a> </td>
  184. <td>(</td>
  185. <td class="paramtype">unsigned int&#160;</td>
  186. <td class="paramname"><em>index</em></td><td>)</td>
  187. <td> const</td>
  188. </tr>
  189. </table>
  190. </div>
  191. <div class="memdoc">
  192. <p>Returns the event with the given index.</p>
  193. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  194. <table class="params">
  195. <tr><td class="paramname">index</td><td>The index of the event to retrieve. </td></tr>
  196. </table>
  197. </dd>
  198. </dl>
  199. <dl class="return"><dt><b>Returns:</b></dt><dd>The event for the given index. </dd></dl>
  200. </div>
  201. </div>
  202. <a class="anchor" id="a1fac259e18fa24cf4cde3e4d8f1823f4"></a><!-- doxytag: member="gameplay::ScriptTarget::EventRegistry::getEvent" ref="a1fac259e18fa24cf4cde3e4d8f1823f4" args="(const char *name) const " -->
  203. <div class="memitem">
  204. <div class="memproto">
  205. <table class="memname">
  206. <tr>
  207. <td class="memname">const <a class="el" href="classgameplay_1_1_script_target_1_1_event.html">Event</a>* <a class="el" href="classgameplay_1_1_script_target_1_1_event_registry.html#a0d3db724c808bd987acdc7bfec4c930e">gameplay::ScriptTarget::EventRegistry::getEvent</a> </td>
  208. <td>(</td>
  209. <td class="paramtype">const char *&#160;</td>
  210. <td class="paramname"><em>name</em></td><td>)</td>
  211. <td> const</td>
  212. </tr>
  213. </table>
  214. </div>
  215. <div class="memdoc">
  216. <p>Returns the event that matches the given name.</p>
  217. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  218. <table class="params">
  219. <tr><td class="paramname">name</td><td>The name of the event to search for. </td></tr>
  220. </table>
  221. </dd>
  222. </dl>
  223. <dl class="return"><dt><b>Returns:</b></dt><dd>The matching event, or NULL if no such event exists. </dd></dl>
  224. </div>
  225. </div>
  226. <a class="anchor" id="a65e9c3ab0c0f4d472cd75a3fd1fed596"></a><!-- doxytag: member="gameplay::ScriptTarget::EventRegistry::getEventCount" ref="a65e9c3ab0c0f4d472cd75a3fd1fed596" args="() const " -->
  227. <div class="memitem">
  228. <div class="memproto">
  229. <table class="memname">
  230. <tr>
  231. <td class="memname">unsigned int <a class="el" href="classgameplay_1_1_script_target_1_1_event_registry.html#a65e9c3ab0c0f4d472cd75a3fd1fed596">gameplay::ScriptTarget::EventRegistry::getEventCount</a> </td>
  232. <td>(</td>
  233. <td class="paramname"></td><td>)</td>
  234. <td> const</td>
  235. </tr>
  236. </table>
  237. </div>
  238. <div class="memdoc">
  239. <p>Returns the number of registered script events.</p>
  240. <dl class="return"><dt><b>Returns:</b></dt><dd>The number of script events registered. </dd></dl>
  241. </div>
  242. </div>
  243. </div><!-- contents -->
  244. <!-- window showing the filter options -->
  245. <div id="MSearchSelectWindow"
  246. onmouseover="return searchBox.OnSearchSelectShow()"
  247. onmouseout="return searchBox.OnSearchSelectHide()"
  248. onkeydown="return searchBox.OnSearchSelectKey(event)">
  249. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a></div>
  250. <!-- iframe showing the search results (closed by default) -->
  251. <div id="MSearchResultsWindow">
  252. <iframe src="javascript:void(0)" frameborder="0"
  253. name="MSearchResults" id="MSearchResults">
  254. </iframe>
  255. </div>
  256. <hr class="footer"/><address class="footer"><small>
  257. Generated on Sat Jan 24 2015 15:29:44 for gameplay by &#160;<a href="http://www.doxygen.org/index.html">
  258. <img class="footer" src="doxygen.png" alt="doxygen"/>
  259. </a> 1.7.6.1
  260. </small></address>
  261. </body>
  262. </html>