| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=9"/>
- <meta name="generator" content="Doxygen 1.8.3.1"/>
- <title>TorqueScript Reference: ParticleAsset Class Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr style="height: 56px;">
- <td style="padding-left: 0.5em;">
- <div id="projectname">TorqueScript Reference
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.3.1 -->
- <div id="navrow1" class="tabs">
- <ul class="tablist">
- <li><a href="index.html"><span>Main Page</span></a></li>
- <li><a href="pages.html"><span>Related Pages</span></a></li>
- <li><a href="modules.html"><span>Modules</span></a></li>
- <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
- </ul>
- </div>
- <div id="navrow2" class="tabs2">
- <ul class="tablist">
- <li><a href="annotated.html"><span>Class List</span></a></li>
- <li><a href="classes.html"><span>Class Index</span></a></li>
- <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
- <li><a href="functions.html"><span>Class Members</span></a></li>
- </ul>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="classParticleAsset-members.html">List of all members</a> </div>
- <div class="headertitle">
- <div class="title">ParticleAsset Class Reference</div> </div>
- </div><!--header-->
- <div class="contents">
- <p>Inherits <a class="el" href="classAssetBase.html">AssetBase</a>.</p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:a661877efc80bda257929f0c7fcc1db6e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a661877efc80bda257929f0c7fcc1db6e">addDataKey</a> (time, value)</td></tr>
- <tr class="separator:a661877efc80bda257929f0c7fcc1db6e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1d1b5e16fc63628c1c611cecaf15b404"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a1d1b5e16fc63628c1c611cecaf15b404">addEmitter</a> (emitterId)</td></tr>
- <tr class="separator:a1d1b5e16fc63628c1c611cecaf15b404"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5ea08dae807ec842c6cbe234f3c7b007"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a5ea08dae807ec842c6cbe234f3c7b007">clearDataKeys</a> ()</td></tr>
- <tr class="separator:a5ea08dae807ec842c6cbe234f3c7b007"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1ab6f23a794d831d90c80723e6b7989a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a1ab6f23a794d831d90c80723e6b7989a">clearEmitters</a> ()</td></tr>
- <tr class="separator:a1ab6f23a794d831d90c80723e6b7989a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae0395abb61c191a0b2e89e8e6c24ee3b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#ae0395abb61c191a0b2e89e8e6c24ee3b">createEmitter</a> ()</td></tr>
- <tr class="memdesc:ae0395abb61c191a0b2e89e8e6c24ee3b"><td class="mdescLeft"> </td><td class="mdescRight">Emitter asset methods. <a href="#ae0395abb61c191a0b2e89e8e6c24ee3b">More...</a><br/></td></tr>
- <tr class="separator:ae0395abb61c191a0b2e89e8e6c24ee3b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a843788246e9ab1fc7433e8a44e1d1192"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a843788246e9ab1fc7433e8a44e1d1192">deselectField</a> ()</td></tr>
- <tr class="separator:a843788246e9ab1fc7433e8a44e1d1192"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a385322400d9d2117450fd74e1eb0098c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a385322400d9d2117450fd74e1eb0098c">findEmitter</a> (emitterName)</td></tr>
- <tr class="separator:a385322400d9d2117450fd74e1eb0098c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab2acadc7a7a23cab17732311824d2720"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#ab2acadc7a7a23cab17732311824d2720">getDataKey</a> (keyIndex)</td></tr>
- <tr class="separator:ab2acadc7a7a23cab17732311824d2720"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac426c7befe25b1edfab3b681204e2a64"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#ac426c7befe25b1edfab3b681204e2a64">getDataKeyCount</a> ()</td></tr>
- <tr class="separator:ac426c7befe25b1edfab3b681204e2a64"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:afa661ee087b2e7625c3676cbed5bab50"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#afa661ee087b2e7625c3676cbed5bab50">getEmitter</a> (emitterIndex)</td></tr>
- <tr class="separator:afa661ee087b2e7625c3676cbed5bab50"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac6bab688c21c2f80dc43acf1405683ff"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#ac6bab688c21c2f80dc43acf1405683ff">getEmitterCount</a> ()</td></tr>
- <tr class="separator:ac6bab688c21c2f80dc43acf1405683ff"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a466b00bf2f5ae8d2c04f5756b9074cca"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a466b00bf2f5ae8d2c04f5756b9074cca">getFieldValue</a> (time)</td></tr>
- <tr class="separator:a466b00bf2f5ae8d2c04f5756b9074cca"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2bbe9bb6823e05dc4eba062c174e9ab2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a2bbe9bb6823e05dc4eba062c174e9ab2">getLifeMode</a> ()</td></tr>
- <tr class="separator:a2bbe9bb6823e05dc4eba062c174e9ab2"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2a9c38808ac39f8c7eedde432e8a452d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a2a9c38808ac39f8c7eedde432e8a452d">getLifetime</a> ()</td></tr>
- <tr class="separator:a2a9c38808ac39f8c7eedde432e8a452d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a085c21d4754924f9b2319b0110b78938"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a085c21d4754924f9b2319b0110b78938">getMaxTime</a> ()</td></tr>
- <tr class="separator:a085c21d4754924f9b2319b0110b78938"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5a54f4d46ac4ffb04c059c68cbe5f64b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a5a54f4d46ac4ffb04c059c68cbe5f64b">getMaxValue</a> ()</td></tr>
- <tr class="separator:a5a54f4d46ac4ffb04c059c68cbe5f64b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a32b94c28efd67a5573e4687006ebab28"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a32b94c28efd67a5573e4687006ebab28">getMinTime</a> ()</td></tr>
- <tr class="separator:a32b94c28efd67a5573e4687006ebab28"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9fb1e6a5dab57b6b13f256978ca49cb8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a9fb1e6a5dab57b6b13f256978ca49cb8">getMinValue</a> ()</td></tr>
- <tr class="separator:a9fb1e6a5dab57b6b13f256978ca49cb8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad13e14f410f6f2fdf10e5a588ff04248"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#ad13e14f410f6f2fdf10e5a588ff04248">getRepeatTime</a> ()</td></tr>
- <tr class="separator:ad13e14f410f6f2fdf10e5a588ff04248"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad4adedf74d82244a76926b5bb1146cc5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#ad4adedf74d82244a76926b5bb1146cc5">getSelectableFieldCount</a> ()</td></tr>
- <tr class="memdesc:ad4adedf74d82244a76926b5bb1146cc5"><td class="mdescLeft"> </td><td class="mdescRight">Particle asset fields. <a href="#ad4adedf74d82244a76926b5bb1146cc5">More...</a><br/></td></tr>
- <tr class="separator:ad4adedf74d82244a76926b5bb1146cc5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a656410eca241806469458e50fe0143d9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a656410eca241806469458e50fe0143d9">getSelectableFieldName</a> (fieldIndex)</td></tr>
- <tr class="separator:a656410eca241806469458e50fe0143d9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aff94cac6249b1c587e26cb64c715b0fe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#aff94cac6249b1c587e26cb64c715b0fe">getSelectedField</a> ()</td></tr>
- <tr class="separator:aff94cac6249b1c587e26cb64c715b0fe"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad9ee1e1a6b7f314ca7a70c3a838bcc2f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#ad9ee1e1a6b7f314ca7a70c3a838bcc2f">getValueScale</a> ()</td></tr>
- <tr class="separator:ad9ee1e1a6b7f314ca7a70c3a838bcc2f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a443b1046ecbc04804aef48641080c83c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a443b1046ecbc04804aef48641080c83c">moveEmitter</a> (fromEmitterIndex, toEmitterIndex)</td></tr>
- <tr class="separator:a443b1046ecbc04804aef48641080c83c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a526f0ca594777e1e7898704644920bae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a526f0ca594777e1e7898704644920bae">removeDataKey</a> (keyIndex)</td></tr>
- <tr class="separator:a526f0ca594777e1e7898704644920bae"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5903b2583332c1d807e353fad28a344f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a5903b2583332c1d807e353fad28a344f">removeEmitter</a> (emitterId,[bool deleteEmitter])</td></tr>
- <tr class="separator:a5903b2583332c1d807e353fad28a344f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a687d85d8bb36cbb086bc6d7df4b1bee9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a687d85d8bb36cbb086bc6d7df4b1bee9">selectField</a> (fieldName)</td></tr>
- <tr class="separator:a687d85d8bb36cbb086bc6d7df4b1bee9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aaf6e29780456083fd9ec57880063a12a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#aaf6e29780456083fd9ec57880063a12a">setDataKeyValue</a> (keyIndex, value)</td></tr>
- <tr class="separator:aaf6e29780456083fd9ec57880063a12a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae2b8cff4324629987e69f1d4557b9619"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#ae2b8cff4324629987e69f1d4557b9619">setLifeMode</a> (lifeMode)</td></tr>
- <tr class="memdesc:ae2b8cff4324629987e69f1d4557b9619"><td class="mdescLeft"> </td><td class="mdescRight">Particle asset accessors. <a href="#ae2b8cff4324629987e69f1d4557b9619">More...</a><br/></td></tr>
- <tr class="separator:ae2b8cff4324629987e69f1d4557b9619"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a986da5eaa0f93b8b350c6398be9b9794"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a986da5eaa0f93b8b350c6398be9b9794">setLifetime</a> (lifeTime)</td></tr>
- <tr class="separator:a986da5eaa0f93b8b350c6398be9b9794"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa2fc6f92b94e635e603073bfdb564284"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#aa2fc6f92b94e635e603073bfdb564284">setRepeatTime</a> (repeatTime)</td></tr>
- <tr class="separator:aa2fc6f92b94e635e603073bfdb564284"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a000c741e5c68b4571838f58d26ccb667"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a000c741e5c68b4571838f58d26ccb667">setSingleDataKey</a> (value)</td></tr>
- <tr class="separator:a000c741e5c68b4571838f58d26ccb667"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0f8cf197492e13fe524358f1e25be836"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a0f8cf197492e13fe524358f1e25be836">setValueScale</a> (valueScale)</td></tr>
- <tr class="separator:a0f8cf197492e13fe524358f1e25be836"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_methods_classAssetBase"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classAssetBase')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classAssetBase.html">AssetBase</a></td></tr>
- <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> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAssetBase.html#a927651202ec0b50abd34a632d7571992">getAssetId</a> ()</td></tr>
- <tr class="separator:a927651202ec0b50abd34a632d7571992 inherit pub_methods_classAssetBase"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a00b3d3cf0e2bb08d4c268f34610bfaa6 inherit pub_methods_classAssetBase"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAssetBase.html#a00b3d3cf0e2bb08d4c268f34610bfaa6">refreshAsset</a> ()</td></tr>
- <tr class="separator:a00b3d3cf0e2bb08d4c268f34610bfaa6 inherit pub_methods_classAssetBase"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_methods_classSimObject"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classSimObject')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classSimObject.html">SimObject</a></td></tr>
- <tr class="memitem:a22437f451ceb1429fa2a3be23d523954 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a22437f451ceb1429fa2a3be23d523954">clone</a> ([copyDynamicFields=false]?)</td></tr>
- <tr class="separator:a22437f451ceb1429fa2a3be23d523954 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a7a4721d0a51e952c211e9b0fea4d8090">delete</a> ()</td></tr>
- <tr class="separator:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a929e1325a515b279faca90a65028782e inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a929e1325a515b279faca90a65028782e">getId</a> ()</td></tr>
- <tr class="separator:a929e1325a515b279faca90a65028782e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a4f673cd959711ae09927e7c44dae5fdb">setName</a> (newName)</td></tr>
- <tr class="separator:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a78ee178b6a73658d65ca60da4d1e6683 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a78ee178b6a73658d65ca60da4d1e6683">getName</a> ()</td></tr>
- <tr class="separator:a78ee178b6a73658d65ca60da4d1e6683 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab8b0f8b874af628d7204d9cc2630ced7 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab8b0f8b874af628d7204d9cc2630ced7">getClassNamespace</a> ()</td></tr>
- <tr class="separator:ab8b0f8b874af628d7204d9cc2630ced7 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6e266d4432d70cad58461d96e1d2cbdf inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a6e266d4432d70cad58461d96e1d2cbdf">getSuperClassNamespace</a> ()</td></tr>
- <tr class="separator:a6e266d4432d70cad58461d96e1d2cbdf inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a847e859bcc5b58df83fa7f331c167c32 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a847e859bcc5b58df83fa7f331c167c32">setClassNamespace</a> (nameSpace)</td></tr>
- <tr class="separator:a847e859bcc5b58df83fa7f331c167c32 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a9cbf471b97387d5bdefb88f92094ad54">setSuperClassNamespace</a> ()</td></tr>
- <tr class="separator:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8f4e85d0903526235ed2ca86df69cdef inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a8f4e85d0903526235ed2ca86df69cdef">isMethod</a> (string methodName)</td></tr>
- <tr class="separator:a8f4e85d0903526235ed2ca86df69cdef inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa9873d392a76100738de2337c882f477 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa9873d392a76100738de2337c882f477">call</a> (methodName,[args]*)</td></tr>
- <tr class="separator:aa9873d392a76100738de2337c882f477 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1810f5aba25efd242c24232c2c2bbd1a">dumpClassHierarchy</a> ()</td></tr>
- <tr class="separator:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#accd2600060dbaee3a3b41aed4034c63c">dump</a> ()</td></tr>
- <tr class="separator:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a66ac731a8dc088fe8c8ab17bf7c9eecd inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a66ac731a8dc088fe8c8ab17bf7c9eecd">isMemberOfClass</a> (string classname)</td></tr>
- <tr class="separator:a66ac731a8dc088fe8c8ab17bf7c9eecd inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3e97a324df2af082cdb089491757ce11 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a3e97a324df2af082cdb089491757ce11">getClassName</a> ()</td></tr>
- <tr class="separator:a3e97a324df2af082cdb089491757ce11 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:abc2222a9649b5c033810e753b07f26a3 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#abc2222a9649b5c033810e753b07f26a3">getFieldValue</a> (fieldName)</td></tr>
- <tr class="separator:abc2222a9649b5c033810e753b07f26a3 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1084f1964e446b3d279943cf6e575069 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1084f1964e446b3d279943cf6e575069">setFieldValue</a> (fieldName, value)</td></tr>
- <tr class="separator:a1084f1964e446b3d279943cf6e575069 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7543b8dc494ec0d9034cb73ae504f3ca inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a7543b8dc494ec0d9034cb73ae504f3ca">getDynamicFieldCount</a> ()</td></tr>
- <tr class="separator:a7543b8dc494ec0d9034cb73ae504f3ca inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0e143217119b68d557d17ac2f13b173e inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0e143217119b68d557d17ac2f13b173e">getDynamicField</a> (index)</td></tr>
- <tr class="separator:a0e143217119b68d557d17ac2f13b173e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af2e74f6b683da8d2085f0991dab7948b inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#af2e74f6b683da8d2085f0991dab7948b">getFieldCount</a> ()</td></tr>
- <tr class="separator:af2e74f6b683da8d2085f0991dab7948b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac636f89189406eef1b401292459b1a3b inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ac636f89189406eef1b401292459b1a3b">getField</a> (int index)</td></tr>
- <tr class="separator:ac636f89189406eef1b401292459b1a3b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa8f68d1e6d8c6601c39b3f676f0e9c70">setProgenitorFile</a> (file)</td></tr>
- <tr class="separator:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a88c8d99755a07ac4648360dd40ff67a5 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a88c8d99755a07ac4648360dd40ff67a5">getProgenitorFile</a> ()</td></tr>
- <tr class="separator:a88c8d99755a07ac4648360dd40ff67a5 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a367706e675179342e6153c45f1ba06ae inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a367706e675179342e6153c45f1ba06ae">getType</a> ()</td></tr>
- <tr class="separator:a367706e675179342e6153c45f1ba06ae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0570b7f6eb94a0ed941fd75f6f01555b inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0570b7f6eb94a0ed941fd75f6f01555b">getFieldType</a> (fieldName)</td></tr>
- <tr class="separator:a0570b7f6eb94a0ed941fd75f6f01555b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a5aaca360a719feabae0e4e57b921deae">setInternalName</a> (string InternalName)</td></tr>
- <tr class="separator:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af9f341b474a28f4bcf79bc02439b7c18 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#af9f341b474a28f4bcf79bc02439b7c18">getInternalName</a> ()</td></tr>
- <tr class="separator:af9f341b474a28f4bcf79bc02439b7c18 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a986f1b4a76969bac5dfd50b22af8dec6 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a986f1b4a76969bac5dfd50b22af8dec6">isChildOfGroup</a> (groupID)</td></tr>
- <tr class="separator:a986f1b4a76969bac5dfd50b22af8dec6 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae329d6593bb3f9b8046e7cae693ccc09 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ae329d6593bb3f9b8046e7cae693ccc09">getGroup</a> ()</td></tr>
- <tr class="separator:ae329d6593bb3f9b8046e7cae693ccc09 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2dd2c7a365c19267d7a26923c7616afd inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a2dd2c7a365c19267d7a26923c7616afd">startTimer</a> (callbackFunction, float timePeriod,[repeat]?)</td></tr>
- <tr class="separator:a2dd2c7a365c19267d7a26923c7616afd inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa6f6bfef028c7b053444cbd48567d286">stopTimer</a> ()</td></tr>
- <tr class="separator:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5807c03d2b725a54732d09b53d5da631 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a5807c03d2b725a54732d09b53d5da631">isTimerActive</a> ()</td></tr>
- <tr class="separator:a5807c03d2b725a54732d09b53d5da631 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6b70a037ad6cea86b10fd5188f42bf52 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a6b70a037ad6cea86b10fd5188f42bf52">schedule</a> (time, command,[arg]*)</td></tr>
- <tr class="separator:a6b70a037ad6cea86b10fd5188f42bf52 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad4944a7132f9ee90f801f4cd57014836 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ad4944a7132f9ee90f801f4cd57014836">save</a> (<a class="el" href="group__FileSystemFunctions.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>,[selectedOnly]?)</td></tr>
- <tr class="separator:ad4944a7132f9ee90f801f4cd57014836 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a216228c27df224ac5e8d3590494bfb3f inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a216228c27df224ac5e8d3590494bfb3f">addFieldFilter</a> (fieldName)</td></tr>
- <tr class="separator:a216228c27df224ac5e8d3590494bfb3f inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad517bd83c1c853985ab07cd22775c43d inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ad517bd83c1c853985ab07cd22775c43d">removeFieldFilter</a> (fieldName)</td></tr>
- <tr class="separator:ad517bd83c1c853985ab07cd22775c43d inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a class="anchor" id="a661877efc80bda257929f0c7fcc1db6e"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> addDataKey </td>
- <td>(</td>
- <td class="paramtype">time </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">value </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Add Data-Key to Graph. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">time</td><td>The key time. </td></tr>
- <tr><td class="paramname">value</td><td>The value at specified time </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns the index of the new data-key or -1 on failure. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a1d1b5e16fc63628c1c611cecaf15b404"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> addEmitter </td>
- <td>(</td>
- <td class="paramtype">emitterId </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Adds an existing emitter. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">emitterId</td><td>The emitter to add. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>On success it returns the ID of the emitter, or 0 if failed. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a5ea08dae807ec842c6cbe234f3c7b007"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> clearDataKeys </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a class="anchor" id="a1ab6f23a794d831d90c80723e6b7989a"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void clearEmitters </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Clear all the emitters. </p>
- <dl class="section return"><dt>Returns</dt><dd>No return Value. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ae0395abb61c191a0b2e89e8e6c24ee3b"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> createEmitter </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Emitter asset methods. </p>
- <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>
- </div>
- </div>
- <a class="anchor" id="a843788246e9ab1fc7433e8a44e1d1192"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void deselectField </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a class="anchor" id="a385322400d9d2117450fd74e1eb0098c"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> findEmitter </td>
- <td>(</td>
- <td class="paramtype">emitterName </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Finds the emitter by its name. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">emitterName</td><td>The name of the desired emitter. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>The emitter or 0 if not found. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ab2acadc7a7a23cab17732311824d2720"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getDataKey </td>
- <td>(</td>
- <td class="paramtype">keyIndex </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Gets the data-key at the specified index from the field. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">keyIndex</td><td>The index of the data-key to be retrieved. </td></tr>
- </table>
- </dd>
- </dl>
- <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>
- </div>
- </div>
- <a class="anchor" id="ac426c7befe25b1edfab3b681204e2a64"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getDataKeyCount </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a class="anchor" id="afa661ee087b2e7625c3676cbed5bab50"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getEmitter </td>
- <td>(</td>
- <td class="paramtype">emitterIndex </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Gets the emitter at the specified index. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">emitterIndex</td><td>The index for the desired emitter </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>The emitter or 0 if not found. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ac6bab688c21c2f80dc43acf1405683ff"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getEmitterCount </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Gets the emitter count. </p>
- <dl class="section return"><dt>Returns</dt><dd>Returns the number of emitters as an integer. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a466b00bf2f5ae8d2c04f5756b9074cca"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> getFieldValue </td>
- <td>(</td>
- <td class="paramtype">time </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get the fields' value at the specified time. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">time</td><td>The time to sample the field value at. </td></tr>
- </table>
- </dd>
- </dl>
- <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>
- </div>
- </div>
- <a class="anchor" id="a2bbe9bb6823e05dc4eba062c174e9ab2"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getLifeMode </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a class="anchor" id="a2a9c38808ac39f8c7eedde432e8a452d"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> getLifetime </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a class="anchor" id="a085c21d4754924f9b2319b0110b78938"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> getMaxTime </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a class="anchor" id="a5a54f4d46ac4ffb04c059c68cbe5f64b"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> getMaxValue </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a class="anchor" id="a32b94c28efd67a5573e4687006ebab28"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> getMinTime </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a class="anchor" id="a9fb1e6a5dab57b6b13f256978ca49cb8"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> getMinValue </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a class="anchor" id="ad13e14f410f6f2fdf10e5a588ff04248"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> getRepeatTime </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a class="anchor" id="ad4adedf74d82244a76926b5bb1146cc5"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getSelectableFieldCount </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Particle asset fields. </p>
- <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>
- </div>
- </div>
- <a class="anchor" id="a656410eca241806469458e50fe0143d9"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getSelectableFieldName </td>
- <td>(</td>
- <td class="paramtype">fieldIndex </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a class="anchor" id="aff94cac6249b1c587e26cb64c715b0fe"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> getSelectedField </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a class="anchor" id="ad9ee1e1a6b7f314ca7a70c3a838bcc2f"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> getValueScale </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a class="anchor" id="a443b1046ecbc04804aef48641080c83c"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void moveEmitter </td>
- <td>(</td>
- <td class="paramtype">fromEmitterIndex </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">toEmitterIndex </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Moves the emitter order. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">fromEmitterIndex</td><td>The source index of the emitter to move. </td></tr>
- <tr><td class="paramname">toEmitterIndex</td><td>The destination index to move the emitter to. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a526f0ca594777e1e7898704644920bae"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> removeDataKey </td>
- <td>(</td>
- <td class="paramtype">keyIndex </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Remove the data-key from the field. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">keyIndex</td><td>The index of the data-key you want to remove. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Whether the operation was successful or not. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a5903b2583332c1d807e353fad28a344f"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> removeEmitter </td>
- <td>(</td>
- <td class="paramtype">emitterId </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Removes an emitter. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">emitterId</td><td>The emitter to remove. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a687d85d8bb36cbb086bc6d7df4b1bee9"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> selectField </td>
- <td>(</td>
- <td class="paramtype">fieldName </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Select the specified field by its name. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <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>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Whether the field was successfully selected or not. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="aaf6e29780456083fd9ec57880063a12a"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> setDataKeyValue </td>
- <td>(</td>
- <td class="paramtype">keyIndex </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">value </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Set data-key value for the field. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">keyIndex</td><td>The index of the key to be modified. </td></tr>
- <tr><td class="paramname">value</td><td>The value to change the key to. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Whether the operation was successful or not. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="ae2b8cff4324629987e69f1d4557b9619"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void setLifeMode </td>
- <td>(</td>
- <td class="paramtype">lifeMode </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Particle asset accessors. </p>
- <p>Sets the life-mode of the particle effect. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <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>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a986da5eaa0f93b8b350c6398be9b9794"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void setLifetime </td>
- <td>(</td>
- <td class="paramtype">lifeTime </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Sets the lifetime of the particle effect. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">lifeTime</td><td>The lifetime of the particle effect. This is used according to the 'lifeMode' setting. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="aa2fc6f92b94e635e603073bfdb564284"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> setRepeatTime </td>
- <td>(</td>
- <td class="paramtype">repeatTime </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- </div>
- </div>
- <a class="anchor" id="a000c741e5c68b4571838f58d26ccb667"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> setSingleDataKey </td>
- <td>(</td>
- <td class="paramtype">value </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- <table class="params">
- <tr><td class="paramname">value</td><td>The value to set the key to. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Returns the index of the new data-key (always zero) or -1 on failure. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a0f8cf197492e13fe524358f1e25be836"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> setValueScale </td>
- <td>(</td>
- <td class="paramtype">valueScale </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- <table class="params">
- <tr><td class="paramname">valueScale</td><td>The scale for field values retrieved from the field. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Whether the operation was successful or not. </dd></dl>
- </div>
- </div>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.8.3.1
- </small></address>
- </body>
- </html>
|