structgameplay_1_1_script_target_1_1_callback_function.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203
  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.org/"><img src="images/logo.png" alt="gameplay" border="0" height="64px"/></a></td>
  23. <td width="100%"/>
  24. <td><a href="http://gameplay3d.org/"><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="http://www.gameplay3d.org/forums"><span class="button">forums</span></a></td>
  28. <td><a href="https://github.com/gameplay3d/GamePlay"><span class="button">download</span></a></td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. <!-- Generated by Doxygen 1.7.6.1 -->
  33. <script type="text/javascript">
  34. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  35. </script>
  36. <div id="navrow1" class="tabs">
  37. <ul class="tablist">
  38. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  39. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  40. <li>
  41. <div id="MSearchBox" class="MSearchBoxInactive">
  42. <span class="left">
  43. <img id="MSearchSelect" src="search/mag_sel.png"
  44. onmouseover="return searchBox.OnSearchSelectShow()"
  45. onmouseout="return searchBox.OnSearchSelectHide()"
  46. alt=""/>
  47. <input type="text" id="MSearchField" value="Search" accesskey="S"
  48. onfocus="searchBox.OnSearchFieldFocus(true)"
  49. onblur="searchBox.OnSearchFieldFocus(false)"
  50. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  51. </span><span class="right">
  52. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  53. </span>
  54. </div>
  55. </li>
  56. </ul>
  57. </div>
  58. <div id="navrow2" class="tabs2">
  59. <ul class="tablist">
  60. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  61. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  62. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  63. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  64. </ul>
  65. </div>
  66. <!-- window showing the filter options -->
  67. <div id="MSearchSelectWindow"
  68. onmouseover="return searchBox.OnSearchSelectShow()"
  69. onmouseout="return searchBox.OnSearchSelectHide()"
  70. onkeydown="return searchBox.OnSearchSelectKey(event)">
  71. <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>
  72. <!-- iframe showing the search results (closed by default) -->
  73. <div id="MSearchResultsWindow">
  74. <iframe src="javascript:void(0)" frameborder="0"
  75. name="MSearchResults" id="MSearchResults">
  76. </iframe>
  77. </div>
  78. <div id="nav-path" class="navpath">
  79. <ul>
  80. <li class="navelem"><b>gameplay</b> </li>
  81. <li class="navelem"><a class="el" href="classgameplay_1_1_script_target.html">ScriptTarget</a> </li>
  82. <li class="navelem"><a class="el" href="structgameplay_1_1_script_target_1_1_callback_function.html">CallbackFunction</a> </li>
  83. </ul>
  84. </div>
  85. </div>
  86. <div class="header">
  87. <div class="summary">
  88. <a href="#pub-methods">Public Member Functions</a> &#124;
  89. <a href="#pub-attribs">Public Attributes</a> </div>
  90. <div class="headertitle">
  91. <div class="title">gameplay::ScriptTarget::CallbackFunction Struct Reference</div> </div>
  92. </div><!--header-->
  93. <div class="contents">
  94. <!-- doxytag: class="gameplay::ScriptTarget::CallbackFunction" -->
  95. <p><code>#include &lt;ScriptTarget.h&gt;</code></p>
  96. <p><a href="structgameplay_1_1_script_target_1_1_callback_function-members.html">List of all members.</a></p>
  97. <table class="memberdecls">
  98. <tr><td colspan="2"><h2><a name="pub-methods"></a>
  99. Public Member Functions</h2></td></tr>
  100. <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgameplay_1_1_script_target_1_1_callback_function.html#a152509825e4ccb0c3cc8672cd0b6cf07">CallbackFunction</a> (<a class="el" href="classgameplay_1_1_script.html">Script</a> *<a class="el" href="structgameplay_1_1_script_target_1_1_callback_function.html#a3656dc651d26c12d77d027b1868632dc">script</a>, const char *<a class="el" href="structgameplay_1_1_script_target_1_1_callback_function.html#a972e7cd976abcc50e2fa8ec1bdfb04da">function</a>)</td></tr>
  101. <tr><td colspan="2"><h2><a name="pub-attribs"></a>
  102. Public Attributes</h2></td></tr>
  103. <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgameplay_1_1_script.html">Script</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgameplay_1_1_script_target_1_1_callback_function.html#a3656dc651d26c12d77d027b1868632dc">script</a></td></tr>
  104. <tr><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgameplay_1_1_script_target_1_1_callback_function.html#a972e7cd976abcc50e2fa8ec1bdfb04da">function</a></td></tr>
  105. </table>
  106. <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
  107. <div class="textblock"><p>Stores a single registered script callback function. </p>
  108. </div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
  109. <a class="anchor" id="a152509825e4ccb0c3cc8672cd0b6cf07"></a><!-- doxytag: member="gameplay::ScriptTarget::CallbackFunction::CallbackFunction" ref="a152509825e4ccb0c3cc8672cd0b6cf07" args="(Script *script, const char *function)" -->
  110. <div class="memitem">
  111. <div class="memproto">
  112. <table class="memname">
  113. <tr>
  114. <td class="memname"><a class="el" href="structgameplay_1_1_script_target_1_1_callback_function.html#a152509825e4ccb0c3cc8672cd0b6cf07">gameplay::ScriptTarget::CallbackFunction::CallbackFunction</a> </td>
  115. <td>(</td>
  116. <td class="paramtype"><a class="el" href="classgameplay_1_1_script.html">Script</a> *&#160;</td>
  117. <td class="paramname"><em>script</em>, </td>
  118. </tr>
  119. <tr>
  120. <td class="paramkey"></td>
  121. <td></td>
  122. <td class="paramtype">const char *&#160;</td>
  123. <td class="paramname"><em>function</em>&#160;</td>
  124. </tr>
  125. <tr>
  126. <td></td>
  127. <td>)</td>
  128. <td></td><td><code> [inline]</code></td>
  129. </tr>
  130. </table>
  131. </div>
  132. <div class="memdoc">
  133. <p>The callback function to registry script function to. </p>
  134. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  135. <table class="params">
  136. <tr><td class="paramname">script</td><td>The script. </td></tr>
  137. <tr><td class="paramname">function</td><td>The script function. </td></tr>
  138. </table>
  139. </dd>
  140. </dl>
  141. </div>
  142. </div>
  143. <hr/><h2>Member Data Documentation</h2>
  144. <a class="anchor" id="a972e7cd976abcc50e2fa8ec1bdfb04da"></a><!-- doxytag: member="gameplay::ScriptTarget::CallbackFunction::function" ref="a972e7cd976abcc50e2fa8ec1bdfb04da" args="" -->
  145. <div class="memitem">
  146. <div class="memproto">
  147. <table class="memname">
  148. <tr>
  149. <td class="memname">std::string <a class="el" href="structgameplay_1_1_script_target_1_1_callback_function.html#a972e7cd976abcc50e2fa8ec1bdfb04da">gameplay::ScriptTarget::CallbackFunction::function</a></td>
  150. </tr>
  151. </table>
  152. </div>
  153. <div class="memdoc">
  154. <p>The function within the script to call. </p>
  155. </div>
  156. </div>
  157. <a class="anchor" id="a3656dc651d26c12d77d027b1868632dc"></a><!-- doxytag: member="gameplay::ScriptTarget::CallbackFunction::script" ref="a3656dc651d26c12d77d027b1868632dc" args="" -->
  158. <div class="memitem">
  159. <div class="memproto">
  160. <table class="memname">
  161. <tr>
  162. <td class="memname"><a class="el" href="classgameplay_1_1_script.html">Script</a>* <a class="el" href="structgameplay_1_1_script_target_1_1_callback_function.html#a3656dc651d26c12d77d027b1868632dc">gameplay::ScriptTarget::CallbackFunction::script</a></td>
  163. </tr>
  164. </table>
  165. </div>
  166. <div class="memdoc">
  167. <p>The script the callback belongs to (or NULL if the callback is a global function) </p>
  168. </div>
  169. </div>
  170. </div><!-- contents -->
  171. <!-- window showing the filter options -->
  172. <div id="MSearchSelectWindow"
  173. onmouseover="return searchBox.OnSearchSelectShow()"
  174. onmouseout="return searchBox.OnSearchSelectHide()"
  175. onkeydown="return searchBox.OnSearchSelectKey(event)">
  176. <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>
  177. <!-- iframe showing the search results (closed by default) -->
  178. <div id="MSearchResultsWindow">
  179. <iframe src="javascript:void(0)" frameborder="0"
  180. name="MSearchResults" id="MSearchResults">
  181. </iframe>
  182. </div>
  183. <hr class="footer"/><address class="footer"><small>
  184. Generated on Sat Jan 24 2015 15:29:44 for gameplay by &#160;<a href="http://www.doxygen.org/index.html">
  185. <img class="footer" src="doxygen.png" alt="doxygen"/>
  186. </a> 1.7.6.1
  187. </small></address>
  188. </body>
  189. </html>