TorqueEngine
/
Torque2D
mirror of https://github.com/TorqueGameEngines/Torque2D.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>TorqueScript Reference: SimSet Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">TorqueScript Reference
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',false,false,'search.php','Search');
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classSimSet-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">SimSet Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;simSet_ScriptBinding.h&gt;</code></p>

<p>Inherits <a class="el" href="classSimObject.html">SimObject</a>.</p>

<p>Inherited by <a class="el" href="classModuleDefinition.html">ModuleDefinition</a>, and <a class="el" href="classNameTags.html">NameTags</a>.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:adb7cacf4f029844f98ffb48d22076468"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#adb7cacf4f029844f98ffb48d22076468">add</a> (obj1, [obj2] *)</td></tr>
<tr class="separator:adb7cacf4f029844f98ffb48d22076468"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ae599ad807bf666a5ef8c965fcb79aa"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#a1ae599ad807bf666a5ef8c965fcb79aa">bringToFront</a> (object)</td></tr>
<tr class="separator:a1ae599ad807bf666a5ef8c965fcb79aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a165f19c3669e970a1c9eecb73da8a5f2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#a165f19c3669e970a1c9eecb73da8a5f2">callOnChildren</a> (string method, [string args] *)</td></tr>
<tr class="separator:a165f19c3669e970a1c9eecb73da8a5f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac8bb3912a3ce86b15842e79d0b421204"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#ac8bb3912a3ce86b15842e79d0b421204">clear</a> ()</td></tr>
<tr class="separator:ac8bb3912a3ce86b15842e79d0b421204"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a54ccf7d816af85ee00644518f0e46f2b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#a54ccf7d816af85ee00644518f0e46f2b">deleteObjects</a> ()</td></tr>
<tr class="separator:a54ccf7d816af85ee00644518f0e46f2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem: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>
<tr class="separator:a45d8af40c4ba1501cfd99ce5536554cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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="classSimSet.html#aed4711154fb09672f96c96467e1a68ea">getCount</a> ()</td></tr>
<tr class="separator:aed4711154fb09672f96c96467e1a68ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem: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>
<tr class="separator:a0b9cbe280c7d43c4934f0feb20cd85e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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="classSimSet.html#a1ae14d8c54362b6352a5887eef6733cc">isMember</a> (object)</td></tr>
<tr class="separator:a1ae14d8c54362b6352a5887eef6733cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2cecf1a379201b595200c33d479fae80"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#a2cecf1a379201b595200c33d479fae80">listObjects</a> ()</td></tr>
<tr class="separator:a2cecf1a379201b595200c33d479fae80"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab635bca66b0f0d23fa6002b75aa0ee7a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#ab635bca66b0f0d23fa6002b75aa0ee7a">pushToBack</a> (object)</td></tr>
<tr class="separator:ab635bca66b0f0d23fa6002b75aa0ee7a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed4ef988fffc9cead280f9b803064e70"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#aed4ef988fffc9cead280f9b803064e70">remove</a> (obj1, [obj2] *)</td></tr>
<tr class="separator:aed4ef988fffc9cead280f9b803064e70"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a71a7c72cb3cc593d9a30c78fa546eb03"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimSet.html#a71a7c72cb3cc593d9a30c78fa546eb03">removeIfMember</a> (obj1, [obj2] *)</td></tr>
<tr class="separator:a71a7c72cb3cc593d9a30c78fa546eb03"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a02cee80758a77628082655b2ec259133"><td class="memItemLeft" align="right" valign="top">void&#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>
<tr class="separator:a02cee80758a77628082655b2ec259133"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="memitem:a2375929bea4901d98ae352231b0721ad 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#a2375929bea4901d98ae352231b0721ad">assignFieldsFrom</a> (<a class="el" href="classSimObject.html">SimObject</a>)</td></tr>
<tr class="separator:a2375929bea4901d98ae352231b0721ad inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a22437f451ceb1429fa2a3be23d523954 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a929e1325a515b279faca90a65028782e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a78ee178b6a73658d65ca60da4d1e6683 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:ab8b0f8b874af628d7204d9cc2630ced7 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a6e266d4432d70cad58461d96e1d2cbdf inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a847e859bcc5b58df83fa7f331c167c32 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a8f4e85d0903526235ed2ca86df69cdef inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ce8801999cf2228ddde6d58ca3773d5 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#a9ce8801999cf2228ddde6d58ca3773d5">call</a> (methodName, [args] *)</td></tr>
<tr class="separator:a9ce8801999cf2228ddde6d58ca3773d5 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a66ac731a8dc088fe8c8ab17bf7c9eecd inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a3e97a324df2af082cdb089491757ce11 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:abc2222a9649b5c033810e753b07f26a3 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a1084f1964e446b3d279943cf6e575069 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab4e32fb984d9ce6584b0fa57c8772d3e 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#ab4e32fb984d9ce6584b0fa57c8772d3e">setEditFieldValue</a> (fieldName, value)</td></tr>
<tr class="separator:ab4e32fb984d9ce6584b0fa57c8772d3e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a7543b8dc494ec0d9034cb73ae504f3ca inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a0e143217119b68d557d17ac2f13b173e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:af2e74f6b683da8d2085f0991dab7948b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:ac636f89189406eef1b401292459b1a3b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a88c8d99755a07ac4648360dd40ff67a5 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a367706e675179342e6153c45f1ba06ae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a0570b7f6eb94a0ed941fd75f6f01555b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:af9f341b474a28f4bcf79bc02439b7c18 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a986f1b4a76969bac5dfd50b22af8dec6 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:ae329d6593bb3f9b8046e7cae693ccc09 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a39653bc04e82875f2dc8d6dea25acdaa inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a5807c03d2b725a54732d09b53d5da631 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a16d537cd7a1c438045bb756fe1e22d2d 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#a16d537cd7a1c438045bb756fe1e22d2d">schedule</a> (time, command, [arg] *)</td></tr>
<tr class="separator:a16d537cd7a1c438045bb756fe1e22d2d inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9f05bc4a94b98e2e3347fe34aeefe7c4 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#a9f05bc4a94b98e2e3347fe34aeefe7c4">startListening</a> (<a class="el" href="classSimObject.html">SimObject</a>)</td></tr>
<tr class="separator:a9f05bc4a94b98e2e3347fe34aeefe7c4 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f7f0520846a222310415ad7a8f8a4bf 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#a3f7f0520846a222310415ad7a8f8a4bf">stopListening</a> (<a class="el" href="classSimObject.html">SimObject</a>)</td></tr>
<tr class="separator:a3f7f0520846a222310415ad7a8f8a4bf inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afa6eac5990b02024e77e3815161159df 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#afa6eac5990b02024e77e3815161159df">addListener</a> (<a class="el" href="classSimObject.html">SimObject</a>)</td></tr>
<tr class="separator:afa6eac5990b02024e77e3815161159df inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07dd4cf0d113ff4a8943b900bda68a1c 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#a07dd4cf0d113ff4a8943b900bda68a1c">removeListener</a> (<a class="el" href="classSimObject.html">SimObject</a>)</td></tr>
<tr class="separator:a07dd4cf0d113ff4a8943b900bda68a1c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a87be48ec4599c3d02a118cee89e47f55 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#a87be48ec4599c3d02a118cee89e47f55">removeAllListeners</a> ()</td></tr>
<tr class="separator:a87be48ec4599c3d02a118cee89e47f55 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1dcaa2910d6405134c74a71745d29154 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#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>
<tr class="separator:a1dcaa2910d6405134c74a71745d29154 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:ab6e816c3694e8b6119bf9ac3f5556f32 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:a216228c27df224ac5e8d3590494bfb3f inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="separator:ad517bd83c1c853985ab07cd22775c43d inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >A container for a sequence of unique SimObjects.</p>
<dl class="section user"><dt>Overview</dt><dd></dd></dl>
<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>
<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>
<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>
<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>
<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>
<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>
<dl class="section user"><dt>Examples</dt><dd></dd></dl>
<p>Creating and Adding**</p>
<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>
<div class="fragment"><div class="line"><span class="keyword">new</span> <a class="code hl_class" href="classSimSet.html">SimSet</a>(Fruit);</div>
<div class="line"><a class="code hl_function" href="group__ConsoleOutput.html#gadc918a80dc292eeae84dcca04998faba">echo</a>(Fruit.getCount());</div>
<div class="line">&gt; 0</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Apple, Pear, etc will be SimObjects</span></div>
<div class="line"><span class="keyword">new</span> <a class="code hl_class" href="classSimObject.html">SimObject</a>(Apple);</div>
<div class="line"><span class="keyword">new</span> <a class="code hl_class" href="classSimObject.html">SimObject</a>(Pear);</div>
<div class="line"><span class="keyword">new</span> <a class="code hl_class" href="classSimObject.html">SimObject</a>(Orange);</div>
<div class="line"><span class="keyword">new</span> <a class="code hl_class" href="classSimObject.html">SimObject</a>(Fig);</div>
<div class="line"><span class="keyword">new</span> <a class="code hl_class" href="classSimObject.html">SimObject</a>(Persimmon);</div>
<div class="line"> </div>
<div class="line"><span class="comment">// add our fruit to the SimSet named Fruit</span></div>
<div class="line">Fruit.add(Apple);</div>
<div class="line">Fruit.add(Pear);</div>
<div class="line">Fruit.add(Orange);</div>
<div class="line">Fruit.add(Fig);</div>
<div class="line">Fruit.add(Persimmon);</div>
<div class="line"><a class="code hl_function" href="group__ConsoleOutput.html#gadc918a80dc292eeae84dcca04998faba">echo</a>(Fruit.getCount());</div>
<div class="line">&gt; 5</div>
<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>
<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>
<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>
</div><!-- fragment --><p >Uniqueness**</p>
<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>
<div class="fragment"><div class="line"><span class="comment">// Apple is already added.</span></div>
<div class="line">Fruit.add(Apple);</div>
<div class="line"><a class="code hl_function" href="group__ConsoleOutput.html#gadc918a80dc292eeae84dcca04998faba">echo</a>(Fruit.getCount());</div>
<div class="line">&gt; 5</div>
</div><!-- fragment --><p >Re-ordering**</p>
<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>
<div class="fragment"><div class="line"><a class="code hl_function" href="group__ConsoleOutput.html#gadc918a80dc292eeae84dcca04998faba">echo</a>(Fruit.getObject(0).getName());</div>
<div class="line">&gt; Apple</div>
<div class="line"> </div>
<div class="line">Fruit.bringToFront(Persimmon);</div>
<div class="line"><a class="code hl_function" href="group__ConsoleOutput.html#gadc918a80dc292eeae84dcca04998faba">echo</a>(Fruit.getObject(0).getName());</div>
<div class="line">&gt; Persimmon</div>
</div><!-- fragment --><p >Now we move a different member to the back.</p>
<div class="fragment"><div class="line">Fruit.pushToBack(Apple);</div>
<div class="line"><a class="code hl_function" href="group__ConsoleOutput.html#gadc918a80dc292eeae84dcca04998faba">echo</a>(Fruit.getObject(4).getName());</div>
<div class="line">&gt; Apple</div>
</div><!-- fragment --><p >Finally, we move the Fig member to precede Pear. Note that all of the other members retain their relative order.</p>
<div class="fragment"><div class="line">Fruit.listObjects();</div>
<div class="line">&gt; 2887,<span class="stringliteral">&quot;Persimmon&quot;</span>: <a class="code hl_class" href="classSimObject.html">SimObject</a> </div>
<div class="line">&gt; 2884,<span class="stringliteral">&quot;Pear&quot;</span>: <a class="code hl_class" href="classSimObject.html">SimObject</a> </div>
<div class="line">&gt; 2885,<span class="stringliteral">&quot;Orange&quot;</span>: <a class="code hl_class" href="classSimObject.html">SimObject</a> </div>
<div class="line">&gt; 2886,<span class="stringliteral">&quot;Fig&quot;</span>: <a class="code hl_class" href="classSimObject.html">SimObject</a> </div>
<div class="line">&gt; 2883,<span class="stringliteral">&quot;Apple&quot;</span>: <a class="code hl_class" href="classSimObject.html">SimObject</a> </div>
<div class="line"> </div>
<div class="line">Fruit.reorderChild(Fig, Pear);</div>
<div class="line">Fruit.listObjects();</div>
<div class="line">&gt; 2887,<span class="stringliteral">&quot;Persimmon&quot;</span>: <a class="code hl_class" href="classSimObject.html">SimObject</a> </div>
<div class="line">&gt; 2886,<span class="stringliteral">&quot;Fig&quot;</span>: <a class="code hl_class" href="classSimObject.html">SimObject</a> </div>
<div class="line">&gt; 2885,<span class="stringliteral">&quot;Orange&quot;</span>: <a class="code hl_class" href="classSimObject.html">SimObject</a> </div>
<div class="line">&gt; 2884,<span class="stringliteral">&quot;Pear&quot;</span>: <a class="code hl_class" href="classSimObject.html">SimObject</a> </div>
<div class="line">&gt; 2883,<span class="stringliteral">&quot;Apple&quot;</span>: <a class="code hl_class" href="classSimObject.html">SimObject</a> </div>
</div><!-- fragment --><p >Removing**</p>
<div class="fragment"><div class="line"><a class="code hl_function" href="group__ConsoleOutput.html#gadc918a80dc292eeae84dcca04998faba">echo</a>(Fruit.isMember(Apple));</div>
<div class="line">&gt; 1</div>
<div class="line"> </div>
<div class="line">Fruit.remove(Apple);</div>
<div class="line"><a class="code hl_function" href="group__ConsoleOutput.html#gadc918a80dc292eeae84dcca04998faba">echo</a>(Fruit.isMember(Apple));</div>
<div class="line">&gt; 0</div>
<div class="line"> </div>
<div class="line"><span class="comment">// Apple was not deleted</span></div>
<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>
<div class="line">&gt; 1</div>
<div class="line"> </div>
<div class="line">Fruit.clear();</div>
<div class="line"><a class="code hl_function" href="group__ConsoleOutput.html#gadc918a80dc292eeae84dcca04998faba">echo</a>(Fruit.getCount());</div>
<div class="line">&gt; 0</div>
<div class="line"> </div>
<div class="line"><span class="comment">// The fruit SimObjects are not deleted by clear() either.  For example...</span></div>
<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>
<div class="line">&gt; 1</div>
<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>
</div><!-- fragment --><dl class="section user"><dt>caveat</dt><dd></dd></dl>
<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>
<div class="fragment"><div class="line"><span class="comment">// DO NOT DO THIS!   this may lead to tears!</span></div>
<div class="line"><span class="keywordflow">for</span> (%i = 0; %i &lt; %mySet.getCount(); %i++)</div>
<div class="line">{</div>
<div class="line">    %<span class="keywordtype">object</span> = %mySet.getObject(%i);</div>
<div class="line">    %<span class="keywordtype">object</span>.delete();</div>
<div class="line">}</div>
</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>
<div class="fragment"><div class="line"><span class="comment">// fixed it</span></div>
<div class="line"><span class="keywordflow">while</span> (%mySet.getCount() &gt; 0)</div>
<div class="line">{</div>
<div class="line">    %<span class="keywordtype">object</span> = %mySet.getObject(0);</div>
<div class="line">    %<span class="keywordtype">object</span>.delete();</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><span class="comment">// or this will work too.  see why?</span></div>
<div class="line"><span class="keywordflow">for</span> (%i = %mySet.getCount() - 1; %i &gt;= 0; %i--)</div>
<div class="line">{</div>
<div class="line">    %<span class="keywordtype">object</span> = %mySet.getObject(%i);</div>
<div class="line">    %<span class="keywordtype">object</span>.delete();</div>
<div class="line">}</div>
</div><!-- fragment --> </div><h2 class="groupheader">Member Function Documentation</h2>
<a id="adb7cacf4f029844f98ffb48d22076468" name="adb7cacf4f029844f98ffb48d22076468"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adb7cacf4f029844f98ffb48d22076468">&#9670;&nbsp;</a></span>add()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void add </td>
          <td>(</td>
          <td class="paramtype">obj1&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">[obj2] *&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<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>
  <table class="params">
    <tr><td class="paramname">obj_1..obj_n</td><td>list of SimObjects to add </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>

</div>
</div>
<a id="a1ae599ad807bf666a5ef8c965fcb79aa" name="a1ae599ad807bf666a5ef8c965fcb79aa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1ae599ad807bf666a5ef8c965fcb79aa">&#9670;&nbsp;</a></span>bringToFront()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void bringToFront </td>
          <td>(</td>
          <td class="paramtype">object&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<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>

</div>
</div>
<a id="a165f19c3669e970a1c9eecb73da8a5f2" name="a165f19c3669e970a1c9eecb73da8a5f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a165f19c3669e970a1c9eecb73da8a5f2">&#9670;&nbsp;</a></span>callOnChildren()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void callOnChildren </td>
          <td>(</td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"><em>method</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">[string args] *&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p >Call a method on all objects contained in the set. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">method</td><td>The name of the method to call. </td></tr>
    <tr><td class="paramname">args</td><td>The arguments to the method. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This method recurses into all SimSets that are children to the set. </dd></dl>
<dl class="section see"><dt>See also</dt><dd>callOnChildrenNoRecurse" ) </dd></dl>

</div>
</div>
<a id="ac8bb3912a3ce86b15842e79d0b421204" name="ac8bb3912a3ce86b15842e79d0b421204"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac8bb3912a3ce86b15842e79d0b421204">&#9670;&nbsp;</a></span>clear()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void clear </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<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>

</div>
</div>
<a id="a54ccf7d816af85ee00644518f0e46f2b" name="a54ccf7d816af85ee00644518f0e46f2b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a54ccf7d816af85ee00644518f0e46f2b">&#9670;&nbsp;</a></span>deleteObjects()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void deleteObjects </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<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>

</div>
</div>
<a id="a45d8af40c4ba1501cfd99ce5536554cc" name="a45d8af40c4ba1501cfd99ce5536554cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a45d8af40c4ba1501cfd99ce5536554cc">&#9670;&nbsp;</a></span>findObjectByInternalName()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> findObjectByInternalName </td>
          <td>(</td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"><em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">[bool searchChildren] ?&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p >Returns the object with given internal name </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>The internal name of the object you wish to find </td></tr>
    <tr><td class="paramname">searchChildren</td><td>Set this true if you wish to search all children as well. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the ID of the object. </dd></dl>

</div>
</div>
<a id="aed4711154fb09672f96c96467e1a68ea" name="aed4711154fb09672f96c96467e1a68ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed4711154fb09672f96c96467e1a68ea">&#9670;&nbsp;</a></span>getCount()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getCount </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<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>

</div>
</div>
<a id="a0b9cbe280c7d43c4934f0feb20cd85e8" name="a0b9cbe280c7d43c4934f0feb20cd85e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0b9cbe280c7d43c4934f0feb20cd85e8">&#9670;&nbsp;</a></span>getObject()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getObject </td>
          <td>(</td>
          <td class="paramtype">index&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<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>
  <table class="params">
    <tr><td class="paramname">index</td><td>into this ordered collection (zero-based). </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the ID of the desired object or -1 on failure </dd></dl>

</div>
</div>
<a id="a1ae14d8c54362b6352a5887eef6733cc" name="a1ae14d8c54362b6352a5887eef6733cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1ae14d8c54362b6352a5887eef6733cc">&#9670;&nbsp;</a></span>isMember()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> isMember </td>
          <td>(</td>
          <td class="paramtype">object&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>Returns true if specified object is a member of the set, and false otherwise </dd></dl>

</div>
</div>
<a id="a2cecf1a379201b595200c33d479fae80" name="a2cecf1a379201b595200c33d479fae80"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2cecf1a379201b595200c33d479fae80">&#9670;&nbsp;</a></span>listObjects()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void listObjects </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p >Prints the object data within the set </p><dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>

</div>
</div>
<a id="ab635bca66b0f0d23fa6002b75aa0ee7a" name="ab635bca66b0f0d23fa6002b75aa0ee7a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab635bca66b0f0d23fa6002b75aa0ee7a">&#9670;&nbsp;</a></span>pushToBack()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void pushToBack </td>
          <td>(</td>
          <td class="paramtype">object&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<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>

</div>
</div>
<a id="aed4ef988fffc9cead280f9b803064e70" name="aed4ef988fffc9cead280f9b803064e70"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed4ef988fffc9cead280f9b803064e70">&#9670;&nbsp;</a></span>remove()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void remove </td>
          <td>(</td>
          <td class="paramtype">obj1&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">[obj2] *&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<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>
  <table class="params">
    <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>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>

</div>
</div>
<a id="a71a7c72cb3cc593d9a30c78fa546eb03" name="a71a7c72cb3cc593d9a30c78fa546eb03"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a71a7c72cb3cc593d9a30c78fa546eb03">&#9670;&nbsp;</a></span>removeIfMember()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void removeIfMember </td>
          <td>(</td>
          <td class="paramtype">obj1&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">[obj2] *&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<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>
  <table class="params">
    <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>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>

</div>
</div>
<a id="a02cee80758a77628082655b2ec259133" name="a02cee80758a77628082655b2ec259133"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a02cee80758a77628082655b2ec259133">&#9670;&nbsp;</a></span>reorderChild()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void reorderChild </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classSimObject.html">SimObject</a>&#160;</td>
          <td class="paramname"><em>child1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classSimObject.html">SimObject</a>&#160;</td>
          <td class="paramname"><em>child2</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<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>
  <table class="params">
    <tr><td class="paramname">child1</td><td>The child you wish to set first </td></tr>
    <tr><td class="paramname">child2</td><td>The child you wish to set after child1 </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
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.4
</small></address>
</body>
</html>