classBehaviorTemplate.html 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542
  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: BehaviorTemplate 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="classBehaviorTemplate-members.html">List of all members</a> </div>
  51. <div class="headertitle">
  52. <div class="title">BehaviorTemplate Class Reference</div> </div>
  53. </div><!--header-->
  54. <div class="contents">
  55. <p>Inherits <a class="el" href="classSimObject.html">SimObject</a>.</p>
  56. <table class="memberdecls">
  57. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  58. Public Member Functions</h2></td></tr>
  59. <tr class="memitem:adda0e083dec79f3d32f00c9b77e0ca77"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorTemplate.html#adda0e083dec79f3d32f00c9b77e0ca77">addBehaviorField</a> (fieldName, desc, type,[defaultValue, userData])</td></tr>
  60. <tr class="separator:adda0e083dec79f3d32f00c9b77e0ca77"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61. <tr class="memitem:a1f1199b67ba4a72a4c9f4a52ca8d4eca"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorTemplate.html#a1f1199b67ba4a72a4c9f4a52ca8d4eca">addBehaviorInput</a> (inputName, label, description)</td></tr>
  62. <tr class="separator:a1f1199b67ba4a72a4c9f4a52ca8d4eca"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63. <tr class="memitem:af5886b1916d5311b759fd36ec9aca151"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorTemplate.html#af5886b1916d5311b759fd36ec9aca151">addBehaviorOutput</a> (outputName, label, description)</td></tr>
  64. <tr class="separator:af5886b1916d5311b759fd36ec9aca151"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65. <tr class="memitem:a69614895dd2c6c3eecb5f599a5c20b10"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorTemplate.html#a69614895dd2c6c3eecb5f599a5c20b10">createInstance</a> ()</td></tr>
  66. <tr class="separator:a69614895dd2c6c3eecb5f599a5c20b10"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67. <tr class="memitem:a032c5a8054fb57b3df3ed6d0103b3040"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorTemplate.html#a032c5a8054fb57b3df3ed6d0103b3040">getBehaviorField</a> (int fieldIndex)</td></tr>
  68. <tr class="separator:a032c5a8054fb57b3df3ed6d0103b3040"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69. <tr class="memitem:aec11c58ec2828d428e52f34d48e8294c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorTemplate.html#aec11c58ec2828d428e52f34d48e8294c">getBehaviorFieldCount</a> ()</td></tr>
  70. <tr class="separator:aec11c58ec2828d428e52f34d48e8294c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71. <tr class="memitem:a9e0286abb6efed33ec51ca39160cdf5e"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorTemplate.html#a9e0286abb6efed33ec51ca39160cdf5e">getBehaviorFieldDescription</a> (int fieldIndex)</td></tr>
  72. <tr class="separator:a9e0286abb6efed33ec51ca39160cdf5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. <tr class="memitem:aff535d958ef9d250d7c8d17492aaf89e"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorTemplate.html#aff535d958ef9d250d7c8d17492aaf89e">getBehaviorFieldUserData</a> (int fieldIndex)</td></tr>
  74. <tr class="separator:aff535d958ef9d250d7c8d17492aaf89e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. <tr class="memitem:a88e33bf9510808644d0e7eaa5a4c9e20"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorTemplate.html#a88e33bf9510808644d0e7eaa5a4c9e20">getBehaviorInput</a> (int inputIndex)</td></tr>
  76. <tr class="separator:a88e33bf9510808644d0e7eaa5a4c9e20"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:aeca336026e2f31c6a0e3b556cc245e22"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorTemplate.html#aeca336026e2f31c6a0e3b556cc245e22">getBehaviorInputCount</a> ()</td></tr>
  78. <tr class="separator:aeca336026e2f31c6a0e3b556cc245e22"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:afff407a21c0a053dd92ed71a75746520"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorTemplate.html#afff407a21c0a053dd92ed71a75746520">getBehaviorOutput</a> (int outputIndex)</td></tr>
  80. <tr class="separator:afff407a21c0a053dd92ed71a75746520"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:ac30e95b7133c5f6bf4c2c7ddca7c8a5d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorTemplate.html#ac30e95b7133c5f6bf4c2c7ddca7c8a5d">getBehaviorOutputCount</a> ()</td></tr>
  82. <tr class="separator:ac30e95b7133c5f6bf4c2c7ddca7c8a5d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:afefafa1c7be9d165fc5d5f3fa7565e68"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorTemplate.html#afefafa1c7be9d165fc5d5f3fa7565e68">hasBehaviorInput</a> (inputName)</td></tr>
  84. <tr class="separator:afefafa1c7be9d165fc5d5f3fa7565e68"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:a9112960d360b2e5ed6f382350c017eef"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorTemplate.html#a9112960d360b2e5ed6f382350c017eef">hasBehaviorOutput</a> (outputName)</td></tr>
  86. <tr class="separator:a9112960d360b2e5ed6f382350c017eef"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <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>
  88. <tr class="memitem:a1c1f9babb145bfdf63e60223663dff3c inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1c1f9babb145bfdf63e60223663dff3c">call</a> (functionName,[args]*)</td></tr>
  89. <tr class="separator:a1c1f9babb145bfdf63e60223663dff3c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a3b4f0f3ccdfa27b8008f8559a83539bc inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a3b4f0f3ccdfa27b8008f8559a83539bc">clone</a> ([bool copyDynamicFields?=false]?)</td></tr>
  91. <tr class="separator:a3b4f0f3ccdfa27b8008f8559a83539bc inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <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>
  93. <tr class="separator:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <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>
  95. <tr class="separator:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <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>
  97. <tr class="separator:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:adeaebc2111072105cbb6961df917d223 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#adeaebc2111072105cbb6961df917d223">getClassName</a> ()</td></tr>
  99. <tr class="separator:adeaebc2111072105cbb6961df917d223 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:afbb3b5d0356df264b7343d135b697bcf inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#afbb3b5d0356df264b7343d135b697bcf">getClassNamespace</a> ()</td></tr>
  101. <tr class="separator:afbb3b5d0356df264b7343d135b697bcf inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a771f0adf4c566c3ac2f7c5c32e75d43c inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a771f0adf4c566c3ac2f7c5c32e75d43c">getDynamicField</a> (index)</td></tr>
  103. <tr class="separator:a771f0adf4c566c3ac2f7c5c32e75d43c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:affd866a31305bc1e70c572b2be76069b inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#affd866a31305bc1e70c572b2be76069b">getDynamicFieldCount</a> ()</td></tr>
  105. <tr class="separator:affd866a31305bc1e70c572b2be76069b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:af219f6b5498fbd8671e298303c28b1dc inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#af219f6b5498fbd8671e298303c28b1dc">getField</a> (int index)</td></tr>
  107. <tr class="separator:af219f6b5498fbd8671e298303c28b1dc inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:a0d14fc4334b31b14e243de86cc1609a4 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0d14fc4334b31b14e243de86cc1609a4">getFieldCount</a> ()</td></tr>
  109. <tr class="separator:a0d14fc4334b31b14e243de86cc1609a4 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:a6c87209e1a998d8b35e1cde74839bfcc inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a6c87209e1a998d8b35e1cde74839bfcc">getFieldType</a> (fieldName)</td></tr>
  111. <tr class="separator:a6c87209e1a998d8b35e1cde74839bfcc inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:adf03af9303912906eada72ccf10115e8 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#adf03af9303912906eada72ccf10115e8">getFieldValue</a> (fieldName)</td></tr>
  113. <tr class="separator:adf03af9303912906eada72ccf10115e8 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:ad35d7fe358fa34d2eba803c7506791f3 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ad35d7fe358fa34d2eba803c7506791f3">getGroup</a> ()</td></tr>
  115. <tr class="separator:ad35d7fe358fa34d2eba803c7506791f3 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:a67283be3f45257d1e0c474c563ebb6b6 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a67283be3f45257d1e0c474c563ebb6b6">getId</a> ()</td></tr>
  117. <tr class="separator:a67283be3f45257d1e0c474c563ebb6b6 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:a137797d39611f3f3108b30852d28622c inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a137797d39611f3f3108b30852d28622c">getInternalName</a> ()</td></tr>
  119. <tr class="separator:a137797d39611f3f3108b30852d28622c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:a510119ff902e4e96165a7475370be836 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a510119ff902e4e96165a7475370be836">getName</a> ()</td></tr>
  121. <tr class="separator:a510119ff902e4e96165a7475370be836 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:aa71cf6ba84b0de85019204261a9136b7 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa71cf6ba84b0de85019204261a9136b7">getProgenitorFile</a> ()</td></tr>
  123. <tr class="separator:aa71cf6ba84b0de85019204261a9136b7 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:a0f693104a44b07db870d4e54f2db4c08 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0f693104a44b07db870d4e54f2db4c08">getSuperClassNamespace</a> ()</td></tr>
  125. <tr class="separator:a0f693104a44b07db870d4e54f2db4c08 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:aec389cbe6ac7aff8ce7196e7dbc007df inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aec389cbe6ac7aff8ce7196e7dbc007df">getType</a> ()</td></tr>
  127. <tr class="separator:aec389cbe6ac7aff8ce7196e7dbc007df inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:af4da33de69819e293d90cf52fcbda6da inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#af4da33de69819e293d90cf52fcbda6da">isChildOfGroup</a> ()</td></tr>
  129. <tr class="separator:af4da33de69819e293d90cf52fcbda6da inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:a35273f559aecabece437c22ee8aee443 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a35273f559aecabece437c22ee8aee443">isMemberOfClass</a> (string classname)</td></tr>
  131. <tr class="separator:a35273f559aecabece437c22ee8aee443 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:a8a1d5ac5403526378c7abb0916c55c3c inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a8a1d5ac5403526378c7abb0916c55c3c">isMethod</a> (const char *methodName)</td></tr>
  133. <tr class="separator:a8a1d5ac5403526378c7abb0916c55c3c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:a8ca0e6f21ff100da6bcd59f51d34fb8e inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a8ca0e6f21ff100da6bcd59f51d34fb8e">isMethod</a> (string method name)</td></tr>
  135. <tr class="separator:a8ca0e6f21ff100da6bcd59f51d34fb8e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:a9fed7ee24702928365ad45e6eaba4d12 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a9fed7ee24702928365ad45e6eaba4d12">isTimerActive</a> ()</td></tr>
  137. <tr class="separator:a9fed7ee24702928365ad45e6eaba4d12 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:aa92c3478d4ff5780f0f027598480d772 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa92c3478d4ff5780f0f027598480d772">save</a> (<a class="el" href="group__FileSystemFunctions.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>,[selectedOnly]?)</td></tr>
  139. <tr class="separator:aa92c3478d4ff5780f0f027598480d772 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:aabc265010a7a59dcec211ddd8f0ac5a7 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aabc265010a7a59dcec211ddd8f0ac5a7">schedule</a> (time, command,[arg]*)</td></tr>
  141. <tr class="separator:aabc265010a7a59dcec211ddd8f0ac5a7 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <tr class="memitem:aa3e15ecdee7ab3ece234913bc4e783c0 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#aa3e15ecdee7ab3ece234913bc4e783c0">setClassNamespace</a> ()</td></tr>
  143. <tr class="separator:aa3e15ecdee7ab3ece234913bc4e783c0 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:ae099b2a1810ca2e23ac11d239ae0197e inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ae099b2a1810ca2e23ac11d239ae0197e">setFieldValue</a> (fieldName, value)</td></tr>
  145. <tr class="separator:ae099b2a1810ca2e23ac11d239ae0197e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <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>
  147. <tr class="separator:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <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>
  149. <tr class="separator:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <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>
  151. <tr class="separator:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <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>
  153. <tr class="separator:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <tr class="memitem:a5447439ba5620b2ac00dc0ef97ef2142 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a5447439ba5620b2ac00dc0ef97ef2142">startTimer</a> (callbackFunction, float timePeriod,[repeat]?)</td></tr>
  155. <tr class="separator:a5447439ba5620b2ac00dc0ef97ef2142 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. <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>
  157. <tr class="separator:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. </table><table class="memberdecls">
  159. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
  160. Additional Inherited Members</h2></td></tr>
  161. <tr class="inherit_header pub_static_methods_classSimObject"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classSimObject')"><img src="closed.png" alt="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="classSimObject.html">SimObject</a></td></tr>
  162. <tr class="memitem:ac7926551c6df020f767d8d87f5a3d575 inherit pub_static_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">static S32 QSORT_CALLBACK&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ac7926551c6df020f767d8d87f5a3d575">compareFields</a> (const void *a, const void *b)</td></tr>
  163. <tr class="separator:ac7926551c6df020f767d8d87f5a3d575 inherit pub_static_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  164. </table>
  165. <h2 class="groupheader">Member Function Documentation</h2>
  166. <a class="anchor" id="adda0e083dec79f3d32f00c9b77e0ca77"></a>
  167. <div class="memitem">
  168. <div class="memproto">
  169. <table class="memname">
  170. <tr>
  171. <td class="memname">bool addBehaviorField </td>
  172. <td>(</td>
  173. <td class="paramtype">fieldName&#160;</td>
  174. <td class="paramname">, </td>
  175. </tr>
  176. <tr>
  177. <td class="paramkey"></td>
  178. <td></td>
  179. <td class="paramtype">desc&#160;</td>
  180. <td class="paramname">, </td>
  181. </tr>
  182. <tr>
  183. <td class="paramkey"></td>
  184. <td></td>
  185. <td class="paramtype">type&#160;</td>
  186. <td class="paramname">&#160;</td>
  187. </tr>
  188. <tr>
  189. <td></td>
  190. <td>)</td>
  191. <td></td><td></td>
  192. </tr>
  193. </table>
  194. </div><div class="memdoc">
  195. <p>Adds a named BehaviorField to a Behavior Template </p>
  196. <dl class="params"><dt>Parameters</dt><dd>
  197. <table class="params">
  198. <tr><td class="paramname">fieldName</td><td>The name of this field </td></tr>
  199. <tr><td class="paramname">desc</td><td>The Description of this field </td></tr>
  200. <tr><td class="paramname">type</td><td>The DataType for this field (default, int, float, Point2F, bool, enum, Object, keybind, color) </td></tr>
  201. <tr><td class="paramname">defaultValue</td><td>The Default value for this field </td></tr>
  202. <tr><td class="paramname">userData</td><td>An extra data field that can be used for custom data on a per-field basis<br/>
  203. Usage for default types<br/>
  204. -enum: a TAB separated list of possible values<br/>
  205. -object: the scene-object type that are valid choices for the field. The object types observe inheritance, so if you have a <a class="el" href="classSceneObject.html">SceneObject</a> field you will be able to choose t2dStaticSrpites, t2dAnimatedSprites, etc. </td></tr>
  206. </table>
  207. </dd>
  208. </dl>
  209. <dl class="section return"><dt>Returns</dt><dd>Whether the field was added or not. </dd></dl>
  210. </div>
  211. </div>
  212. <a class="anchor" id="a1f1199b67ba4a72a4c9f4a52ca8d4eca"></a>
  213. <div class="memitem">
  214. <div class="memproto">
  215. <table class="memname">
  216. <tr>
  217. <td class="memname">bool addBehaviorInput </td>
  218. <td>(</td>
  219. <td class="paramtype">inputName&#160;</td>
  220. <td class="paramname">, </td>
  221. </tr>
  222. <tr>
  223. <td class="paramkey"></td>
  224. <td></td>
  225. <td class="paramtype">label&#160;</td>
  226. <td class="paramname">, </td>
  227. </tr>
  228. <tr>
  229. <td class="paramkey"></td>
  230. <td></td>
  231. <td class="paramtype">description&#160;</td>
  232. <td class="paramname">&#160;</td>
  233. </tr>
  234. <tr>
  235. <td></td>
  236. <td>)</td>
  237. <td></td><td></td>
  238. </tr>
  239. </table>
  240. </div><div class="memdoc">
  241. <p>Adds a behavior input. </p>
  242. <dl class="params"><dt>Parameters</dt><dd>
  243. <table class="params">
  244. <tr><td class="paramname">inputName</td><td>The input name to use. </td></tr>
  245. <tr><td class="paramname">label</td><td>The short label name to show in the editor. </td></tr>
  246. <tr><td class="paramname">description</td><td>The long description to show in the editor. </td></tr>
  247. </table>
  248. </dd>
  249. </dl>
  250. <dl class="section return"><dt>Returns</dt><dd>Whether the input was added or not. </dd></dl>
  251. </div>
  252. </div>
  253. <a class="anchor" id="af5886b1916d5311b759fd36ec9aca151"></a>
  254. <div class="memitem">
  255. <div class="memproto">
  256. <table class="memname">
  257. <tr>
  258. <td class="memname">bool addBehaviorOutput </td>
  259. <td>(</td>
  260. <td class="paramtype">outputName&#160;</td>
  261. <td class="paramname">, </td>
  262. </tr>
  263. <tr>
  264. <td class="paramkey"></td>
  265. <td></td>
  266. <td class="paramtype">label&#160;</td>
  267. <td class="paramname">, </td>
  268. </tr>
  269. <tr>
  270. <td class="paramkey"></td>
  271. <td></td>
  272. <td class="paramtype">description&#160;</td>
  273. <td class="paramname">&#160;</td>
  274. </tr>
  275. <tr>
  276. <td></td>
  277. <td>)</td>
  278. <td></td><td></td>
  279. </tr>
  280. </table>
  281. </div><div class="memdoc">
  282. <p>Adds a behavior output. </p>
  283. <dl class="params"><dt>Parameters</dt><dd>
  284. <table class="params">
  285. <tr><td class="paramname">outputName</td><td>The output name to use. </td></tr>
  286. <tr><td class="paramname">label</td><td>The short label name to show in the editor. </td></tr>
  287. <tr><td class="paramname">description</td><td>The long description to show in the editor. </td></tr>
  288. </table>
  289. </dd>
  290. </dl>
  291. <dl class="section return"><dt>Returns</dt><dd>Whether the output was added or not. </dd></dl>
  292. </div>
  293. </div>
  294. <a class="anchor" id="a69614895dd2c6c3eecb5f599a5c20b10"></a>
  295. <div class="memitem">
  296. <div class="memproto">
  297. <table class="memname">
  298. <tr>
  299. <td class="memname">int createInstance </td>
  300. <td>(</td>
  301. <td class="paramname"></td><td>)</td>
  302. <td></td>
  303. </tr>
  304. </table>
  305. </div><div class="memdoc">
  306. <p>Create an instance of this behavior. </p>
  307. <dl class="section return"><dt>Returns</dt><dd>(<a class="el" href="classBehaviorInstance.html">BehaviorInstance</a> inst) The behavior instance created </dd></dl>
  308. </div>
  309. </div>
  310. <a class="anchor" id="a032c5a8054fb57b3df3ed6d0103b3040"></a>
  311. <div class="memitem">
  312. <div class="memproto">
  313. <table class="memname">
  314. <tr>
  315. <td class="memname">string getBehaviorField </td>
  316. <td>(</td>
  317. <td class="paramtype">int&#160;</td>
  318. <td class="paramname"><em>fieldIndex</em></td><td>)</td>
  319. <td></td>
  320. </tr>
  321. </table>
  322. </div><div class="memdoc">
  323. <p>Gets a tab-delimited description of the behavior field. </p>
  324. <dl class="params"><dt>Parameters</dt><dd>
  325. <table class="params">
  326. <tr><td class="paramname">fieldIndex</td><td>The index of the behavior field. </td></tr>
  327. </table>
  328. </dd>
  329. </dl>
  330. <dl class="section return"><dt>Returns</dt><dd>A tab-delimited description of the behavior field of the format &lt;Name&gt;&lt;Type&gt;&lt;DefaultValue&gt; or an empty string if behavior field is not found. </dd></dl>
  331. </div>
  332. </div>
  333. <a class="anchor" id="aec11c58ec2828d428e52f34d48e8294c"></a>
  334. <div class="memitem">
  335. <div class="memproto">
  336. <table class="memname">
  337. <tr>
  338. <td class="memname">int getBehaviorFieldCount </td>
  339. <td>(</td>
  340. <td class="paramname"></td><td>)</td>
  341. <td></td>
  342. </tr>
  343. </table>
  344. </div><div class="memdoc">
  345. <p>Get the number of behavior fields. </p>
  346. <dl class="section return"><dt>Returns</dt><dd>Returns the number of behavior fields. </dd></dl>
  347. </div>
  348. </div>
  349. <a class="anchor" id="a9e0286abb6efed33ec51ca39160cdf5e"></a>
  350. <div class="memitem">
  351. <div class="memproto">
  352. <table class="memname">
  353. <tr>
  354. <td class="memname">string getBehaviorFieldDescription </td>
  355. <td>(</td>
  356. <td class="paramtype">int&#160;</td>
  357. <td class="paramname"><em>fieldIndex</em></td><td>)</td>
  358. <td></td>
  359. </tr>
  360. </table>
  361. </div><div class="memdoc">
  362. <p>Gets the description of the field. </p>
  363. <dl class="params"><dt>Parameters</dt><dd>
  364. <table class="params">
  365. <tr><td class="paramname">fieldIndex</td><td>The index of the behavior field. </td></tr>
  366. </table>
  367. </dd>
  368. </dl>
  369. <dl class="section return"><dt>Returns</dt><dd>Returns the field description. </dd></dl>
  370. </div>
  371. </div>
  372. <a class="anchor" id="aff535d958ef9d250d7c8d17492aaf89e"></a>
  373. <div class="memitem">
  374. <div class="memproto">
  375. <table class="memname">
  376. <tr>
  377. <td class="memname">string getBehaviorFieldUserData </td>
  378. <td>(</td>
  379. <td class="paramtype">int&#160;</td>
  380. <td class="paramname"><em>fieldIndex</em></td><td>)</td>
  381. <td></td>
  382. </tr>
  383. </table>
  384. </div><div class="memdoc">
  385. <p>Gets the UserData associated with a field by index in the field list </p>
  386. <dl class="params"><dt>Parameters</dt><dd>
  387. <table class="params">
  388. <tr><td class="paramname">fieldIndex</td><td>The index of the behavior field. </td></tr>
  389. </table>
  390. </dd>
  391. </dl>
  392. <dl class="section return"><dt>Returns</dt><dd>Returns a string representing the user data of this field </dd></dl>
  393. </div>
  394. </div>
  395. <a class="anchor" id="a88e33bf9510808644d0e7eaa5a4c9e20"></a>
  396. <div class="memitem">
  397. <div class="memproto">
  398. <table class="memname">
  399. <tr>
  400. <td class="memname">string getBehaviorInput </td>
  401. <td>(</td>
  402. <td class="paramtype">int&#160;</td>
  403. <td class="paramname"><em>inputIndex</em></td><td>)</td>
  404. <td></td>
  405. </tr>
  406. </table>
  407. </div><div class="memdoc">
  408. <p>Gets a comma-delimited description of the behavior input. </p>
  409. <dl class="params"><dt>Parameters</dt><dd>
  410. <table class="params">
  411. <tr><td class="paramname">inputIndex</td><td>The index of the behavior input. </td></tr>
  412. </table>
  413. </dd>
  414. </dl>
  415. <dl class="section return"><dt>Returns</dt><dd>A comma-delimited description of the behavior input of the format &lt;Name&gt;,&lt;Label&gt;&lt;,Description&gt; or an empty string if behavior input is not found. </dd></dl>
  416. </div>
  417. </div>
  418. <a class="anchor" id="aeca336026e2f31c6a0e3b556cc245e22"></a>
  419. <div class="memitem">
  420. <div class="memproto">
  421. <table class="memname">
  422. <tr>
  423. <td class="memname">int getBehaviorInputCount </td>
  424. <td>(</td>
  425. <td class="paramname"></td><td>)</td>
  426. <td></td>
  427. </tr>
  428. </table>
  429. </div><div class="memdoc">
  430. <p>Get the number of behavior inputs. </p>
  431. <dl class="section return"><dt>Returns</dt><dd>Returns the number of behavior inputs. </dd></dl>
  432. </div>
  433. </div>
  434. <a class="anchor" id="afff407a21c0a053dd92ed71a75746520"></a>
  435. <div class="memitem">
  436. <div class="memproto">
  437. <table class="memname">
  438. <tr>
  439. <td class="memname">string getBehaviorOutput </td>
  440. <td>(</td>
  441. <td class="paramtype">int&#160;</td>
  442. <td class="paramname"><em>outputIndex</em></td><td>)</td>
  443. <td></td>
  444. </tr>
  445. </table>
  446. </div><div class="memdoc">
  447. <p>Gets a comma-delimited description of the behavior output. </p>
  448. <dl class="params"><dt>Parameters</dt><dd>
  449. <table class="params">
  450. <tr><td class="paramname">outputIndex</td><td>The index of the behavior output. </td></tr>
  451. </table>
  452. </dd>
  453. </dl>
  454. <dl class="section return"><dt>Returns</dt><dd>A comma-delimited description of the behavior output of the format &lt;Name&gt;,&lt;Label&gt;&lt;,Description&gt; or an empty string if behavior output is not found. </dd></dl>
  455. </div>
  456. </div>
  457. <a class="anchor" id="ac30e95b7133c5f6bf4c2c7ddca7c8a5d"></a>
  458. <div class="memitem">
  459. <div class="memproto">
  460. <table class="memname">
  461. <tr>
  462. <td class="memname">int getBehaviorOutputCount </td>
  463. <td>(</td>
  464. <td class="paramname"></td><td>)</td>
  465. <td></td>
  466. </tr>
  467. </table>
  468. </div><div class="memdoc">
  469. <p>Get the number of behavior outputs. </p>
  470. <dl class="section return"><dt>Returns</dt><dd>Returns the number of behavior outputs. </dd></dl>
  471. </div>
  472. </div>
  473. <a class="anchor" id="afefafa1c7be9d165fc5d5f3fa7565e68"></a>
  474. <div class="memitem">
  475. <div class="memproto">
  476. <table class="memname">
  477. <tr>
  478. <td class="memname">bool hasBehaviorInput </td>
  479. <td>(</td>
  480. <td class="paramtype">inputName&#160;</td>
  481. <td class="paramname"></td><td>)</td>
  482. <td></td>
  483. </tr>
  484. </table>
  485. </div><div class="memdoc">
  486. <p>Gets whether the behavior has the behavior input or not. </p>
  487. <dl class="params"><dt>Parameters</dt><dd>
  488. <table class="params">
  489. <tr><td class="paramname">inputName</td><td>The input name to check. </td></tr>
  490. </table>
  491. </dd>
  492. </dl>
  493. <dl class="section return"><dt>Returns</dt><dd>Whether the behavior has the behavior input or not. </dd></dl>
  494. </div>
  495. </div>
  496. <a class="anchor" id="a9112960d360b2e5ed6f382350c017eef"></a>
  497. <div class="memitem">
  498. <div class="memproto">
  499. <table class="memname">
  500. <tr>
  501. <td class="memname">bool hasBehaviorOutput </td>
  502. <td>(</td>
  503. <td class="paramtype">outputName&#160;</td>
  504. <td class="paramname"></td><td>)</td>
  505. <td></td>
  506. </tr>
  507. </table>
  508. </div><div class="memdoc">
  509. <p>Gets whether the behavior has the behavior output or not. </p>
  510. <dl class="params"><dt>Parameters</dt><dd>
  511. <table class="params">
  512. <tr><td class="paramname">outputName</td><td>The output name to check. </td></tr>
  513. </table>
  514. </dd>
  515. </dl>
  516. <dl class="section return"><dt>Returns</dt><dd>Whether the behavior has the behavior output or not. </dd></dl>
  517. </div>
  518. </div>
  519. </div><!-- contents -->
  520. <!-- start footer part -->
  521. <hr class="footer"/><address class="footer"><small>
  522. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  523. <img class="footer" src="doxygen.png" alt="doxygen"/>
  524. </a> 1.8.3.1
  525. </small></address>
  526. </body>
  527. </html>