classSimSet.html 66 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.9.8"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>TorqueScript Reference: SimSet Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  13. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  14. </head>
  15. <body>
  16. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  17. <div id="titlearea">
  18. <table cellspacing="0" cellpadding="0">
  19. <tbody>
  20. <tr id="projectrow">
  21. <td id="projectalign">
  22. <div id="projectname">TorqueScript Reference
  23. </div>
  24. </td>
  25. </tr>
  26. </tbody>
  27. </table>
  28. </div>
  29. <!-- end header part -->
  30. <!-- Generated by Doxygen 1.9.8 -->
  31. <script type="text/javascript" src="menudata.js"></script>
  32. <script type="text/javascript" src="menu.js"></script>
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  35. $(function() {
  36. initMenu('',false,false,'search.php','Search');
  37. });
  38. /* @license-end */
  39. </script>
  40. <div id="main-nav"></div>
  41. </div><!-- top -->
  42. <div class="header">
  43. <div class="summary">
  44. <a href="#pub-methods">Public Member Functions</a> &#124;
  45. <a href="classSimSet-members.html">List of all members</a> </div>
  46. <div class="headertitle"><div class="title">SimSet Class Reference</div></div>
  47. </div><!--header-->
  48. <div class="contents">
  49. <p><code>#include &lt;simSet_ScriptBinding.h&gt;</code></p>
  50. <p>Inherits <a class="el" href="classSimObject.html">SimObject</a>.</p>
  51. <p>Inherited by <a class="el" href="classModuleDefinition.html">ModuleDefinition</a>, and <a class="el" href="classNameTags.html">NameTags</a>.</p>
  52. <table class="memberdecls">
  53. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  54. Public Member Functions</h2></td></tr>
  55. <tr class="memitem:adb7cacf4f029844f98ffb48d22076468" id="r_adb7cacf4f029844f98ffb48d22076468"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#adb7cacf4f029844f98ffb48d22076468">add</a> (obj1, [obj2] *)</td></tr>
  56. <tr class="separator:adb7cacf4f029844f98ffb48d22076468"><td class="memSeparator" colspan="2">&#160;</td></tr>
  57. <tr class="memitem:a1ae599ad807bf666a5ef8c965fcb79aa" id="r_a1ae599ad807bf666a5ef8c965fcb79aa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#a1ae599ad807bf666a5ef8c965fcb79aa">bringToFront</a> (object)</td></tr>
  58. <tr class="separator:a1ae599ad807bf666a5ef8c965fcb79aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  59. <tr class="memitem:a165f19c3669e970a1c9eecb73da8a5f2" id="r_a165f19c3669e970a1c9eecb73da8a5f2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#a165f19c3669e970a1c9eecb73da8a5f2">callOnChildren</a> (string method, [string args] *)</td></tr>
  60. <tr class="separator:a165f19c3669e970a1c9eecb73da8a5f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61. <tr class="memitem:aacfc055ec034ede4b7cc3872ef7c0026" id="r_aacfc055ec034ede4b7cc3872ef7c0026"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#aacfc055ec034ede4b7cc3872ef7c0026">callOnChildrenNoRecurse</a> (string method, [string args] *)</td></tr>
  62. <tr class="separator:aacfc055ec034ede4b7cc3872ef7c0026"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63. <tr class="memitem:ac8bb3912a3ce86b15842e79d0b421204" id="r_ac8bb3912a3ce86b15842e79d0b421204"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#ac8bb3912a3ce86b15842e79d0b421204">clear</a> ()</td></tr>
  64. <tr class="separator:ac8bb3912a3ce86b15842e79d0b421204"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65. <tr class="memitem:a54ccf7d816af85ee00644518f0e46f2b" id="r_a54ccf7d816af85ee00644518f0e46f2b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#a54ccf7d816af85ee00644518f0e46f2b">deleteObjects</a> ()</td></tr>
  66. <tr class="separator:a54ccf7d816af85ee00644518f0e46f2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67. <tr class="memitem:a45d8af40c4ba1501cfd99ce5536554cc" id="r_a45d8af40c4ba1501cfd99ce5536554cc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#a45d8af40c4ba1501cfd99ce5536554cc">findObjectByInternalName</a> (string name, [bool searchChildren]?)</td></tr>
  68. <tr class="separator:a45d8af40c4ba1501cfd99ce5536554cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69. <tr class="memitem:aed4711154fb09672f96c96467e1a68ea" id="r_aed4711154fb09672f96c96467e1a68ea"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#aed4711154fb09672f96c96467e1a68ea">getCount</a> ()</td></tr>
  70. <tr class="separator:aed4711154fb09672f96c96467e1a68ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71. <tr class="memitem:a0b9cbe280c7d43c4934f0feb20cd85e8" id="r_a0b9cbe280c7d43c4934f0feb20cd85e8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#a0b9cbe280c7d43c4934f0feb20cd85e8">getObject</a> (index)</td></tr>
  72. <tr class="separator:a0b9cbe280c7d43c4934f0feb20cd85e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. <tr class="memitem:a1ae14d8c54362b6352a5887eef6733cc" id="r_a1ae14d8c54362b6352a5887eef6733cc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#a1ae14d8c54362b6352a5887eef6733cc">isMember</a> (object)</td></tr>
  74. <tr class="separator:a1ae14d8c54362b6352a5887eef6733cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. <tr class="memitem:a2cecf1a379201b595200c33d479fae80" id="r_a2cecf1a379201b595200c33d479fae80"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#a2cecf1a379201b595200c33d479fae80">listObjects</a> ()</td></tr>
  76. <tr class="separator:a2cecf1a379201b595200c33d479fae80"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:ab635bca66b0f0d23fa6002b75aa0ee7a" id="r_ab635bca66b0f0d23fa6002b75aa0ee7a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#ab635bca66b0f0d23fa6002b75aa0ee7a">pushToBack</a> (object)</td></tr>
  78. <tr class="separator:ab635bca66b0f0d23fa6002b75aa0ee7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:aed4ef988fffc9cead280f9b803064e70" id="r_aed4ef988fffc9cead280f9b803064e70"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#aed4ef988fffc9cead280f9b803064e70">remove</a> (obj1, [obj2] *)</td></tr>
  80. <tr class="separator:aed4ef988fffc9cead280f9b803064e70"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:a71a7c72cb3cc593d9a30c78fa546eb03" id="r_a71a7c72cb3cc593d9a30c78fa546eb03"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#a71a7c72cb3cc593d9a30c78fa546eb03">removeIfMember</a> (obj1, [obj2] *)</td></tr>
  82. <tr class="separator:a71a7c72cb3cc593d9a30c78fa546eb03"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:a02cee80758a77628082655b2ec259133" id="r_a02cee80758a77628082655b2ec259133"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#a02cee80758a77628082655b2ec259133">reorderChild</a> (<a class="el" href="classSimObject.html">SimObject</a> child1, <a class="el" href="classSimObject.html">SimObject</a> child2)</td></tr>
  84. <tr class="separator:a02cee80758a77628082655b2ec259133"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <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>
  86. <tr class="memitem:a2375929bea4901d98ae352231b0721ad inherit pub_methods_classSimObject" id="r_a2375929bea4901d98ae352231b0721ad"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a2375929bea4901d98ae352231b0721ad">assignFieldsFrom</a> (<a class="el" href="classSimObject.html">SimObject</a>)</td></tr>
  87. <tr class="separator:a2375929bea4901d98ae352231b0721ad inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:a22437f451ceb1429fa2a3be23d523954 inherit pub_methods_classSimObject" id="r_a22437f451ceb1429fa2a3be23d523954"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a22437f451ceb1429fa2a3be23d523954">clone</a> ([copyDynamicFields=false]?)</td></tr>
  89. <tr class="separator:a22437f451ceb1429fa2a3be23d523954 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject" id="r_a7a4721d0a51e952c211e9b0fea4d8090"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a7a4721d0a51e952c211e9b0fea4d8090">delete</a> ()</td></tr>
  91. <tr class="separator:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:a929e1325a515b279faca90a65028782e inherit pub_methods_classSimObject" id="r_a929e1325a515b279faca90a65028782e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a929e1325a515b279faca90a65028782e">getId</a> ()</td></tr>
  93. <tr class="separator:a929e1325a515b279faca90a65028782e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject" id="r_a4f673cd959711ae09927e7c44dae5fdb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a4f673cd959711ae09927e7c44dae5fdb">setName</a> (newName)</td></tr>
  95. <tr class="separator:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:a78ee178b6a73658d65ca60da4d1e6683 inherit pub_methods_classSimObject" id="r_a78ee178b6a73658d65ca60da4d1e6683"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a78ee178b6a73658d65ca60da4d1e6683">getName</a> ()</td></tr>
  97. <tr class="separator:a78ee178b6a73658d65ca60da4d1e6683 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:ab8b0f8b874af628d7204d9cc2630ced7 inherit pub_methods_classSimObject" id="r_ab8b0f8b874af628d7204d9cc2630ced7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab8b0f8b874af628d7204d9cc2630ced7">getClassNamespace</a> ()</td></tr>
  99. <tr class="separator:ab8b0f8b874af628d7204d9cc2630ced7 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:a6e266d4432d70cad58461d96e1d2cbdf inherit pub_methods_classSimObject" id="r_a6e266d4432d70cad58461d96e1d2cbdf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a6e266d4432d70cad58461d96e1d2cbdf">getSuperClassNamespace</a> ()</td></tr>
  101. <tr class="separator:a6e266d4432d70cad58461d96e1d2cbdf inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a847e859bcc5b58df83fa7f331c167c32 inherit pub_methods_classSimObject" id="r_a847e859bcc5b58df83fa7f331c167c32"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a847e859bcc5b58df83fa7f331c167c32">setClassNamespace</a> (nameSpace)</td></tr>
  103. <tr class="separator:a847e859bcc5b58df83fa7f331c167c32 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject" id="r_a9cbf471b97387d5bdefb88f92094ad54"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a9cbf471b97387d5bdefb88f92094ad54">setSuperClassNamespace</a> ()</td></tr>
  105. <tr class="separator:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:a8f4e85d0903526235ed2ca86df69cdef inherit pub_methods_classSimObject" id="r_a8f4e85d0903526235ed2ca86df69cdef"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a8f4e85d0903526235ed2ca86df69cdef">isMethod</a> (string methodName)</td></tr>
  107. <tr class="separator:a8f4e85d0903526235ed2ca86df69cdef inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:a9ce8801999cf2228ddde6d58ca3773d5 inherit pub_methods_classSimObject" id="r_a9ce8801999cf2228ddde6d58ca3773d5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a9ce8801999cf2228ddde6d58ca3773d5">call</a> (methodName, [args] *)</td></tr>
  109. <tr class="separator:a9ce8801999cf2228ddde6d58ca3773d5 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject" id="r_a1810f5aba25efd242c24232c2c2bbd1a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1810f5aba25efd242c24232c2c2bbd1a">dumpClassHierarchy</a> ()</td></tr>
  111. <tr class="separator:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject" id="r_accd2600060dbaee3a3b41aed4034c63c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#accd2600060dbaee3a3b41aed4034c63c">dump</a> ()</td></tr>
  113. <tr class="separator:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:a66ac731a8dc088fe8c8ab17bf7c9eecd inherit pub_methods_classSimObject" id="r_a66ac731a8dc088fe8c8ab17bf7c9eecd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a66ac731a8dc088fe8c8ab17bf7c9eecd">isMemberOfClass</a> (string classname)</td></tr>
  115. <tr class="separator:a66ac731a8dc088fe8c8ab17bf7c9eecd inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:a3e97a324df2af082cdb089491757ce11 inherit pub_methods_classSimObject" id="r_a3e97a324df2af082cdb089491757ce11"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a3e97a324df2af082cdb089491757ce11">getClassName</a> ()</td></tr>
  117. <tr class="separator:a3e97a324df2af082cdb089491757ce11 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:abc2222a9649b5c033810e753b07f26a3 inherit pub_methods_classSimObject" id="r_abc2222a9649b5c033810e753b07f26a3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#abc2222a9649b5c033810e753b07f26a3">getFieldValue</a> (fieldName)</td></tr>
  119. <tr class="separator:abc2222a9649b5c033810e753b07f26a3 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:a1084f1964e446b3d279943cf6e575069 inherit pub_methods_classSimObject" id="r_a1084f1964e446b3d279943cf6e575069"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1084f1964e446b3d279943cf6e575069">setFieldValue</a> (fieldName, value)</td></tr>
  121. <tr class="separator:a1084f1964e446b3d279943cf6e575069 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:ab4e32fb984d9ce6584b0fa57c8772d3e inherit pub_methods_classSimObject" id="r_ab4e32fb984d9ce6584b0fa57c8772d3e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab4e32fb984d9ce6584b0fa57c8772d3e">setEditFieldValue</a> (fieldName, value)</td></tr>
  123. <tr class="separator:ab4e32fb984d9ce6584b0fa57c8772d3e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:a7543b8dc494ec0d9034cb73ae504f3ca inherit pub_methods_classSimObject" id="r_a7543b8dc494ec0d9034cb73ae504f3ca"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a7543b8dc494ec0d9034cb73ae504f3ca">getDynamicFieldCount</a> ()</td></tr>
  125. <tr class="separator:a7543b8dc494ec0d9034cb73ae504f3ca inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:a0e143217119b68d557d17ac2f13b173e inherit pub_methods_classSimObject" id="r_a0e143217119b68d557d17ac2f13b173e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0e143217119b68d557d17ac2f13b173e">getDynamicField</a> (index)</td></tr>
  127. <tr class="separator:a0e143217119b68d557d17ac2f13b173e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:af2e74f6b683da8d2085f0991dab7948b inherit pub_methods_classSimObject" id="r_af2e74f6b683da8d2085f0991dab7948b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#af2e74f6b683da8d2085f0991dab7948b">getFieldCount</a> ()</td></tr>
  129. <tr class="separator:af2e74f6b683da8d2085f0991dab7948b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:ac636f89189406eef1b401292459b1a3b inherit pub_methods_classSimObject" id="r_ac636f89189406eef1b401292459b1a3b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ac636f89189406eef1b401292459b1a3b">getField</a> (int index)</td></tr>
  131. <tr class="separator:ac636f89189406eef1b401292459b1a3b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject" id="r_aa8f68d1e6d8c6601c39b3f676f0e9c70"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa8f68d1e6d8c6601c39b3f676f0e9c70">setProgenitorFile</a> (file)</td></tr>
  133. <tr class="separator:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:a88c8d99755a07ac4648360dd40ff67a5 inherit pub_methods_classSimObject" id="r_a88c8d99755a07ac4648360dd40ff67a5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a88c8d99755a07ac4648360dd40ff67a5">getProgenitorFile</a> ()</td></tr>
  135. <tr class="separator:a88c8d99755a07ac4648360dd40ff67a5 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:a367706e675179342e6153c45f1ba06ae inherit pub_methods_classSimObject" id="r_a367706e675179342e6153c45f1ba06ae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a367706e675179342e6153c45f1ba06ae">getType</a> ()</td></tr>
  137. <tr class="separator:a367706e675179342e6153c45f1ba06ae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:a0570b7f6eb94a0ed941fd75f6f01555b inherit pub_methods_classSimObject" id="r_a0570b7f6eb94a0ed941fd75f6f01555b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0570b7f6eb94a0ed941fd75f6f01555b">getFieldType</a> (fieldName)</td></tr>
  139. <tr class="separator:a0570b7f6eb94a0ed941fd75f6f01555b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject" id="r_a5aaca360a719feabae0e4e57b921deae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a5aaca360a719feabae0e4e57b921deae">setInternalName</a> (string InternalName)</td></tr>
  141. <tr class="separator:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <tr class="memitem:af9f341b474a28f4bcf79bc02439b7c18 inherit pub_methods_classSimObject" id="r_af9f341b474a28f4bcf79bc02439b7c18"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#af9f341b474a28f4bcf79bc02439b7c18">getInternalName</a> ()</td></tr>
  143. <tr class="separator:af9f341b474a28f4bcf79bc02439b7c18 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:a986f1b4a76969bac5dfd50b22af8dec6 inherit pub_methods_classSimObject" id="r_a986f1b4a76969bac5dfd50b22af8dec6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a986f1b4a76969bac5dfd50b22af8dec6">isChildOfGroup</a> (groupID)</td></tr>
  145. <tr class="separator:a986f1b4a76969bac5dfd50b22af8dec6 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:ae329d6593bb3f9b8046e7cae693ccc09 inherit pub_methods_classSimObject" id="r_ae329d6593bb3f9b8046e7cae693ccc09"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ae329d6593bb3f9b8046e7cae693ccc09">getGroup</a> ()</td></tr>
  147. <tr class="separator:ae329d6593bb3f9b8046e7cae693ccc09 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <tr class="memitem:a39653bc04e82875f2dc8d6dea25acdaa inherit pub_methods_classSimObject" id="r_a39653bc04e82875f2dc8d6dea25acdaa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a39653bc04e82875f2dc8d6dea25acdaa">startTimer</a> (callbackFunction, float timePeriod, [repeat]?)</td></tr>
  149. <tr class="separator:a39653bc04e82875f2dc8d6dea25acdaa inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <tr class="memitem:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject" id="r_aa6f6bfef028c7b053444cbd48567d286"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa6f6bfef028c7b053444cbd48567d286">stopTimer</a> ()</td></tr>
  151. <tr class="separator:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:a5807c03d2b725a54732d09b53d5da631 inherit pub_methods_classSimObject" id="r_a5807c03d2b725a54732d09b53d5da631"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a5807c03d2b725a54732d09b53d5da631">isTimerActive</a> ()</td></tr>
  153. <tr class="separator:a5807c03d2b725a54732d09b53d5da631 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <tr class="memitem:a16d537cd7a1c438045bb756fe1e22d2d inherit pub_methods_classSimObject" id="r_a16d537cd7a1c438045bb756fe1e22d2d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a16d537cd7a1c438045bb756fe1e22d2d">schedule</a> (time, command, [arg] *)</td></tr>
  155. <tr class="separator:a16d537cd7a1c438045bb756fe1e22d2d inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. <tr class="memitem:a9f05bc4a94b98e2e3347fe34aeefe7c4 inherit pub_methods_classSimObject" id="r_a9f05bc4a94b98e2e3347fe34aeefe7c4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a9f05bc4a94b98e2e3347fe34aeefe7c4">startListening</a> (<a class="el" href="classSimObject.html">SimObject</a>)</td></tr>
  157. <tr class="separator:a9f05bc4a94b98e2e3347fe34aeefe7c4 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <tr class="memitem:a3f7f0520846a222310415ad7a8f8a4bf inherit pub_methods_classSimObject" id="r_a3f7f0520846a222310415ad7a8f8a4bf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a3f7f0520846a222310415ad7a8f8a4bf">stopListening</a> (<a class="el" href="classSimObject.html">SimObject</a>)</td></tr>
  159. <tr class="separator:a3f7f0520846a222310415ad7a8f8a4bf inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  160. <tr class="memitem:afa6eac5990b02024e77e3815161159df inherit pub_methods_classSimObject" id="r_afa6eac5990b02024e77e3815161159df"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#afa6eac5990b02024e77e3815161159df">addListener</a> (<a class="el" href="classSimObject.html">SimObject</a>)</td></tr>
  161. <tr class="separator:afa6eac5990b02024e77e3815161159df inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  162. <tr class="memitem:a07dd4cf0d113ff4a8943b900bda68a1c inherit pub_methods_classSimObject" id="r_a07dd4cf0d113ff4a8943b900bda68a1c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a07dd4cf0d113ff4a8943b900bda68a1c">removeListener</a> (<a class="el" href="classSimObject.html">SimObject</a>)</td></tr>
  163. <tr class="separator:a07dd4cf0d113ff4a8943b900bda68a1c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  164. <tr class="memitem:a87be48ec4599c3d02a118cee89e47f55 inherit pub_methods_classSimObject" id="r_a87be48ec4599c3d02a118cee89e47f55"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a87be48ec4599c3d02a118cee89e47f55">removeAllListeners</a> ()</td></tr>
  165. <tr class="separator:a87be48ec4599c3d02a118cee89e47f55 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  166. <tr class="memitem:a1dcaa2910d6405134c74a71745d29154 inherit pub_methods_classSimObject" id="r_a1dcaa2910d6405134c74a71745d29154"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1dcaa2910d6405134c74a71745d29154">postEvent</a> (<a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> eventName, <a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> data)</td></tr>
  167. <tr class="separator:a1dcaa2910d6405134c74a71745d29154 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  168. <tr class="memitem:ab6e816c3694e8b6119bf9ac3f5556f32 inherit pub_methods_classSimObject" id="r_ab6e816c3694e8b6119bf9ac3f5556f32"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab6e816c3694e8b6119bf9ac3f5556f32">save</a> (<a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>, [selectedOnly]?)</td></tr>
  169. <tr class="separator:ab6e816c3694e8b6119bf9ac3f5556f32 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  170. <tr class="memitem:a216228c27df224ac5e8d3590494bfb3f inherit pub_methods_classSimObject" id="r_a216228c27df224ac5e8d3590494bfb3f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a216228c27df224ac5e8d3590494bfb3f">addFieldFilter</a> (fieldName)</td></tr>
  171. <tr class="separator:a216228c27df224ac5e8d3590494bfb3f inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  172. <tr class="memitem:ad517bd83c1c853985ab07cd22775c43d inherit pub_methods_classSimObject" id="r_ad517bd83c1c853985ab07cd22775c43d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ad517bd83c1c853985ab07cd22775c43d">removeFieldFilter</a> (fieldName)</td></tr>
  173. <tr class="separator:ad517bd83c1c853985ab07cd22775c43d inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  174. </table>
  175. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  176. <div class="textblock"><p>A container for a sequence of unique SimObjects.</p>
  177. <dl class="section user"><dt>Overview</dt><dd></dd></dl>
  178. <p>A <a class="el" href="classSimSet.html">SimSet</a> is a specized container: an ordered set of references to SimObjects. As the name "set" implies, a <a class="el" href="classSimObject.html">SimObject</a> can appear no more than once within a particular <a class="el" href="classSimSet.html">SimSet</a>. Attempting to add an object multiple times will not change the <a class="el" href="classSimSet.html">SimSet</a> not does it (nor should it) warn you. A <a class="el" href="classSimSet.html">SimSet</a> keeps its items ordered, however, so it is more than a mathematical "set." You can reorder the objects.</p>
  179. <p>A Simset only <em>references</em> SimObjects. The deletion of a <a class="el" href="classSimSet.html">SimSet</a> will not delete the objects in it. Likewise, removing an object from a <a class="el" href="classSimSet.html">SimSet</a> does not delete that object. Note that a <a class="el" href="classSimObject.html">SimObject</a> can be a member of any number of SimSets.</p>
  180. <p>When a <a class="el" href="classSimObject.html">SimObject</a> is deleted, it will be automatically removed from any SimSets it is in. This is one of a SimSets most powerful features. There can be no invalid references to objects because you can not insert a non-existent reference, and references to SimObjects are automatically removed when those objects are deleted.</p>
  181. <p>Due to its many capabilities, a <a class="el" href="classSimSet.html">SimSet</a> is usually the appropriate structure for keeping Collections in Torque2D.*</p>
  182. <p>Note that only SimObjects can be held in SimSets. Strings, for instance, can not. But, because <a class="el" href="classSimObject.html">SimObject</a> is the base class for almost all script classes, you can add almost any script class to a <a class="el" href="classSimSet.html">SimSet</a>.</p>
  183. <p>The <a class="el" href="classSimSet.html">SimSet</a>'s member objects are stored initially in the order of insertion (<a class="el" href="classSimSet.html#adb7cacf4f029844f98ffb48d22076468">add()</a>), and can be removed (<a class="el" href="classSimSet.html#aed4ef988fffc9cead280f9b803064e70">remove()</a>), retrieved (<a class="el" href="classSimSet.html#a0b9cbe280c7d43c4934f0feb20cd85e8">getObject()</a>), and queried (<a class="el" href="classSimSet.html#a1ae14d8c54362b6352a5887eef6733cc">isMember()</a>). The <a class="el" href="classSimSet.html">SimSet</a> can have all its members counted (<a class="el" href="classSimSet.html#aed4711154fb09672f96c96467e1a68ea">getCount()</a>), printed (<a class="el" href="classSimSet.html#a2cecf1a379201b595200c33d479fae80">listObjects()</a>), and removed (<a class="el" href="classSimSet.html#ac8bb3912a3ce86b15842e79d0b421204">clear()</a>). A member can be reordered via <a class="el" href="classSimSet.html#a1ae599ad807bf666a5ef8c965fcb79aa">bringToFront()</a> and <a class="el" href="classSimSet.html#ab635bca66b0f0d23fa6002b75aa0ee7a">pushToBack()</a>, or re-ordered relative to another via <a class="el" href="classSimSet.html#a02cee80758a77628082655b2ec259133">reorderChild()</a>.</p>
  184. <dl class="section user"><dt>Examples</dt><dd></dd></dl>
  185. <p>Creating and Adding**</p>
  186. <p>We create the <a class="el" href="classSimSet.html">SimSet</a>, then create objects to put in it, then we add them all in.</p>
  187. <div class="fragment"><div class="line"><span class="keyword">new</span> <a class="code hl_class" href="classSimSet.html">SimSet</a>(Fruit);</div>
  188. <div class="line"><a class="code hl_function" href="group__ConsoleOutput.html#gadc918a80dc292eeae84dcca04998faba">echo</a>(Fruit.getCount());</div>
  189. <div class="line">&gt; 0</div>
  190. <div class="line"> </div>
  191. <div class="line"><span class="comment">// Apple, Pear, etc will be SimObjects</span></div>
  192. <div class="line"><span class="keyword">new</span> <a class="code hl_class" href="classSimObject.html">SimObject</a>(Apple);</div>
  193. <div class="line"><span class="keyword">new</span> <a class="code hl_class" href="classSimObject.html">SimObject</a>(Pear);</div>
  194. <div class="line"><span class="keyword">new</span> <a class="code hl_class" href="classSimObject.html">SimObject</a>(Orange);</div>
  195. <div class="line"><span class="keyword">new</span> <a class="code hl_class" href="classSimObject.html">SimObject</a>(Fig);</div>
  196. <div class="line"><span class="keyword">new</span> <a class="code hl_class" href="classSimObject.html">SimObject</a>(Persimmon);</div>
  197. <div class="line"> </div>
  198. <div class="line"><span class="comment">// add our fruit to the SimSet named Fruit</span></div>
  199. <div class="line">Fruit.add(Apple);</div>
  200. <div class="line">Fruit.add(Pear);</div>
  201. <div class="line">Fruit.add(Orange);</div>
  202. <div class="line">Fruit.add(Fig);</div>
  203. <div class="line">Fruit.add(Persimmon);</div>
  204. <div class="line"><a class="code hl_function" href="group__ConsoleOutput.html#gadc918a80dc292eeae84dcca04998faba">echo</a>(Fruit.getCount());</div>
  205. <div class="line">&gt; 5</div>
  206. <div class="ttc" id="aclassSimObject_html"><div class="ttname"><a href="classSimObject.html">SimObject</a></div><div class="ttdef"><b>Definition</b> simObject_ScriptBinding.h:23</div></div>
  207. <div class="ttc" id="aclassSimSet_html"><div class="ttname"><a href="classSimSet.html">SimSet</a></div><div class="ttdef"><b>Definition</b> simSet_ScriptBinding.h:192</div></div>
  208. <div class="ttc" id="agroup__ConsoleOutput_html_gadc918a80dc292eeae84dcca04998faba"><div class="ttname"><a href="group__ConsoleOutput.html#gadc918a80dc292eeae84dcca04998faba">echo</a></div><div class="ttdeci">void echo(text, [...] *)</div><div class="ttdef"><b>Definition</b> output_ScriptBinding.h:36</div></div>
  209. </div><!-- fragment --><p>Uniqueness**</p>
  210. <p>Continuing the above example, each member of the <a class="el" href="classSimSet.html">SimSet</a> appears exactly once: the <a class="el" href="classSimSet.html">SimSet</a> is a mathematically proper set.</p>
  211. <div class="fragment"><div class="line"><span class="comment">// Apple is already added.</span></div>
  212. <div class="line">Fruit.add(Apple);</div>
  213. <div class="line"><a class="code hl_function" href="group__ConsoleOutput.html#gadc918a80dc292eeae84dcca04998faba">echo</a>(Fruit.getCount());</div>
  214. <div class="line">&gt; 5</div>
  215. </div><!-- fragment --><p>Re-ordering**</p>
  216. <p>The members of a <a class="el" href="classSimSet.html">SimSet</a> are well ordered. Let us move a different object to the front.</p>
  217. <div class="fragment"><div class="line"><a class="code hl_function" href="group__ConsoleOutput.html#gadc918a80dc292eeae84dcca04998faba">echo</a>(Fruit.getObject(0).getName());</div>
  218. <div class="line">&gt; Apple</div>
  219. <div class="line"> </div>
  220. <div class="line">Fruit.bringToFront(Persimmon);</div>
  221. <div class="line"><a class="code hl_function" href="group__ConsoleOutput.html#gadc918a80dc292eeae84dcca04998faba">echo</a>(Fruit.getObject(0).getName());</div>
  222. <div class="line">&gt; Persimmon</div>
  223. </div><!-- fragment --><p>Now we move a different member to the back.</p>
  224. <div class="fragment"><div class="line">Fruit.pushToBack(Apple);</div>
  225. <div class="line"><a class="code hl_function" href="group__ConsoleOutput.html#gadc918a80dc292eeae84dcca04998faba">echo</a>(Fruit.getObject(4).getName());</div>
  226. <div class="line">&gt; Apple</div>
  227. </div><!-- fragment --><p>Finally, we move the Fig member to precede Pear. Note that all of the other members retain their relative order.</p>
  228. <div class="fragment"><div class="line">Fruit.listObjects();</div>
  229. <div class="line">&gt; 2887,<span class="stringliteral">&quot;Persimmon&quot;</span>: <a class="code hl_class" href="classSimObject.html">SimObject</a> </div>
  230. <div class="line">&gt; 2884,<span class="stringliteral">&quot;Pear&quot;</span>: <a class="code hl_class" href="classSimObject.html">SimObject</a> </div>
  231. <div class="line">&gt; 2885,<span class="stringliteral">&quot;Orange&quot;</span>: <a class="code hl_class" href="classSimObject.html">SimObject</a> </div>
  232. <div class="line">&gt; 2886,<span class="stringliteral">&quot;Fig&quot;</span>: <a class="code hl_class" href="classSimObject.html">SimObject</a> </div>
  233. <div class="line">&gt; 2883,<span class="stringliteral">&quot;Apple&quot;</span>: <a class="code hl_class" href="classSimObject.html">SimObject</a> </div>
  234. <div class="line"> </div>
  235. <div class="line">Fruit.reorderChild(Fig, Pear);</div>
  236. <div class="line">Fruit.listObjects();</div>
  237. <div class="line">&gt; 2887,<span class="stringliteral">&quot;Persimmon&quot;</span>: <a class="code hl_class" href="classSimObject.html">SimObject</a> </div>
  238. <div class="line">&gt; 2886,<span class="stringliteral">&quot;Fig&quot;</span>: <a class="code hl_class" href="classSimObject.html">SimObject</a> </div>
  239. <div class="line">&gt; 2885,<span class="stringliteral">&quot;Orange&quot;</span>: <a class="code hl_class" href="classSimObject.html">SimObject</a> </div>
  240. <div class="line">&gt; 2884,<span class="stringliteral">&quot;Pear&quot;</span>: <a class="code hl_class" href="classSimObject.html">SimObject</a> </div>
  241. <div class="line">&gt; 2883,<span class="stringliteral">&quot;Apple&quot;</span>: <a class="code hl_class" href="classSimObject.html">SimObject</a> </div>
  242. </div><!-- fragment --><p>Removing**</p>
  243. <div class="fragment"><div class="line"><a class="code hl_function" href="group__ConsoleOutput.html#gadc918a80dc292eeae84dcca04998faba">echo</a>(Fruit.isMember(Apple));</div>
  244. <div class="line">&gt; 1</div>
  245. <div class="line"> </div>
  246. <div class="line">Fruit.remove(Apple);</div>
  247. <div class="line"><a class="code hl_function" href="group__ConsoleOutput.html#gadc918a80dc292eeae84dcca04998faba">echo</a>(Fruit.isMember(Apple));</div>
  248. <div class="line">&gt; 0</div>
  249. <div class="line"> </div>
  250. <div class="line"><span class="comment">// Apple was not deleted</span></div>
  251. <div class="line"><a class="code hl_function" href="group__ConsoleOutput.html#gadc918a80dc292eeae84dcca04998faba">echo</a>(<a class="code hl_function" href="group__ObjectFunctions.html#ga589006948543b3e679a816aa9f310635">isObject</a>(Apple));</div>
  252. <div class="line">&gt; 1</div>
  253. <div class="line"> </div>
  254. <div class="line">Fruit.clear();</div>
  255. <div class="line"><a class="code hl_function" href="group__ConsoleOutput.html#gadc918a80dc292eeae84dcca04998faba">echo</a>(Fruit.getCount());</div>
  256. <div class="line">&gt; 0</div>
  257. <div class="line"> </div>
  258. <div class="line"><span class="comment">// The fruit SimObjects are not deleted by clear() either. For example...</span></div>
  259. <div class="line"><a class="code hl_function" href="group__ConsoleOutput.html#gadc918a80dc292eeae84dcca04998faba">echo</a>(<a class="code hl_function" href="group__ObjectFunctions.html#ga589006948543b3e679a816aa9f310635">isObject</a>(Persimmon));</div>
  260. <div class="line">&gt; 1</div>
  261. <div class="ttc" id="agroup__ObjectFunctions_html_ga589006948543b3e679a816aa9f310635"><div class="ttname"><a href="group__ObjectFunctions.html#ga589006948543b3e679a816aa9f310635">isObject</a></div><div class="ttdeci">Boolean isObject(handle)</div><div class="ttdef"><b>Definition</b> simBase_ScriptBinding.h:212</div></div>
  262. </div><!-- fragment --><dl class="section user"><dt>caveat</dt><dd></dd></dl>
  263. <p>Suppose you want to delete the items in a <a class="el" href="classSimSet.html">SimSet</a>. Remember that, as you delete each one, it is automatically removed from the <a class="el" href="classSimSet.html">SimSet</a>, which in turn changes the index of any items that came after the one you just deleted!</p>
  264. <div class="fragment"><div class="line"><span class="comment">// DO NOT DO THIS! this may lead to tears!</span></div>
  265. <div class="line"><span class="keywordflow">for</span> (%i = 0; %i &lt; %mySet.getCount(); %i++)</div>
  266. <div class="line">{</div>
  267. <div class="line"> %<span class="keywordtype">object</span> = %mySet.getObject(%i);</div>
  268. <div class="line"> %<span class="keywordtype">object</span>.delete();</div>
  269. <div class="line">}</div>
  270. </div><!-- fragment --><p>The problem is that you delete the object at index 0. This, in turn, moves the objects down one index so that what was at index 1 is not at index 0. But your loop will not try index 0 again, where there is a fresh object. Instead it will skip to index 1. You will only delete half the items.</p>
  271. <div class="fragment"><div class="line"><span class="comment">// fixed it</span></div>
  272. <div class="line"><span class="keywordflow">while</span> (%mySet.getCount() &gt; 0)</div>
  273. <div class="line">{</div>
  274. <div class="line"> %<span class="keywordtype">object</span> = %mySet.getObject(0);</div>
  275. <div class="line"> %<span class="keywordtype">object</span>.delete();</div>
  276. <div class="line">}</div>
  277. <div class="line"> </div>
  278. <div class="line"><span class="comment">// or this will work too. see why?</span></div>
  279. <div class="line"><span class="keywordflow">for</span> (%i = %mySet.getCount() - 1; %i &gt;= 0; %i--)</div>
  280. <div class="line">{</div>
  281. <div class="line"> %<span class="keywordtype">object</span> = %mySet.getObject(%i);</div>
  282. <div class="line"> %<span class="keywordtype">object</span>.delete();</div>
  283. <div class="line">}</div>
  284. </div><!-- fragment --> </div><h2 class="groupheader">Member Function Documentation</h2>
  285. <a id="adb7cacf4f029844f98ffb48d22076468" name="adb7cacf4f029844f98ffb48d22076468"></a>
  286. <h2 class="memtitle"><span class="permalink"><a href="#adb7cacf4f029844f98ffb48d22076468">&#9670;&#160;</a></span>add()</h2>
  287. <div class="memitem">
  288. <div class="memproto">
  289. <table class="memname">
  290. <tr>
  291. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> add </td>
  292. <td>(</td>
  293. <td class="paramtype">obj1&#160;</td>
  294. <td class="paramname">, </td>
  295. </tr>
  296. <tr>
  297. <td class="paramkey"></td>
  298. <td></td>
  299. <td class="paramtype">[obj2] *&#160;</td>
  300. <td class="paramname">&#160;</td>
  301. </tr>
  302. <tr>
  303. <td></td>
  304. <td>)</td>
  305. <td></td><td></td>
  306. </tr>
  307. </table>
  308. </div><div class="memdoc">
  309. <p>Appends given <a class="el" href="classSimObject.html">SimObject</a> (or list of SimObjects) to the <a class="el" href="classSimSet.html">SimSet</a>. </p><dl class="params"><dt>Parameters</dt><dd>
  310. <table class="params">
  311. <tr><td class="paramname">obj_1..obj_n</td><td>list of SimObjects to add </td></tr>
  312. </table>
  313. </dd>
  314. </dl>
  315. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  316. </div>
  317. </div>
  318. <a id="a1ae599ad807bf666a5ef8c965fcb79aa" name="a1ae599ad807bf666a5ef8c965fcb79aa"></a>
  319. <h2 class="memtitle"><span class="permalink"><a href="#a1ae599ad807bf666a5ef8c965fcb79aa">&#9670;&#160;</a></span>bringToFront()</h2>
  320. <div class="memitem">
  321. <div class="memproto">
  322. <table class="memname">
  323. <tr>
  324. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> bringToFront </td>
  325. <td>(</td>
  326. <td class="paramtype">object&#160;</td>
  327. <td class="paramname"></td><td>)</td>
  328. <td></td>
  329. </tr>
  330. </table>
  331. </div><div class="memdoc">
  332. <p>Brings <a class="el" href="classSimObject.html">SimObject</a> to front of set. If the <a class="el" href="classSimObject.html">SimObject</a> is not in the set, do nothing. </p><dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  333. </div>
  334. </div>
  335. <a id="a165f19c3669e970a1c9eecb73da8a5f2" name="a165f19c3669e970a1c9eecb73da8a5f2"></a>
  336. <h2 class="memtitle"><span class="permalink"><a href="#a165f19c3669e970a1c9eecb73da8a5f2">&#9670;&#160;</a></span>callOnChildren()</h2>
  337. <div class="memitem">
  338. <div class="memproto">
  339. <table class="memname">
  340. <tr>
  341. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> callOnChildren </td>
  342. <td>(</td>
  343. <td class="paramtype">string&#160;</td>
  344. <td class="paramname"><em>method</em>, </td>
  345. </tr>
  346. <tr>
  347. <td class="paramkey"></td>
  348. <td></td>
  349. <td class="paramtype">[string args] *&#160;</td>
  350. <td class="paramname">&#160;</td>
  351. </tr>
  352. <tr>
  353. <td></td>
  354. <td>)</td>
  355. <td></td><td></td>
  356. </tr>
  357. </table>
  358. </div><div class="memdoc">
  359. <p>Call a method on all objects contained in the set. </p><dl class="params"><dt>Parameters</dt><dd>
  360. <table class="params">
  361. <tr><td class="paramname">method</td><td>The name of the method to call. </td></tr>
  362. <tr><td class="paramname">args</td><td>The arguments to the method. </td></tr>
  363. </table>
  364. </dd>
  365. </dl>
  366. <dl class="section note"><dt>Note</dt><dd>This method recurses into all SimSets that are children to the set. </dd></dl>
  367. <dl class="section see"><dt>See also</dt><dd><a class="el" href="classSimSet.html#aacfc055ec034ede4b7cc3872ef7c0026">callOnChildrenNoRecurse</a>" ) </dd></dl>
  368. </div>
  369. </div>
  370. <a id="aacfc055ec034ede4b7cc3872ef7c0026" name="aacfc055ec034ede4b7cc3872ef7c0026"></a>
  371. <h2 class="memtitle"><span class="permalink"><a href="#aacfc055ec034ede4b7cc3872ef7c0026">&#9670;&#160;</a></span>callOnChildrenNoRecurse()</h2>
  372. <div class="memitem">
  373. <div class="memproto">
  374. <table class="memname">
  375. <tr>
  376. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> callOnChildrenNoRecurse </td>
  377. <td>(</td>
  378. <td class="paramtype">string&#160;</td>
  379. <td class="paramname"><em>method</em>, </td>
  380. </tr>
  381. <tr>
  382. <td class="paramkey"></td>
  383. <td></td>
  384. <td class="paramtype">[string args] *&#160;</td>
  385. <td class="paramname">&#160;</td>
  386. </tr>
  387. <tr>
  388. <td></td>
  389. <td>)</td>
  390. <td></td><td></td>
  391. </tr>
  392. </table>
  393. </div><div class="memdoc">
  394. <p>Call a method on all objects contained in the set. </p><dl class="params"><dt>Parameters</dt><dd>
  395. <table class="params">
  396. <tr><td class="paramname">method</td><td>The name of the method to call. </td></tr>
  397. <tr><td class="paramname">args</td><td>The arguments to the method. </td></tr>
  398. </table>
  399. </dd>
  400. </dl>
  401. <dl class="section note"><dt>Note</dt><dd>This method does not recursively call into all SimSets that are children to the set. </dd></dl>
  402. <dl class="section see"><dt>See also</dt><dd><a class="el" href="classSimSet.html#a165f19c3669e970a1c9eecb73da8a5f2">callOnChildren</a>" ) </dd></dl>
  403. </div>
  404. </div>
  405. <a id="ac8bb3912a3ce86b15842e79d0b421204" name="ac8bb3912a3ce86b15842e79d0b421204"></a>
  406. <h2 class="memtitle"><span class="permalink"><a href="#ac8bb3912a3ce86b15842e79d0b421204">&#9670;&#160;</a></span>clear()</h2>
  407. <div class="memitem">
  408. <div class="memproto">
  409. <table class="memname">
  410. <tr>
  411. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> clear </td>
  412. <td>(</td>
  413. <td class="paramname"></td><td>)</td>
  414. <td></td>
  415. </tr>
  416. </table>
  417. </div><div class="memdoc">
  418. <p>Clears the Simset This does not delete the cleared SimObjects. </p><dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  419. </div>
  420. </div>
  421. <a id="a54ccf7d816af85ee00644518f0e46f2b" name="a54ccf7d816af85ee00644518f0e46f2b"></a>
  422. <h2 class="memtitle"><span class="permalink"><a href="#a54ccf7d816af85ee00644518f0e46f2b">&#9670;&#160;</a></span>deleteObjects()</h2>
  423. <div class="memitem">
  424. <div class="memproto">
  425. <table class="memname">
  426. <tr>
  427. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> deleteObjects </td>
  428. <td>(</td>
  429. <td class="paramname"></td><td>)</td>
  430. <td></td>
  431. </tr>
  432. </table>
  433. </div><div class="memdoc">
  434. <p>Deletes all the objects in the <a class="el" href="classSimSet.html">SimSet</a>. </p><dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  435. </div>
  436. </div>
  437. <a id="a45d8af40c4ba1501cfd99ce5536554cc" name="a45d8af40c4ba1501cfd99ce5536554cc"></a>
  438. <h2 class="memtitle"><span class="permalink"><a href="#a45d8af40c4ba1501cfd99ce5536554cc">&#9670;&#160;</a></span>findObjectByInternalName()</h2>
  439. <div class="memitem">
  440. <div class="memproto">
  441. <table class="memname">
  442. <tr>
  443. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> findObjectByInternalName </td>
  444. <td>(</td>
  445. <td class="paramtype">string&#160;</td>
  446. <td class="paramname"><em>name</em>, </td>
  447. </tr>
  448. <tr>
  449. <td class="paramkey"></td>
  450. <td></td>
  451. <td class="paramtype">[bool searchChildren] ?&#160;</td>
  452. <td class="paramname">&#160;</td>
  453. </tr>
  454. <tr>
  455. <td></td>
  456. <td>)</td>
  457. <td></td><td></td>
  458. </tr>
  459. </table>
  460. </div><div class="memdoc">
  461. <p>Returns the object with given internal name </p><dl class="params"><dt>Parameters</dt><dd>
  462. <table class="params">
  463. <tr><td class="paramname">name</td><td>The internal name of the object you wish to find </td></tr>
  464. <tr><td class="paramname">searchChildren</td><td>Set this true if you wish to search all children as well. </td></tr>
  465. </table>
  466. </dd>
  467. </dl>
  468. <dl class="section return"><dt>Returns</dt><dd>Returns the ID of the object. </dd></dl>
  469. </div>
  470. </div>
  471. <a id="aed4711154fb09672f96c96467e1a68ea" name="aed4711154fb09672f96c96467e1a68ea"></a>
  472. <h2 class="memtitle"><span class="permalink"><a href="#aed4711154fb09672f96c96467e1a68ea">&#9670;&#160;</a></span>getCount()</h2>
  473. <div class="memitem">
  474. <div class="memproto">
  475. <table class="memname">
  476. <tr>
  477. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getCount </td>
  478. <td>(</td>
  479. <td class="paramname"></td><td>)</td>
  480. <td></td>
  481. </tr>
  482. </table>
  483. </div><div class="memdoc">
  484. <dl class="section return"><dt>Returns</dt><dd>Returns the number of objects in the <a class="el" href="classSimSet.html">SimSet</a> </dd></dl>
  485. </div>
  486. </div>
  487. <a id="a0b9cbe280c7d43c4934f0feb20cd85e8" name="a0b9cbe280c7d43c4934f0feb20cd85e8"></a>
  488. <h2 class="memtitle"><span class="permalink"><a href="#a0b9cbe280c7d43c4934f0feb20cd85e8">&#9670;&#160;</a></span>getObject()</h2>
  489. <div class="memitem">
  490. <div class="memproto">
  491. <table class="memname">
  492. <tr>
  493. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getObject </td>
  494. <td>(</td>
  495. <td class="paramtype">index&#160;</td>
  496. <td class="paramname"></td><td>)</td>
  497. <td></td>
  498. </tr>
  499. </table>
  500. </div><div class="memdoc">
  501. <p>Returns a member <a class="el" href="classSimObject.html">SimObject</a> of the <a class="el" href="classSimSet.html">SimSet</a> </p><dl class="params"><dt>Parameters</dt><dd>
  502. <table class="params">
  503. <tr><td class="paramname">index</td><td>into this ordered collection (zero-based). </td></tr>
  504. </table>
  505. </dd>
  506. </dl>
  507. <dl class="section return"><dt>Returns</dt><dd>Returns the ID of the desired object or -1 on failure </dd></dl>
  508. </div>
  509. </div>
  510. <a id="a1ae14d8c54362b6352a5887eef6733cc" name="a1ae14d8c54362b6352a5887eef6733cc"></a>
  511. <h2 class="memtitle"><span class="permalink"><a href="#a1ae14d8c54362b6352a5887eef6733cc">&#9670;&#160;</a></span>isMember()</h2>
  512. <div class="memitem">
  513. <div class="memproto">
  514. <table class="memname">
  515. <tr>
  516. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> isMember </td>
  517. <td>(</td>
  518. <td class="paramtype">object&#160;</td>
  519. <td class="paramname"></td><td>)</td>
  520. <td></td>
  521. </tr>
  522. </table>
  523. </div><div class="memdoc">
  524. <dl class="section return"><dt>Returns</dt><dd>Returns true if specified object is a member of the set, and false otherwise </dd></dl>
  525. </div>
  526. </div>
  527. <a id="a2cecf1a379201b595200c33d479fae80" name="a2cecf1a379201b595200c33d479fae80"></a>
  528. <h2 class="memtitle"><span class="permalink"><a href="#a2cecf1a379201b595200c33d479fae80">&#9670;&#160;</a></span>listObjects()</h2>
  529. <div class="memitem">
  530. <div class="memproto">
  531. <table class="memname">
  532. <tr>
  533. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> listObjects </td>
  534. <td>(</td>
  535. <td class="paramname"></td><td>)</td>
  536. <td></td>
  537. </tr>
  538. </table>
  539. </div><div class="memdoc">
  540. <p>Prints the object data within the set </p><dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  541. </div>
  542. </div>
  543. <a id="ab635bca66b0f0d23fa6002b75aa0ee7a" name="ab635bca66b0f0d23fa6002b75aa0ee7a"></a>
  544. <h2 class="memtitle"><span class="permalink"><a href="#ab635bca66b0f0d23fa6002b75aa0ee7a">&#9670;&#160;</a></span>pushToBack()</h2>
  545. <div class="memitem">
  546. <div class="memproto">
  547. <table class="memname">
  548. <tr>
  549. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> pushToBack </td>
  550. <td>(</td>
  551. <td class="paramtype">object&#160;</td>
  552. <td class="paramname"></td><td>)</td>
  553. <td></td>
  554. </tr>
  555. </table>
  556. </div><div class="memdoc">
  557. <p>Sends item to back of set. If the <a class="el" href="classSimObject.html">SimObject</a> is not in the set, do nothing. </p><dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  558. </div>
  559. </div>
  560. <a id="aed4ef988fffc9cead280f9b803064e70" name="aed4ef988fffc9cead280f9b803064e70"></a>
  561. <h2 class="memtitle"><span class="permalink"><a href="#aed4ef988fffc9cead280f9b803064e70">&#9670;&#160;</a></span>remove()</h2>
  562. <div class="memitem">
  563. <div class="memproto">
  564. <table class="memname">
  565. <tr>
  566. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> remove </td>
  567. <td>(</td>
  568. <td class="paramtype">obj1&#160;</td>
  569. <td class="paramname">, </td>
  570. </tr>
  571. <tr>
  572. <td class="paramkey"></td>
  573. <td></td>
  574. <td class="paramtype">[obj2] *&#160;</td>
  575. <td class="paramname">&#160;</td>
  576. </tr>
  577. <tr>
  578. <td></td>
  579. <td>)</td>
  580. <td></td><td></td>
  581. </tr>
  582. </table>
  583. </div><div class="memdoc">
  584. <p>Removes given <a class="el" href="classSimObject.html">SimObject</a> (or list of SimObjects) from the <a class="el" href="classSimSet.html">SimSet</a>. </p><dl class="params"><dt>Parameters</dt><dd>
  585. <table class="params">
  586. <tr><td class="paramname">obj_1..obj_n</td><td>list of SimObjects to remove The SimObjects are not deleted. An attempt to remove a <a class="el" href="classSimObject.html">SimObject</a> that is not present in the <a class="el" href="classSimSet.html">SimSet</a> will print a warning and continue. </td></tr>
  587. </table>
  588. </dd>
  589. </dl>
  590. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  591. </div>
  592. </div>
  593. <a id="a71a7c72cb3cc593d9a30c78fa546eb03" name="a71a7c72cb3cc593d9a30c78fa546eb03"></a>
  594. <h2 class="memtitle"><span class="permalink"><a href="#a71a7c72cb3cc593d9a30c78fa546eb03">&#9670;&#160;</a></span>removeIfMember()</h2>
  595. <div class="memitem">
  596. <div class="memproto">
  597. <table class="memname">
  598. <tr>
  599. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> removeIfMember </td>
  600. <td>(</td>
  601. <td class="paramtype">obj1&#160;</td>
  602. <td class="paramname">, </td>
  603. </tr>
  604. <tr>
  605. <td class="paramkey"></td>
  606. <td></td>
  607. <td class="paramtype">[obj2] *&#160;</td>
  608. <td class="paramname">&#160;</td>
  609. </tr>
  610. <tr>
  611. <td></td>
  612. <td>)</td>
  613. <td></td><td></td>
  614. </tr>
  615. </table>
  616. </div><div class="memdoc">
  617. <p>Removes given <a class="el" href="classSimObject.html">SimObject</a> (or list of SimObjects) from the <a class="el" href="classSimSet.html">SimSet</a> with no warning. </p><dl class="params"><dt>Parameters</dt><dd>
  618. <table class="params">
  619. <tr><td class="paramname">obj_1..obj_n</td><td>list of SimObjects to remove The SimObjects are not deleted. An attempt to remove a <a class="el" href="classSimObject.html">SimObject</a> that is not present in the <a class="el" href="classSimSet.html">SimSet</a> will silently fail. </td></tr>
  620. </table>
  621. </dd>
  622. </dl>
  623. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  624. </div>
  625. </div>
  626. <a id="a02cee80758a77628082655b2ec259133" name="a02cee80758a77628082655b2ec259133"></a>
  627. <h2 class="memtitle"><span class="permalink"><a href="#a02cee80758a77628082655b2ec259133">&#9670;&#160;</a></span>reorderChild()</h2>
  628. <div class="memitem">
  629. <div class="memproto">
  630. <table class="memname">
  631. <tr>
  632. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> reorderChild </td>
  633. <td>(</td>
  634. <td class="paramtype"><a class="el" href="classSimObject.html">SimObject</a>&#160;</td>
  635. <td class="paramname"><em>child1</em>, </td>
  636. </tr>
  637. <tr>
  638. <td class="paramkey"></td>
  639. <td></td>
  640. <td class="paramtype"><a class="el" href="classSimObject.html">SimObject</a>&#160;</td>
  641. <td class="paramname"><em>child2</em>&#160;</td>
  642. </tr>
  643. <tr>
  644. <td></td>
  645. <td>)</td>
  646. <td></td><td></td>
  647. </tr>
  648. </table>
  649. </div><div class="memdoc">
  650. <p>Bring child 1 before child 2 Both SimObjects must already be child objects. If not, the operation silently fails. </p><dl class="params"><dt>Parameters</dt><dd>
  651. <table class="params">
  652. <tr><td class="paramname">child1</td><td>The child you wish to set first </td></tr>
  653. <tr><td class="paramname">child2</td><td>The child you wish to set after child1 </td></tr>
  654. </table>
  655. </dd>
  656. </dl>
  657. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  658. </div>
  659. </div>
  660. </div><!-- contents -->
  661. <!-- start footer part -->
  662. <hr class="footer"/><address class="footer"><small>
  663. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
  664. </small></address>
  665. </body>
  666. </html>