classBehaviorTemplate.html 48 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790
  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. <title>BehaviorTemplate Class Reference</title>
  6. <link href="torquedoc.css" rel="stylesheet" type="text/css"/>
  7. </head>
  8. <body>
  9. <table width="100%" class="header">
  10. <tr>
  11. </tr>
  12. <tr><td class="headermenu">
  13. <center>
  14. <a class="qindex" href="index.html">Main</a> &nbsp;
  15. <a class="qindex" target="_blank" href="https://github.com/GarageGames/Torque2D">GitHub</a>
  16. </center>
  17. </td></tr>
  18. </table>
  19. <br>
  20. <!-- END HEADER -->
  21. <!-- Generated by Doxygen 1.8.3.1 -->
  22. </div><!-- top -->
  23. <div class="header">
  24. <div class="summary">
  25. <a href="classBehaviorTemplate-members.html">List of all members</a> &#124;
  26. <a href="#pub-methods">Public Member Functions</a> </div>
  27. <div class="headertitle">
  28. <div class="title">BehaviorTemplate Class Reference</div> </div>
  29. </div><!--header-->
  30. <div class="contents">
  31. <p>Inherits <a class="el" href="classSimObject.html">SimObject</a>.</p>
  32. <table class="memberdecls">
  33. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  34. Public Member Functions</h2></td></tr>
  35. <tr class="memitem:a3181a0b44e220175943596a4174959b9"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorTemplate.html#a3181a0b44e220175943596a4174959b9">addBehaviorField</a> (fieldName, desc, type,[defaultValue, userData])</td></tr>
  36. <tr class="separator:a3181a0b44e220175943596a4174959b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  37. <tr class="memitem:ae4daf680f83774c29a75aaa7acbe9577"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorTemplate.html#ae4daf680f83774c29a75aaa7acbe9577">addBehaviorInput</a> (inputName, label, <a class="el" href="classBehaviorTemplate.html#a4c289887255ada1cdf1f992c609394df">description</a>)</td></tr>
  38. <tr class="separator:ae4daf680f83774c29a75aaa7acbe9577"><td class="memSeparator" colspan="2">&#160;</td></tr>
  39. <tr class="memitem:a54e5fe058e2a91e8ddaf15690a99f9cc"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorTemplate.html#a54e5fe058e2a91e8ddaf15690a99f9cc">addBehaviorOutput</a> (outputName, label, <a class="el" href="classBehaviorTemplate.html#a4c289887255ada1cdf1f992c609394df">description</a>)</td></tr>
  40. <tr class="separator:a54e5fe058e2a91e8ddaf15690a99f9cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  41. <tr class="memitem:af606273c081488b14f86af0606445326"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorTemplate.html#af606273c081488b14f86af0606445326">createInstance</a> ()</td></tr>
  42. <tr class="separator:af606273c081488b14f86af0606445326"><td class="memSeparator" colspan="2">&#160;</td></tr>
  43. <tr class="memitem:a8189e321f7781f20d39fccc931a83c29"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorTemplate.html#a8189e321f7781f20d39fccc931a83c29">getBehaviorField</a> (int fieldIndex)</td></tr>
  44. <tr class="separator:a8189e321f7781f20d39fccc931a83c29"><td class="memSeparator" colspan="2">&#160;</td></tr>
  45. <tr class="memitem:a02b51c4b1685e0a75a57cc41d2dee98e"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorTemplate.html#a02b51c4b1685e0a75a57cc41d2dee98e">getBehaviorFieldCount</a> ()</td></tr>
  46. <tr class="separator:a02b51c4b1685e0a75a57cc41d2dee98e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  47. <tr class="memitem:a085d68710e9c4433058be65016714b32"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorTemplate.html#a085d68710e9c4433058be65016714b32">getBehaviorFieldDescription</a> (int fieldIndex)</td></tr>
  48. <tr class="separator:a085d68710e9c4433058be65016714b32"><td class="memSeparator" colspan="2">&#160;</td></tr>
  49. <tr class="memitem:a74d8c7aaee420df759827c778d34df2b"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorTemplate.html#a74d8c7aaee420df759827c778d34df2b">getBehaviorFieldUserData</a> (int fieldIndex)</td></tr>
  50. <tr class="separator:a74d8c7aaee420df759827c778d34df2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  51. <tr class="memitem:a2715caa594320a579b09130870dce843"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorTemplate.html#a2715caa594320a579b09130870dce843">getBehaviorInput</a> (int inputIndex)</td></tr>
  52. <tr class="separator:a2715caa594320a579b09130870dce843"><td class="memSeparator" colspan="2">&#160;</td></tr>
  53. <tr class="memitem:a62f94a250bd474272ba7246461fafee2"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorTemplate.html#a62f94a250bd474272ba7246461fafee2">getBehaviorInputCount</a> ()</td></tr>
  54. <tr class="separator:a62f94a250bd474272ba7246461fafee2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  55. <tr class="memitem:a636a5182eca962fa630da95f1806f7dd"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorTemplate.html#a636a5182eca962fa630da95f1806f7dd">getBehaviorOutput</a> (int outputIndex)</td></tr>
  56. <tr class="separator:a636a5182eca962fa630da95f1806f7dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  57. <tr class="memitem:ae120c2f8c8d46d875404e8c21082b003"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorTemplate.html#ae120c2f8c8d46d875404e8c21082b003">getBehaviorOutputCount</a> ()</td></tr>
  58. <tr class="separator:ae120c2f8c8d46d875404e8c21082b003"><td class="memSeparator" colspan="2">&#160;</td></tr>
  59. <tr class="memitem:a8083a644ec1130a4f7b38488321b162b"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorTemplate.html#a8083a644ec1130a4f7b38488321b162b">hasBehaviorInput</a> (inputName)</td></tr>
  60. <tr class="separator:a8083a644ec1130a4f7b38488321b162b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61. <tr class="memitem:a4532acf16c1ac9a1786af78875df2bab"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorTemplate.html#a4532acf16c1ac9a1786af78875df2bab">hasBehaviorOutput</a> (outputName)</td></tr>
  62. <tr class="separator:a4532acf16c1ac9a1786af78875df2bab"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63. <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>
  64. <tr class="memitem:aa19815069e82c393e2c10885eabf8016 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa19815069e82c393e2c10885eabf8016">addFieldFilter</a> (fieldName)</td></tr>
  65. <tr class="separator:aa19815069e82c393e2c10885eabf8016 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66. <tr class="memitem:a804a3fb06b864699c7bc2601e685756d inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a804a3fb06b864699c7bc2601e685756d">call</a> (%args)</td></tr>
  67. <tr class="separator:a804a3fb06b864699c7bc2601e685756d inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68. <tr class="memitem:abce68a893b7efa10c06ea780ddda7f06 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#abce68a893b7efa10c06ea780ddda7f06">clone</a> ([bool copyDynamicFields?=false])</td></tr>
  69. <tr class="separator:abce68a893b7efa10c06ea780ddda7f06 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70. <tr class="memitem:a0407d340f60883977e60e7414f804be8 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0407d340f60883977e60e7414f804be8">delete</a> ()</td></tr>
  71. <tr class="separator:a0407d340f60883977e60e7414f804be8 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72. <tr class="memitem:a6a5e4ea85ff866ed5340d20993541c50 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a6a5e4ea85ff866ed5340d20993541c50">dump</a> ()</td></tr>
  73. <tr class="separator:a6a5e4ea85ff866ed5340d20993541c50 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <tr class="memitem:a7b595302fce08857b11a01bbb1083a7e inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a7b595302fce08857b11a01bbb1083a7e">dumpClassHierarchy</a> ()</td></tr>
  75. <tr class="separator:a7b595302fce08857b11a01bbb1083a7e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem:a8e927f41d38b279dc8684f7ced03c0fb inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a8e927f41d38b279dc8684f7ced03c0fb">getClassName</a> ()</td></tr>
  77. <tr class="separator:a8e927f41d38b279dc8684f7ced03c0fb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:a90cc89c3cebc772fdadfd9ac87ecd24e inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a90cc89c3cebc772fdadfd9ac87ecd24e">getClassNamespace</a> ()</td></tr>
  79. <tr class="separator:a90cc89c3cebc772fdadfd9ac87ecd24e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:a09ab8f9a6a8e3ee0cfc3c78ebb54f113 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a09ab8f9a6a8e3ee0cfc3c78ebb54f113">getDynamicField</a> (index)</td></tr>
  81. <tr class="separator:a09ab8f9a6a8e3ee0cfc3c78ebb54f113 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:a2d78d37eac1f119baf560cd273c03538 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a2d78d37eac1f119baf560cd273c03538">getDynamicFieldCount</a> ()</td></tr>
  83. <tr class="separator:a2d78d37eac1f119baf560cd273c03538 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:a55ace9339e968c26428e0082bd190693 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a55ace9339e968c26428e0082bd190693">getField</a> (int index)</td></tr>
  85. <tr class="separator:a55ace9339e968c26428e0082bd190693 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:abef30dc0fc312dd3334e2a4a8491da37 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#abef30dc0fc312dd3334e2a4a8491da37">getFieldCount</a> ()</td></tr>
  87. <tr class="separator:abef30dc0fc312dd3334e2a4a8491da37 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:a6e9001db89eb8822430f0d02c6108b43 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a6e9001db89eb8822430f0d02c6108b43">getFieldType</a> (fieldName)</td></tr>
  89. <tr class="separator:a6e9001db89eb8822430f0d02c6108b43 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:addb1c5fbb1495cf580318456b639548d inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#addb1c5fbb1495cf580318456b639548d">getFieldValue</a> (fieldName)</td></tr>
  91. <tr class="separator:addb1c5fbb1495cf580318456b639548d inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:a1a4f6c730ac5325e79cc4554e43db26e inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1a4f6c730ac5325e79cc4554e43db26e">getGroup</a> ()</td></tr>
  93. <tr class="separator:a1a4f6c730ac5325e79cc4554e43db26e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a230cd7c02705a8d3eea78cacb320591f inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a230cd7c02705a8d3eea78cacb320591f">getId</a> ()</td></tr>
  95. <tr class="separator:a230cd7c02705a8d3eea78cacb320591f inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:a9b026d477bdd586a8ad5ee0e7a6fb7fe inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a9b026d477bdd586a8ad5ee0e7a6fb7fe">getInternalName</a> ()</td></tr>
  97. <tr class="separator:a9b026d477bdd586a8ad5ee0e7a6fb7fe inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:a84e32f38cdb775bfe739867d55737b4d inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a84e32f38cdb775bfe739867d55737b4d">getName</a> ()</td></tr>
  99. <tr class="separator:a84e32f38cdb775bfe739867d55737b4d inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:a1058915844541a6bebebc75415bbe7e0 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1058915844541a6bebebc75415bbe7e0">getProgenitorFile</a> ()</td></tr>
  101. <tr class="separator:a1058915844541a6bebebc75415bbe7e0 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a4b464b66407955fa435f66dc684971c8 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a4b464b66407955fa435f66dc684971c8">getSuperClassNamespace</a> ()</td></tr>
  103. <tr class="separator:a4b464b66407955fa435f66dc684971c8 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a320f74b22aa85775725f8569154d667e inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a320f74b22aa85775725f8569154d667e">getType</a> ()</td></tr>
  105. <tr class="separator:a320f74b22aa85775725f8569154d667e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:a1260a9ecd13cdbea359d9fe7c045794e inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1260a9ecd13cdbea359d9fe7c045794e">isChildOfGroup</a> ()</td></tr>
  107. <tr class="separator:a1260a9ecd13cdbea359d9fe7c045794e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:a86048647be436a21246de6a92f807ea4 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a86048647be436a21246de6a92f807ea4">isMemberOfClass</a> (string classname)</td></tr>
  109. <tr class="separator:a86048647be436a21246de6a92f807ea4 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:a89bdccd1d3b307d9caf08496003a63cb inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a89bdccd1d3b307d9caf08496003a63cb">isMethod</a> (string method name)</td></tr>
  111. <tr class="separator:a89bdccd1d3b307d9caf08496003a63cb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:a4d77984a510b832f0f2a87d132192af1 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a4d77984a510b832f0f2a87d132192af1">isTimerActive</a> ()</td></tr>
  113. <tr class="separator:a4d77984a510b832f0f2a87d132192af1 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:a5a3e025c27ebe1d34a8485ee53199dcb inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a5a3e025c27ebe1d34a8485ee53199dcb">removeFieldFilter</a> (fieldName)</td></tr>
  115. <tr class="separator:a5a3e025c27ebe1d34a8485ee53199dcb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:aac4f9db0033e9192254a8308f6101909 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aac4f9db0033e9192254a8308f6101909">save</a> (fileName,[selectedOnly])</td></tr>
  117. <tr class="separator:aac4f9db0033e9192254a8308f6101909 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:a38c14c64f403c3df7749ca315c325386 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a38c14c64f403c3df7749ca315c325386">schedule</a> (time, command,&lt; arg1...argN &gt;)</td></tr>
  119. <tr class="separator:a38c14c64f403c3df7749ca315c325386 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:ac70958a4cae93deda0d031947d187892 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ac70958a4cae93deda0d031947d187892">setClassNamespace</a> ()</td></tr>
  121. <tr class="separator:ac70958a4cae93deda0d031947d187892 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:a29f97240eeaf780e9c02bee7aa6e7b25 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a29f97240eeaf780e9c02bee7aa6e7b25">setFieldValue</a> (fieldName, value)</td></tr>
  123. <tr class="separator:a29f97240eeaf780e9c02bee7aa6e7b25 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:acf355cf2001b85ffcf07958400c97605 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#acf355cf2001b85ffcf07958400c97605">setInternalName</a> ()</td></tr>
  125. <tr class="separator:acf355cf2001b85ffcf07958400c97605 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:a1e799de6b4329f9ce9b94a176ad1cfbb inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1e799de6b4329f9ce9b94a176ad1cfbb">setName</a> (newName)</td></tr>
  127. <tr class="separator:a1e799de6b4329f9ce9b94a176ad1cfbb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:ad2b00ab622649aa8b1b2b5600ea4abb1 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ad2b00ab622649aa8b1b2b5600ea4abb1">setProgenitorFile</a> (file)</td></tr>
  129. <tr class="separator:ad2b00ab622649aa8b1b2b5600ea4abb1 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:a94f53f0f93ced24b597de83aa122e824 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a94f53f0f93ced24b597de83aa122e824">setSuperClassNamespace</a> ()</td></tr>
  131. <tr class="separator:a94f53f0f93ced24b597de83aa122e824 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:ab928f21c5a7e13a0c2cdbcf479c9e07d inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab928f21c5a7e13a0c2cdbcf479c9e07d">startTimer</a> (callbackFunction, float timePeriod,[repeat])</td></tr>
  133. <tr class="separator:ab928f21c5a7e13a0c2cdbcf479c9e07d inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:acd9c4032150dd0566eca593062588e9f inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#acd9c4032150dd0566eca593062588e9f">stopTimer</a> ()</td></tr>
  135. <tr class="separator:acd9c4032150dd0566eca593062588e9f inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. </table><table class="memberdecls">
  137. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  138. Public Attributes</h2></td></tr>
  139. <tr><td colspan="2"><div class="groupHeader">behavior</div></td></tr>
  140. <tr class="memitem:a68bb03ed73354c8dd1ee758656456172"><td class="memItemLeft" align="right" valign="top">caseString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorTemplate.html#a68bb03ed73354c8dd1ee758656456172">friendlyName</a></td></tr>
  141. <tr class="separator:a68bb03ed73354c8dd1ee758656456172"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <tr class="memitem:a4c289887255ada1cdf1f992c609394df"><td class="memItemLeft" align="right" valign="top">caseString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorTemplate.html#a4c289887255ada1cdf1f992c609394df">description</a></td></tr>
  143. <tr class="separator:a4c289887255ada1cdf1f992c609394df"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:aeba069ad16965c2417b5d3c12b6cf167"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorTemplate.html#aeba069ad16965c2417b5d3c12b6cf167">behaviorType</a></td></tr>
  145. <tr class="separator:aeba069ad16965c2417b5d3c12b6cf167"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr><td colspan="2"><div class="groupHeader">SimBase</div></td></tr>
  147. <tr class="memitem:adf06886b2c43b4abcb5b65f7d00ce057"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorTemplate.html#adf06886b2c43b4abcb5b65f7d00ce057">canSaveDynamicFields</a></td></tr>
  148. <tr class="separator:adf06886b2c43b4abcb5b65f7d00ce057"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:a3819630569557bc5c6269300a7a32158"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorTemplate.html#a3819630569557bc5c6269300a7a32158">internalName</a></td></tr>
  150. <tr class="separator:a3819630569557bc5c6269300a7a32158"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <tr class="memitem:a8fae8b7c5d9d41a42f153e3bc2c15f42"><td class="memItemLeft" align="right" valign="top">SimObjectPtr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorTemplate.html#a8fae8b7c5d9d41a42f153e3bc2c15f42">parentGroup</a></td></tr>
  152. <tr class="separator:a8fae8b7c5d9d41a42f153e3bc2c15f42"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. <tr><td colspan="2"><div class="groupHeader">Namespace Linking</div></td></tr>
  154. <tr class="memitem:a9015448e6878ba9d8734c35cc9fa4591"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorTemplate.html#a9015448e6878ba9d8734c35cc9fa4591">superclass</a></td></tr>
  155. <tr class="separator:a9015448e6878ba9d8734c35cc9fa4591"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. <tr class="memitem:a9a8fdfba8d93423b7a86bd1fe5e4d210"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorTemplate.html#a9a8fdfba8d93423b7a86bd1fe5e4d210">class</a></td></tr>
  157. <tr class="separator:a9a8fdfba8d93423b7a86bd1fe5e4d210"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <tr class="inherit_header pub_attribs_classSimObject"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classSimObject')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="classSimObject.html">SimObject</a></td></tr>
  159. <tr class="memitem:ab49fae316a2d0c12834f50c3d77202e6 inherit pub_attribs_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab49fae316a2d0c12834f50c3d77202e6">canSaveDynamicFields</a></td></tr>
  160. <tr class="separator:ab49fae316a2d0c12834f50c3d77202e6 inherit pub_attribs_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  161. <tr class="memitem:ad03202387165717f164f996a5b22c9bb inherit pub_attribs_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ad03202387165717f164f996a5b22c9bb">internalName</a></td></tr>
  162. <tr class="separator:ad03202387165717f164f996a5b22c9bb inherit pub_attribs_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  163. <tr class="memitem:a0f783d7e37cad2b0a9d6f7b0d1672a28 inherit pub_attribs_classSimObject"><td class="memItemLeft" align="right" valign="top">SimObjectPtr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0f783d7e37cad2b0a9d6f7b0d1672a28">parentGroup</a></td></tr>
  164. <tr class="separator:a0f783d7e37cad2b0a9d6f7b0d1672a28 inherit pub_attribs_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  165. <tr class="memitem:aa0d134072878053537fefb1768b63d3f inherit pub_attribs_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa0d134072878053537fefb1768b63d3f">superclass</a></td></tr>
  166. <tr class="separator:aa0d134072878053537fefb1768b63d3f inherit pub_attribs_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  167. <tr class="memitem:ab83c7a59a66018d9b5eec3c8dcd3397d inherit pub_attribs_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab83c7a59a66018d9b5eec3c8dcd3397d">class</a></td></tr>
  168. <tr class="separator:ab83c7a59a66018d9b5eec3c8dcd3397d inherit pub_attribs_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  169. </table>
  170. <h2 class="groupheader">Member Function Documentation</h2>
  171. <a class="anchor" id="a3181a0b44e220175943596a4174959b9"></a>
  172. <div class="memitem">
  173. <div class="memproto">
  174. <table class="mlabels">
  175. <tr>
  176. <td class="mlabels-left">
  177. <table class="memname">
  178. <tr>
  179. <td class="memname">virtual bool BehaviorTemplate::addBehaviorField </td>
  180. <td>(</td>
  181. <td class="paramtype">fieldName&#160;</td>
  182. <td class="paramname">, </td>
  183. </tr>
  184. <tr>
  185. <td class="paramkey"></td>
  186. <td></td>
  187. <td class="paramtype">desc&#160;</td>
  188. <td class="paramname">, </td>
  189. </tr>
  190. <tr>
  191. <td class="paramkey"></td>
  192. <td></td>
  193. <td class="paramtype">type&#160;</td>
  194. <td class="paramname">&#160;</td>
  195. </tr>
  196. <tr>
  197. <td></td>
  198. <td>)</td>
  199. <td></td><td></td>
  200. </tr>
  201. </table>
  202. </td>
  203. <td class="mlabels-right">
  204. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  205. </tr>
  206. </table>
  207. </div><div class="memdoc">
  208. <p>Adds a named BehaviorField to a Behavior Template </p>
  209. <dl class="params"><dt>Parameters</dt><dd>
  210. <table class="params">
  211. <tr><td class="paramname">fieldName</td><td>The name of this field </td></tr>
  212. <tr><td class="paramname">desc</td><td>The Description of this field </td></tr>
  213. <tr><td class="paramname">type</td><td>The DataType for this field (default, int, float, Point2F, bool, enum, Object, keybind, color) </td></tr>
  214. <tr><td class="paramname">defaultValue</td><td>The Default value for this field </td></tr>
  215. <tr><td class="paramname">userData</td><td>An extra data field that can be used for custom data on a per-field basis<br/>
  216. Usage for default types<br/>
  217. -enum: a TAB separated list of possible values<br/>
  218. -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>
  219. </table>
  220. </dd>
  221. </dl>
  222. <dl class="section return"><dt>Returns</dt><dd>Whether the field was added or not. </dd></dl>
  223. </div>
  224. </div>
  225. <a class="anchor" id="ae4daf680f83774c29a75aaa7acbe9577"></a>
  226. <div class="memitem">
  227. <div class="memproto">
  228. <table class="mlabels">
  229. <tr>
  230. <td class="mlabels-left">
  231. <table class="memname">
  232. <tr>
  233. <td class="memname">virtual bool BehaviorTemplate::addBehaviorInput </td>
  234. <td>(</td>
  235. <td class="paramtype">inputName&#160;</td>
  236. <td class="paramname">, </td>
  237. </tr>
  238. <tr>
  239. <td class="paramkey"></td>
  240. <td></td>
  241. <td class="paramtype">label&#160;</td>
  242. <td class="paramname">, </td>
  243. </tr>
  244. <tr>
  245. <td class="paramkey"></td>
  246. <td></td>
  247. <td class="paramtype"><a class="el" href="classBehaviorTemplate.html#a4c289887255ada1cdf1f992c609394df">description</a>&#160;</td>
  248. <td class="paramname">&#160;</td>
  249. </tr>
  250. <tr>
  251. <td></td>
  252. <td>)</td>
  253. <td></td><td></td>
  254. </tr>
  255. </table>
  256. </td>
  257. <td class="mlabels-right">
  258. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  259. </tr>
  260. </table>
  261. </div><div class="memdoc">
  262. <ul>
  263. <li>Adds a behavior input. <dl class="params"><dt>Parameters</dt><dd>
  264. <table class="params">
  265. <tr><td class="paramname">inputName</td><td>The input name to use. </td></tr>
  266. <tr><td class="paramname">label</td><td>The short label name to show in the editor. </td></tr>
  267. <tr><td class="paramname">description</td><td>The long description to show in the editor. </td></tr>
  268. </table>
  269. </dd>
  270. </dl>
  271. <dl class="section return"><dt>Returns</dt><dd>Whether the input was added or not. </dd></dl>
  272. </li>
  273. </ul>
  274. </div>
  275. </div>
  276. <a class="anchor" id="a54e5fe058e2a91e8ddaf15690a99f9cc"></a>
  277. <div class="memitem">
  278. <div class="memproto">
  279. <table class="mlabels">
  280. <tr>
  281. <td class="mlabels-left">
  282. <table class="memname">
  283. <tr>
  284. <td class="memname">virtual bool BehaviorTemplate::addBehaviorOutput </td>
  285. <td>(</td>
  286. <td class="paramtype">outputName&#160;</td>
  287. <td class="paramname">, </td>
  288. </tr>
  289. <tr>
  290. <td class="paramkey"></td>
  291. <td></td>
  292. <td class="paramtype">label&#160;</td>
  293. <td class="paramname">, </td>
  294. </tr>
  295. <tr>
  296. <td class="paramkey"></td>
  297. <td></td>
  298. <td class="paramtype"><a class="el" href="classBehaviorTemplate.html#a4c289887255ada1cdf1f992c609394df">description</a>&#160;</td>
  299. <td class="paramname">&#160;</td>
  300. </tr>
  301. <tr>
  302. <td></td>
  303. <td>)</td>
  304. <td></td><td></td>
  305. </tr>
  306. </table>
  307. </td>
  308. <td class="mlabels-right">
  309. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  310. </tr>
  311. </table>
  312. </div><div class="memdoc">
  313. <ul>
  314. <li>Adds a behavior output. <dl class="params"><dt>Parameters</dt><dd>
  315. <table class="params">
  316. <tr><td class="paramname">outputName</td><td>The output name to use. </td></tr>
  317. <tr><td class="paramname">label</td><td>The short label name to show in the editor. </td></tr>
  318. <tr><td class="paramname">description</td><td>The long description to show in the editor. </td></tr>
  319. </table>
  320. </dd>
  321. </dl>
  322. <dl class="section return"><dt>Returns</dt><dd>Whether the output was added or not. </dd></dl>
  323. </li>
  324. </ul>
  325. </div>
  326. </div>
  327. <a class="anchor" id="af606273c081488b14f86af0606445326"></a>
  328. <div class="memitem">
  329. <div class="memproto">
  330. <table class="mlabels">
  331. <tr>
  332. <td class="mlabels-left">
  333. <table class="memname">
  334. <tr>
  335. <td class="memname">virtual int BehaviorTemplate::createInstance </td>
  336. <td>(</td>
  337. <td class="paramname"></td><td>)</td>
  338. <td></td>
  339. </tr>
  340. </table>
  341. </td>
  342. <td class="mlabels-right">
  343. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  344. </tr>
  345. </table>
  346. </div><div class="memdoc">
  347. <ul>
  348. <li>Create an instance of this behavior. <dl class="section return"><dt>Returns</dt><dd>(<a class="el" href="classBehaviorInstance.html">BehaviorInstance</a> inst) The behavior instance created </dd></dl>
  349. </li>
  350. </ul>
  351. </div>
  352. </div>
  353. <a class="anchor" id="a8189e321f7781f20d39fccc931a83c29"></a>
  354. <div class="memitem">
  355. <div class="memproto">
  356. <table class="mlabels">
  357. <tr>
  358. <td class="mlabels-left">
  359. <table class="memname">
  360. <tr>
  361. <td class="memname">virtual string BehaviorTemplate::getBehaviorField </td>
  362. <td>(</td>
  363. <td class="paramtype">int&#160;</td>
  364. <td class="paramname"><em>fieldIndex</em></td><td>)</td>
  365. <td></td>
  366. </tr>
  367. </table>
  368. </td>
  369. <td class="mlabels-right">
  370. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  371. </tr>
  372. </table>
  373. </div><div class="memdoc">
  374. <ul>
  375. <li>Gets a tab-delimited description of the behavior field. <dl class="params"><dt>Parameters</dt><dd>
  376. <table class="params">
  377. <tr><td class="paramname">fieldIndex</td><td>The index of the behavior field. </td></tr>
  378. </table>
  379. </dd>
  380. </dl>
  381. <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>
  382. </li>
  383. </ul>
  384. </div>
  385. </div>
  386. <a class="anchor" id="a02b51c4b1685e0a75a57cc41d2dee98e"></a>
  387. <div class="memitem">
  388. <div class="memproto">
  389. <table class="mlabels">
  390. <tr>
  391. <td class="mlabels-left">
  392. <table class="memname">
  393. <tr>
  394. <td class="memname">virtual int BehaviorTemplate::getBehaviorFieldCount </td>
  395. <td>(</td>
  396. <td class="paramname"></td><td>)</td>
  397. <td></td>
  398. </tr>
  399. </table>
  400. </td>
  401. <td class="mlabels-right">
  402. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  403. </tr>
  404. </table>
  405. </div><div class="memdoc">
  406. <ul>
  407. <li>Get the number of behavior fields. <dl class="section return"><dt>Returns</dt><dd>Returns the number of behavior fields. </dd></dl>
  408. </li>
  409. </ul>
  410. </div>
  411. </div>
  412. <a class="anchor" id="a085d68710e9c4433058be65016714b32"></a>
  413. <div class="memitem">
  414. <div class="memproto">
  415. <table class="mlabels">
  416. <tr>
  417. <td class="mlabels-left">
  418. <table class="memname">
  419. <tr>
  420. <td class="memname">virtual string BehaviorTemplate::getBehaviorFieldDescription </td>
  421. <td>(</td>
  422. <td class="paramtype">int&#160;</td>
  423. <td class="paramname"><em>fieldIndex</em></td><td>)</td>
  424. <td></td>
  425. </tr>
  426. </table>
  427. </td>
  428. <td class="mlabels-right">
  429. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  430. </tr>
  431. </table>
  432. </div><div class="memdoc">
  433. <ul>
  434. <li>Gets the description of the field. <dl class="params"><dt>Parameters</dt><dd>
  435. <table class="params">
  436. <tr><td class="paramname">fieldIndex</td><td>The index of the behavior field. </td></tr>
  437. </table>
  438. </dd>
  439. </dl>
  440. <dl class="section return"><dt>Returns</dt><dd>Returns the field description. </dd></dl>
  441. </li>
  442. </ul>
  443. </div>
  444. </div>
  445. <a class="anchor" id="a74d8c7aaee420df759827c778d34df2b"></a>
  446. <div class="memitem">
  447. <div class="memproto">
  448. <table class="mlabels">
  449. <tr>
  450. <td class="mlabels-left">
  451. <table class="memname">
  452. <tr>
  453. <td class="memname">virtual string BehaviorTemplate::getBehaviorFieldUserData </td>
  454. <td>(</td>
  455. <td class="paramtype">int&#160;</td>
  456. <td class="paramname"><em>fieldIndex</em></td><td>)</td>
  457. <td></td>
  458. </tr>
  459. </table>
  460. </td>
  461. <td class="mlabels-right">
  462. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  463. </tr>
  464. </table>
  465. </div><div class="memdoc">
  466. <ul>
  467. <li>Gets the UserData associated with a field by index in the field list <dl class="params"><dt>Parameters</dt><dd>
  468. <table class="params">
  469. <tr><td class="paramname">fieldIndex</td><td>The index of the behavior field. </td></tr>
  470. </table>
  471. </dd>
  472. </dl>
  473. <dl class="section return"><dt>Returns</dt><dd>Returns a string representing the user data of this field </dd></dl>
  474. </li>
  475. </ul>
  476. </div>
  477. </div>
  478. <a class="anchor" id="a2715caa594320a579b09130870dce843"></a>
  479. <div class="memitem">
  480. <div class="memproto">
  481. <table class="mlabels">
  482. <tr>
  483. <td class="mlabels-left">
  484. <table class="memname">
  485. <tr>
  486. <td class="memname">virtual string BehaviorTemplate::getBehaviorInput </td>
  487. <td>(</td>
  488. <td class="paramtype">int&#160;</td>
  489. <td class="paramname"><em>inputIndex</em></td><td>)</td>
  490. <td></td>
  491. </tr>
  492. </table>
  493. </td>
  494. <td class="mlabels-right">
  495. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  496. </tr>
  497. </table>
  498. </div><div class="memdoc">
  499. <ul>
  500. <li>Gets a comma-delimited description of the behavior input. <dl class="params"><dt>Parameters</dt><dd>
  501. <table class="params">
  502. <tr><td class="paramname">inputIndex</td><td>The index of the behavior input. </td></tr>
  503. </table>
  504. </dd>
  505. </dl>
  506. <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>
  507. </li>
  508. </ul>
  509. </div>
  510. </div>
  511. <a class="anchor" id="a62f94a250bd474272ba7246461fafee2"></a>
  512. <div class="memitem">
  513. <div class="memproto">
  514. <table class="mlabels">
  515. <tr>
  516. <td class="mlabels-left">
  517. <table class="memname">
  518. <tr>
  519. <td class="memname">virtual int BehaviorTemplate::getBehaviorInputCount </td>
  520. <td>(</td>
  521. <td class="paramname"></td><td>)</td>
  522. <td></td>
  523. </tr>
  524. </table>
  525. </td>
  526. <td class="mlabels-right">
  527. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  528. </tr>
  529. </table>
  530. </div><div class="memdoc">
  531. <ul>
  532. <li>Get the number of behavior inputs. <dl class="section return"><dt>Returns</dt><dd>Returns the number of behavior inputs. </dd></dl>
  533. </li>
  534. </ul>
  535. </div>
  536. </div>
  537. <a class="anchor" id="a636a5182eca962fa630da95f1806f7dd"></a>
  538. <div class="memitem">
  539. <div class="memproto">
  540. <table class="mlabels">
  541. <tr>
  542. <td class="mlabels-left">
  543. <table class="memname">
  544. <tr>
  545. <td class="memname">virtual string BehaviorTemplate::getBehaviorOutput </td>
  546. <td>(</td>
  547. <td class="paramtype">int&#160;</td>
  548. <td class="paramname"><em>outputIndex</em></td><td>)</td>
  549. <td></td>
  550. </tr>
  551. </table>
  552. </td>
  553. <td class="mlabels-right">
  554. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  555. </tr>
  556. </table>
  557. </div><div class="memdoc">
  558. <ul>
  559. <li>Gets a comma-delimited description of the behavior output. <dl class="params"><dt>Parameters</dt><dd>
  560. <table class="params">
  561. <tr><td class="paramname">outputIndex</td><td>The index of the behavior output. </td></tr>
  562. </table>
  563. </dd>
  564. </dl>
  565. <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>
  566. </li>
  567. </ul>
  568. </div>
  569. </div>
  570. <a class="anchor" id="ae120c2f8c8d46d875404e8c21082b003"></a>
  571. <div class="memitem">
  572. <div class="memproto">
  573. <table class="mlabels">
  574. <tr>
  575. <td class="mlabels-left">
  576. <table class="memname">
  577. <tr>
  578. <td class="memname">virtual int BehaviorTemplate::getBehaviorOutputCount </td>
  579. <td>(</td>
  580. <td class="paramname"></td><td>)</td>
  581. <td></td>
  582. </tr>
  583. </table>
  584. </td>
  585. <td class="mlabels-right">
  586. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  587. </tr>
  588. </table>
  589. </div><div class="memdoc">
  590. <ul>
  591. <li>Get the number of behavior outputs. <dl class="section return"><dt>Returns</dt><dd>Returns the number of behavior outputs. </dd></dl>
  592. </li>
  593. </ul>
  594. </div>
  595. </div>
  596. <a class="anchor" id="a8083a644ec1130a4f7b38488321b162b"></a>
  597. <div class="memitem">
  598. <div class="memproto">
  599. <table class="mlabels">
  600. <tr>
  601. <td class="mlabels-left">
  602. <table class="memname">
  603. <tr>
  604. <td class="memname">virtual bool BehaviorTemplate::hasBehaviorInput </td>
  605. <td>(</td>
  606. <td class="paramtype">inputName&#160;</td>
  607. <td class="paramname"></td><td>)</td>
  608. <td></td>
  609. </tr>
  610. </table>
  611. </td>
  612. <td class="mlabels-right">
  613. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  614. </tr>
  615. </table>
  616. </div><div class="memdoc">
  617. <ul>
  618. <li>Gets whether the behavior has the behavior input or not. <dl class="params"><dt>Parameters</dt><dd>
  619. <table class="params">
  620. <tr><td class="paramname">inputName</td><td>The input name to check. </td></tr>
  621. </table>
  622. </dd>
  623. </dl>
  624. <dl class="section return"><dt>Returns</dt><dd>Whether the behavior has the behavior input or not. </dd></dl>
  625. </li>
  626. </ul>
  627. </div>
  628. </div>
  629. <a class="anchor" id="a4532acf16c1ac9a1786af78875df2bab"></a>
  630. <div class="memitem">
  631. <div class="memproto">
  632. <table class="mlabels">
  633. <tr>
  634. <td class="mlabels-left">
  635. <table class="memname">
  636. <tr>
  637. <td class="memname">virtual bool BehaviorTemplate::hasBehaviorOutput </td>
  638. <td>(</td>
  639. <td class="paramtype">outputName&#160;</td>
  640. <td class="paramname"></td><td>)</td>
  641. <td></td>
  642. </tr>
  643. </table>
  644. </td>
  645. <td class="mlabels-right">
  646. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  647. </tr>
  648. </table>
  649. </div><div class="memdoc">
  650. <ul>
  651. <li>Gets whether the behavior has the behavior output or not. <dl class="params"><dt>Parameters</dt><dd>
  652. <table class="params">
  653. <tr><td class="paramname">outputName</td><td>The output name to check. </td></tr>
  654. </table>
  655. </dd>
  656. </dl>
  657. <dl class="section return"><dt>Returns</dt><dd>Whether the behavior has the behavior output or not. </dd></dl>
  658. </li>
  659. </ul>
  660. </div>
  661. </div>
  662. <h2 class="groupheader">Member Data Documentation</h2>
  663. <a class="anchor" id="aeba069ad16965c2417b5d3c12b6cf167"></a>
  664. <div class="memitem">
  665. <div class="memproto">
  666. <table class="memname">
  667. <tr>
  668. <td class="memname">string BehaviorTemplate::behaviorType</td>
  669. </tr>
  670. </table>
  671. </div><div class="memdoc">
  672. <p>?? Organizational keyword ?? </p>
  673. </div>
  674. </div>
  675. <a class="anchor" id="adf06886b2c43b4abcb5b65f7d00ce057"></a>
  676. <div class="memitem">
  677. <div class="memproto">
  678. <table class="memname">
  679. <tr>
  680. <td class="memname">bool BehaviorTemplate::canSaveDynamicFields</td>
  681. </tr>
  682. </table>
  683. </div><div class="memdoc">
  684. </div>
  685. </div>
  686. <a class="anchor" id="a9a8fdfba8d93423b7a86bd1fe5e4d210"></a>
  687. <div class="memitem">
  688. <div class="memproto">
  689. <table class="memname">
  690. <tr>
  691. <td class="memname">string BehaviorTemplate::class</td>
  692. </tr>
  693. </table>
  694. </div><div class="memdoc">
  695. <p>Script SuperClass of object. </p>
  696. </div>
  697. </div>
  698. <a class="anchor" id="a4c289887255ada1cdf1f992c609394df"></a>
  699. <div class="memitem">
  700. <div class="memproto">
  701. <table class="memname">
  702. <tr>
  703. <td class="memname">caseString BehaviorTemplate::description</td>
  704. </tr>
  705. </table>
  706. </div><div class="memdoc">
  707. <p>The description of this behavior. </p>
  708. </div>
  709. </div>
  710. <a class="anchor" id="a68bb03ed73354c8dd1ee758656456172"></a>
  711. <div class="memitem">
  712. <div class="memproto">
  713. <table class="memname">
  714. <tr>
  715. <td class="memname">caseString BehaviorTemplate::friendlyName</td>
  716. </tr>
  717. </table>
  718. </div><div class="memdoc">
  719. <p>Human friendly name of this behavior </p>
  720. </div>
  721. </div>
  722. <a class="anchor" id="a3819630569557bc5c6269300a7a32158"></a>
  723. <div class="memitem">
  724. <div class="memproto">
  725. <table class="memname">
  726. <tr>
  727. <td class="memname">string BehaviorTemplate::internalName</td>
  728. </tr>
  729. </table>
  730. </div><div class="memdoc">
  731. </div>
  732. </div>
  733. <a class="anchor" id="a8fae8b7c5d9d41a42f153e3bc2c15f42"></a>
  734. <div class="memitem">
  735. <div class="memproto">
  736. <table class="memname">
  737. <tr>
  738. <td class="memname">SimObjectPtr BehaviorTemplate::parentGroup</td>
  739. </tr>
  740. </table>
  741. </div><div class="memdoc">
  742. <p>Group hierarchy parent of the object. </p>
  743. </div>
  744. </div>
  745. <a class="anchor" id="a9015448e6878ba9d8734c35cc9fa4591"></a>
  746. <div class="memitem">
  747. <div class="memproto">
  748. <table class="memname">
  749. <tr>
  750. <td class="memname">string BehaviorTemplate::superclass</td>
  751. </tr>
  752. </table>
  753. </div><div class="memdoc">
  754. <p>Script Class of object. </p>
  755. </div>
  756. </div>
  757. </div><!-- contents -->
  758. <!-- START FOOTER -->
  759. <br>
  760. <br>
  761. <center>
  762. <div style="color: #777777;">
  763. Copyright &copy; 2013 <a style="color: #777777;" target="_blank" href="http://www.garagegames.com">GarageGames, LLC</a>. All Rights Reserved.
  764. </div>
  765. </center>
  766. </body>
  767. </html>