classParticleAsset.html 63 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.3.1"/>
  7. <title>TorqueScript Reference: ParticleAsset Class Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  13. </head>
  14. <body>
  15. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  16. <div id="titlearea">
  17. <table cellspacing="0" cellpadding="0">
  18. <tbody>
  19. <tr style="height: 56px;">
  20. <td style="padding-left: 0.5em;">
  21. <div id="projectname">TorqueScript Reference
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.3.1 -->
  30. <div id="navrow1" class="tabs">
  31. <ul class="tablist">
  32. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  34. <li><a href="modules.html"><span>Modules</span></a></li>
  35. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  36. </ul>
  37. </div>
  38. <div id="navrow2" class="tabs2">
  39. <ul class="tablist">
  40. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  41. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  42. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  43. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  44. </ul>
  45. </div>
  46. </div><!-- top -->
  47. <div class="header">
  48. <div class="summary">
  49. <a href="#pub-methods">Public Member Functions</a> &#124;
  50. <a href="classParticleAsset-members.html">List of all members</a> </div>
  51. <div class="headertitle">
  52. <div class="title">ParticleAsset Class Reference</div> </div>
  53. </div><!--header-->
  54. <div class="contents">
  55. <p>Inherits <a class="el" href="classAssetBase.html">AssetBase</a>.</p>
  56. <table class="memberdecls">
  57. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  58. Public Member Functions</h2></td></tr>
  59. <tr class="memitem:a661877efc80bda257929f0c7fcc1db6e"><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="classParticleAsset.html#a661877efc80bda257929f0c7fcc1db6e">addDataKey</a> (time, value)</td></tr>
  60. <tr class="separator:a661877efc80bda257929f0c7fcc1db6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61. <tr class="memitem:a1d1b5e16fc63628c1c611cecaf15b404"><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="classParticleAsset.html#a1d1b5e16fc63628c1c611cecaf15b404">addEmitter</a> (emitterId)</td></tr>
  62. <tr class="separator:a1d1b5e16fc63628c1c611cecaf15b404"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63. <tr class="memitem:a5ea08dae807ec842c6cbe234f3c7b007"><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="classParticleAsset.html#a5ea08dae807ec842c6cbe234f3c7b007">clearDataKeys</a> ()</td></tr>
  64. <tr class="separator:a5ea08dae807ec842c6cbe234f3c7b007"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65. <tr class="memitem:a1ab6f23a794d831d90c80723e6b7989a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a1ab6f23a794d831d90c80723e6b7989a">clearEmitters</a> ()</td></tr>
  66. <tr class="separator:a1ab6f23a794d831d90c80723e6b7989a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67. <tr class="memitem:ae0395abb61c191a0b2e89e8e6c24ee3b"><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="classParticleAsset.html#ae0395abb61c191a0b2e89e8e6c24ee3b">createEmitter</a> ()</td></tr>
  68. <tr class="memdesc:ae0395abb61c191a0b2e89e8e6c24ee3b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Emitter asset methods. <a href="#ae0395abb61c191a0b2e89e8e6c24ee3b">More...</a><br/></td></tr>
  69. <tr class="separator:ae0395abb61c191a0b2e89e8e6c24ee3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70. <tr class="memitem:a843788246e9ab1fc7433e8a44e1d1192"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a843788246e9ab1fc7433e8a44e1d1192">deselectField</a> ()</td></tr>
  71. <tr class="separator:a843788246e9ab1fc7433e8a44e1d1192"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72. <tr class="memitem:a385322400d9d2117450fd74e1eb0098c"><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="classParticleAsset.html#a385322400d9d2117450fd74e1eb0098c">findEmitter</a> (emitterName)</td></tr>
  73. <tr class="separator:a385322400d9d2117450fd74e1eb0098c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <tr class="memitem:ab2acadc7a7a23cab17732311824d2720"><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="classParticleAsset.html#ab2acadc7a7a23cab17732311824d2720">getDataKey</a> (keyIndex)</td></tr>
  75. <tr class="separator:ab2acadc7a7a23cab17732311824d2720"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem:ac426c7befe25b1edfab3b681204e2a64"><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="classParticleAsset.html#ac426c7befe25b1edfab3b681204e2a64">getDataKeyCount</a> ()</td></tr>
  77. <tr class="separator:ac426c7befe25b1edfab3b681204e2a64"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:afa661ee087b2e7625c3676cbed5bab50"><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="classParticleAsset.html#afa661ee087b2e7625c3676cbed5bab50">getEmitter</a> (emitterIndex)</td></tr>
  79. <tr class="separator:afa661ee087b2e7625c3676cbed5bab50"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:ac6bab688c21c2f80dc43acf1405683ff"><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="classParticleAsset.html#ac6bab688c21c2f80dc43acf1405683ff">getEmitterCount</a> ()</td></tr>
  81. <tr class="separator:ac6bab688c21c2f80dc43acf1405683ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:a466b00bf2f5ae8d2c04f5756b9074cca"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a466b00bf2f5ae8d2c04f5756b9074cca">getFieldValue</a> (time)</td></tr>
  83. <tr class="separator:a466b00bf2f5ae8d2c04f5756b9074cca"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:a2bbe9bb6823e05dc4eba062c174e9ab2"><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="classParticleAsset.html#a2bbe9bb6823e05dc4eba062c174e9ab2">getLifeMode</a> ()</td></tr>
  85. <tr class="separator:a2bbe9bb6823e05dc4eba062c174e9ab2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:a2a9c38808ac39f8c7eedde432e8a452d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a2a9c38808ac39f8c7eedde432e8a452d">getLifetime</a> ()</td></tr>
  87. <tr class="separator:a2a9c38808ac39f8c7eedde432e8a452d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:a085c21d4754924f9b2319b0110b78938"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a085c21d4754924f9b2319b0110b78938">getMaxTime</a> ()</td></tr>
  89. <tr class="separator:a085c21d4754924f9b2319b0110b78938"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a5a54f4d46ac4ffb04c059c68cbe5f64b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a5a54f4d46ac4ffb04c059c68cbe5f64b">getMaxValue</a> ()</td></tr>
  91. <tr class="separator:a5a54f4d46ac4ffb04c059c68cbe5f64b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:a32b94c28efd67a5573e4687006ebab28"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a32b94c28efd67a5573e4687006ebab28">getMinTime</a> ()</td></tr>
  93. <tr class="separator:a32b94c28efd67a5573e4687006ebab28"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a9fb1e6a5dab57b6b13f256978ca49cb8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a9fb1e6a5dab57b6b13f256978ca49cb8">getMinValue</a> ()</td></tr>
  95. <tr class="separator:a9fb1e6a5dab57b6b13f256978ca49cb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:ad13e14f410f6f2fdf10e5a588ff04248"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#ad13e14f410f6f2fdf10e5a588ff04248">getRepeatTime</a> ()</td></tr>
  97. <tr class="separator:ad13e14f410f6f2fdf10e5a588ff04248"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:ad4adedf74d82244a76926b5bb1146cc5"><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="classParticleAsset.html#ad4adedf74d82244a76926b5bb1146cc5">getSelectableFieldCount</a> ()</td></tr>
  99. <tr class="memdesc:ad4adedf74d82244a76926b5bb1146cc5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Particle asset fields. <a href="#ad4adedf74d82244a76926b5bb1146cc5">More...</a><br/></td></tr>
  100. <tr class="separator:ad4adedf74d82244a76926b5bb1146cc5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:a656410eca241806469458e50fe0143d9"><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="classParticleAsset.html#a656410eca241806469458e50fe0143d9">getSelectableFieldName</a> (fieldIndex)</td></tr>
  102. <tr class="separator:a656410eca241806469458e50fe0143d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:aff94cac6249b1c587e26cb64c715b0fe"><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="classParticleAsset.html#aff94cac6249b1c587e26cb64c715b0fe">getSelectedField</a> ()</td></tr>
  104. <tr class="separator:aff94cac6249b1c587e26cb64c715b0fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:ad9ee1e1a6b7f314ca7a70c3a838bcc2f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#ad9ee1e1a6b7f314ca7a70c3a838bcc2f">getValueScale</a> ()</td></tr>
  106. <tr class="separator:ad9ee1e1a6b7f314ca7a70c3a838bcc2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a443b1046ecbc04804aef48641080c83c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a443b1046ecbc04804aef48641080c83c">moveEmitter</a> (fromEmitterIndex, toEmitterIndex)</td></tr>
  108. <tr class="separator:a443b1046ecbc04804aef48641080c83c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:a526f0ca594777e1e7898704644920bae"><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="classParticleAsset.html#a526f0ca594777e1e7898704644920bae">removeDataKey</a> (keyIndex)</td></tr>
  110. <tr class="separator:a526f0ca594777e1e7898704644920bae"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:a5903b2583332c1d807e353fad28a344f"><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="classParticleAsset.html#a5903b2583332c1d807e353fad28a344f">removeEmitter</a> (emitterId,[bool deleteEmitter])</td></tr>
  112. <tr class="separator:a5903b2583332c1d807e353fad28a344f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:a687d85d8bb36cbb086bc6d7df4b1bee9"><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="classParticleAsset.html#a687d85d8bb36cbb086bc6d7df4b1bee9">selectField</a> (fieldName)</td></tr>
  114. <tr class="separator:a687d85d8bb36cbb086bc6d7df4b1bee9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:aaf6e29780456083fd9ec57880063a12a"><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="classParticleAsset.html#aaf6e29780456083fd9ec57880063a12a">setDataKeyValue</a> (keyIndex, value)</td></tr>
  116. <tr class="separator:aaf6e29780456083fd9ec57880063a12a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:ae2b8cff4324629987e69f1d4557b9619"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#ae2b8cff4324629987e69f1d4557b9619">setLifeMode</a> (lifeMode)</td></tr>
  118. <tr class="memdesc:ae2b8cff4324629987e69f1d4557b9619"><td class="mdescLeft">&#160;</td><td class="mdescRight">Particle asset accessors. <a href="#ae2b8cff4324629987e69f1d4557b9619">More...</a><br/></td></tr>
  119. <tr class="separator:ae2b8cff4324629987e69f1d4557b9619"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:a986da5eaa0f93b8b350c6398be9b9794"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a986da5eaa0f93b8b350c6398be9b9794">setLifetime</a> (lifeTime)</td></tr>
  121. <tr class="separator:a986da5eaa0f93b8b350c6398be9b9794"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:aa2fc6f92b94e635e603073bfdb564284"><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="classParticleAsset.html#aa2fc6f92b94e635e603073bfdb564284">setRepeatTime</a> (repeatTime)</td></tr>
  123. <tr class="separator:aa2fc6f92b94e635e603073bfdb564284"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:a000c741e5c68b4571838f58d26ccb667"><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="classParticleAsset.html#a000c741e5c68b4571838f58d26ccb667">setSingleDataKey</a> (value)</td></tr>
  125. <tr class="separator:a000c741e5c68b4571838f58d26ccb667"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:a0f8cf197492e13fe524358f1e25be836"><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="classParticleAsset.html#a0f8cf197492e13fe524358f1e25be836">setValueScale</a> (valueScale)</td></tr>
  127. <tr class="separator:a0f8cf197492e13fe524358f1e25be836"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="inherit_header pub_methods_classAssetBase"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classAssetBase')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classAssetBase.html">AssetBase</a></td></tr>
  129. <tr class="memitem:a927651202ec0b50abd34a632d7571992 inherit pub_methods_classAssetBase"><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="classAssetBase.html#a927651202ec0b50abd34a632d7571992">getAssetId</a> ()</td></tr>
  130. <tr class="separator:a927651202ec0b50abd34a632d7571992 inherit pub_methods_classAssetBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:a00b3d3cf0e2bb08d4c268f34610bfaa6 inherit pub_methods_classAssetBase"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAssetBase.html#a00b3d3cf0e2bb08d4c268f34610bfaa6">refreshAsset</a> ()</td></tr>
  132. <tr class="separator:a00b3d3cf0e2bb08d4c268f34610bfaa6 inherit pub_methods_classAssetBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <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>
  134. <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>
  135. <tr class="separator:a22437f451ceb1429fa2a3be23d523954 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <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>
  137. <tr class="separator:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <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>
  139. <tr class="separator:a929e1325a515b279faca90a65028782e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <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>
  141. <tr class="separator:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <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>
  143. <tr class="separator:a78ee178b6a73658d65ca60da4d1e6683 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <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>
  145. <tr class="separator:ab8b0f8b874af628d7204d9cc2630ced7 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <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>
  147. <tr class="separator:a6e266d4432d70cad58461d96e1d2cbdf inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <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>
  149. <tr class="separator:a847e859bcc5b58df83fa7f331c167c32 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <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>
  151. <tr class="separator:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <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>
  153. <tr class="separator:a8f4e85d0903526235ed2ca86df69cdef inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <tr class="memitem:aa9873d392a76100738de2337c882f477 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#aa9873d392a76100738de2337c882f477">call</a> (methodName,[args]*)</td></tr>
  155. <tr class="separator:aa9873d392a76100738de2337c882f477 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. <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>
  157. <tr class="separator:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <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>
  159. <tr class="separator:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  160. <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>
  161. <tr class="separator:a66ac731a8dc088fe8c8ab17bf7c9eecd inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  162. <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>
  163. <tr class="separator:a3e97a324df2af082cdb089491757ce11 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  164. <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>
  165. <tr class="separator:abc2222a9649b5c033810e753b07f26a3 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  166. <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>
  167. <tr class="separator:a1084f1964e446b3d279943cf6e575069 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  168. <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>
  169. <tr class="separator:a7543b8dc494ec0d9034cb73ae504f3ca inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  170. <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>
  171. <tr class="separator:a0e143217119b68d557d17ac2f13b173e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  172. <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>
  173. <tr class="separator:af2e74f6b683da8d2085f0991dab7948b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  174. <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>
  175. <tr class="separator:ac636f89189406eef1b401292459b1a3b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  176. <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>
  177. <tr class="separator:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  178. <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>
  179. <tr class="separator:a88c8d99755a07ac4648360dd40ff67a5 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  180. <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>
  181. <tr class="separator:a367706e675179342e6153c45f1ba06ae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  182. <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>
  183. <tr class="separator:a0570b7f6eb94a0ed941fd75f6f01555b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  184. <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>
  185. <tr class="separator:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  186. <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>
  187. <tr class="separator:af9f341b474a28f4bcf79bc02439b7c18 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  188. <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>
  189. <tr class="separator:a986f1b4a76969bac5dfd50b22af8dec6 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  190. <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>
  191. <tr class="separator:ae329d6593bb3f9b8046e7cae693ccc09 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  192. <tr class="memitem:a2dd2c7a365c19267d7a26923c7616afd 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#a2dd2c7a365c19267d7a26923c7616afd">startTimer</a> (callbackFunction, float timePeriod,[repeat]?)</td></tr>
  193. <tr class="separator:a2dd2c7a365c19267d7a26923c7616afd inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  194. <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>
  195. <tr class="separator:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  196. <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>
  197. <tr class="separator:a5807c03d2b725a54732d09b53d5da631 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  198. <tr class="memitem:a6b70a037ad6cea86b10fd5188f42bf52 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#a6b70a037ad6cea86b10fd5188f42bf52">schedule</a> (time, command,[arg]*)</td></tr>
  199. <tr class="separator:a6b70a037ad6cea86b10fd5188f42bf52 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  200. <tr class="memitem:ad4944a7132f9ee90f801f4cd57014836 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#ad4944a7132f9ee90f801f4cd57014836">save</a> (<a class="el" href="group__FileSystemFunctions.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>,[selectedOnly]?)</td></tr>
  201. <tr class="separator:ad4944a7132f9ee90f801f4cd57014836 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  202. <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>
  203. <tr class="separator:a216228c27df224ac5e8d3590494bfb3f inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  204. <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>
  205. <tr class="separator:ad517bd83c1c853985ab07cd22775c43d inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  206. </table>
  207. <h2 class="groupheader">Member Function Documentation</h2>
  208. <a class="anchor" id="a661877efc80bda257929f0c7fcc1db6e"></a>
  209. <div class="memitem">
  210. <div class="memproto">
  211. <table class="memname">
  212. <tr>
  213. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> addDataKey </td>
  214. <td>(</td>
  215. <td class="paramtype">time&#160;</td>
  216. <td class="paramname">, </td>
  217. </tr>
  218. <tr>
  219. <td class="paramkey"></td>
  220. <td></td>
  221. <td class="paramtype">value&#160;</td>
  222. <td class="paramname">&#160;</td>
  223. </tr>
  224. <tr>
  225. <td></td>
  226. <td>)</td>
  227. <td></td><td></td>
  228. </tr>
  229. </table>
  230. </div><div class="memdoc">
  231. <p>Add Data-Key to Graph. </p>
  232. <dl class="params"><dt>Parameters</dt><dd>
  233. <table class="params">
  234. <tr><td class="paramname">time</td><td>The key time. </td></tr>
  235. <tr><td class="paramname">value</td><td>The value at specified time </td></tr>
  236. </table>
  237. </dd>
  238. </dl>
  239. <dl class="section return"><dt>Returns</dt><dd>Returns the index of the new data-key or -1 on failure. </dd></dl>
  240. </div>
  241. </div>
  242. <a class="anchor" id="a1d1b5e16fc63628c1c611cecaf15b404"></a>
  243. <div class="memitem">
  244. <div class="memproto">
  245. <table class="memname">
  246. <tr>
  247. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> addEmitter </td>
  248. <td>(</td>
  249. <td class="paramtype">emitterId&#160;</td>
  250. <td class="paramname"></td><td>)</td>
  251. <td></td>
  252. </tr>
  253. </table>
  254. </div><div class="memdoc">
  255. <p>Adds an existing emitter. </p>
  256. <dl class="params"><dt>Parameters</dt><dd>
  257. <table class="params">
  258. <tr><td class="paramname">emitterId</td><td>The emitter to add. </td></tr>
  259. </table>
  260. </dd>
  261. </dl>
  262. <dl class="section return"><dt>Returns</dt><dd>On success it returns the ID of the emitter, or 0 if failed. </dd></dl>
  263. </div>
  264. </div>
  265. <a class="anchor" id="a5ea08dae807ec842c6cbe234f3c7b007"></a>
  266. <div class="memitem">
  267. <div class="memproto">
  268. <table class="memname">
  269. <tr>
  270. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> clearDataKeys </td>
  271. <td>(</td>
  272. <td class="paramname"></td><td>)</td>
  273. <td></td>
  274. </tr>
  275. </table>
  276. </div><div class="memdoc">
  277. <p>Clears all data-key(s) from the field. </p>
  278. <dl class="section return"><dt>Returns</dt><dd>Whether the operation was successful or not. </dd></dl>
  279. </div>
  280. </div>
  281. <a class="anchor" id="a1ab6f23a794d831d90c80723e6b7989a"></a>
  282. <div class="memitem">
  283. <div class="memproto">
  284. <table class="memname">
  285. <tr>
  286. <td class="memname">void clearEmitters </td>
  287. <td>(</td>
  288. <td class="paramname"></td><td>)</td>
  289. <td></td>
  290. </tr>
  291. </table>
  292. </div><div class="memdoc">
  293. <p>Clear all the emitters. </p>
  294. <dl class="section return"><dt>Returns</dt><dd>No return Value. </dd></dl>
  295. </div>
  296. </div>
  297. <a class="anchor" id="ae0395abb61c191a0b2e89e8e6c24ee3b"></a>
  298. <div class="memitem">
  299. <div class="memproto">
  300. <table class="memname">
  301. <tr>
  302. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> createEmitter </td>
  303. <td>(</td>
  304. <td class="paramname"></td><td>)</td>
  305. <td></td>
  306. </tr>
  307. </table>
  308. </div><div class="memdoc">
  309. <p>Emitter asset methods. </p>
  310. <p>Creates and add a new emitter. </p>
  311. <dl class="section return"><dt>Returns</dt><dd>The new emitter that was added or 0 if failed. </dd></dl>
  312. </div>
  313. </div>
  314. <a class="anchor" id="a843788246e9ab1fc7433e8a44e1d1192"></a>
  315. <div class="memitem">
  316. <div class="memproto">
  317. <table class="memname">
  318. <tr>
  319. <td class="memname">void deselectField </td>
  320. <td>(</td>
  321. <td class="paramname"></td><td>)</td>
  322. <td></td>
  323. </tr>
  324. </table>
  325. </div><div class="memdoc">
  326. <p>Deselect any selected field. If no field is selected then nothing happens. </p>
  327. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  328. </div>
  329. </div>
  330. <a class="anchor" id="a385322400d9d2117450fd74e1eb0098c"></a>
  331. <div class="memitem">
  332. <div class="memproto">
  333. <table class="memname">
  334. <tr>
  335. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> findEmitter </td>
  336. <td>(</td>
  337. <td class="paramtype">emitterName&#160;</td>
  338. <td class="paramname"></td><td>)</td>
  339. <td></td>
  340. </tr>
  341. </table>
  342. </div><div class="memdoc">
  343. <p>Finds the emitter by its name. </p>
  344. <dl class="params"><dt>Parameters</dt><dd>
  345. <table class="params">
  346. <tr><td class="paramname">emitterName</td><td>The name of the desired emitter. </td></tr>
  347. </table>
  348. </dd>
  349. </dl>
  350. <dl class="section return"><dt>Returns</dt><dd>The emitter or 0 if not found. </dd></dl>
  351. </div>
  352. </div>
  353. <a class="anchor" id="ab2acadc7a7a23cab17732311824d2720"></a>
  354. <div class="memitem">
  355. <div class="memproto">
  356. <table class="memname">
  357. <tr>
  358. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getDataKey </td>
  359. <td>(</td>
  360. <td class="paramtype">keyIndex&#160;</td>
  361. <td class="paramname"></td><td>)</td>
  362. <td></td>
  363. </tr>
  364. </table>
  365. </div><div class="memdoc">
  366. <p>Gets the data-key at the specified index from the field. </p>
  367. <dl class="params"><dt>Parameters</dt><dd>
  368. <table class="params">
  369. <tr><td class="paramname">keyIndex</td><td>The index of the data-key to be retrieved. </td></tr>
  370. </table>
  371. </dd>
  372. </dl>
  373. <dl class="section return"><dt>Returns</dt><dd>The data-key comprising both the time and value or nothing if the key is invalid. </dd></dl>
  374. </div>
  375. </div>
  376. <a class="anchor" id="ac426c7befe25b1edfab3b681204e2a64"></a>
  377. <div class="memitem">
  378. <div class="memproto">
  379. <table class="memname">
  380. <tr>
  381. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getDataKeyCount </td>
  382. <td>(</td>
  383. <td class="paramname"></td><td>)</td>
  384. <td></td>
  385. </tr>
  386. </table>
  387. </div><div class="memdoc">
  388. <p>Gets the data-key count. </p>
  389. <dl class="section return"><dt>Returns</dt><dd>The number of data-keys in the currently selected field or -1 if no field is selected. </dd></dl>
  390. </div>
  391. </div>
  392. <a class="anchor" id="afa661ee087b2e7625c3676cbed5bab50"></a>
  393. <div class="memitem">
  394. <div class="memproto">
  395. <table class="memname">
  396. <tr>
  397. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getEmitter </td>
  398. <td>(</td>
  399. <td class="paramtype">emitterIndex&#160;</td>
  400. <td class="paramname"></td><td>)</td>
  401. <td></td>
  402. </tr>
  403. </table>
  404. </div><div class="memdoc">
  405. <p>Gets the emitter at the specified index. </p>
  406. <dl class="params"><dt>Parameters</dt><dd>
  407. <table class="params">
  408. <tr><td class="paramname">emitterIndex</td><td>The index for the desired emitter </td></tr>
  409. </table>
  410. </dd>
  411. </dl>
  412. <dl class="section return"><dt>Returns</dt><dd>The emitter or 0 if not found. </dd></dl>
  413. </div>
  414. </div>
  415. <a class="anchor" id="ac6bab688c21c2f80dc43acf1405683ff"></a>
  416. <div class="memitem">
  417. <div class="memproto">
  418. <table class="memname">
  419. <tr>
  420. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getEmitterCount </td>
  421. <td>(</td>
  422. <td class="paramname"></td><td>)</td>
  423. <td></td>
  424. </tr>
  425. </table>
  426. </div><div class="memdoc">
  427. <p>Gets the emitter count. </p>
  428. <dl class="section return"><dt>Returns</dt><dd>Returns the number of emitters as an integer. </dd></dl>
  429. </div>
  430. </div>
  431. <a class="anchor" id="a466b00bf2f5ae8d2c04f5756b9074cca"></a>
  432. <div class="memitem">
  433. <div class="memproto">
  434. <table class="memname">
  435. <tr>
  436. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> getFieldValue </td>
  437. <td>(</td>
  438. <td class="paramtype">time&#160;</td>
  439. <td class="paramname"></td><td>)</td>
  440. <td></td>
  441. </tr>
  442. </table>
  443. </div><div class="memdoc">
  444. <p>Get the fields' value at the specified time. </p>
  445. <dl class="params"><dt>Parameters</dt><dd>
  446. <table class="params">
  447. <tr><td class="paramname">time</td><td>The time to sample the field value at. </td></tr>
  448. </table>
  449. </dd>
  450. </dl>
  451. <dl class="section return"><dt>Returns</dt><dd>The fields' value at the specified time or always 0.0 if no field is selected. </dd></dl>
  452. </div>
  453. </div>
  454. <a class="anchor" id="a2bbe9bb6823e05dc4eba062c174e9ab2"></a>
  455. <div class="memitem">
  456. <div class="memproto">
  457. <table class="memname">
  458. <tr>
  459. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getLifeMode </td>
  460. <td>(</td>
  461. <td class="paramname"></td><td>)</td>
  462. <td></td>
  463. </tr>
  464. </table>
  465. </div><div class="memdoc">
  466. <p>Gets the life-mode of the particle effect. </p>
  467. <dl class="section return"><dt>Returns</dt><dd>The life-mode of the particle effect. </dd></dl>
  468. </div>
  469. </div>
  470. <a class="anchor" id="a2a9c38808ac39f8c7eedde432e8a452d"></a>
  471. <div class="memitem">
  472. <div class="memproto">
  473. <table class="memname">
  474. <tr>
  475. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> getLifetime </td>
  476. <td>(</td>
  477. <td class="paramname"></td><td>)</td>
  478. <td></td>
  479. </tr>
  480. </table>
  481. </div><div class="memdoc">
  482. <p>Gets the lifetime of the particle effect. </p>
  483. <dl class="section return"><dt>Returns</dt><dd>The lifetime of the particle effect. </dd></dl>
  484. </div>
  485. </div>
  486. <a class="anchor" id="a085c21d4754924f9b2319b0110b78938"></a>
  487. <div class="memitem">
  488. <div class="memproto">
  489. <table class="memname">
  490. <tr>
  491. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> getMaxTime </td>
  492. <td>(</td>
  493. <td class="paramname"></td><td>)</td>
  494. <td></td>
  495. </tr>
  496. </table>
  497. </div><div class="memdoc">
  498. <p>Get the maximum time for the field. </p>
  499. <dl class="section return"><dt>Returns</dt><dd>The maximum time for the field or always 0.0 if no field is selected. </dd></dl>
  500. </div>
  501. </div>
  502. <a class="anchor" id="a5a54f4d46ac4ffb04c059c68cbe5f64b"></a>
  503. <div class="memitem">
  504. <div class="memproto">
  505. <table class="memname">
  506. <tr>
  507. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> getMaxValue </td>
  508. <td>(</td>
  509. <td class="paramname"></td><td>)</td>
  510. <td></td>
  511. </tr>
  512. </table>
  513. </div><div class="memdoc">
  514. <p>Get the maximum value for the field. </p>
  515. <dl class="section return"><dt>Returns</dt><dd>The maximum value for the field or always 0.0 if no field is selected. </dd></dl>
  516. </div>
  517. </div>
  518. <a class="anchor" id="a32b94c28efd67a5573e4687006ebab28"></a>
  519. <div class="memitem">
  520. <div class="memproto">
  521. <table class="memname">
  522. <tr>
  523. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> getMinTime </td>
  524. <td>(</td>
  525. <td class="paramname"></td><td>)</td>
  526. <td></td>
  527. </tr>
  528. </table>
  529. </div><div class="memdoc">
  530. <p>Get the minimum time for the field. </p>
  531. <dl class="section return"><dt>Returns</dt><dd>The minimum time for the field or always 0.0 if no field is selected. </dd></dl>
  532. </div>
  533. </div>
  534. <a class="anchor" id="a9fb1e6a5dab57b6b13f256978ca49cb8"></a>
  535. <div class="memitem">
  536. <div class="memproto">
  537. <table class="memname">
  538. <tr>
  539. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> getMinValue </td>
  540. <td>(</td>
  541. <td class="paramname"></td><td>)</td>
  542. <td></td>
  543. </tr>
  544. </table>
  545. </div><div class="memdoc">
  546. <p>Get the minimum value for the field. </p>
  547. <dl class="section return"><dt>Returns</dt><dd>The minimum value for the field or always 0.0 if no field is selected. </dd></dl>
  548. </div>
  549. </div>
  550. <a class="anchor" id="ad13e14f410f6f2fdf10e5a588ff04248"></a>
  551. <div class="memitem">
  552. <div class="memproto">
  553. <table class="memname">
  554. <tr>
  555. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> getRepeatTime </td>
  556. <td>(</td>
  557. <td class="paramname"></td><td>)</td>
  558. <td></td>
  559. </tr>
  560. </table>
  561. </div><div class="memdoc">
  562. <p>Gets the time period that the fields' value repeat (cycle) at. </p>
  563. <dl class="section return"><dt>Returns</dt><dd>The time period that the fields' value repeat (cycle) at. </dd></dl>
  564. </div>
  565. </div>
  566. <a class="anchor" id="ad4adedf74d82244a76926b5bb1146cc5"></a>
  567. <div class="memitem">
  568. <div class="memproto">
  569. <table class="memname">
  570. <tr>
  571. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getSelectableFieldCount </td>
  572. <td>(</td>
  573. <td class="paramname"></td><td>)</td>
  574. <td></td>
  575. </tr>
  576. </table>
  577. </div><div class="memdoc">
  578. <p>Particle asset fields. </p>
  579. <p>Gets the number of available selectable fields. </p>
  580. <dl class="section return"><dt>Returns</dt><dd>The number of available selectable fields. </dd></dl>
  581. </div>
  582. </div>
  583. <a class="anchor" id="a656410eca241806469458e50fe0143d9"></a>
  584. <div class="memitem">
  585. <div class="memproto">
  586. <table class="memname">
  587. <tr>
  588. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getSelectableFieldName </td>
  589. <td>(</td>
  590. <td class="paramtype">fieldIndex&#160;</td>
  591. <td class="paramname"></td><td>)</td>
  592. <td></td>
  593. </tr>
  594. </table>
  595. </div><div class="memdoc">
  596. <p>Gets the selectable field at the specified index. </p>
  597. <dl class="section return"><dt>Returns</dt><dd>The selectable field name at the specified index. </dd></dl>
  598. </div>
  599. </div>
  600. <a class="anchor" id="aff94cac6249b1c587e26cb64c715b0fe"></a>
  601. <div class="memitem">
  602. <div class="memproto">
  603. <table class="memname">
  604. <tr>
  605. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> getSelectedField </td>
  606. <td>(</td>
  607. <td class="paramname"></td><td>)</td>
  608. <td></td>
  609. </tr>
  610. </table>
  611. </div><div class="memdoc">
  612. <p>Gets the selected field name or nothing if no field is selected. </p>
  613. <dl class="section return"><dt>Returns</dt><dd>The selected field name or nothing if no fields is selected. </dd></dl>
  614. </div>
  615. </div>
  616. <a class="anchor" id="ad9ee1e1a6b7f314ca7a70c3a838bcc2f"></a>
  617. <div class="memitem">
  618. <div class="memproto">
  619. <table class="memname">
  620. <tr>
  621. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> getValueScale </td>
  622. <td>(</td>
  623. <td class="paramname"></td><td>)</td>
  624. <td></td>
  625. </tr>
  626. </table>
  627. </div><div class="memdoc">
  628. <p>Gets the scaling of field values' retrieved from the field. </p>
  629. <dl class="section return"><dt>Returns</dt><dd>The scaling of field values' retrieved from the field. </dd></dl>
  630. </div>
  631. </div>
  632. <a class="anchor" id="a443b1046ecbc04804aef48641080c83c"></a>
  633. <div class="memitem">
  634. <div class="memproto">
  635. <table class="memname">
  636. <tr>
  637. <td class="memname">void moveEmitter </td>
  638. <td>(</td>
  639. <td class="paramtype">fromEmitterIndex&#160;</td>
  640. <td class="paramname">, </td>
  641. </tr>
  642. <tr>
  643. <td class="paramkey"></td>
  644. <td></td>
  645. <td class="paramtype">toEmitterIndex&#160;</td>
  646. <td class="paramname">&#160;</td>
  647. </tr>
  648. <tr>
  649. <td></td>
  650. <td>)</td>
  651. <td></td><td></td>
  652. </tr>
  653. </table>
  654. </div><div class="memdoc">
  655. <p>Moves the emitter order. </p>
  656. <dl class="params"><dt>Parameters</dt><dd>
  657. <table class="params">
  658. <tr><td class="paramname">fromEmitterIndex</td><td>The source index of the emitter to move. </td></tr>
  659. <tr><td class="paramname">toEmitterIndex</td><td>The destination index to move the emitter to. </td></tr>
  660. </table>
  661. </dd>
  662. </dl>
  663. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  664. </div>
  665. </div>
  666. <a class="anchor" id="a526f0ca594777e1e7898704644920bae"></a>
  667. <div class="memitem">
  668. <div class="memproto">
  669. <table class="memname">
  670. <tr>
  671. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> removeDataKey </td>
  672. <td>(</td>
  673. <td class="paramtype">keyIndex&#160;</td>
  674. <td class="paramname"></td><td>)</td>
  675. <td></td>
  676. </tr>
  677. </table>
  678. </div><div class="memdoc">
  679. <p>Remove the data-key from the field. </p>
  680. <dl class="params"><dt>Parameters</dt><dd>
  681. <table class="params">
  682. <tr><td class="paramname">keyIndex</td><td>The index of the data-key you want to remove. </td></tr>
  683. </table>
  684. </dd>
  685. </dl>
  686. <dl class="section return"><dt>Returns</dt><dd>Whether the operation was successful or not. </dd></dl>
  687. </div>
  688. </div>
  689. <a class="anchor" id="a5903b2583332c1d807e353fad28a344f"></a>
  690. <div class="memitem">
  691. <div class="memproto">
  692. <table class="memname">
  693. <tr>
  694. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> removeEmitter </td>
  695. <td>(</td>
  696. <td class="paramtype">emitterId&#160;</td>
  697. <td class="paramname"></td><td>)</td>
  698. <td></td>
  699. </tr>
  700. </table>
  701. </div><div class="memdoc">
  702. <p>Removes an emitter. </p>
  703. <dl class="params"><dt>Parameters</dt><dd>
  704. <table class="params">
  705. <tr><td class="paramname">emitterId</td><td>The emitter to remove. </td></tr>
  706. </table>
  707. </dd>
  708. </dl>
  709. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  710. </div>
  711. </div>
  712. <a class="anchor" id="a687d85d8bb36cbb086bc6d7df4b1bee9"></a>
  713. <div class="memitem">
  714. <div class="memproto">
  715. <table class="memname">
  716. <tr>
  717. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> selectField </td>
  718. <td>(</td>
  719. <td class="paramtype">fieldName&#160;</td>
  720. <td class="paramname"></td><td>)</td>
  721. <td></td>
  722. </tr>
  723. </table>
  724. </div><div class="memdoc">
  725. <p>Select the specified field by its name. </p>
  726. <dl class="params"><dt>Parameters</dt><dd>
  727. <table class="params">
  728. <tr><td class="paramname">fieldName</td><td>The field name to use for the selection. Use an empty name to deselect to stop accidental changes. </td></tr>
  729. </table>
  730. </dd>
  731. </dl>
  732. <dl class="section return"><dt>Returns</dt><dd>Whether the field was successfully selected or not. </dd></dl>
  733. </div>
  734. </div>
  735. <a class="anchor" id="aaf6e29780456083fd9ec57880063a12a"></a>
  736. <div class="memitem">
  737. <div class="memproto">
  738. <table class="memname">
  739. <tr>
  740. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> setDataKeyValue </td>
  741. <td>(</td>
  742. <td class="paramtype">keyIndex&#160;</td>
  743. <td class="paramname">, </td>
  744. </tr>
  745. <tr>
  746. <td class="paramkey"></td>
  747. <td></td>
  748. <td class="paramtype">value&#160;</td>
  749. <td class="paramname">&#160;</td>
  750. </tr>
  751. <tr>
  752. <td></td>
  753. <td>)</td>
  754. <td></td><td></td>
  755. </tr>
  756. </table>
  757. </div><div class="memdoc">
  758. <p>Set data-key value for the field. </p>
  759. <dl class="params"><dt>Parameters</dt><dd>
  760. <table class="params">
  761. <tr><td class="paramname">keyIndex</td><td>The index of the key to be modified. </td></tr>
  762. <tr><td class="paramname">value</td><td>The value to change the key to. </td></tr>
  763. </table>
  764. </dd>
  765. </dl>
  766. <dl class="section return"><dt>Returns</dt><dd>Whether the operation was successful or not. </dd></dl>
  767. </div>
  768. </div>
  769. <a class="anchor" id="ae2b8cff4324629987e69f1d4557b9619"></a>
  770. <div class="memitem">
  771. <div class="memproto">
  772. <table class="memname">
  773. <tr>
  774. <td class="memname">void setLifeMode </td>
  775. <td>(</td>
  776. <td class="paramtype">lifeMode&#160;</td>
  777. <td class="paramname"></td><td>)</td>
  778. <td></td>
  779. </tr>
  780. </table>
  781. </div><div class="memdoc">
  782. <p>Particle asset accessors. </p>
  783. <p>Sets the life-mode of the particle effect. </p>
  784. <dl class="params"><dt>Parameters</dt><dd>
  785. <table class="params">
  786. <tr><td class="paramname">lifeMode</td><td>The life-mode of the particle effect (either INFINITE, CYCLE, KILL or STOP. A life-mode of INFINITE causes the particle effect to last forever. A life-mode of CYCLE causes the particle effect to restart playing when its specified 'lifetime' has been reached. A life-mode of KILL causes the particle effect to be deleted when its specified 'lifetime' has been reached. A life-mode of STOP causes the particle effect to stop playing (but not be deleted) when its specified lifetime has been reached. </td></tr>
  787. </table>
  788. </dd>
  789. </dl>
  790. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  791. </div>
  792. </div>
  793. <a class="anchor" id="a986da5eaa0f93b8b350c6398be9b9794"></a>
  794. <div class="memitem">
  795. <div class="memproto">
  796. <table class="memname">
  797. <tr>
  798. <td class="memname">void setLifetime </td>
  799. <td>(</td>
  800. <td class="paramtype">lifeTime&#160;</td>
  801. <td class="paramname"></td><td>)</td>
  802. <td></td>
  803. </tr>
  804. </table>
  805. </div><div class="memdoc">
  806. <p>Sets the lifetime of the particle effect. </p>
  807. <dl class="params"><dt>Parameters</dt><dd>
  808. <table class="params">
  809. <tr><td class="paramname">lifeTime</td><td>The lifetime of the particle effect. This is used according to the 'lifeMode' setting. </td></tr>
  810. </table>
  811. </dd>
  812. </dl>
  813. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  814. </div>
  815. </div>
  816. <a class="anchor" id="aa2fc6f92b94e635e603073bfdb564284"></a>
  817. <div class="memitem">
  818. <div class="memproto">
  819. <table class="memname">
  820. <tr>
  821. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> setRepeatTime </td>
  822. <td>(</td>
  823. <td class="paramtype">repeatTime&#160;</td>
  824. <td class="paramname"></td><td>)</td>
  825. <td></td>
  826. </tr>
  827. </table>
  828. </div><div class="memdoc">
  829. <p>Sets the time period to repeat (cycle) the fields' values at. </p>
  830. <dl class="section return"><dt>Returns</dt><dd>Whether the operation was successful or not. </dd></dl>
  831. </div>
  832. </div>
  833. <a class="anchor" id="a000c741e5c68b4571838f58d26ccb667"></a>
  834. <div class="memitem">
  835. <div class="memproto">
  836. <table class="memname">
  837. <tr>
  838. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> setSingleDataKey </td>
  839. <td>(</td>
  840. <td class="paramtype">value&#160;</td>
  841. <td class="paramname"></td><td>)</td>
  842. <td></td>
  843. </tr>
  844. </table>
  845. </div><div class="memdoc">
  846. <p>Sets a single data-key at time-zero with the specified value. All existing keys are cleared. </p>
  847. <dl class="params"><dt>Parameters</dt><dd>
  848. <table class="params">
  849. <tr><td class="paramname">value</td><td>The value to set the key to. </td></tr>
  850. </table>
  851. </dd>
  852. </dl>
  853. <dl class="section return"><dt>Returns</dt><dd>Returns the index of the new data-key (always zero) or -1 on failure. </dd></dl>
  854. </div>
  855. </div>
  856. <a class="anchor" id="a0f8cf197492e13fe524358f1e25be836"></a>
  857. <div class="memitem">
  858. <div class="memproto">
  859. <table class="memname">
  860. <tr>
  861. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> setValueScale </td>
  862. <td>(</td>
  863. <td class="paramtype">valueScale&#160;</td>
  864. <td class="paramname"></td><td>)</td>
  865. <td></td>
  866. </tr>
  867. </table>
  868. </div><div class="memdoc">
  869. <p>Set the scaling of field values retrieved from the field. This does not alter the actual data-key values. </p>
  870. <dl class="params"><dt>Parameters</dt><dd>
  871. <table class="params">
  872. <tr><td class="paramname">valueScale</td><td>The scale for field values retrieved from the field. </td></tr>
  873. </table>
  874. </dd>
  875. </dl>
  876. <dl class="section return"><dt>Returns</dt><dd>Whether the operation was successful or not. </dd></dl>
  877. </div>
  878. </div>
  879. </div><!-- contents -->
  880. <!-- start footer part -->
  881. <hr class="footer"/><address class="footer"><small>
  882. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  883. <img class="footer" src="doxygen.png" alt="doxygen"/>
  884. </a> 1.8.3.1
  885. </small></address>
  886. </body>
  887. </html>