classSceneObjectSet.html 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.10"/>
  7. <title>TorqueScript Reference: SceneObjectSet Class Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  13. </head>
  14. <body>
  15. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  16. <div id="titlearea">
  17. <table cellspacing="0" cellpadding="0">
  18. <tbody>
  19. <tr style="height: 56px;">
  20. <td id="projectalign" style="padding-left: 0.5em;">
  21. <div id="projectname">TorqueScript Reference
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.10 -->
  30. <div id="navrow1" class="tabs">
  31. <ul class="tablist">
  32. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33. <li><a href="modules.html"><span>Modules</span></a></li>
  34. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  35. </ul>
  36. </div>
  37. <div id="navrow2" class="tabs2">
  38. <ul class="tablist">
  39. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  40. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  41. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  42. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  43. </ul>
  44. </div>
  45. </div><!-- top -->
  46. <div class="header">
  47. <div class="summary">
  48. <a href="#pub-methods">Public Member Functions</a> &#124;
  49. <a href="classSceneObjectSet-members.html">List of all members</a> </div>
  50. <div class="headertitle">
  51. <div class="title">SceneObjectSet Class Reference</div> </div>
  52. </div><!--header-->
  53. <div class="contents">
  54. <p>Inherits <a class="el" href="classSimObject.html">SimObject</a>.</p>
  55. <table class="memberdecls">
  56. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  57. Public Member Functions</h2></td></tr>
  58. <tr class="memitem:a69ce422fdc543526a4353520db467f5c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSceneObjectSet.html#a69ce422fdc543526a4353520db467f5c">add</a> (obj1,...)</td></tr>
  59. <tr class="separator:a69ce422fdc543526a4353520db467f5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  60. <tr class="memitem:a1ae599ad807bf666a5ef8c965fcb79aa"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSceneObjectSet.html#a1ae599ad807bf666a5ef8c965fcb79aa">bringToFront</a> (object)</td></tr>
  61. <tr class="separator:a1ae599ad807bf666a5ef8c965fcb79aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  62. <tr class="memitem:a43220bd75ba264471a869e2000ebdd78"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSceneObjectSet.html#a43220bd75ba264471a869e2000ebdd78">callOnChildren</a> (string method, string args...)</td></tr>
  63. <tr class="separator:a43220bd75ba264471a869e2000ebdd78"><td class="memSeparator" colspan="2">&#160;</td></tr>
  64. <tr class="memitem:ac8bb3912a3ce86b15842e79d0b421204"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSceneObjectSet.html#ac8bb3912a3ce86b15842e79d0b421204">clear</a> ()</td></tr>
  65. <tr class="separator:ac8bb3912a3ce86b15842e79d0b421204"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66. <tr class="memitem:a54ccf7d816af85ee00644518f0e46f2b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSceneObjectSet.html#a54ccf7d816af85ee00644518f0e46f2b">deleteObjects</a> ()</td></tr>
  67. <tr class="separator:a54ccf7d816af85ee00644518f0e46f2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68. <tr class="memitem:a5b02b95caac2a1524340c9a4001abd52"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSceneObjectSet.html#a5b02b95caac2a1524340c9a4001abd52">dumpObjects</a> ()</td></tr>
  69. <tr class="separator:a5b02b95caac2a1524340c9a4001abd52"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70. <tr class="memitem:a6fdfb17d10c9c470e16cdd91861cd6ae"><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="classSceneObjectSet.html#a6fdfb17d10c9c470e16cdd91861cd6ae">findObjectByInternalName</a> (string name, [bool searchChildren])</td></tr>
  71. <tr class="separator:a6fdfb17d10c9c470e16cdd91861cd6ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72. <tr class="memitem: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="classSceneObjectSet.html#aed4711154fb09672f96c96467e1a68ea">getCount</a> ()</td></tr>
  73. <tr class="separator:aed4711154fb09672f96c96467e1a68ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <tr class="memitem:ac3cbfbb897653b7fd450f2532b0b6500"><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="classSceneObjectSet.html#ac3cbfbb897653b7fd450f2532b0b6500">getObject</a> (objIndex)</td></tr>
  75. <tr class="separator:ac3cbfbb897653b7fd450f2532b0b6500"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem: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="classSceneObjectSet.html#a1ae14d8c54362b6352a5887eef6733cc">isMember</a> (object)</td></tr>
  77. <tr class="separator:a1ae14d8c54362b6352a5887eef6733cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:ab635bca66b0f0d23fa6002b75aa0ee7a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSceneObjectSet.html#ab635bca66b0f0d23fa6002b75aa0ee7a">pushToBack</a> (object)</td></tr>
  79. <tr class="separator:ab635bca66b0f0d23fa6002b75aa0ee7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:aaabd113cb3a1b61913229245f16246e9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSceneObjectSet.html#aaabd113cb3a1b61913229245f16246e9">remove</a> (obj1,...)</td></tr>
  81. <tr class="separator:aaabd113cb3a1b61913229245f16246e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:a895cc03d6f060d82263c56b1a3cac8ce"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSceneObjectSet.html#a895cc03d6f060d82263c56b1a3cac8ce">reorderChild</a> (child1, child2)</td></tr>
  83. <tr class="separator:a895cc03d6f060d82263c56b1a3cac8ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <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>
  85. <tr class="memitem:a22437f451ceb1429fa2a3be23d523954 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a22437f451ceb1429fa2a3be23d523954">clone</a> ([copyDynamicFields=false]?)</td></tr>
  86. <tr class="separator:a22437f451ceb1429fa2a3be23d523954 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a7a4721d0a51e952c211e9b0fea4d8090">delete</a> ()</td></tr>
  88. <tr class="separator:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:a929e1325a515b279faca90a65028782e inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a929e1325a515b279faca90a65028782e">getId</a> ()</td></tr>
  90. <tr class="separator:a929e1325a515b279faca90a65028782e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a4f673cd959711ae09927e7c44dae5fdb">setName</a> (newName)</td></tr>
  92. <tr class="separator:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:a78ee178b6a73658d65ca60da4d1e6683 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a78ee178b6a73658d65ca60da4d1e6683">getName</a> ()</td></tr>
  94. <tr class="separator:a78ee178b6a73658d65ca60da4d1e6683 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:ab8b0f8b874af628d7204d9cc2630ced7 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab8b0f8b874af628d7204d9cc2630ced7">getClassNamespace</a> ()</td></tr>
  96. <tr class="separator:ab8b0f8b874af628d7204d9cc2630ced7 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:a6e266d4432d70cad58461d96e1d2cbdf inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a6e266d4432d70cad58461d96e1d2cbdf">getSuperClassNamespace</a> ()</td></tr>
  98. <tr class="separator:a6e266d4432d70cad58461d96e1d2cbdf inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:a847e859bcc5b58df83fa7f331c167c32 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a847e859bcc5b58df83fa7f331c167c32">setClassNamespace</a> (nameSpace)</td></tr>
  100. <tr class="separator:a847e859bcc5b58df83fa7f331c167c32 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a9cbf471b97387d5bdefb88f92094ad54">setSuperClassNamespace</a> ()</td></tr>
  102. <tr class="separator:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:a8f4e85d0903526235ed2ca86df69cdef inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a8f4e85d0903526235ed2ca86df69cdef">isMethod</a> (string methodName)</td></tr>
  104. <tr class="separator:a8f4e85d0903526235ed2ca86df69cdef inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:abd9730d5538d1713b82fe92bca7b5cba inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#abd9730d5538d1713b82fe92bca7b5cba">call</a> (methodName, [args]*)</td></tr>
  106. <tr class="separator:abd9730d5538d1713b82fe92bca7b5cba inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1810f5aba25efd242c24232c2c2bbd1a">dumpClassHierarchy</a> ()</td></tr>
  108. <tr class="separator:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#accd2600060dbaee3a3b41aed4034c63c">dump</a> ()</td></tr>
  110. <tr class="separator:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:a66ac731a8dc088fe8c8ab17bf7c9eecd inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a66ac731a8dc088fe8c8ab17bf7c9eecd">isMemberOfClass</a> (string classname)</td></tr>
  112. <tr class="separator:a66ac731a8dc088fe8c8ab17bf7c9eecd inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:a3e97a324df2af082cdb089491757ce11 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a3e97a324df2af082cdb089491757ce11">getClassName</a> ()</td></tr>
  114. <tr class="separator:a3e97a324df2af082cdb089491757ce11 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:abc2222a9649b5c033810e753b07f26a3 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#abc2222a9649b5c033810e753b07f26a3">getFieldValue</a> (fieldName)</td></tr>
  116. <tr class="separator:abc2222a9649b5c033810e753b07f26a3 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:a1084f1964e446b3d279943cf6e575069 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1084f1964e446b3d279943cf6e575069">setFieldValue</a> (fieldName, value)</td></tr>
  118. <tr class="separator:a1084f1964e446b3d279943cf6e575069 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:a7543b8dc494ec0d9034cb73ae504f3ca inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a7543b8dc494ec0d9034cb73ae504f3ca">getDynamicFieldCount</a> ()</td></tr>
  120. <tr class="separator:a7543b8dc494ec0d9034cb73ae504f3ca inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:a0e143217119b68d557d17ac2f13b173e inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0e143217119b68d557d17ac2f13b173e">getDynamicField</a> (index)</td></tr>
  122. <tr class="separator:a0e143217119b68d557d17ac2f13b173e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:af2e74f6b683da8d2085f0991dab7948b inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#af2e74f6b683da8d2085f0991dab7948b">getFieldCount</a> ()</td></tr>
  124. <tr class="separator:af2e74f6b683da8d2085f0991dab7948b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:ac636f89189406eef1b401292459b1a3b inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ac636f89189406eef1b401292459b1a3b">getField</a> (int index)</td></tr>
  126. <tr class="separator:ac636f89189406eef1b401292459b1a3b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa8f68d1e6d8c6601c39b3f676f0e9c70">setProgenitorFile</a> (file)</td></tr>
  128. <tr class="separator:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:a88c8d99755a07ac4648360dd40ff67a5 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a88c8d99755a07ac4648360dd40ff67a5">getProgenitorFile</a> ()</td></tr>
  130. <tr class="separator:a88c8d99755a07ac4648360dd40ff67a5 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:a367706e675179342e6153c45f1ba06ae inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a367706e675179342e6153c45f1ba06ae">getType</a> ()</td></tr>
  132. <tr class="separator:a367706e675179342e6153c45f1ba06ae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:a0570b7f6eb94a0ed941fd75f6f01555b inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0570b7f6eb94a0ed941fd75f6f01555b">getFieldType</a> (fieldName)</td></tr>
  134. <tr class="separator:a0570b7f6eb94a0ed941fd75f6f01555b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a5aaca360a719feabae0e4e57b921deae">setInternalName</a> (string InternalName)</td></tr>
  136. <tr class="separator:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:af9f341b474a28f4bcf79bc02439b7c18 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#af9f341b474a28f4bcf79bc02439b7c18">getInternalName</a> ()</td></tr>
  138. <tr class="separator:af9f341b474a28f4bcf79bc02439b7c18 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:a986f1b4a76969bac5dfd50b22af8dec6 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a986f1b4a76969bac5dfd50b22af8dec6">isChildOfGroup</a> (groupID)</td></tr>
  140. <tr class="separator:a986f1b4a76969bac5dfd50b22af8dec6 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:ae329d6593bb3f9b8046e7cae693ccc09 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ae329d6593bb3f9b8046e7cae693ccc09">getGroup</a> ()</td></tr>
  142. <tr class="separator:ae329d6593bb3f9b8046e7cae693ccc09 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:a39653bc04e82875f2dc8d6dea25acdaa inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a39653bc04e82875f2dc8d6dea25acdaa">startTimer</a> (callbackFunction, float timePeriod, [repeat]?)</td></tr>
  144. <tr class="separator:a39653bc04e82875f2dc8d6dea25acdaa inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <tr class="memitem:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa6f6bfef028c7b053444cbd48567d286">stopTimer</a> ()</td></tr>
  146. <tr class="separator:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:a5807c03d2b725a54732d09b53d5da631 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a5807c03d2b725a54732d09b53d5da631">isTimerActive</a> ()</td></tr>
  148. <tr class="separator:a5807c03d2b725a54732d09b53d5da631 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:ab5179f3203c92793cb8f4e6066b55e39 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab5179f3203c92793cb8f4e6066b55e39">schedule</a> (time, command, [arg]*)</td></tr>
  150. <tr class="separator:ab5179f3203c92793cb8f4e6066b55e39 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <tr class="memitem:ab6e816c3694e8b6119bf9ac3f5556f32 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab6e816c3694e8b6119bf9ac3f5556f32">save</a> (<a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>, [selectedOnly]?)</td></tr>
  152. <tr class="separator:ab6e816c3694e8b6119bf9ac3f5556f32 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. <tr class="memitem:a216228c27df224ac5e8d3590494bfb3f inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a216228c27df224ac5e8d3590494bfb3f">addFieldFilter</a> (fieldName)</td></tr>
  154. <tr class="separator:a216228c27df224ac5e8d3590494bfb3f inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:ad517bd83c1c853985ab07cd22775c43d inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ad517bd83c1c853985ab07cd22775c43d">removeFieldFilter</a> (fieldName)</td></tr>
  156. <tr class="separator:ad517bd83c1c853985ab07cd22775c43d inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. </table>
  158. <h2 class="groupheader">Member Function Documentation</h2>
  159. <a class="anchor" id="a69ce422fdc543526a4353520db467f5c"></a>
  160. <div class="memitem">
  161. <div class="memproto">
  162. <table class="memname">
  163. <tr>
  164. <td class="memname">void add </td>
  165. <td>(</td>
  166. <td class="paramtype">obj1&#160;</td>
  167. <td class="paramname">, </td>
  168. </tr>
  169. <tr>
  170. <td class="paramkey"></td>
  171. <td></td>
  172. <td class="paramtype">&#160;</td>
  173. <td class="paramname"><em>...</em>&#160;</td>
  174. </tr>
  175. <tr>
  176. <td></td>
  177. <td>)</td>
  178. <td></td><td></td>
  179. </tr>
  180. </table>
  181. </div><div class="memdoc">
  182. <p>Adds given list of objects to the <a class="el" href="classSceneObjectSet.html">SceneObjectSet</a>. </p><dl class="params"><dt>Parameters</dt><dd>
  183. <table class="params">
  184. <tr><td class="paramname">obj_i</td><td>(i is unilimited) Variable list of objects to add </td></tr>
  185. </table>
  186. </dd>
  187. </dl>
  188. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  189. </div>
  190. </div>
  191. <a class="anchor" id="a1ae599ad807bf666a5ef8c965fcb79aa"></a>
  192. <div class="memitem">
  193. <div class="memproto">
  194. <table class="memname">
  195. <tr>
  196. <td class="memname">void bringToFront </td>
  197. <td>(</td>
  198. <td class="paramtype">object&#160;</td>
  199. <td class="paramname"></td><td>)</td>
  200. <td></td>
  201. </tr>
  202. </table>
  203. </div><div class="memdoc">
  204. <p>Brings object to front of set. </p><dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  205. </div>
  206. </div>
  207. <a class="anchor" id="a43220bd75ba264471a869e2000ebdd78"></a>
  208. <div class="memitem">
  209. <div class="memproto">
  210. <table class="memname">
  211. <tr>
  212. <td class="memname">void callOnChildren </td>
  213. <td>(</td>
  214. <td class="paramtype">string&#160;</td>
  215. <td class="paramname"><em>method</em>, </td>
  216. </tr>
  217. <tr>
  218. <td class="paramkey"></td>
  219. <td></td>
  220. <td class="paramtype">string&#160;</td>
  221. <td class="paramname"><em>args...</em>&#160;</td>
  222. </tr>
  223. <tr>
  224. <td></td>
  225. <td>)</td>
  226. <td></td><td></td>
  227. </tr>
  228. </table>
  229. </div><div class="memdoc">
  230. <p>Call a method on all objects contained in the set. </p><dl class="params"><dt>Parameters</dt><dd>
  231. <table class="params">
  232. <tr><td class="paramname">method</td><td>The name of the method to call. </td></tr>
  233. <tr><td class="paramname">args</td><td>The arguments to the method. </td></tr>
  234. </table>
  235. </dd>
  236. </dl>
  237. <dl class="section note"><dt>Note</dt><dd>This method recurses into all SimSets that are children to the set. </dd></dl>
  238. <dl class="section see"><dt>See also</dt><dd>callOnChildrenNoRecurse </dd></dl>
  239. </div>
  240. </div>
  241. <a class="anchor" id="ac8bb3912a3ce86b15842e79d0b421204"></a>
  242. <div class="memitem">
  243. <div class="memproto">
  244. <table class="memname">
  245. <tr>
  246. <td class="memname">void clear </td>
  247. <td>(</td>
  248. <td class="paramname"></td><td>)</td>
  249. <td></td>
  250. </tr>
  251. </table>
  252. </div><div class="memdoc">
  253. <p>Clears the <a class="el" href="classSceneObjectSet.html">SceneObjectSet</a> </p><dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  254. </div>
  255. </div>
  256. <a class="anchor" id="a54ccf7d816af85ee00644518f0e46f2b"></a>
  257. <div class="memitem">
  258. <div class="memproto">
  259. <table class="memname">
  260. <tr>
  261. <td class="memname">void deleteObjects </td>
  262. <td>(</td>
  263. <td class="paramname"></td><td>)</td>
  264. <td></td>
  265. </tr>
  266. </table>
  267. </div><div class="memdoc">
  268. <p>Deletes all the objects in the <a class="el" href="classSceneObjectSet.html">SceneObjectSet</a>. </p><dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  269. </div>
  270. </div>
  271. <a class="anchor" id="a5b02b95caac2a1524340c9a4001abd52"></a>
  272. <div class="memitem">
  273. <div class="memproto">
  274. <table class="memname">
  275. <tr>
  276. <td class="memname">void dumpObjects </td>
  277. <td>(</td>
  278. <td class="paramname"></td><td>)</td>
  279. <td></td>
  280. </tr>
  281. </table>
  282. </div><div class="memdoc">
  283. <p>Dumps the object data within the set </p><dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  284. </div>
  285. </div>
  286. <a class="anchor" id="a6fdfb17d10c9c470e16cdd91861cd6ae"></a>
  287. <div class="memitem">
  288. <div class="memproto">
  289. <table class="memname">
  290. <tr>
  291. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> findObjectByInternalName </td>
  292. <td>(</td>
  293. <td class="paramtype">string&#160;</td>
  294. <td class="paramname"><em>name</em></td><td>)</td>
  295. <td></td>
  296. </tr>
  297. </table>
  298. </div><div class="memdoc">
  299. <p>Returns the object with given internal name </p><dl class="params"><dt>Parameters</dt><dd>
  300. <table class="params">
  301. <tr><td class="paramname">name</td><td>The internal name of the object you wish to find </td></tr>
  302. <tr><td class="paramname">searchChildren</td><td>Set this true if you wish to search all children as well. </td></tr>
  303. </table>
  304. </dd>
  305. </dl>
  306. <dl class="section return"><dt>Returns</dt><dd>Returns the ID of the object. </dd></dl>
  307. </div>
  308. </div>
  309. <a class="anchor" id="aed4711154fb09672f96c96467e1a68ea"></a>
  310. <div class="memitem">
  311. <div class="memproto">
  312. <table class="memname">
  313. <tr>
  314. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getCount </td>
  315. <td>(</td>
  316. <td class="paramname"></td><td>)</td>
  317. <td></td>
  318. </tr>
  319. </table>
  320. </div><div class="memdoc">
  321. <dl class="section return"><dt>Returns</dt><dd>Returns the number of objects in the <a class="el" href="classSceneObjectSet.html">SceneObjectSet</a> </dd></dl>
  322. </div>
  323. </div>
  324. <a class="anchor" id="ac3cbfbb897653b7fd450f2532b0b6500"></a>
  325. <div class="memitem">
  326. <div class="memproto">
  327. <table class="memname">
  328. <tr>
  329. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getObject </td>
  330. <td>(</td>
  331. <td class="paramtype">objIndex&#160;</td>
  332. <td class="paramname"></td><td>)</td>
  333. <td></td>
  334. </tr>
  335. </table>
  336. </div><div class="memdoc">
  337. <dl class="section return"><dt>Returns</dt><dd>Returns the ID of the desired object or -1 on failure </dd></dl>
  338. </div>
  339. </div>
  340. <a class="anchor" id="a1ae14d8c54362b6352a5887eef6733cc"></a>
  341. <div class="memitem">
  342. <div class="memproto">
  343. <table class="memname">
  344. <tr>
  345. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> isMember </td>
  346. <td>(</td>
  347. <td class="paramtype">object&#160;</td>
  348. <td class="paramname"></td><td>)</td>
  349. <td></td>
  350. </tr>
  351. </table>
  352. </div><div class="memdoc">
  353. <dl class="section return"><dt>Returns</dt><dd>Returns true if specified object is a member of the set, and false otherwise </dd></dl>
  354. </div>
  355. </div>
  356. <a class="anchor" id="ab635bca66b0f0d23fa6002b75aa0ee7a"></a>
  357. <div class="memitem">
  358. <div class="memproto">
  359. <table class="memname">
  360. <tr>
  361. <td class="memname">void pushToBack </td>
  362. <td>(</td>
  363. <td class="paramtype">object&#160;</td>
  364. <td class="paramname"></td><td>)</td>
  365. <td></td>
  366. </tr>
  367. </table>
  368. </div><div class="memdoc">
  369. <p>Sends item to back of set. </p><dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  370. </div>
  371. </div>
  372. <a class="anchor" id="aaabd113cb3a1b61913229245f16246e9"></a>
  373. <div class="memitem">
  374. <div class="memproto">
  375. <table class="memname">
  376. <tr>
  377. <td class="memname">void remove </td>
  378. <td>(</td>
  379. <td class="paramtype">obj1&#160;</td>
  380. <td class="paramname">, </td>
  381. </tr>
  382. <tr>
  383. <td class="paramkey"></td>
  384. <td></td>
  385. <td class="paramtype">&#160;</td>
  386. <td class="paramname"><em>...</em>&#160;</td>
  387. </tr>
  388. <tr>
  389. <td></td>
  390. <td>)</td>
  391. <td></td><td></td>
  392. </tr>
  393. </table>
  394. </div><div class="memdoc">
  395. <p>Removes given listy of objects from the <a class="el" href="classSceneObjectSet.html">SceneObjectSet</a>. </p><dl class="params"><dt>Parameters</dt><dd>
  396. <table class="params">
  397. <tr><td class="paramname">obj_i</td><td>(i is unilimited) Variable list of objects to remove </td></tr>
  398. </table>
  399. </dd>
  400. </dl>
  401. <dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>
  402. </div>
  403. </div>
  404. <a class="anchor" id="a895cc03d6f060d82263c56b1a3cac8ce"></a>
  405. <div class="memitem">
  406. <div class="memproto">
  407. <table class="memname">
  408. <tr>
  409. <td class="memname">void reorderChild </td>
  410. <td>(</td>
  411. <td class="paramtype">child1&#160;</td>
  412. <td class="paramname">, </td>
  413. </tr>
  414. <tr>
  415. <td class="paramkey"></td>
  416. <td></td>
  417. <td class="paramtype">child2&#160;</td>
  418. <td class="paramname">&#160;</td>
  419. </tr>
  420. <tr>
  421. <td></td>
  422. <td>)</td>
  423. <td></td><td></td>
  424. </tr>
  425. </table>
  426. </div><div class="memdoc">
  427. <p>Uses <a class="el" href="classSceneObjectSet.html">SceneObjectSet</a> reorder to push child 1 before child 2 - both must already be child controls of this control </p><dl class="params"><dt>Parameters</dt><dd>
  428. <table class="params">
  429. <tr><td class="paramname">child1</td><td>The child you wish to set first </td></tr>
  430. <tr><td class="paramname">child2</td><td>The child you wish to set after child1 </td></tr>
  431. </table>
  432. </dd>
  433. </dl>
  434. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  435. </div>
  436. </div>
  437. </div><!-- contents -->
  438. <!-- start footer part -->
  439. <hr class="footer"/><address class="footer"><small>
  440. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  441. <img class="footer" src="doxygen.png" alt="doxygen"/>
  442. </a> 1.8.10
  443. </small></address>
  444. </body>
  445. </html>