classBehaviorComponent.html 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461
  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: BehaviorComponent 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. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  13. </head>
  14. <body>
  15. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  16. <div id="titlearea">
  17. <table cellspacing="0" cellpadding="0">
  18. <tbody>
  19. <tr style="height: 56px;">
  20. <td style="padding-left: 0.5em;">
  21. <div id="projectname">TorqueScript Reference
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.3.1 -->
  30. <div id="navrow1" class="tabs">
  31. <ul class="tablist">
  32. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  34. <li><a href="modules.html"><span>Modules</span></a></li>
  35. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  36. </ul>
  37. </div>
  38. <div id="navrow2" class="tabs2">
  39. <ul class="tablist">
  40. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  41. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  42. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  43. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  44. </ul>
  45. </div>
  46. </div><!-- top -->
  47. <div class="header">
  48. <div class="summary">
  49. <a href="#pub-methods">Public Member Functions</a> &#124;
  50. <a href="classBehaviorComponent-members.html">List of all members</a> </div>
  51. <div class="headertitle">
  52. <div class="title">BehaviorComponent Class Reference</div> </div>
  53. </div><!--header-->
  54. <div class="contents">
  55. <p>Inherits <a class="el" href="classDynamicConsoleMethodComponent.html">DynamicConsoleMethodComponent</a>.</p>
  56. <p>Inherited by <a class="el" href="classScene.html">Scene</a>, and <a class="el" href="classSceneObject.html">SceneObject</a>.</p>
  57. <table class="memberdecls">
  58. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  59. Public Member Functions</h2></td></tr>
  60. <tr class="memitem:a191700f13d3e43312e84217f6b69f9ee"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#a191700f13d3e43312e84217f6b69f9ee">addBehavior</a> (<a class="el" href="classBehaviorInstance.html">BehaviorInstance</a> bi)</td></tr>
  61. <tr class="separator:a191700f13d3e43312e84217f6b69f9ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
  62. <tr class="memitem:a75cf9aca6491d3442a30255e50929c07"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#a75cf9aca6491d3442a30255e50929c07">clearBehaviors</a> ()</td></tr>
  63. <tr class="separator:a75cf9aca6491d3442a30255e50929c07"><td class="memSeparator" colspan="2">&#160;</td></tr>
  64. <tr class="memitem:a24eff746b90533b916b2b3aa0f27d8f3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#a24eff746b90533b916b2b3aa0f27d8f3">connect</a> (outputBehavior, inputBehavior, outputName, inputName)</td></tr>
  65. <tr class="separator:a24eff746b90533b916b2b3aa0f27d8f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66. <tr class="memitem:a5021752e2f48900d3a7cb3ffdab1f7a9"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#a5021752e2f48900d3a7cb3ffdab1f7a9">disconnect</a> (outputBehavior, inputBehavior, outputName, inputName)</td></tr>
  67. <tr class="separator:a5021752e2f48900d3a7cb3ffdab1f7a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68. <tr class="memitem:a7d996d1d925e53a122b1f3cf57f5abce"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#a7d996d1d925e53a122b1f3cf57f5abce">getBehavior</a> (string BehaviorTemplateName)</td></tr>
  69. <tr class="separator:a7d996d1d925e53a122b1f3cf57f5abce"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70. <tr class="memitem:aed9520e4500354682950371b062d974d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#aed9520e4500354682950371b062d974d">getBehaviorByIndex</a> (int index)</td></tr>
  71. <tr class="separator:aed9520e4500354682950371b062d974d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72. <tr class="memitem:a88ee692a8690fd9de215f7ece20623b5"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#a88ee692a8690fd9de215f7ece20623b5">getBehaviorConnection</a> (outputBehavior, outputName, connectionIndex)</td></tr>
  73. <tr class="separator:a88ee692a8690fd9de215f7ece20623b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <tr class="memitem:ad50805919d99adf0f65c6b94bd9e5dfd"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#ad50805919d99adf0f65c6b94bd9e5dfd">getBehaviorConnectionCount</a> (outputBehavior, outputName)</td></tr>
  75. <tr class="separator:ad50805919d99adf0f65c6b94bd9e5dfd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem:ab6dc6b3eb09a1d6f8f4c8ec9a4108d17"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#ab6dc6b3eb09a1d6f8f4c8ec9a4108d17">getBehaviorCount</a> ()</td></tr>
  77. <tr class="separator:ab6dc6b3eb09a1d6f8f4c8ec9a4108d17"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:ae81bec76a6acbc925694c5a050198609"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#ae81bec76a6acbc925694c5a050198609">raise</a> (outputBehavior, outputName,[deltaTime])</td></tr>
  79. <tr class="separator:ae81bec76a6acbc925694c5a050198609"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:a5f71e751ee5ab7b8ea61e31a77983f4b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#a5f71e751ee5ab7b8ea61e31a77983f4b">removeBehavior</a> (<a class="el" href="classBehaviorInstance.html">BehaviorInstance</a> bi,[bool deleteBehavior=true])</td></tr>
  81. <tr class="separator:a5f71e751ee5ab7b8ea61e31a77983f4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:a753fb3072cd4e96d997755452bc13071"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#a753fb3072cd4e96d997755452bc13071">reOrder</a> (<a class="el" href="classBehaviorInstance.html">BehaviorInstance</a> inst,[int desiredIndex=0])</td></tr>
  83. <tr class="separator:a753fb3072cd4e96d997755452bc13071"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. </table>
  85. <h2 class="groupheader">Member Function Documentation</h2>
  86. <a class="anchor" id="a191700f13d3e43312e84217f6b69f9ee"></a>
  87. <div class="memitem">
  88. <div class="memproto">
  89. <table class="memname">
  90. <tr>
  91. <td class="memname">bool addBehavior </td>
  92. <td>(</td>
  93. <td class="paramtype"><a class="el" href="classBehaviorInstance.html">BehaviorInstance</a>&#160;</td>
  94. <td class="paramname"><em>bi</em></td><td>)</td>
  95. <td></td>
  96. </tr>
  97. </table>
  98. </div><div class="memdoc">
  99. <p>Add a behavior to the object </p>
  100. <dl class="params"><dt>Parameters</dt><dd>
  101. <table class="params">
  102. <tr><td class="paramname">bi</td><td>The behavior instance to add </td></tr>
  103. </table>
  104. </dd>
  105. </dl>
  106. <dl class="section return"><dt>Returns</dt><dd>(bool success) Whether or not the behavior was successfully added </dd></dl>
  107. </div>
  108. </div>
  109. <a class="anchor" id="a75cf9aca6491d3442a30255e50929c07"></a>
  110. <div class="memitem">
  111. <div class="memproto">
  112. <table class="memname">
  113. <tr>
  114. <td class="memname">void clearBehaviors </td>
  115. <td>(</td>
  116. <td class="paramname"></td><td>)</td>
  117. <td></td>
  118. </tr>
  119. </table>
  120. </div><div class="memdoc">
  121. <p>Clear all behavior instances </p>
  122. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  123. </div>
  124. </div>
  125. <a class="anchor" id="a24eff746b90533b916b2b3aa0f27d8f3"></a>
  126. <div class="memitem">
  127. <div class="memproto">
  128. <table class="memname">
  129. <tr>
  130. <td class="memname">bool connect </td>
  131. <td>(</td>
  132. <td class="paramtype">outputBehavior&#160;</td>
  133. <td class="paramname">, </td>
  134. </tr>
  135. <tr>
  136. <td class="paramkey"></td>
  137. <td></td>
  138. <td class="paramtype">inputBehavior&#160;</td>
  139. <td class="paramname">, </td>
  140. </tr>
  141. <tr>
  142. <td class="paramkey"></td>
  143. <td></td>
  144. <td class="paramtype">outputName&#160;</td>
  145. <td class="paramname">, </td>
  146. </tr>
  147. <tr>
  148. <td class="paramkey"></td>
  149. <td></td>
  150. <td class="paramtype">inputName&#160;</td>
  151. <td class="paramname">&#160;</td>
  152. </tr>
  153. <tr>
  154. <td></td>
  155. <td>)</td>
  156. <td></td><td></td>
  157. </tr>
  158. </table>
  159. </div><div class="memdoc">
  160. <p>Connects a behavior output to a behavior input. </p>
  161. <dl class="params"><dt>Parameters</dt><dd>
  162. <table class="params">
  163. <tr><td class="paramname">outputBehavior</td><td>The behavior that owns the output. </td></tr>
  164. <tr><td class="paramname">inputBehavior</td><td>The behavior that owns the input. </td></tr>
  165. <tr><td class="paramname">outputName</td><td>The output name owned by the output behavior. </td></tr>
  166. <tr><td class="paramname">inputName</td><td>The input name owned by the input behavior. </td></tr>
  167. </table>
  168. </dd>
  169. </dl>
  170. <dl class="section return"><dt>Returns</dt><dd>(bool success) Whether the connection was successful or not. </dd></dl>
  171. </div>
  172. </div>
  173. <a class="anchor" id="a5021752e2f48900d3a7cb3ffdab1f7a9"></a>
  174. <div class="memitem">
  175. <div class="memproto">
  176. <table class="memname">
  177. <tr>
  178. <td class="memname">bool disconnect </td>
  179. <td>(</td>
  180. <td class="paramtype">outputBehavior&#160;</td>
  181. <td class="paramname">, </td>
  182. </tr>
  183. <tr>
  184. <td class="paramkey"></td>
  185. <td></td>
  186. <td class="paramtype">inputBehavior&#160;</td>
  187. <td class="paramname">, </td>
  188. </tr>
  189. <tr>
  190. <td class="paramkey"></td>
  191. <td></td>
  192. <td class="paramtype">outputName&#160;</td>
  193. <td class="paramname">, </td>
  194. </tr>
  195. <tr>
  196. <td class="paramkey"></td>
  197. <td></td>
  198. <td class="paramtype">inputName&#160;</td>
  199. <td class="paramname">&#160;</td>
  200. </tr>
  201. <tr>
  202. <td></td>
  203. <td>)</td>
  204. <td></td><td></td>
  205. </tr>
  206. </table>
  207. </div><div class="memdoc">
  208. <p>Connects a behavior output to a behavior input. </p>
  209. <dl class="params"><dt>Parameters</dt><dd>
  210. <table class="params">
  211. <tr><td class="paramname">outputBehavior</td><td>The behavior that owns the output. </td></tr>
  212. <tr><td class="paramname">inputBehavior</td><td>The behavior that owns the input. </td></tr>
  213. <tr><td class="paramname">outputName</td><td>The output name owned by the output behavior. </td></tr>
  214. <tr><td class="paramname">inputName</td><td>The input name owned by the input behavior. </td></tr>
  215. </table>
  216. </dd>
  217. </dl>
  218. <dl class="section return"><dt>Returns</dt><dd>(bool success) Whether the disconnection was successful or not. </dd></dl>
  219. </div>
  220. </div>
  221. <a class="anchor" id="a7d996d1d925e53a122b1f3cf57f5abce"></a>
  222. <div class="memitem">
  223. <div class="memproto">
  224. <table class="memname">
  225. <tr>
  226. <td class="memname">int getBehavior </td>
  227. <td>(</td>
  228. <td class="paramtype">string&#160;</td>
  229. <td class="paramname"><em>BehaviorTemplateName</em></td><td>)</td>
  230. <td></td>
  231. </tr>
  232. </table>
  233. </div><div class="memdoc">
  234. <p>gets a behavior </p>
  235. <dl class="params"><dt>Parameters</dt><dd>
  236. <table class="params">
  237. <tr><td class="paramname">BehaviorTemplateName</td><td>The name of the template of the behavior instance you want </td></tr>
  238. </table>
  239. </dd>
  240. </dl>
  241. <dl class="section return"><dt>Returns</dt><dd>(<a class="el" href="classBehaviorInstance.html">BehaviorInstance</a> bi) The behavior instance you requested </dd></dl>
  242. </div>
  243. </div>
  244. <a class="anchor" id="aed9520e4500354682950371b062d974d"></a>
  245. <div class="memitem">
  246. <div class="memproto">
  247. <table class="memname">
  248. <tr>
  249. <td class="memname">int getBehaviorByIndex </td>
  250. <td>(</td>
  251. <td class="paramtype">int&#160;</td>
  252. <td class="paramname"><em>index</em></td><td>)</td>
  253. <td></td>
  254. </tr>
  255. </table>
  256. </div><div class="memdoc">
  257. <p>Gets a particular behavior </p>
  258. <dl class="params"><dt>Parameters</dt><dd>
  259. <table class="params">
  260. <tr><td class="paramname">index</td><td>The index of the behavior to get </td></tr>
  261. </table>
  262. </dd>
  263. </dl>
  264. <dl class="section return"><dt>Returns</dt><dd>(<a class="el" href="classBehaviorInstance.html">BehaviorInstance</a> bi) The behavior instance you requested </dd></dl>
  265. </div>
  266. </div>
  267. <a class="anchor" id="a88ee692a8690fd9de215f7ece20623b5"></a>
  268. <div class="memitem">
  269. <div class="memproto">
  270. <table class="memname">
  271. <tr>
  272. <td class="memname">string getBehaviorConnection </td>
  273. <td>(</td>
  274. <td class="paramtype">outputBehavior&#160;</td>
  275. <td class="paramname">, </td>
  276. </tr>
  277. <tr>
  278. <td class="paramkey"></td>
  279. <td></td>
  280. <td class="paramtype">outputName&#160;</td>
  281. <td class="paramname">, </td>
  282. </tr>
  283. <tr>
  284. <td class="paramkey"></td>
  285. <td></td>
  286. <td class="paramtype">connectionIndex&#160;</td>
  287. <td class="paramname">&#160;</td>
  288. </tr>
  289. <tr>
  290. <td></td>
  291. <td>)</td>
  292. <td></td><td></td>
  293. </tr>
  294. </table>
  295. </div><div class="memdoc">
  296. <p>Gets a comma-delimited list of connections on the behavior output on the specified behavior. </p>
  297. <dl class="params"><dt>Parameters</dt><dd>
  298. <table class="params">
  299. <tr><td class="paramname">outputBehavior</td><td>The behavior that owns the output. </td></tr>
  300. <tr><td class="paramname">outputName</td><td>The output name owned by the output behavior. </td></tr>
  301. <tr><td class="paramname">connectionIndex</td><td>The connection index. </td></tr>
  302. </table>
  303. </dd>
  304. </dl>
  305. <dl class="section return"><dt>Returns</dt><dd>Returns a comma-delimited list of connections on the behavior output on the specified behavior of the format &lt;OutputBehavior&gt;,&lt;InputBehavior&gt;,&lt;OutputName&gt;,&lt;InputName&gt;. </dd></dl>
  306. </div>
  307. </div>
  308. <a class="anchor" id="ad50805919d99adf0f65c6b94bd9e5dfd"></a>
  309. <div class="memitem">
  310. <div class="memproto">
  311. <table class="memname">
  312. <tr>
  313. <td class="memname">int getBehaviorConnectionCount </td>
  314. <td>(</td>
  315. <td class="paramtype">outputBehavior&#160;</td>
  316. <td class="paramname">, </td>
  317. </tr>
  318. <tr>
  319. <td class="paramkey"></td>
  320. <td></td>
  321. <td class="paramtype">outputName&#160;</td>
  322. <td class="paramname">&#160;</td>
  323. </tr>
  324. <tr>
  325. <td></td>
  326. <td>)</td>
  327. <td></td><td></td>
  328. </tr>
  329. </table>
  330. </div><div class="memdoc">
  331. <p>Gets the number of connections on the behavior output on the specified behavior. </p>
  332. <dl class="params"><dt>Parameters</dt><dd>
  333. <table class="params">
  334. <tr><td class="paramname">outputBehavior</td><td>The behavior that owns the output. </td></tr>
  335. <tr><td class="paramname">outputName</td><td>The output name owned by the output behavior. </td></tr>
  336. </table>
  337. </dd>
  338. </dl>
  339. <dl class="section return"><dt>Returns</dt><dd>The number of connections on the behavior output on the specified behavior. </dd></dl>
  340. </div>
  341. </div>
  342. <a class="anchor" id="ab6dc6b3eb09a1d6f8f4c8ec9a4108d17"></a>
  343. <div class="memitem">
  344. <div class="memproto">
  345. <table class="memname">
  346. <tr>
  347. <td class="memname">int getBehaviorCount </td>
  348. <td>(</td>
  349. <td class="paramname"></td><td>)</td>
  350. <td></td>
  351. </tr>
  352. </table>
  353. </div><div class="memdoc">
  354. <p>Get the count of behaviors on an object </p>
  355. <dl class="section return"><dt>Returns</dt><dd>(int count) The number of behaviors on an object </dd></dl>
  356. </div>
  357. </div>
  358. <a class="anchor" id="ae81bec76a6acbc925694c5a050198609"></a>
  359. <div class="memitem">
  360. <div class="memproto">
  361. <table class="memname">
  362. <tr>
  363. <td class="memname">bool raise </td>
  364. <td>(</td>
  365. <td class="paramtype">outputBehavior&#160;</td>
  366. <td class="paramname">, </td>
  367. </tr>
  368. <tr>
  369. <td class="paramkey"></td>
  370. <td></td>
  371. <td class="paramtype">outputName&#160;</td>
  372. <td class="paramname">&#160;</td>
  373. </tr>
  374. <tr>
  375. <td></td>
  376. <td>)</td>
  377. <td></td><td></td>
  378. </tr>
  379. </table>
  380. </div><div class="memdoc">
  381. <p>Raise a signal on the behavior output on the specified behavior. </p>
  382. <dl class="params"><dt>Parameters</dt><dd>
  383. <table class="params">
  384. <tr><td class="paramname">outputBehavior</td><td>The behavior that owns the output. </td></tr>
  385. <tr><td class="paramname">outputName</td><td>The output name owned by the output behavior. </td></tr>
  386. <tr><td class="paramname">[deltaTime]</td><td>Optional time-delta (ms) when the raise should occur. </td></tr>
  387. </table>
  388. </dd>
  389. </dl>
  390. <dl class="section return"><dt>Returns</dt><dd>(bool success) Whether the signal raise was successful or not. </dd></dl>
  391. </div>
  392. </div>
  393. <a class="anchor" id="a5f71e751ee5ab7b8ea61e31a77983f4b"></a>
  394. <div class="memitem">
  395. <div class="memproto">
  396. <table class="memname">
  397. <tr>
  398. <td class="memname">bool removeBehavior </td>
  399. <td>(</td>
  400. <td class="paramtype"><a class="el" href="classBehaviorInstance.html">BehaviorInstance</a>&#160;</td>
  401. <td class="paramname"><em>bi</em></td><td>)</td>
  402. <td></td>
  403. </tr>
  404. </table>
  405. </div><div class="memdoc">
  406. <dl class="params"><dt>Parameters</dt><dd>
  407. <table class="params">
  408. <tr><td class="paramname">bi</td><td>The behavior instance to remove </td></tr>
  409. <tr><td class="paramname">deleteBehavior</td><td>Whether or not to delete the behavior </td></tr>
  410. </table>
  411. </dd>
  412. </dl>
  413. <dl class="section return"><dt>Returns</dt><dd>(bool success) Whether the behavior was successfully removed </dd></dl>
  414. </div>
  415. </div>
  416. <a class="anchor" id="a753fb3072cd4e96d997755452bc13071"></a>
  417. <div class="memitem">
  418. <div class="memproto">
  419. <table class="memname">
  420. <tr>
  421. <td class="memname">bool reOrder </td>
  422. <td>(</td>
  423. <td class="paramtype"><a class="el" href="classBehaviorInstance.html">BehaviorInstance</a>&#160;</td>
  424. <td class="paramname"><em>inst</em></td><td>)</td>
  425. <td></td>
  426. </tr>
  427. </table>
  428. </div><div class="memdoc">
  429. <dl class="params"><dt>Parameters</dt><dd>
  430. <table class="params">
  431. <tr><td class="paramname">inst</td><td>The behavior instance you want to reorder </td></tr>
  432. <tr><td class="paramname">desiredIndex</td><td>The index you want the behavior instance to be reordered to </td></tr>
  433. </table>
  434. </dd>
  435. </dl>
  436. <dl class="section return"><dt>Returns</dt><dd>(bool success) Whether or not the behavior instance was successfully reordered </dd></dl>
  437. </div>
  438. </div>
  439. </div><!-- contents -->
  440. <!-- start footer part -->
  441. <hr class="footer"/><address class="footer"><small>
  442. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  443. <img class="footer" src="doxygen.png" alt="doxygen"/>
  444. </a> 1.8.3.1
  445. </small></address>
  446. </body>
  447. </html>