classParticleAsset.html 77 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.9.8"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>TorqueScript Reference: ParticleAsset Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  13. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  14. </head>
  15. <body>
  16. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  17. <div id="titlearea">
  18. <table cellspacing="0" cellpadding="0">
  19. <tbody>
  20. <tr id="projectrow">
  21. <td id="projectalign">
  22. <div id="projectname">TorqueScript Reference
  23. </div>
  24. </td>
  25. </tr>
  26. </tbody>
  27. </table>
  28. </div>
  29. <!-- end header part -->
  30. <!-- Generated by Doxygen 1.9.8 -->
  31. <script type="text/javascript" src="menudata.js"></script>
  32. <script type="text/javascript" src="menu.js"></script>
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  35. $(function() {
  36. initMenu('',false,false,'search.php','Search');
  37. });
  38. /* @license-end */
  39. </script>
  40. <div id="main-nav"></div>
  41. </div><!-- top -->
  42. <div class="header">
  43. <div class="summary">
  44. <a href="#pub-methods">Public Member Functions</a> &#124;
  45. <a href="classParticleAsset-members.html">List of all members</a> </div>
  46. <div class="headertitle"><div class="title">ParticleAsset Class Reference</div></div>
  47. </div><!--header-->
  48. <div class="contents">
  49. <p><code>#include &lt;ParticleAsset_ScriptBinding.h&gt;</code></p>
  50. <p>Inherits <a class="el" href="classAssetBase.html">AssetBase</a>.</p>
  51. <table class="memberdecls">
  52. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  53. Public Member Functions</h2></td></tr>
  54. <tr class="memitem:a661877efc80bda257929f0c7fcc1db6e" id="r_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>
  55. <tr class="separator:a661877efc80bda257929f0c7fcc1db6e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  56. <tr class="memitem:a1d1b5e16fc63628c1c611cecaf15b404" id="r_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>
  57. <tr class="separator:a1d1b5e16fc63628c1c611cecaf15b404"><td class="memSeparator" colspan="2">&#160;</td></tr>
  58. <tr class="memitem:a5ea08dae807ec842c6cbe234f3c7b007" id="r_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>
  59. <tr class="separator:a5ea08dae807ec842c6cbe234f3c7b007"><td class="memSeparator" colspan="2">&#160;</td></tr>
  60. <tr class="memitem:a1ab6f23a794d831d90c80723e6b7989a" id="r_a1ab6f23a794d831d90c80723e6b7989a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a1ab6f23a794d831d90c80723e6b7989a">clearEmitters</a> ()</td></tr>
  61. <tr class="separator:a1ab6f23a794d831d90c80723e6b7989a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  62. <tr class="memitem:ae0395abb61c191a0b2e89e8e6c24ee3b" id="r_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>
  63. <tr class="memdesc:ae0395abb61c191a0b2e89e8e6c24ee3b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Emitter asset methods. <br /></td></tr>
  64. <tr class="separator:ae0395abb61c191a0b2e89e8e6c24ee3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65. <tr class="memitem:a843788246e9ab1fc7433e8a44e1d1192" id="r_a843788246e9ab1fc7433e8a44e1d1192"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a843788246e9ab1fc7433e8a44e1d1192">deselectField</a> ()</td></tr>
  66. <tr class="separator:a843788246e9ab1fc7433e8a44e1d1192"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67. <tr class="memitem:a385322400d9d2117450fd74e1eb0098c" id="r_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>
  68. <tr class="separator:a385322400d9d2117450fd74e1eb0098c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69. <tr class="memitem:ab2acadc7a7a23cab17732311824d2720" id="r_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>
  70. <tr class="separator:ab2acadc7a7a23cab17732311824d2720"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71. <tr class="memitem:ac426c7befe25b1edfab3b681204e2a64" id="r_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>
  72. <tr class="separator:ac426c7befe25b1edfab3b681204e2a64"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. <tr class="memitem:afa661ee087b2e7625c3676cbed5bab50" id="r_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>
  74. <tr class="separator:afa661ee087b2e7625c3676cbed5bab50"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. <tr class="memitem:ac6bab688c21c2f80dc43acf1405683ff" id="r_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>
  76. <tr class="separator:ac6bab688c21c2f80dc43acf1405683ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:a466b00bf2f5ae8d2c04f5756b9074cca" id="r_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>
  78. <tr class="separator:a466b00bf2f5ae8d2c04f5756b9074cca"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:a2bbe9bb6823e05dc4eba062c174e9ab2" id="r_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>
  80. <tr class="separator:a2bbe9bb6823e05dc4eba062c174e9ab2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:a2a9c38808ac39f8c7eedde432e8a452d" id="r_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>
  82. <tr class="separator:a2a9c38808ac39f8c7eedde432e8a452d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:a085c21d4754924f9b2319b0110b78938" id="r_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>
  84. <tr class="separator:a085c21d4754924f9b2319b0110b78938"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:a5a54f4d46ac4ffb04c059c68cbe5f64b" id="r_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>
  86. <tr class="separator:a5a54f4d46ac4ffb04c059c68cbe5f64b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:a32b94c28efd67a5573e4687006ebab28" id="r_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>
  88. <tr class="separator:a32b94c28efd67a5573e4687006ebab28"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:a9fb1e6a5dab57b6b13f256978ca49cb8" id="r_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>
  90. <tr class="separator:a9fb1e6a5dab57b6b13f256978ca49cb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:ad13e14f410f6f2fdf10e5a588ff04248" id="r_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>
  92. <tr class="separator:ad13e14f410f6f2fdf10e5a588ff04248"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:ad4adedf74d82244a76926b5bb1146cc5" id="r_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>
  94. <tr class="memdesc:ad4adedf74d82244a76926b5bb1146cc5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Particle asset fields. <br /></td></tr>
  95. <tr class="separator:ad4adedf74d82244a76926b5bb1146cc5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:a656410eca241806469458e50fe0143d9" id="r_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>
  97. <tr class="separator:a656410eca241806469458e50fe0143d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:a3c6738b3947f0305f0092733a07c0716" id="r_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>
  99. <tr class="separator:a3c6738b3947f0305f0092733a07c0716"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:ad9ee1e1a6b7f314ca7a70c3a838bcc2f" id="r_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>
  101. <tr class="separator:ad9ee1e1a6b7f314ca7a70c3a838bcc2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a443b1046ecbc04804aef48641080c83c" id="r_a443b1046ecbc04804aef48641080c83c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a443b1046ecbc04804aef48641080c83c">moveEmitter</a> (fromEmitterIndex, toEmitterIndex)</td></tr>
  103. <tr class="separator:a443b1046ecbc04804aef48641080c83c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a526f0ca594777e1e7898704644920bae" id="r_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>
  105. <tr class="separator:a526f0ca594777e1e7898704644920bae"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:acedca9c1eb5157fdcb03dacf76bcbe92" id="r_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>
  107. <tr class="separator:acedca9c1eb5157fdcb03dacf76bcbe92"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:a687d85d8bb36cbb086bc6d7df4b1bee9" id="r_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>
  109. <tr class="separator:a687d85d8bb36cbb086bc6d7df4b1bee9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:aaf6e29780456083fd9ec57880063a12a" id="r_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>
  111. <tr class="separator:aaf6e29780456083fd9ec57880063a12a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:ae2b8cff4324629987e69f1d4557b9619" id="r_ae2b8cff4324629987e69f1d4557b9619"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#ae2b8cff4324629987e69f1d4557b9619">setLifeMode</a> (lifeMode)</td></tr>
  113. <tr class="memdesc:ae2b8cff4324629987e69f1d4557b9619"><td class="mdescLeft">&#160;</td><td class="mdescRight">Particle asset accessors. <br /></td></tr>
  114. <tr class="separator:ae2b8cff4324629987e69f1d4557b9619"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:a986da5eaa0f93b8b350c6398be9b9794" id="r_a986da5eaa0f93b8b350c6398be9b9794"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a986da5eaa0f93b8b350c6398be9b9794">setLifetime</a> (lifeTime)</td></tr>
  116. <tr class="separator:a986da5eaa0f93b8b350c6398be9b9794"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:aa2fc6f92b94e635e603073bfdb564284" id="r_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>
  118. <tr class="separator:aa2fc6f92b94e635e603073bfdb564284"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:a000c741e5c68b4571838f58d26ccb667" id="r_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>
  120. <tr class="separator:a000c741e5c68b4571838f58d26ccb667"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:a0f8cf197492e13fe524358f1e25be836" id="r_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>
  122. <tr class="separator:a0f8cf197492e13fe524358f1e25be836"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <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>
  124. <tr class="memitem:a927651202ec0b50abd34a632d7571992 inherit pub_methods_classAssetBase" id="r_a927651202ec0b50abd34a632d7571992"><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>
  125. <tr class="separator:a927651202ec0b50abd34a632d7571992 inherit pub_methods_classAssetBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:a00b3d3cf0e2bb08d4c268f34610bfaa6 inherit pub_methods_classAssetBase" id="r_a00b3d3cf0e2bb08d4c268f34610bfaa6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAssetBase.html#a00b3d3cf0e2bb08d4c268f34610bfaa6">refreshAsset</a> ()</td></tr>
  127. <tr class="separator:a00b3d3cf0e2bb08d4c268f34610bfaa6 inherit pub_methods_classAssetBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <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>
  129. <tr class="memitem:a2375929bea4901d98ae352231b0721ad inherit pub_methods_classSimObject" id="r_a2375929bea4901d98ae352231b0721ad"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a2375929bea4901d98ae352231b0721ad">assignFieldsFrom</a> (<a class="el" href="classSimObject.html">SimObject</a>)</td></tr>
  130. <tr class="separator:a2375929bea4901d98ae352231b0721ad inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:a22437f451ceb1429fa2a3be23d523954 inherit pub_methods_classSimObject" id="r_a22437f451ceb1429fa2a3be23d523954"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a22437f451ceb1429fa2a3be23d523954">clone</a> ([copyDynamicFields=false]?)</td></tr>
  132. <tr class="separator:a22437f451ceb1429fa2a3be23d523954 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject" id="r_a7a4721d0a51e952c211e9b0fea4d8090"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a7a4721d0a51e952c211e9b0fea4d8090">delete</a> ()</td></tr>
  134. <tr class="separator:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:a929e1325a515b279faca90a65028782e inherit pub_methods_classSimObject" id="r_a929e1325a515b279faca90a65028782e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a929e1325a515b279faca90a65028782e">getId</a> ()</td></tr>
  136. <tr class="separator:a929e1325a515b279faca90a65028782e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject" id="r_a4f673cd959711ae09927e7c44dae5fdb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a4f673cd959711ae09927e7c44dae5fdb">setName</a> (newName)</td></tr>
  138. <tr class="separator:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:a78ee178b6a73658d65ca60da4d1e6683 inherit pub_methods_classSimObject" id="r_a78ee178b6a73658d65ca60da4d1e6683"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a78ee178b6a73658d65ca60da4d1e6683">getName</a> ()</td></tr>
  140. <tr class="separator:a78ee178b6a73658d65ca60da4d1e6683 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:ab8b0f8b874af628d7204d9cc2630ced7 inherit pub_methods_classSimObject" id="r_ab8b0f8b874af628d7204d9cc2630ced7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab8b0f8b874af628d7204d9cc2630ced7">getClassNamespace</a> ()</td></tr>
  142. <tr class="separator:ab8b0f8b874af628d7204d9cc2630ced7 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:a6e266d4432d70cad58461d96e1d2cbdf inherit pub_methods_classSimObject" id="r_a6e266d4432d70cad58461d96e1d2cbdf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a6e266d4432d70cad58461d96e1d2cbdf">getSuperClassNamespace</a> ()</td></tr>
  144. <tr class="separator:a6e266d4432d70cad58461d96e1d2cbdf inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <tr class="memitem:a847e859bcc5b58df83fa7f331c167c32 inherit pub_methods_classSimObject" id="r_a847e859bcc5b58df83fa7f331c167c32"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a847e859bcc5b58df83fa7f331c167c32">setClassNamespace</a> (nameSpace)</td></tr>
  146. <tr class="separator:a847e859bcc5b58df83fa7f331c167c32 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject" id="r_a9cbf471b97387d5bdefb88f92094ad54"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a9cbf471b97387d5bdefb88f92094ad54">setSuperClassNamespace</a> ()</td></tr>
  148. <tr class="separator:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:a8f4e85d0903526235ed2ca86df69cdef inherit pub_methods_classSimObject" id="r_a8f4e85d0903526235ed2ca86df69cdef"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a8f4e85d0903526235ed2ca86df69cdef">isMethod</a> (string methodName)</td></tr>
  150. <tr class="separator:a8f4e85d0903526235ed2ca86df69cdef inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <tr class="memitem:a9ce8801999cf2228ddde6d58ca3773d5 inherit pub_methods_classSimObject" id="r_a9ce8801999cf2228ddde6d58ca3773d5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a9ce8801999cf2228ddde6d58ca3773d5">call</a> (methodName, [args] *)</td></tr>
  152. <tr class="separator:a9ce8801999cf2228ddde6d58ca3773d5 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. <tr class="memitem:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject" id="r_a1810f5aba25efd242c24232c2c2bbd1a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1810f5aba25efd242c24232c2c2bbd1a">dumpClassHierarchy</a> ()</td></tr>
  154. <tr class="separator:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject" id="r_accd2600060dbaee3a3b41aed4034c63c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#accd2600060dbaee3a3b41aed4034c63c">dump</a> ()</td></tr>
  156. <tr class="separator:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. <tr class="memitem:a66ac731a8dc088fe8c8ab17bf7c9eecd inherit pub_methods_classSimObject" id="r_a66ac731a8dc088fe8c8ab17bf7c9eecd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a66ac731a8dc088fe8c8ab17bf7c9eecd">isMemberOfClass</a> (string classname)</td></tr>
  158. <tr class="separator:a66ac731a8dc088fe8c8ab17bf7c9eecd inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  159. <tr class="memitem:a3e97a324df2af082cdb089491757ce11 inherit pub_methods_classSimObject" id="r_a3e97a324df2af082cdb089491757ce11"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a3e97a324df2af082cdb089491757ce11">getClassName</a> ()</td></tr>
  160. <tr class="separator:a3e97a324df2af082cdb089491757ce11 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  161. <tr class="memitem:abc2222a9649b5c033810e753b07f26a3 inherit pub_methods_classSimObject" id="r_abc2222a9649b5c033810e753b07f26a3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#abc2222a9649b5c033810e753b07f26a3">getFieldValue</a> (fieldName)</td></tr>
  162. <tr class="separator:abc2222a9649b5c033810e753b07f26a3 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  163. <tr class="memitem:a1084f1964e446b3d279943cf6e575069 inherit pub_methods_classSimObject" id="r_a1084f1964e446b3d279943cf6e575069"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1084f1964e446b3d279943cf6e575069">setFieldValue</a> (fieldName, value)</td></tr>
  164. <tr class="separator:a1084f1964e446b3d279943cf6e575069 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  165. <tr class="memitem:ab4e32fb984d9ce6584b0fa57c8772d3e inherit pub_methods_classSimObject" id="r_ab4e32fb984d9ce6584b0fa57c8772d3e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab4e32fb984d9ce6584b0fa57c8772d3e">setEditFieldValue</a> (fieldName, value)</td></tr>
  166. <tr class="separator:ab4e32fb984d9ce6584b0fa57c8772d3e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  167. <tr class="memitem:a7543b8dc494ec0d9034cb73ae504f3ca inherit pub_methods_classSimObject" id="r_a7543b8dc494ec0d9034cb73ae504f3ca"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a7543b8dc494ec0d9034cb73ae504f3ca">getDynamicFieldCount</a> ()</td></tr>
  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" id="r_a0e143217119b68d557d17ac2f13b173e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0e143217119b68d557d17ac2f13b173e">getDynamicField</a> (index)</td></tr>
  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" id="r_af2e74f6b683da8d2085f0991dab7948b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#af2e74f6b683da8d2085f0991dab7948b">getFieldCount</a> ()</td></tr>
  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" id="r_ac636f89189406eef1b401292459b1a3b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ac636f89189406eef1b401292459b1a3b">getField</a> (int index)</td></tr>
  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" id="r_aa8f68d1e6d8c6601c39b3f676f0e9c70"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa8f68d1e6d8c6601c39b3f676f0e9c70">setProgenitorFile</a> (file)</td></tr>
  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" id="r_a88c8d99755a07ac4648360dd40ff67a5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a88c8d99755a07ac4648360dd40ff67a5">getProgenitorFile</a> ()</td></tr>
  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" id="r_a367706e675179342e6153c45f1ba06ae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a367706e675179342e6153c45f1ba06ae">getType</a> ()</td></tr>
  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" id="r_a0570b7f6eb94a0ed941fd75f6f01555b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0570b7f6eb94a0ed941fd75f6f01555b">getFieldType</a> (fieldName)</td></tr>
  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" id="r_a5aaca360a719feabae0e4e57b921deae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a5aaca360a719feabae0e4e57b921deae">setInternalName</a> (string InternalName)</td></tr>
  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" id="r_af9f341b474a28f4bcf79bc02439b7c18"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#af9f341b474a28f4bcf79bc02439b7c18">getInternalName</a> ()</td></tr>
  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" id="r_a986f1b4a76969bac5dfd50b22af8dec6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a986f1b4a76969bac5dfd50b22af8dec6">isChildOfGroup</a> (groupID)</td></tr>
  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" id="r_ae329d6593bb3f9b8046e7cae693ccc09"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ae329d6593bb3f9b8046e7cae693ccc09">getGroup</a> ()</td></tr>
  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" id="r_a39653bc04e82875f2dc8d6dea25acdaa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a39653bc04e82875f2dc8d6dea25acdaa">startTimer</a> (callbackFunction, float timePeriod, [repeat]?)</td></tr>
  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" id="r_aa6f6bfef028c7b053444cbd48567d286"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa6f6bfef028c7b053444cbd48567d286">stopTimer</a> ()</td></tr>
  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" id="r_a5807c03d2b725a54732d09b53d5da631"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a5807c03d2b725a54732d09b53d5da631">isTimerActive</a> ()</td></tr>
  196. <tr class="separator:a5807c03d2b725a54732d09b53d5da631 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  197. <tr class="memitem:a16d537cd7a1c438045bb756fe1e22d2d inherit pub_methods_classSimObject" id="r_a16d537cd7a1c438045bb756fe1e22d2d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a16d537cd7a1c438045bb756fe1e22d2d">schedule</a> (time, command, [arg] *)</td></tr>
  198. <tr class="separator:a16d537cd7a1c438045bb756fe1e22d2d inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  199. <tr class="memitem:a9f05bc4a94b98e2e3347fe34aeefe7c4 inherit pub_methods_classSimObject" id="r_a9f05bc4a94b98e2e3347fe34aeefe7c4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a9f05bc4a94b98e2e3347fe34aeefe7c4">startListening</a> (<a class="el" href="classSimObject.html">SimObject</a>)</td></tr>
  200. <tr class="separator:a9f05bc4a94b98e2e3347fe34aeefe7c4 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  201. <tr class="memitem:a3f7f0520846a222310415ad7a8f8a4bf inherit pub_methods_classSimObject" id="r_a3f7f0520846a222310415ad7a8f8a4bf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a3f7f0520846a222310415ad7a8f8a4bf">stopListening</a> (<a class="el" href="classSimObject.html">SimObject</a>)</td></tr>
  202. <tr class="separator:a3f7f0520846a222310415ad7a8f8a4bf inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  203. <tr class="memitem:afa6eac5990b02024e77e3815161159df inherit pub_methods_classSimObject" id="r_afa6eac5990b02024e77e3815161159df"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#afa6eac5990b02024e77e3815161159df">addListener</a> (<a class="el" href="classSimObject.html">SimObject</a>)</td></tr>
  204. <tr class="separator:afa6eac5990b02024e77e3815161159df inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  205. <tr class="memitem:a07dd4cf0d113ff4a8943b900bda68a1c inherit pub_methods_classSimObject" id="r_a07dd4cf0d113ff4a8943b900bda68a1c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a07dd4cf0d113ff4a8943b900bda68a1c">removeListener</a> (<a class="el" href="classSimObject.html">SimObject</a>)</td></tr>
  206. <tr class="separator:a07dd4cf0d113ff4a8943b900bda68a1c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  207. <tr class="memitem:a87be48ec4599c3d02a118cee89e47f55 inherit pub_methods_classSimObject" id="r_a87be48ec4599c3d02a118cee89e47f55"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a87be48ec4599c3d02a118cee89e47f55">removeAllListeners</a> ()</td></tr>
  208. <tr class="separator:a87be48ec4599c3d02a118cee89e47f55 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  209. <tr class="memitem:a1dcaa2910d6405134c74a71745d29154 inherit pub_methods_classSimObject" id="r_a1dcaa2910d6405134c74a71745d29154"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1dcaa2910d6405134c74a71745d29154">postEvent</a> (<a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> eventName, <a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> data)</td></tr>
  210. <tr class="separator:a1dcaa2910d6405134c74a71745d29154 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  211. <tr class="memitem:ab6e816c3694e8b6119bf9ac3f5556f32 inherit pub_methods_classSimObject" id="r_ab6e816c3694e8b6119bf9ac3f5556f32"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab6e816c3694e8b6119bf9ac3f5556f32">save</a> (<a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>, [selectedOnly]?)</td></tr>
  212. <tr class="separator:ab6e816c3694e8b6119bf9ac3f5556f32 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  213. <tr class="memitem:a216228c27df224ac5e8d3590494bfb3f inherit pub_methods_classSimObject" id="r_a216228c27df224ac5e8d3590494bfb3f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a216228c27df224ac5e8d3590494bfb3f">addFieldFilter</a> (fieldName)</td></tr>
  214. <tr class="separator:a216228c27df224ac5e8d3590494bfb3f inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  215. <tr class="memitem:ad517bd83c1c853985ab07cd22775c43d inherit pub_methods_classSimObject" id="r_ad517bd83c1c853985ab07cd22775c43d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ad517bd83c1c853985ab07cd22775c43d">removeFieldFilter</a> (fieldName)</td></tr>
  216. <tr class="separator:ad517bd83c1c853985ab07cd22775c43d inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  217. </table>
  218. <h2 class="groupheader">Member Function Documentation</h2>
  219. <a id="a661877efc80bda257929f0c7fcc1db6e" name="a661877efc80bda257929f0c7fcc1db6e"></a>
  220. <h2 class="memtitle"><span class="permalink"><a href="#a661877efc80bda257929f0c7fcc1db6e">&#9670;&#160;</a></span>addDataKey()</h2>
  221. <div class="memitem">
  222. <div class="memproto">
  223. <table class="memname">
  224. <tr>
  225. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> addDataKey </td>
  226. <td>(</td>
  227. <td class="paramtype">time&#160;</td>
  228. <td class="paramname">, </td>
  229. </tr>
  230. <tr>
  231. <td class="paramkey"></td>
  232. <td></td>
  233. <td class="paramtype">value&#160;</td>
  234. <td class="paramname">&#160;</td>
  235. </tr>
  236. <tr>
  237. <td></td>
  238. <td>)</td>
  239. <td></td><td></td>
  240. </tr>
  241. </table>
  242. </div><div class="memdoc">
  243. <p>Add Data-Key to Graph. </p><dl class="params"><dt>Parameters</dt><dd>
  244. <table class="params">
  245. <tr><td class="paramname">time</td><td>The key time. </td></tr>
  246. <tr><td class="paramname">value</td><td>The value at specified time </td></tr>
  247. </table>
  248. </dd>
  249. </dl>
  250. <dl class="section return"><dt>Returns</dt><dd>Returns the index of the new data-key or -1 on failure. </dd></dl>
  251. </div>
  252. </div>
  253. <a id="a1d1b5e16fc63628c1c611cecaf15b404" name="a1d1b5e16fc63628c1c611cecaf15b404"></a>
  254. <h2 class="memtitle"><span class="permalink"><a href="#a1d1b5e16fc63628c1c611cecaf15b404">&#9670;&#160;</a></span>addEmitter()</h2>
  255. <div class="memitem">
  256. <div class="memproto">
  257. <table class="memname">
  258. <tr>
  259. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> addEmitter </td>
  260. <td>(</td>
  261. <td class="paramtype">emitterId&#160;</td>
  262. <td class="paramname"></td><td>)</td>
  263. <td></td>
  264. </tr>
  265. </table>
  266. </div><div class="memdoc">
  267. <p>Adds an existing emitter. </p><dl class="params"><dt>Parameters</dt><dd>
  268. <table class="params">
  269. <tr><td class="paramname">emitterId</td><td>The emitter to add. </td></tr>
  270. </table>
  271. </dd>
  272. </dl>
  273. <dl class="section return"><dt>Returns</dt><dd>On success it returns the ID of the emitter, or 0 if failed. </dd></dl>
  274. </div>
  275. </div>
  276. <a id="a5ea08dae807ec842c6cbe234f3c7b007" name="a5ea08dae807ec842c6cbe234f3c7b007"></a>
  277. <h2 class="memtitle"><span class="permalink"><a href="#a5ea08dae807ec842c6cbe234f3c7b007">&#9670;&#160;</a></span>clearDataKeys()</h2>
  278. <div class="memitem">
  279. <div class="memproto">
  280. <table class="memname">
  281. <tr>
  282. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> clearDataKeys </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>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>
  290. </div>
  291. </div>
  292. <a id="a1ab6f23a794d831d90c80723e6b7989a" name="a1ab6f23a794d831d90c80723e6b7989a"></a>
  293. <h2 class="memtitle"><span class="permalink"><a href="#a1ab6f23a794d831d90c80723e6b7989a">&#9670;&#160;</a></span>clearEmitters()</h2>
  294. <div class="memitem">
  295. <div class="memproto">
  296. <table class="memname">
  297. <tr>
  298. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> clearEmitters </td>
  299. <td>(</td>
  300. <td class="paramname"></td><td>)</td>
  301. <td></td>
  302. </tr>
  303. </table>
  304. </div><div class="memdoc">
  305. <p>Clear all the emitters. </p><dl class="section return"><dt>Returns</dt><dd>No return Value. </dd></dl>
  306. </div>
  307. </div>
  308. <a id="ae0395abb61c191a0b2e89e8e6c24ee3b" name="ae0395abb61c191a0b2e89e8e6c24ee3b"></a>
  309. <h2 class="memtitle"><span class="permalink"><a href="#ae0395abb61c191a0b2e89e8e6c24ee3b">&#9670;&#160;</a></span>createEmitter()</h2>
  310. <div class="memitem">
  311. <div class="memproto">
  312. <table class="memname">
  313. <tr>
  314. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> createEmitter </td>
  315. <td>(</td>
  316. <td class="paramname"></td><td>)</td>
  317. <td></td>
  318. </tr>
  319. </table>
  320. </div><div class="memdoc">
  321. <p>Emitter asset methods. </p>
  322. <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>
  323. </div>
  324. </div>
  325. <a id="a843788246e9ab1fc7433e8a44e1d1192" name="a843788246e9ab1fc7433e8a44e1d1192"></a>
  326. <h2 class="memtitle"><span class="permalink"><a href="#a843788246e9ab1fc7433e8a44e1d1192">&#9670;&#160;</a></span>deselectField()</h2>
  327. <div class="memitem">
  328. <div class="memproto">
  329. <table class="memname">
  330. <tr>
  331. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> deselectField </td>
  332. <td>(</td>
  333. <td class="paramname"></td><td>)</td>
  334. <td></td>
  335. </tr>
  336. </table>
  337. </div><div class="memdoc">
  338. <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>
  339. </div>
  340. </div>
  341. <a id="a385322400d9d2117450fd74e1eb0098c" name="a385322400d9d2117450fd74e1eb0098c"></a>
  342. <h2 class="memtitle"><span class="permalink"><a href="#a385322400d9d2117450fd74e1eb0098c">&#9670;&#160;</a></span>findEmitter()</h2>
  343. <div class="memitem">
  344. <div class="memproto">
  345. <table class="memname">
  346. <tr>
  347. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> findEmitter </td>
  348. <td>(</td>
  349. <td class="paramtype">emitterName&#160;</td>
  350. <td class="paramname"></td><td>)</td>
  351. <td></td>
  352. </tr>
  353. </table>
  354. </div><div class="memdoc">
  355. <p>Finds the emitter by its name. </p><dl class="params"><dt>Parameters</dt><dd>
  356. <table class="params">
  357. <tr><td class="paramname">emitterName</td><td>The name of the desired emitter. </td></tr>
  358. </table>
  359. </dd>
  360. </dl>
  361. <dl class="section return"><dt>Returns</dt><dd>The emitter or 0 if not found. </dd></dl>
  362. </div>
  363. </div>
  364. <a id="ab2acadc7a7a23cab17732311824d2720" name="ab2acadc7a7a23cab17732311824d2720"></a>
  365. <h2 class="memtitle"><span class="permalink"><a href="#ab2acadc7a7a23cab17732311824d2720">&#9670;&#160;</a></span>getDataKey()</h2>
  366. <div class="memitem">
  367. <div class="memproto">
  368. <table class="memname">
  369. <tr>
  370. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getDataKey </td>
  371. <td>(</td>
  372. <td class="paramtype">keyIndex&#160;</td>
  373. <td class="paramname"></td><td>)</td>
  374. <td></td>
  375. </tr>
  376. </table>
  377. </div><div class="memdoc">
  378. <p>Gets the data-key at the specified index from the field. </p><dl class="params"><dt>Parameters</dt><dd>
  379. <table class="params">
  380. <tr><td class="paramname">keyIndex</td><td>The index of the data-key to be retrieved. </td></tr>
  381. </table>
  382. </dd>
  383. </dl>
  384. <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>
  385. </div>
  386. </div>
  387. <a id="ac426c7befe25b1edfab3b681204e2a64" name="ac426c7befe25b1edfab3b681204e2a64"></a>
  388. <h2 class="memtitle"><span class="permalink"><a href="#ac426c7befe25b1edfab3b681204e2a64">&#9670;&#160;</a></span>getDataKeyCount()</h2>
  389. <div class="memitem">
  390. <div class="memproto">
  391. <table class="memname">
  392. <tr>
  393. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getDataKeyCount </td>
  394. <td>(</td>
  395. <td class="paramname"></td><td>)</td>
  396. <td></td>
  397. </tr>
  398. </table>
  399. </div><div class="memdoc">
  400. <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>
  401. </div>
  402. </div>
  403. <a id="afa661ee087b2e7625c3676cbed5bab50" name="afa661ee087b2e7625c3676cbed5bab50"></a>
  404. <h2 class="memtitle"><span class="permalink"><a href="#afa661ee087b2e7625c3676cbed5bab50">&#9670;&#160;</a></span>getEmitter()</h2>
  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> getEmitter </td>
  410. <td>(</td>
  411. <td class="paramtype">emitterIndex&#160;</td>
  412. <td class="paramname"></td><td>)</td>
  413. <td></td>
  414. </tr>
  415. </table>
  416. </div><div class="memdoc">
  417. <p>Gets the emitter at the specified index. </p><dl class="params"><dt>Parameters</dt><dd>
  418. <table class="params">
  419. <tr><td class="paramname">emitterIndex</td><td>The index for the desired emitter </td></tr>
  420. </table>
  421. </dd>
  422. </dl>
  423. <dl class="section return"><dt>Returns</dt><dd>The emitter or 0 if not found. </dd></dl>
  424. </div>
  425. </div>
  426. <a id="ac6bab688c21c2f80dc43acf1405683ff" name="ac6bab688c21c2f80dc43acf1405683ff"></a>
  427. <h2 class="memtitle"><span class="permalink"><a href="#ac6bab688c21c2f80dc43acf1405683ff">&#9670;&#160;</a></span>getEmitterCount()</h2>
  428. <div class="memitem">
  429. <div class="memproto">
  430. <table class="memname">
  431. <tr>
  432. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getEmitterCount </td>
  433. <td>(</td>
  434. <td class="paramname"></td><td>)</td>
  435. <td></td>
  436. </tr>
  437. </table>
  438. </div><div class="memdoc">
  439. <p>Gets the emitter count. </p><dl class="section return"><dt>Returns</dt><dd>Returns the number of emitters as an integer. </dd></dl>
  440. </div>
  441. </div>
  442. <a id="a466b00bf2f5ae8d2c04f5756b9074cca" name="a466b00bf2f5ae8d2c04f5756b9074cca"></a>
  443. <h2 class="memtitle"><span class="permalink"><a href="#a466b00bf2f5ae8d2c04f5756b9074cca">&#9670;&#160;</a></span>getFieldValue()</h2>
  444. <div class="memitem">
  445. <div class="memproto">
  446. <table class="memname">
  447. <tr>
  448. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> getFieldValue </td>
  449. <td>(</td>
  450. <td class="paramtype">time&#160;</td>
  451. <td class="paramname"></td><td>)</td>
  452. <td></td>
  453. </tr>
  454. </table>
  455. </div><div class="memdoc">
  456. <p>Get the fields' value at the specified time. </p><dl class="params"><dt>Parameters</dt><dd>
  457. <table class="params">
  458. <tr><td class="paramname">time</td><td>The time to sample the field value at. </td></tr>
  459. </table>
  460. </dd>
  461. </dl>
  462. <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>
  463. </div>
  464. </div>
  465. <a id="a2bbe9bb6823e05dc4eba062c174e9ab2" name="a2bbe9bb6823e05dc4eba062c174e9ab2"></a>
  466. <h2 class="memtitle"><span class="permalink"><a href="#a2bbe9bb6823e05dc4eba062c174e9ab2">&#9670;&#160;</a></span>getLifeMode()</h2>
  467. <div class="memitem">
  468. <div class="memproto">
  469. <table class="memname">
  470. <tr>
  471. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getLifeMode </td>
  472. <td>(</td>
  473. <td class="paramname"></td><td>)</td>
  474. <td></td>
  475. </tr>
  476. </table>
  477. </div><div class="memdoc">
  478. <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>
  479. </div>
  480. </div>
  481. <a id="a2a9c38808ac39f8c7eedde432e8a452d" name="a2a9c38808ac39f8c7eedde432e8a452d"></a>
  482. <h2 class="memtitle"><span class="permalink"><a href="#a2a9c38808ac39f8c7eedde432e8a452d">&#9670;&#160;</a></span>getLifetime()</h2>
  483. <div class="memitem">
  484. <div class="memproto">
  485. <table class="memname">
  486. <tr>
  487. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> getLifetime </td>
  488. <td>(</td>
  489. <td class="paramname"></td><td>)</td>
  490. <td></td>
  491. </tr>
  492. </table>
  493. </div><div class="memdoc">
  494. <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>
  495. </div>
  496. </div>
  497. <a id="a085c21d4754924f9b2319b0110b78938" name="a085c21d4754924f9b2319b0110b78938"></a>
  498. <h2 class="memtitle"><span class="permalink"><a href="#a085c21d4754924f9b2319b0110b78938">&#9670;&#160;</a></span>getMaxTime()</h2>
  499. <div class="memitem">
  500. <div class="memproto">
  501. <table class="memname">
  502. <tr>
  503. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> getMaxTime </td>
  504. <td>(</td>
  505. <td class="paramname"></td><td>)</td>
  506. <td></td>
  507. </tr>
  508. </table>
  509. </div><div class="memdoc">
  510. <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>
  511. </div>
  512. </div>
  513. <a id="a5a54f4d46ac4ffb04c059c68cbe5f64b" name="a5a54f4d46ac4ffb04c059c68cbe5f64b"></a>
  514. <h2 class="memtitle"><span class="permalink"><a href="#a5a54f4d46ac4ffb04c059c68cbe5f64b">&#9670;&#160;</a></span>getMaxValue()</h2>
  515. <div class="memitem">
  516. <div class="memproto">
  517. <table class="memname">
  518. <tr>
  519. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> getMaxValue </td>
  520. <td>(</td>
  521. <td class="paramname"></td><td>)</td>
  522. <td></td>
  523. </tr>
  524. </table>
  525. </div><div class="memdoc">
  526. <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>
  527. </div>
  528. </div>
  529. <a id="a32b94c28efd67a5573e4687006ebab28" name="a32b94c28efd67a5573e4687006ebab28"></a>
  530. <h2 class="memtitle"><span class="permalink"><a href="#a32b94c28efd67a5573e4687006ebab28">&#9670;&#160;</a></span>getMinTime()</h2>
  531. <div class="memitem">
  532. <div class="memproto">
  533. <table class="memname">
  534. <tr>
  535. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> getMinTime </td>
  536. <td>(</td>
  537. <td class="paramname"></td><td>)</td>
  538. <td></td>
  539. </tr>
  540. </table>
  541. </div><div class="memdoc">
  542. <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>
  543. </div>
  544. </div>
  545. <a id="a9fb1e6a5dab57b6b13f256978ca49cb8" name="a9fb1e6a5dab57b6b13f256978ca49cb8"></a>
  546. <h2 class="memtitle"><span class="permalink"><a href="#a9fb1e6a5dab57b6b13f256978ca49cb8">&#9670;&#160;</a></span>getMinValue()</h2>
  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#ga3eec930799ce76daa315153278a4cdb2">Float</a> getMinValue </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>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>
  559. </div>
  560. </div>
  561. <a id="ad13e14f410f6f2fdf10e5a588ff04248" name="ad13e14f410f6f2fdf10e5a588ff04248"></a>
  562. <h2 class="memtitle"><span class="permalink"><a href="#ad13e14f410f6f2fdf10e5a588ff04248">&#9670;&#160;</a></span>getRepeatTime()</h2>
  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#ga3eec930799ce76daa315153278a4cdb2">Float</a> getRepeatTime </td>
  568. <td>(</td>
  569. <td class="paramname"></td><td>)</td>
  570. <td></td>
  571. </tr>
  572. </table>
  573. </div><div class="memdoc">
  574. <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>
  575. </div>
  576. </div>
  577. <a id="ad4adedf74d82244a76926b5bb1146cc5" name="ad4adedf74d82244a76926b5bb1146cc5"></a>
  578. <h2 class="memtitle"><span class="permalink"><a href="#ad4adedf74d82244a76926b5bb1146cc5">&#9670;&#160;</a></span>getSelectableFieldCount()</h2>
  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#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getSelectableFieldCount </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>Particle asset fields. </p>
  591. <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>
  592. </div>
  593. </div>
  594. <a id="a656410eca241806469458e50fe0143d9" name="a656410eca241806469458e50fe0143d9"></a>
  595. <h2 class="memtitle"><span class="permalink"><a href="#a656410eca241806469458e50fe0143d9">&#9670;&#160;</a></span>getSelectableFieldName()</h2>
  596. <div class="memitem">
  597. <div class="memproto">
  598. <table class="memname">
  599. <tr>
  600. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getSelectableFieldName </td>
  601. <td>(</td>
  602. <td class="paramtype">fieldIndex&#160;</td>
  603. <td class="paramname"></td><td>)</td>
  604. <td></td>
  605. </tr>
  606. </table>
  607. </div><div class="memdoc">
  608. <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>
  609. </div>
  610. </div>
  611. <a id="a3c6738b3947f0305f0092733a07c0716" name="a3c6738b3947f0305f0092733a07c0716"></a>
  612. <h2 class="memtitle"><span class="permalink"><a href="#a3c6738b3947f0305f0092733a07c0716">&#9670;&#160;</a></span>getSelectedField()</h2>
  613. <div class="memitem">
  614. <div class="memproto">
  615. <table class="memname">
  616. <tr>
  617. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getSelectedField </td>
  618. <td>(</td>
  619. <td class="paramname"></td><td>)</td>
  620. <td></td>
  621. </tr>
  622. </table>
  623. </div><div class="memdoc">
  624. <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>
  625. </div>
  626. </div>
  627. <a id="ad9ee1e1a6b7f314ca7a70c3a838bcc2f" name="ad9ee1e1a6b7f314ca7a70c3a838bcc2f"></a>
  628. <h2 class="memtitle"><span class="permalink"><a href="#ad9ee1e1a6b7f314ca7a70c3a838bcc2f">&#9670;&#160;</a></span>getValueScale()</h2>
  629. <div class="memitem">
  630. <div class="memproto">
  631. <table class="memname">
  632. <tr>
  633. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> getValueScale </td>
  634. <td>(</td>
  635. <td class="paramname"></td><td>)</td>
  636. <td></td>
  637. </tr>
  638. </table>
  639. </div><div class="memdoc">
  640. <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>
  641. </div>
  642. </div>
  643. <a id="a443b1046ecbc04804aef48641080c83c" name="a443b1046ecbc04804aef48641080c83c"></a>
  644. <h2 class="memtitle"><span class="permalink"><a href="#a443b1046ecbc04804aef48641080c83c">&#9670;&#160;</a></span>moveEmitter()</h2>
  645. <div class="memitem">
  646. <div class="memproto">
  647. <table class="memname">
  648. <tr>
  649. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> moveEmitter </td>
  650. <td>(</td>
  651. <td class="paramtype">fromEmitterIndex&#160;</td>
  652. <td class="paramname">, </td>
  653. </tr>
  654. <tr>
  655. <td class="paramkey"></td>
  656. <td></td>
  657. <td class="paramtype">toEmitterIndex&#160;</td>
  658. <td class="paramname">&#160;</td>
  659. </tr>
  660. <tr>
  661. <td></td>
  662. <td>)</td>
  663. <td></td><td></td>
  664. </tr>
  665. </table>
  666. </div><div class="memdoc">
  667. <p>Moves the emitter order. </p><dl class="params"><dt>Parameters</dt><dd>
  668. <table class="params">
  669. <tr><td class="paramname">fromEmitterIndex</td><td>The source index of the emitter to move. </td></tr>
  670. <tr><td class="paramname">toEmitterIndex</td><td>The destination index to move the emitter to. </td></tr>
  671. </table>
  672. </dd>
  673. </dl>
  674. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  675. </div>
  676. </div>
  677. <a id="a526f0ca594777e1e7898704644920bae" name="a526f0ca594777e1e7898704644920bae"></a>
  678. <h2 class="memtitle"><span class="permalink"><a href="#a526f0ca594777e1e7898704644920bae">&#9670;&#160;</a></span>removeDataKey()</h2>
  679. <div class="memitem">
  680. <div class="memproto">
  681. <table class="memname">
  682. <tr>
  683. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> removeDataKey </td>
  684. <td>(</td>
  685. <td class="paramtype">keyIndex&#160;</td>
  686. <td class="paramname"></td><td>)</td>
  687. <td></td>
  688. </tr>
  689. </table>
  690. </div><div class="memdoc">
  691. <p>Remove the data-key from the field. </p><dl class="params"><dt>Parameters</dt><dd>
  692. <table class="params">
  693. <tr><td class="paramname">keyIndex</td><td>The index of the data-key you want to remove. </td></tr>
  694. </table>
  695. </dd>
  696. </dl>
  697. <dl class="section return"><dt>Returns</dt><dd>Whether the operation was successful or not. </dd></dl>
  698. </div>
  699. </div>
  700. <a id="acedca9c1eb5157fdcb03dacf76bcbe92" name="acedca9c1eb5157fdcb03dacf76bcbe92"></a>
  701. <h2 class="memtitle"><span class="permalink"><a href="#acedca9c1eb5157fdcb03dacf76bcbe92">&#9670;&#160;</a></span>removeEmitter()</h2>
  702. <div class="memitem">
  703. <div class="memproto">
  704. <table class="memname">
  705. <tr>
  706. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> removeEmitter </td>
  707. <td>(</td>
  708. <td class="paramtype">emitterId&#160;</td>
  709. <td class="paramname"></td><td>)</td>
  710. <td></td>
  711. </tr>
  712. </table>
  713. </div><div class="memdoc">
  714. <p>Removes an emitter. </p><dl class="params"><dt>Parameters</dt><dd>
  715. <table class="params">
  716. <tr><td class="paramname">emitterId</td><td>The emitter to remove. </td></tr>
  717. </table>
  718. </dd>
  719. </dl>
  720. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  721. </div>
  722. </div>
  723. <a id="a687d85d8bb36cbb086bc6d7df4b1bee9" name="a687d85d8bb36cbb086bc6d7df4b1bee9"></a>
  724. <h2 class="memtitle"><span class="permalink"><a href="#a687d85d8bb36cbb086bc6d7df4b1bee9">&#9670;&#160;</a></span>selectField()</h2>
  725. <div class="memitem">
  726. <div class="memproto">
  727. <table class="memname">
  728. <tr>
  729. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> selectField </td>
  730. <td>(</td>
  731. <td class="paramtype">fieldName&#160;</td>
  732. <td class="paramname"></td><td>)</td>
  733. <td></td>
  734. </tr>
  735. </table>
  736. </div><div class="memdoc">
  737. <p>Select the specified field by its name. </p><dl class="params"><dt>Parameters</dt><dd>
  738. <table class="params">
  739. <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>
  740. </table>
  741. </dd>
  742. </dl>
  743. <dl class="section return"><dt>Returns</dt><dd>Whether the field was successfully selected or not. </dd></dl>
  744. </div>
  745. </div>
  746. <a id="aaf6e29780456083fd9ec57880063a12a" name="aaf6e29780456083fd9ec57880063a12a"></a>
  747. <h2 class="memtitle"><span class="permalink"><a href="#aaf6e29780456083fd9ec57880063a12a">&#9670;&#160;</a></span>setDataKeyValue()</h2>
  748. <div class="memitem">
  749. <div class="memproto">
  750. <table class="memname">
  751. <tr>
  752. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> setDataKeyValue </td>
  753. <td>(</td>
  754. <td class="paramtype">keyIndex&#160;</td>
  755. <td class="paramname">, </td>
  756. </tr>
  757. <tr>
  758. <td class="paramkey"></td>
  759. <td></td>
  760. <td class="paramtype">value&#160;</td>
  761. <td class="paramname">&#160;</td>
  762. </tr>
  763. <tr>
  764. <td></td>
  765. <td>)</td>
  766. <td></td><td></td>
  767. </tr>
  768. </table>
  769. </div><div class="memdoc">
  770. <p>Set data-key value for the field. </p><dl class="params"><dt>Parameters</dt><dd>
  771. <table class="params">
  772. <tr><td class="paramname">keyIndex</td><td>The index of the key to be modified. </td></tr>
  773. <tr><td class="paramname">value</td><td>The value to change the key to. </td></tr>
  774. </table>
  775. </dd>
  776. </dl>
  777. <dl class="section return"><dt>Returns</dt><dd>Whether the operation was successful or not. </dd></dl>
  778. </div>
  779. </div>
  780. <a id="ae2b8cff4324629987e69f1d4557b9619" name="ae2b8cff4324629987e69f1d4557b9619"></a>
  781. <h2 class="memtitle"><span class="permalink"><a href="#ae2b8cff4324629987e69f1d4557b9619">&#9670;&#160;</a></span>setLifeMode()</h2>
  782. <div class="memitem">
  783. <div class="memproto">
  784. <table class="memname">
  785. <tr>
  786. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> setLifeMode </td>
  787. <td>(</td>
  788. <td class="paramtype">lifeMode&#160;</td>
  789. <td class="paramname"></td><td>)</td>
  790. <td></td>
  791. </tr>
  792. </table>
  793. </div><div class="memdoc">
  794. <p>Particle asset accessors. </p>
  795. <p>Sets the life-mode of the particle effect. </p><dl class="params"><dt>Parameters</dt><dd>
  796. <table class="params">
  797. <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>
  798. </table>
  799. </dd>
  800. </dl>
  801. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  802. </div>
  803. </div>
  804. <a id="a986da5eaa0f93b8b350c6398be9b9794" name="a986da5eaa0f93b8b350c6398be9b9794"></a>
  805. <h2 class="memtitle"><span class="permalink"><a href="#a986da5eaa0f93b8b350c6398be9b9794">&#9670;&#160;</a></span>setLifetime()</h2>
  806. <div class="memitem">
  807. <div class="memproto">
  808. <table class="memname">
  809. <tr>
  810. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> setLifetime </td>
  811. <td>(</td>
  812. <td class="paramtype">lifeTime&#160;</td>
  813. <td class="paramname"></td><td>)</td>
  814. <td></td>
  815. </tr>
  816. </table>
  817. </div><div class="memdoc">
  818. <p>Sets the lifetime of the particle effect. </p><dl class="params"><dt>Parameters</dt><dd>
  819. <table class="params">
  820. <tr><td class="paramname">lifeTime</td><td>The lifetime of the particle effect. This is used according to the 'lifeMode' setting. </td></tr>
  821. </table>
  822. </dd>
  823. </dl>
  824. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  825. </div>
  826. </div>
  827. <a id="aa2fc6f92b94e635e603073bfdb564284" name="aa2fc6f92b94e635e603073bfdb564284"></a>
  828. <h2 class="memtitle"><span class="permalink"><a href="#aa2fc6f92b94e635e603073bfdb564284">&#9670;&#160;</a></span>setRepeatTime()</h2>
  829. <div class="memitem">
  830. <div class="memproto">
  831. <table class="memname">
  832. <tr>
  833. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> setRepeatTime </td>
  834. <td>(</td>
  835. <td class="paramtype">repeatTime&#160;</td>
  836. <td class="paramname"></td><td>)</td>
  837. <td></td>
  838. </tr>
  839. </table>
  840. </div><div class="memdoc">
  841. <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>
  842. </div>
  843. </div>
  844. <a id="a000c741e5c68b4571838f58d26ccb667" name="a000c741e5c68b4571838f58d26ccb667"></a>
  845. <h2 class="memtitle"><span class="permalink"><a href="#a000c741e5c68b4571838f58d26ccb667">&#9670;&#160;</a></span>setSingleDataKey()</h2>
  846. <div class="memitem">
  847. <div class="memproto">
  848. <table class="memname">
  849. <tr>
  850. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> setSingleDataKey </td>
  851. <td>(</td>
  852. <td class="paramtype">value&#160;</td>
  853. <td class="paramname"></td><td>)</td>
  854. <td></td>
  855. </tr>
  856. </table>
  857. </div><div class="memdoc">
  858. <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>
  859. <table class="params">
  860. <tr><td class="paramname">value</td><td>The value to set the key to. </td></tr>
  861. </table>
  862. </dd>
  863. </dl>
  864. <dl class="section return"><dt>Returns</dt><dd>Returns the index of the new data-key (always zero) or -1 on failure. </dd></dl>
  865. </div>
  866. </div>
  867. <a id="a0f8cf197492e13fe524358f1e25be836" name="a0f8cf197492e13fe524358f1e25be836"></a>
  868. <h2 class="memtitle"><span class="permalink"><a href="#a0f8cf197492e13fe524358f1e25be836">&#9670;&#160;</a></span>setValueScale()</h2>
  869. <div class="memitem">
  870. <div class="memproto">
  871. <table class="memname">
  872. <tr>
  873. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> setValueScale </td>
  874. <td>(</td>
  875. <td class="paramtype">valueScale&#160;</td>
  876. <td class="paramname"></td><td>)</td>
  877. <td></td>
  878. </tr>
  879. </table>
  880. </div><div class="memdoc">
  881. <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>
  882. <table class="params">
  883. <tr><td class="paramname">valueScale</td><td>The scale for field values retrieved from the field. </td></tr>
  884. </table>
  885. </dd>
  886. </dl>
  887. <dl class="section return"><dt>Returns</dt><dd>Whether the operation was successful or not. </dd></dl>
  888. </div>
  889. </div>
  890. </div><!-- contents -->
  891. <!-- start footer part -->
  892. <hr class="footer"/><address class="footer"><small>
  893. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
  894. </small></address>
  895. </body>
  896. </html>