classgameplay_1_1_a_i_state.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218
  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>AIState Class Reference</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_a_i_state.html">AIState</a> </li>
  81. </ul>
  82. </div>
  83. </div>
  84. <div class="header">
  85. <div class="summary">
  86. <a href="#nested-classes">Classes</a> &#124;
  87. <a href="#pub-methods">Public Member Functions</a> &#124;
  88. <a href="#pub-static-methods">Static Public Member Functions</a> </div>
  89. <div class="headertitle">
  90. <div class="title">gameplay::AIState Class Reference</div> </div>
  91. </div><!--header-->
  92. <div class="contents">
  93. <!-- doxytag: class="gameplay::AIState" --><!-- doxytag: inherits="gameplay::Ref" -->
  94. <p><code>#include &lt;AIState.h&gt;</code></p>
  95. <div class="dynheader">
  96. Inheritance diagram for gameplay::AIState:</div>
  97. <div class="dyncontent">
  98. <div class="center">
  99. <img src="classgameplay_1_1_a_i_state.png" usemap="#gameplay::AIState_map" alt=""/>
  100. <map id="gameplay::AIState_map" name="gameplay::AIState_map">
  101. <area href="classgameplay_1_1_ref.html" alt="gameplay::Ref" shape="rect" coords="0,0,112,24"/>
  102. </map>
  103. </div></div>
  104. <p><a href="classgameplay_1_1_a_i_state-members.html">List of all members.</a></p>
  105. <table class="memberdecls">
  106. <tr><td colspan="2"><h2><a name="nested-classes"></a>
  107. Classes</h2></td></tr>
  108. <tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_a_i_state_1_1_listener.html">Listener</a></td></tr>
  109. <tr><td colspan="2"><h2><a name="pub-methods"></a>
  110. Public Member Functions</h2></td></tr>
  111. <tr><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_a_i_state.html#a4e6152c3e229ddc4c14cfe58c822bb65">getId</a> () const </td></tr>
  112. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_a_i_state.html#a05fc7669fb69d215d297781cc555b816">setListener</a> (<a class="el" href="classgameplay_1_1_a_i_state_1_1_listener.html">Listener</a> *listener)</td></tr>
  113. <tr><td colspan="2"><h2><a name="pub-static-methods"></a>
  114. Static Public Member Functions</h2></td></tr>
  115. <tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classgameplay_1_1_a_i_state.html">AIState</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_a_i_state.html#a02c9debfc16ef2763e5e6c3ed80d2f34">create</a> (const char *id)</td></tr>
  116. </table>
  117. <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
  118. <div class="textblock"><p>Defines a single state in an <a class="el" href="classgameplay_1_1_a_i_state_machine.html">AIStateMachine</a>.</p>
  119. <p>An <a class="el" href="classgameplay_1_1_a_i_state.html">AIState</a> encapsulates a state and unit of work within an AI state machine. Events can be programmed or scripted when the state is entered, exited and each frame/tick in its update event. </p>
  120. </div><hr/><h2>Member Function Documentation</h2>
  121. <a class="anchor" id="a02c9debfc16ef2763e5e6c3ed80d2f34"></a><!-- doxytag: member="gameplay::AIState::create" ref="a02c9debfc16ef2763e5e6c3ed80d2f34" args="(const char *id)" -->
  122. <div class="memitem">
  123. <div class="memproto">
  124. <table class="memname">
  125. <tr>
  126. <td class="memname">static <a class="el" href="classgameplay_1_1_a_i_state.html">AIState</a>* <a class="el" href="classgameplay_1_1_a_i_state.html#a02c9debfc16ef2763e5e6c3ed80d2f34">gameplay::AIState::create</a> </td>
  127. <td>(</td>
  128. <td class="paramtype">const char *&#160;</td>
  129. <td class="paramname"><em>id</em></td><td>)</td>
  130. <td><code> [static]</code></td>
  131. </tr>
  132. </table>
  133. </div>
  134. <div class="memdoc">
  135. <p>Creates a new AISTate.</p>
  136. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  137. <table class="params">
  138. <tr><td class="paramname">id</td><td>The ID of the new <a class="el" href="classgameplay_1_1_a_i_state.html">AIState</a>.</td></tr>
  139. </table>
  140. </dd>
  141. </dl>
  142. <dl class="return"><dt><b>Returns:</b></dt><dd>The new <a class="el" href="classgameplay_1_1_a_i_state.html">AIState</a>. </dd></dl>
  143. </div>
  144. </div>
  145. <a class="anchor" id="a4e6152c3e229ddc4c14cfe58c822bb65"></a><!-- doxytag: member="gameplay::AIState::getId" ref="a4e6152c3e229ddc4c14cfe58c822bb65" args="() const " -->
  146. <div class="memitem">
  147. <div class="memproto">
  148. <table class="memname">
  149. <tr>
  150. <td class="memname">const char* <a class="el" href="classgameplay_1_1_a_i_state.html#a4e6152c3e229ddc4c14cfe58c822bb65">gameplay::AIState::getId</a> </td>
  151. <td>(</td>
  152. <td class="paramname"></td><td>)</td>
  153. <td> const</td>
  154. </tr>
  155. </table>
  156. </div>
  157. <div class="memdoc">
  158. <p>Returns the ID of this state.</p>
  159. <dl class="return"><dt><b>Returns:</b></dt><dd>The state ID. </dd></dl>
  160. </div>
  161. </div>
  162. <a class="anchor" id="a05fc7669fb69d215d297781cc555b816"></a><!-- doxytag: member="gameplay::AIState::setListener" ref="a05fc7669fb69d215d297781cc555b816" args="(Listener *listener)" -->
  163. <div class="memitem">
  164. <div class="memproto">
  165. <table class="memname">
  166. <tr>
  167. <td class="memname">void <a class="el" href="classgameplay_1_1_a_i_state.html#a05fc7669fb69d215d297781cc555b816">gameplay::AIState::setListener</a> </td>
  168. <td>(</td>
  169. <td class="paramtype"><a class="el" href="classgameplay_1_1_a_i_state_1_1_listener.html">Listener</a> *&#160;</td>
  170. <td class="paramname"><em>listener</em></td><td>)</td>
  171. <td></td>
  172. </tr>
  173. </table>
  174. </div>
  175. <div class="memdoc">
  176. <p>Sets a listener to dispatch state events to.</p>
  177. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  178. <table class="params">
  179. <tr><td class="paramname">listener</td><td><a class="el" href="classgameplay_1_1_a_i_state_1_1_listener.html">Listener</a> to dispatch state events to, or NULL to disable event dispatching. </td></tr>
  180. </table>
  181. </dd>
  182. </dl>
  183. </div>
  184. </div>
  185. </div><!-- contents -->
  186. <!-- window showing the filter options -->
  187. <div id="MSearchSelectWindow"
  188. onmouseover="return searchBox.OnSearchSelectShow()"
  189. onmouseout="return searchBox.OnSearchSelectHide()"
  190. onkeydown="return searchBox.OnSearchSelectKey(event)">
  191. <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>
  192. <!-- iframe showing the search results (closed by default) -->
  193. <div id="MSearchResultsWindow">
  194. <iframe src="javascript:void(0)" frameborder="0"
  195. name="MSearchResults" id="MSearchResults">
  196. </iframe>
  197. </div>
  198. <hr class="footer"/><address class="footer"><small>
  199. Generated on Sat Jan 24 2015 15:29:41 for gameplay by &#160;<a href="http://www.doxygen.org/index.html">
  200. <img class="footer" src="doxygen.png" alt="doxygen"/>
  201. </a> 1.7.6.1
  202. </small></address>
  203. </body>
  204. </html>