classParticleAsset.html 63 KB

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