classBehaviorComponent.html 45 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550
  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:a3ee1b2fe701b5a95dff404b588375dde"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#a3ee1b2fe701b5a95dff404b588375dde">addBehavior</a> (<a class="el" href="classBehaviorInstance.html">BehaviorInstance</a> bi)</td></tr>
  61. <tr class="separator:a3ee1b2fe701b5a95dff404b588375dde"><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:a8025fb8ffc02dd84c90905dd73859afa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#a8025fb8ffc02dd84c90905dd73859afa">connect</a> (outputBehavior, inputBehavior, outputName, inputName)</td></tr>
  65. <tr class="separator:a8025fb8ffc02dd84c90905dd73859afa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66. <tr class="memitem:a1995380a2798b116abca2aa8044e17ae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#a1995380a2798b116abca2aa8044e17ae">disconnect</a> (outputBehavior, inputBehavior, outputName, inputName)</td></tr>
  67. <tr class="separator:a1995380a2798b116abca2aa8044e17ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68. <tr class="memitem:ade6e99c5fecdf8932adbd93fc26458ec"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#ade6e99c5fecdf8932adbd93fc26458ec">getBehavior</a> (string BehaviorTemplateName)</td></tr>
  69. <tr class="separator:ade6e99c5fecdf8932adbd93fc26458ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70. <tr class="memitem:a5ef382f32a62ed540d71ddbebe09ea05"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#a5ef382f32a62ed540d71ddbebe09ea05">getBehaviorByIndex</a> (int index)</td></tr>
  71. <tr class="separator:a5ef382f32a62ed540d71ddbebe09ea05"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72. <tr class="memitem:aacdd87bb5197791aed305847cabd3ae8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#aacdd87bb5197791aed305847cabd3ae8">getBehaviorConnection</a> (outputBehavior, outputName, connectionIndex)</td></tr>
  73. <tr class="separator:aacdd87bb5197791aed305847cabd3ae8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <tr class="memitem:afd1e09bef3f16afe94910c356123c5d3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#afd1e09bef3f16afe94910c356123c5d3">getBehaviorConnectionCount</a> (outputBehavior, outputName)</td></tr>
  75. <tr class="separator:afd1e09bef3f16afe94910c356123c5d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem:ad94b8644d096dbd023e02e42fcf1625c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#ad94b8644d096dbd023e02e42fcf1625c">getBehaviorCount</a> ()</td></tr>
  77. <tr class="separator:ad94b8644d096dbd023e02e42fcf1625c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:a0a5b7c24e55a803dac194ba3c6c392cf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#a0a5b7c24e55a803dac194ba3c6c392cf">raise</a> (outputBehavior, outputName,[deltaTime])</td></tr>
  79. <tr class="separator:a0a5b7c24e55a803dac194ba3c6c392cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:a6abd974e3f1814e2f4238e3d77477578"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#a6abd974e3f1814e2f4238e3d77477578">removeBehavior</a> (<a class="el" href="classBehaviorInstance.html">BehaviorInstance</a> bi,[bool deleteBehavior=true])</td></tr>
  81. <tr class="separator:a6abd974e3f1814e2f4238e3d77477578"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:a6f36c7acf98573635dad24b7d7193b22"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#a6f36c7acf98573635dad24b7d7193b22">reOrder</a> (<a class="el" href="classBehaviorInstance.html">BehaviorInstance</a> inst,[int desiredIndex=0])</td></tr>
  83. <tr class="separator:a6f36c7acf98573635dad24b7d7193b22"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="inherit_header pub_methods_classDynamicConsoleMethodComponent"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classDynamicConsoleMethodComponent')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classDynamicConsoleMethodComponent.html">DynamicConsoleMethodComponent</a></td></tr>
  85. <tr class="memitem:aaf3c579116f01660ee8c9eaf3707836f inherit pub_methods_classDynamicConsoleMethodComponent"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDynamicConsoleMethodComponent.html#aaf3c579116f01660ee8c9eaf3707836f">callOnBehaviors</a> (methodName, argi)</td></tr>
  86. <tr class="separator:aaf3c579116f01660ee8c9eaf3707836f inherit pub_methods_classDynamicConsoleMethodComponent"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="inherit_header pub_methods_classSimComponent"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classSimComponent')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classSimComponent.html">SimComponent</a></td></tr>
  88. <tr class="memitem:af77bd2fcd1d0e89168e634c05d582984 inherit pub_methods_classSimComponent"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimComponent.html#af77bd2fcd1d0e89168e634c05d582984">addComponents</a> (compObjName, compObjName2,...)</td></tr>
  89. <tr class="separator:af77bd2fcd1d0e89168e634c05d582984 inherit pub_methods_classSimComponent"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:ac6b65b4366172bffb80c0b0b12b592d1 inherit pub_methods_classSimComponent"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimComponent.html#ac6b65b4366172bffb80c0b0b12b592d1">getComponent</a> (idx)</td></tr>
  91. <tr class="separator:ac6b65b4366172bffb80c0b0b12b592d1 inherit pub_methods_classSimComponent"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:a552c25f512c6560d2a2f3f8ced594492 inherit pub_methods_classSimComponent"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimComponent.html#a552c25f512c6560d2a2f3f8ced594492">getComponentCount</a> ()</td></tr>
  93. <tr class="separator:a552c25f512c6560d2a2f3f8ced594492 inherit pub_methods_classSimComponent"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a8f0546e83514d6d10458185eed4b1194 inherit pub_methods_classSimComponent"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimComponent.html#a8f0546e83514d6d10458185eed4b1194">isEnabled</a> ()</td></tr>
  95. <tr class="separator:a8f0546e83514d6d10458185eed4b1194 inherit pub_methods_classSimComponent"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:aa6b7f4d7b403aa6fe61f85ac5ed958a0 inherit pub_methods_classSimComponent"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimComponent.html#aa6b7f4d7b403aa6fe61f85ac5ed958a0">removeComponents</a> (compObjName, compObjName2,...)</td></tr>
  97. <tr class="separator:aa6b7f4d7b403aa6fe61f85ac5ed958a0 inherit pub_methods_classSimComponent"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:af8a22cb1cf3aa737bdd42a61cf8fde0a inherit pub_methods_classSimComponent"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimComponent.html#af8a22cb1cf3aa737bdd42a61cf8fde0a">setEnabled</a> (enabled)</td></tr>
  99. <tr class="separator:af8a22cb1cf3aa737bdd42a61cf8fde0a inherit pub_methods_classSimComponent"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="inherit_header pub_methods_classSimObject"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classSimObject')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classSimObject.html">SimObject</a></td></tr>
  101. <tr class="memitem:a22437f451ceb1429fa2a3be23d523954 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a22437f451ceb1429fa2a3be23d523954">clone</a> ([copyDynamicFields=false]?)</td></tr>
  102. <tr class="separator:a22437f451ceb1429fa2a3be23d523954 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a7a4721d0a51e952c211e9b0fea4d8090">delete</a> ()</td></tr>
  104. <tr class="separator:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:a929e1325a515b279faca90a65028782e inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a929e1325a515b279faca90a65028782e">getId</a> ()</td></tr>
  106. <tr class="separator:a929e1325a515b279faca90a65028782e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a4f673cd959711ae09927e7c44dae5fdb">setName</a> (newName)</td></tr>
  108. <tr class="separator:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:a78ee178b6a73658d65ca60da4d1e6683 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a78ee178b6a73658d65ca60da4d1e6683">getName</a> ()</td></tr>
  110. <tr class="separator:a78ee178b6a73658d65ca60da4d1e6683 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:ab8b0f8b874af628d7204d9cc2630ced7 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab8b0f8b874af628d7204d9cc2630ced7">getClassNamespace</a> ()</td></tr>
  112. <tr class="separator:ab8b0f8b874af628d7204d9cc2630ced7 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:a6e266d4432d70cad58461d96e1d2cbdf inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a6e266d4432d70cad58461d96e1d2cbdf">getSuperClassNamespace</a> ()</td></tr>
  114. <tr class="separator:a6e266d4432d70cad58461d96e1d2cbdf inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:a847e859bcc5b58df83fa7f331c167c32 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a847e859bcc5b58df83fa7f331c167c32">setClassNamespace</a> (nameSpace)</td></tr>
  116. <tr class="separator:a847e859bcc5b58df83fa7f331c167c32 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a9cbf471b97387d5bdefb88f92094ad54">setSuperClassNamespace</a> ()</td></tr>
  118. <tr class="separator:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:a8f4e85d0903526235ed2ca86df69cdef inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a8f4e85d0903526235ed2ca86df69cdef">isMethod</a> (string methodName)</td></tr>
  120. <tr class="separator:a8f4e85d0903526235ed2ca86df69cdef inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:aa9873d392a76100738de2337c882f477 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa9873d392a76100738de2337c882f477">call</a> (methodName,[args]*)</td></tr>
  122. <tr class="separator:aa9873d392a76100738de2337c882f477 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1810f5aba25efd242c24232c2c2bbd1a">dumpClassHierarchy</a> ()</td></tr>
  124. <tr class="separator:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#accd2600060dbaee3a3b41aed4034c63c">dump</a> ()</td></tr>
  126. <tr class="separator:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:a66ac731a8dc088fe8c8ab17bf7c9eecd inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a66ac731a8dc088fe8c8ab17bf7c9eecd">isMemberOfClass</a> (string classname)</td></tr>
  128. <tr class="separator:a66ac731a8dc088fe8c8ab17bf7c9eecd inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:a3e97a324df2af082cdb089491757ce11 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a3e97a324df2af082cdb089491757ce11">getClassName</a> ()</td></tr>
  130. <tr class="separator:a3e97a324df2af082cdb089491757ce11 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:abc2222a9649b5c033810e753b07f26a3 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#abc2222a9649b5c033810e753b07f26a3">getFieldValue</a> (fieldName)</td></tr>
  132. <tr class="separator:abc2222a9649b5c033810e753b07f26a3 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:a1084f1964e446b3d279943cf6e575069 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1084f1964e446b3d279943cf6e575069">setFieldValue</a> (fieldName, value)</td></tr>
  134. <tr class="separator:a1084f1964e446b3d279943cf6e575069 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:a7543b8dc494ec0d9034cb73ae504f3ca inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a7543b8dc494ec0d9034cb73ae504f3ca">getDynamicFieldCount</a> ()</td></tr>
  136. <tr class="separator:a7543b8dc494ec0d9034cb73ae504f3ca inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:a0e143217119b68d557d17ac2f13b173e inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0e143217119b68d557d17ac2f13b173e">getDynamicField</a> (index)</td></tr>
  138. <tr class="separator:a0e143217119b68d557d17ac2f13b173e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:af2e74f6b683da8d2085f0991dab7948b inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#af2e74f6b683da8d2085f0991dab7948b">getFieldCount</a> ()</td></tr>
  140. <tr class="separator:af2e74f6b683da8d2085f0991dab7948b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:ac636f89189406eef1b401292459b1a3b inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ac636f89189406eef1b401292459b1a3b">getField</a> (int index)</td></tr>
  142. <tr class="separator:ac636f89189406eef1b401292459b1a3b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa8f68d1e6d8c6601c39b3f676f0e9c70">setProgenitorFile</a> (file)</td></tr>
  144. <tr class="separator:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <tr class="memitem:a88c8d99755a07ac4648360dd40ff67a5 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a88c8d99755a07ac4648360dd40ff67a5">getProgenitorFile</a> ()</td></tr>
  146. <tr class="separator:a88c8d99755a07ac4648360dd40ff67a5 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:a367706e675179342e6153c45f1ba06ae inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a367706e675179342e6153c45f1ba06ae">getType</a> ()</td></tr>
  148. <tr class="separator:a367706e675179342e6153c45f1ba06ae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:a0570b7f6eb94a0ed941fd75f6f01555b inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0570b7f6eb94a0ed941fd75f6f01555b">getFieldType</a> (fieldName)</td></tr>
  150. <tr class="separator:a0570b7f6eb94a0ed941fd75f6f01555b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <tr class="memitem:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a5aaca360a719feabae0e4e57b921deae">setInternalName</a> (string InternalName)</td></tr>
  152. <tr class="separator:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. <tr class="memitem:af9f341b474a28f4bcf79bc02439b7c18 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#af9f341b474a28f4bcf79bc02439b7c18">getInternalName</a> ()</td></tr>
  154. <tr class="separator:af9f341b474a28f4bcf79bc02439b7c18 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:a986f1b4a76969bac5dfd50b22af8dec6 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a986f1b4a76969bac5dfd50b22af8dec6">isChildOfGroup</a> (groupID)</td></tr>
  156. <tr class="separator:a986f1b4a76969bac5dfd50b22af8dec6 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. <tr class="memitem:ae329d6593bb3f9b8046e7cae693ccc09 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ae329d6593bb3f9b8046e7cae693ccc09">getGroup</a> ()</td></tr>
  158. <tr class="separator:ae329d6593bb3f9b8046e7cae693ccc09 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  159. <tr class="memitem:a2dd2c7a365c19267d7a26923c7616afd inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a2dd2c7a365c19267d7a26923c7616afd">startTimer</a> (callbackFunction, float timePeriod,[repeat]?)</td></tr>
  160. <tr class="separator:a2dd2c7a365c19267d7a26923c7616afd inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  161. <tr class="memitem:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa6f6bfef028c7b053444cbd48567d286">stopTimer</a> ()</td></tr>
  162. <tr class="separator:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  163. <tr class="memitem:a5807c03d2b725a54732d09b53d5da631 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a5807c03d2b725a54732d09b53d5da631">isTimerActive</a> ()</td></tr>
  164. <tr class="separator:a5807c03d2b725a54732d09b53d5da631 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  165. <tr class="memitem:a6b70a037ad6cea86b10fd5188f42bf52 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a6b70a037ad6cea86b10fd5188f42bf52">schedule</a> (time, command,[arg]*)</td></tr>
  166. <tr class="separator:a6b70a037ad6cea86b10fd5188f42bf52 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  167. <tr class="memitem:ad4944a7132f9ee90f801f4cd57014836 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ad4944a7132f9ee90f801f4cd57014836">save</a> (<a class="el" href="group__FileSystemFunctions.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>,[selectedOnly]?)</td></tr>
  168. <tr class="separator:ad4944a7132f9ee90f801f4cd57014836 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  169. <tr class="memitem:a216228c27df224ac5e8d3590494bfb3f inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a216228c27df224ac5e8d3590494bfb3f">addFieldFilter</a> (fieldName)</td></tr>
  170. <tr class="separator:a216228c27df224ac5e8d3590494bfb3f inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  171. <tr class="memitem:ad517bd83c1c853985ab07cd22775c43d inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ad517bd83c1c853985ab07cd22775c43d">removeFieldFilter</a> (fieldName)</td></tr>
  172. <tr class="separator:ad517bd83c1c853985ab07cd22775c43d inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  173. </table>
  174. <h2 class="groupheader">Member Function Documentation</h2>
  175. <a class="anchor" id="a3ee1b2fe701b5a95dff404b588375dde"></a>
  176. <div class="memitem">
  177. <div class="memproto">
  178. <table class="memname">
  179. <tr>
  180. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> addBehavior </td>
  181. <td>(</td>
  182. <td class="paramtype"><a class="el" href="classBehaviorInstance.html">BehaviorInstance</a>&#160;</td>
  183. <td class="paramname"><em>bi</em></td><td>)</td>
  184. <td></td>
  185. </tr>
  186. </table>
  187. </div><div class="memdoc">
  188. <p>Add a behavior to the object </p>
  189. <dl class="params"><dt>Parameters</dt><dd>
  190. <table class="params">
  191. <tr><td class="paramname">bi</td><td>The behavior instance to add </td></tr>
  192. </table>
  193. </dd>
  194. </dl>
  195. <dl class="section return"><dt>Returns</dt><dd>(bool success) Whether or not the behavior was successfully added </dd></dl>
  196. </div>
  197. </div>
  198. <a class="anchor" id="a75cf9aca6491d3442a30255e50929c07"></a>
  199. <div class="memitem">
  200. <div class="memproto">
  201. <table class="memname">
  202. <tr>
  203. <td class="memname">void clearBehaviors </td>
  204. <td>(</td>
  205. <td class="paramname"></td><td>)</td>
  206. <td></td>
  207. </tr>
  208. </table>
  209. </div><div class="memdoc">
  210. <p>Clear all behavior instances </p>
  211. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  212. </div>
  213. </div>
  214. <a class="anchor" id="a8025fb8ffc02dd84c90905dd73859afa"></a>
  215. <div class="memitem">
  216. <div class="memproto">
  217. <table class="memname">
  218. <tr>
  219. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> connect </td>
  220. <td>(</td>
  221. <td class="paramtype">outputBehavior&#160;</td>
  222. <td class="paramname">, </td>
  223. </tr>
  224. <tr>
  225. <td class="paramkey"></td>
  226. <td></td>
  227. <td class="paramtype">inputBehavior&#160;</td>
  228. <td class="paramname">, </td>
  229. </tr>
  230. <tr>
  231. <td class="paramkey"></td>
  232. <td></td>
  233. <td class="paramtype">outputName&#160;</td>
  234. <td class="paramname">, </td>
  235. </tr>
  236. <tr>
  237. <td class="paramkey"></td>
  238. <td></td>
  239. <td class="paramtype">inputName&#160;</td>
  240. <td class="paramname">&#160;</td>
  241. </tr>
  242. <tr>
  243. <td></td>
  244. <td>)</td>
  245. <td></td><td></td>
  246. </tr>
  247. </table>
  248. </div><div class="memdoc">
  249. <p>Connects a behavior output to a behavior input. </p>
  250. <dl class="params"><dt>Parameters</dt><dd>
  251. <table class="params">
  252. <tr><td class="paramname">outputBehavior</td><td>The behavior that owns the output. </td></tr>
  253. <tr><td class="paramname">inputBehavior</td><td>The behavior that owns the input. </td></tr>
  254. <tr><td class="paramname">outputName</td><td>The output name owned by the output behavior. </td></tr>
  255. <tr><td class="paramname">inputName</td><td>The input name owned by the input behavior. </td></tr>
  256. </table>
  257. </dd>
  258. </dl>
  259. <dl class="section return"><dt>Returns</dt><dd>(bool success) Whether the connection was successful or not. </dd></dl>
  260. </div>
  261. </div>
  262. <a class="anchor" id="a1995380a2798b116abca2aa8044e17ae"></a>
  263. <div class="memitem">
  264. <div class="memproto">
  265. <table class="memname">
  266. <tr>
  267. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> disconnect </td>
  268. <td>(</td>
  269. <td class="paramtype">outputBehavior&#160;</td>
  270. <td class="paramname">, </td>
  271. </tr>
  272. <tr>
  273. <td class="paramkey"></td>
  274. <td></td>
  275. <td class="paramtype">inputBehavior&#160;</td>
  276. <td class="paramname">, </td>
  277. </tr>
  278. <tr>
  279. <td class="paramkey"></td>
  280. <td></td>
  281. <td class="paramtype">outputName&#160;</td>
  282. <td class="paramname">, </td>
  283. </tr>
  284. <tr>
  285. <td class="paramkey"></td>
  286. <td></td>
  287. <td class="paramtype">inputName&#160;</td>
  288. <td class="paramname">&#160;</td>
  289. </tr>
  290. <tr>
  291. <td></td>
  292. <td>)</td>
  293. <td></td><td></td>
  294. </tr>
  295. </table>
  296. </div><div class="memdoc">
  297. <p>Connects a behavior output to a behavior input. </p>
  298. <dl class="params"><dt>Parameters</dt><dd>
  299. <table class="params">
  300. <tr><td class="paramname">outputBehavior</td><td>The behavior that owns the output. </td></tr>
  301. <tr><td class="paramname">inputBehavior</td><td>The behavior that owns the input. </td></tr>
  302. <tr><td class="paramname">outputName</td><td>The output name owned by the output behavior. </td></tr>
  303. <tr><td class="paramname">inputName</td><td>The input name owned by the input behavior. </td></tr>
  304. </table>
  305. </dd>
  306. </dl>
  307. <dl class="section return"><dt>Returns</dt><dd>(bool success) Whether the disconnection was successful or not. </dd></dl>
  308. </div>
  309. </div>
  310. <a class="anchor" id="ade6e99c5fecdf8932adbd93fc26458ec"></a>
  311. <div class="memitem">
  312. <div class="memproto">
  313. <table class="memname">
  314. <tr>
  315. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getBehavior </td>
  316. <td>(</td>
  317. <td class="paramtype">string&#160;</td>
  318. <td class="paramname"><em>BehaviorTemplateName</em></td><td>)</td>
  319. <td></td>
  320. </tr>
  321. </table>
  322. </div><div class="memdoc">
  323. <p>gets a behavior </p>
  324. <dl class="params"><dt>Parameters</dt><dd>
  325. <table class="params">
  326. <tr><td class="paramname">BehaviorTemplateName</td><td>The name of the template of the behavior instance you want </td></tr>
  327. </table>
  328. </dd>
  329. </dl>
  330. <dl class="section return"><dt>Returns</dt><dd>(<a class="el" href="classBehaviorInstance.html">BehaviorInstance</a> bi) The behavior instance you requested </dd></dl>
  331. </div>
  332. </div>
  333. <a class="anchor" id="a5ef382f32a62ed540d71ddbebe09ea05"></a>
  334. <div class="memitem">
  335. <div class="memproto">
  336. <table class="memname">
  337. <tr>
  338. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getBehaviorByIndex </td>
  339. <td>(</td>
  340. <td class="paramtype">int&#160;</td>
  341. <td class="paramname"><em>index</em></td><td>)</td>
  342. <td></td>
  343. </tr>
  344. </table>
  345. </div><div class="memdoc">
  346. <p>Gets a particular behavior </p>
  347. <dl class="params"><dt>Parameters</dt><dd>
  348. <table class="params">
  349. <tr><td class="paramname">index</td><td>The index of the behavior to get </td></tr>
  350. </table>
  351. </dd>
  352. </dl>
  353. <dl class="section return"><dt>Returns</dt><dd>(<a class="el" href="classBehaviorInstance.html">BehaviorInstance</a> bi) The behavior instance you requested </dd></dl>
  354. </div>
  355. </div>
  356. <a class="anchor" id="aacdd87bb5197791aed305847cabd3ae8"></a>
  357. <div class="memitem">
  358. <div class="memproto">
  359. <table class="memname">
  360. <tr>
  361. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getBehaviorConnection </td>
  362. <td>(</td>
  363. <td class="paramtype">outputBehavior&#160;</td>
  364. <td class="paramname">, </td>
  365. </tr>
  366. <tr>
  367. <td class="paramkey"></td>
  368. <td></td>
  369. <td class="paramtype">outputName&#160;</td>
  370. <td class="paramname">, </td>
  371. </tr>
  372. <tr>
  373. <td class="paramkey"></td>
  374. <td></td>
  375. <td class="paramtype">connectionIndex&#160;</td>
  376. <td class="paramname">&#160;</td>
  377. </tr>
  378. <tr>
  379. <td></td>
  380. <td>)</td>
  381. <td></td><td></td>
  382. </tr>
  383. </table>
  384. </div><div class="memdoc">
  385. <p>Gets a comma-delimited list of connections on the behavior output on the specified behavior. </p>
  386. <dl class="params"><dt>Parameters</dt><dd>
  387. <table class="params">
  388. <tr><td class="paramname">outputBehavior</td><td>The behavior that owns the output. </td></tr>
  389. <tr><td class="paramname">outputName</td><td>The output name owned by the output behavior. </td></tr>
  390. <tr><td class="paramname">connectionIndex</td><td>The connection index. </td></tr>
  391. </table>
  392. </dd>
  393. </dl>
  394. <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>
  395. </div>
  396. </div>
  397. <a class="anchor" id="afd1e09bef3f16afe94910c356123c5d3"></a>
  398. <div class="memitem">
  399. <div class="memproto">
  400. <table class="memname">
  401. <tr>
  402. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getBehaviorConnectionCount </td>
  403. <td>(</td>
  404. <td class="paramtype">outputBehavior&#160;</td>
  405. <td class="paramname">, </td>
  406. </tr>
  407. <tr>
  408. <td class="paramkey"></td>
  409. <td></td>
  410. <td class="paramtype">outputName&#160;</td>
  411. <td class="paramname">&#160;</td>
  412. </tr>
  413. <tr>
  414. <td></td>
  415. <td>)</td>
  416. <td></td><td></td>
  417. </tr>
  418. </table>
  419. </div><div class="memdoc">
  420. <p>Gets the number of connections on the behavior output on the specified behavior. </p>
  421. <dl class="params"><dt>Parameters</dt><dd>
  422. <table class="params">
  423. <tr><td class="paramname">outputBehavior</td><td>The behavior that owns the output. </td></tr>
  424. <tr><td class="paramname">outputName</td><td>The output name owned by the output behavior. </td></tr>
  425. </table>
  426. </dd>
  427. </dl>
  428. <dl class="section return"><dt>Returns</dt><dd>The number of connections on the behavior output on the specified behavior. </dd></dl>
  429. </div>
  430. </div>
  431. <a class="anchor" id="ad94b8644d096dbd023e02e42fcf1625c"></a>
  432. <div class="memitem">
  433. <div class="memproto">
  434. <table class="memname">
  435. <tr>
  436. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getBehaviorCount </td>
  437. <td>(</td>
  438. <td class="paramname"></td><td>)</td>
  439. <td></td>
  440. </tr>
  441. </table>
  442. </div><div class="memdoc">
  443. <p>Get the count of behaviors on an object </p>
  444. <dl class="section return"><dt>Returns</dt><dd>(int count) The number of behaviors on an object </dd></dl>
  445. </div>
  446. </div>
  447. <a class="anchor" id="a0a5b7c24e55a803dac194ba3c6c392cf"></a>
  448. <div class="memitem">
  449. <div class="memproto">
  450. <table class="memname">
  451. <tr>
  452. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> raise </td>
  453. <td>(</td>
  454. <td class="paramtype">outputBehavior&#160;</td>
  455. <td class="paramname">, </td>
  456. </tr>
  457. <tr>
  458. <td class="paramkey"></td>
  459. <td></td>
  460. <td class="paramtype">outputName&#160;</td>
  461. <td class="paramname">&#160;</td>
  462. </tr>
  463. <tr>
  464. <td></td>
  465. <td>)</td>
  466. <td></td><td></td>
  467. </tr>
  468. </table>
  469. </div><div class="memdoc">
  470. <p>Raise a signal on the behavior output on the specified behavior. </p>
  471. <dl class="params"><dt>Parameters</dt><dd>
  472. <table class="params">
  473. <tr><td class="paramname">outputBehavior</td><td>The behavior that owns the output. </td></tr>
  474. <tr><td class="paramname">outputName</td><td>The output name owned by the output behavior. </td></tr>
  475. <tr><td class="paramname">[deltaTime]</td><td>Optional time-delta (ms) when the raise should occur. </td></tr>
  476. </table>
  477. </dd>
  478. </dl>
  479. <dl class="section return"><dt>Returns</dt><dd>(bool success) Whether the signal raise was successful or not. </dd></dl>
  480. </div>
  481. </div>
  482. <a class="anchor" id="a6abd974e3f1814e2f4238e3d77477578"></a>
  483. <div class="memitem">
  484. <div class="memproto">
  485. <table class="memname">
  486. <tr>
  487. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> removeBehavior </td>
  488. <td>(</td>
  489. <td class="paramtype"><a class="el" href="classBehaviorInstance.html">BehaviorInstance</a>&#160;</td>
  490. <td class="paramname"><em>bi</em></td><td>)</td>
  491. <td></td>
  492. </tr>
  493. </table>
  494. </div><div class="memdoc">
  495. <dl class="params"><dt>Parameters</dt><dd>
  496. <table class="params">
  497. <tr><td class="paramname">bi</td><td>The behavior instance to remove </td></tr>
  498. <tr><td class="paramname">deleteBehavior</td><td>Whether or not to delete the behavior </td></tr>
  499. </table>
  500. </dd>
  501. </dl>
  502. <dl class="section return"><dt>Returns</dt><dd>(bool success) Whether the behavior was successfully removed </dd></dl>
  503. </div>
  504. </div>
  505. <a class="anchor" id="a6f36c7acf98573635dad24b7d7193b22"></a>
  506. <div class="memitem">
  507. <div class="memproto">
  508. <table class="memname">
  509. <tr>
  510. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> reOrder </td>
  511. <td>(</td>
  512. <td class="paramtype"><a class="el" href="classBehaviorInstance.html">BehaviorInstance</a>&#160;</td>
  513. <td class="paramname"><em>inst</em></td><td>)</td>
  514. <td></td>
  515. </tr>
  516. </table>
  517. </div><div class="memdoc">
  518. <dl class="params"><dt>Parameters</dt><dd>
  519. <table class="params">
  520. <tr><td class="paramname">inst</td><td>The behavior instance you want to reorder </td></tr>
  521. <tr><td class="paramname">desiredIndex</td><td>The index you want the behavior instance to be reordered to </td></tr>
  522. </table>
  523. </dd>
  524. </dl>
  525. <dl class="section return"><dt>Returns</dt><dd>(bool success) Whether or not the behavior instance was successfully reordered </dd></dl>
  526. </div>
  527. </div>
  528. </div><!-- contents -->
  529. <!-- start footer part -->
  530. <hr class="footer"/><address class="footer"><small>
  531. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  532. <img class="footer" src="doxygen.png" alt="doxygen"/>
  533. </a> 1.8.3.1
  534. </small></address>
  535. </body>
  536. </html>