TorqueEngine
/
Torque2D
oglindă de https://github.com/TorqueGameEngines/Torque2D.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928
							<!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&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;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&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<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:a97ba2a47fd89944e231d5b648ba57e9d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a97ba2a47fd89944e231d5b648ba57e9d">addDataKey</a> (time, value)</td></tr>
<tr class="separator:a97ba2a47fd89944e231d5b648ba57e9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a62c52869c292e382898baf8bf0f10751"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a62c52869c292e382898baf8bf0f10751">addEmitter</a> (emitterId)</td></tr>
<tr class="separator:a62c52869c292e382898baf8bf0f10751"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a34667db6397218cec6095b95566157c7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a34667db6397218cec6095b95566157c7">clearDataKeys</a> ()</td></tr>
<tr class="separator:a34667db6397218cec6095b95566157c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ab6f23a794d831d90c80723e6b7989a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a1ab6f23a794d831d90c80723e6b7989a">clearEmitters</a> ()</td></tr>
<tr class="separator:a1ab6f23a794d831d90c80723e6b7989a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aadf1b5310270fdf2a86ce4397f3a34b3"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#aadf1b5310270fdf2a86ce4397f3a34b3">createEmitter</a> ()</td></tr>
<tr class="memdesc:aadf1b5310270fdf2a86ce4397f3a34b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Emitter asset methods.  <a href="#aadf1b5310270fdf2a86ce4397f3a34b3">More...</a><br/></td></tr>
<tr class="separator:aadf1b5310270fdf2a86ce4397f3a34b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a843788246e9ab1fc7433e8a44e1d1192"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a843788246e9ab1fc7433e8a44e1d1192">deselectField</a> ()</td></tr>
<tr class="separator:a843788246e9ab1fc7433e8a44e1d1192"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a236782130d1270fc150f21a6fe12ed89"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a236782130d1270fc150f21a6fe12ed89">findEmitter</a> (emitterName)</td></tr>
<tr class="separator:a236782130d1270fc150f21a6fe12ed89"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae447ba16e8e7120d61232985438c8945"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#ae447ba16e8e7120d61232985438c8945">getDataKey</a> (keyIndex)</td></tr>
<tr class="separator:ae447ba16e8e7120d61232985438c8945"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d122dcf6b3f9182b56e04dc63c5bb39"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a9d122dcf6b3f9182b56e04dc63c5bb39">getDataKeyCount</a> ()</td></tr>
<tr class="separator:a9d122dcf6b3f9182b56e04dc63c5bb39"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a83e0967a5f30ffb41c025a2b1975d79e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a83e0967a5f30ffb41c025a2b1975d79e">getEmitter</a> (emitterIndex)</td></tr>
<tr class="separator:a83e0967a5f30ffb41c025a2b1975d79e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3cb4eef072fe81e8d510b26375e6eda1"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a3cb4eef072fe81e8d510b26375e6eda1">getEmitterCount</a> ()</td></tr>
<tr class="separator:a3cb4eef072fe81e8d510b26375e6eda1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a86b28285f18abb693b75612d7c9850c4"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a86b28285f18abb693b75612d7c9850c4">getFieldValue</a> (time)</td></tr>
<tr class="separator:a86b28285f18abb693b75612d7c9850c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a966b7c894d36d4f06c1ca1cc5b92c115"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a966b7c894d36d4f06c1ca1cc5b92c115">getLifeMode</a> ()</td></tr>
<tr class="separator:a966b7c894d36d4f06c1ca1cc5b92c115"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9a53c351d6e15571338f8f815ba4cfae"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a9a53c351d6e15571338f8f815ba4cfae">getLifetime</a> ()</td></tr>
<tr class="separator:a9a53c351d6e15571338f8f815ba4cfae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afe4de1ef0f2ed8518705fd63eac66cbb"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#afe4de1ef0f2ed8518705fd63eac66cbb">getMaxTime</a> ()</td></tr>
<tr class="separator:afe4de1ef0f2ed8518705fd63eac66cbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a228202a335fb156e2b29f4b9d178305e"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a228202a335fb156e2b29f4b9d178305e">getMaxValue</a> ()</td></tr>
<tr class="separator:a228202a335fb156e2b29f4b9d178305e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abd8aea7c4b1e56289610de501589412f"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#abd8aea7c4b1e56289610de501589412f">getMinTime</a> ()</td></tr>
<tr class="separator:abd8aea7c4b1e56289610de501589412f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac4d15a794724d9eb9c23fa9909bdf1d4"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#ac4d15a794724d9eb9c23fa9909bdf1d4">getMinValue</a> ()</td></tr>
<tr class="separator:ac4d15a794724d9eb9c23fa9909bdf1d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae5229ab25f74656324c83bc2003fb3ec"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#ae5229ab25f74656324c83bc2003fb3ec">getRepeatTime</a> ()</td></tr>
<tr class="separator:ae5229ab25f74656324c83bc2003fb3ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad13c2ee3067336b59a51741bcda0050f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#ad13c2ee3067336b59a51741bcda0050f">getSelectableFieldCount</a> ()</td></tr>
<tr class="memdesc:ad13c2ee3067336b59a51741bcda0050f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Particle asset fields.  <a href="#ad13c2ee3067336b59a51741bcda0050f">More...</a><br/></td></tr>
<tr class="separator:ad13c2ee3067336b59a51741bcda0050f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3b76abbf116608d5cd2981856abf81f"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#aa3b76abbf116608d5cd2981856abf81f">getSelectableFieldName</a> (fieldIndex)</td></tr>
<tr class="separator:aa3b76abbf116608d5cd2981856abf81f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ac6c66b7f08dec954784dbb85cfa27a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a9ac6c66b7f08dec954784dbb85cfa27a">getSelectedField</a> ()</td></tr>
<tr class="separator:a9ac6c66b7f08dec954784dbb85cfa27a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a50ad86e4769d41f235193b69e0588086"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a50ad86e4769d41f235193b69e0588086">getValueScale</a> ()</td></tr>
<tr class="separator:a50ad86e4769d41f235193b69e0588086"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a443b1046ecbc04804aef48641080c83c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a443b1046ecbc04804aef48641080c83c">moveEmitter</a> (fromEmitterIndex, toEmitterIndex)</td></tr>
<tr class="separator:a443b1046ecbc04804aef48641080c83c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a16c5643abb891c0e1181a07ea0de33a5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a16c5643abb891c0e1181a07ea0de33a5">removeDataKey</a> (keyIndex)</td></tr>
<tr class="separator:a16c5643abb891c0e1181a07ea0de33a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1b164ba3e16400f89b44ce14fed9f81f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a1b164ba3e16400f89b44ce14fed9f81f">removeEmitter</a> (emitterId,[bool deleteEmitter])</td></tr>
<tr class="separator:a1b164ba3e16400f89b44ce14fed9f81f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2690a5bf3b2e6a5a33eb96424413e5c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#ae2690a5bf3b2e6a5a33eb96424413e5c">selectField</a> (fieldName)</td></tr>
<tr class="separator:ae2690a5bf3b2e6a5a33eb96424413e5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae84fc77a2783203e020cc5fa0363f817"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#ae84fc77a2783203e020cc5fa0363f817">setDataKeyValue</a> (keyIndex, value)</td></tr>
<tr class="separator:ae84fc77a2783203e020cc5fa0363f817"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2b8cff4324629987e69f1d4557b9619"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#ae2b8cff4324629987e69f1d4557b9619">setLifeMode</a> (lifeMode)</td></tr>
<tr class="memdesc:ae2b8cff4324629987e69f1d4557b9619"><td class="mdescLeft">&#160;</td><td class="mdescRight">Particle asset accessors.  <a href="#ae2b8cff4324629987e69f1d4557b9619">More...</a><br/></td></tr>
<tr class="separator:ae2b8cff4324629987e69f1d4557b9619"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a986da5eaa0f93b8b350c6398be9b9794"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a986da5eaa0f93b8b350c6398be9b9794">setLifetime</a> (lifeTime)</td></tr>
<tr class="separator:a986da5eaa0f93b8b350c6398be9b9794"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a60a646933e416110d101fa03dfbc0610"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a60a646933e416110d101fa03dfbc0610">setRepeatTime</a> (repeatTime)</td></tr>
<tr class="separator:a60a646933e416110d101fa03dfbc0610"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1f46c6384a2d7630e9434fc477cdc13"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#aa1f46c6384a2d7630e9434fc477cdc13">setSingleDataKey</a> (value)</td></tr>
<tr class="separator:aa1f46c6384a2d7630e9434fc477cdc13"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3a20dde4fb2608332294d19794b2a579"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParticleAsset.html#a3a20dde4fb2608332294d19794b2a579">setValueScale</a> (valueScale)</td></tr>
<tr class="separator:a3a20dde4fb2608332294d19794b2a579"><td class="memSeparator" colspan="2">&#160;</td></tr>
<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>
<tr class="memitem:af221d4adee530465ded020e194496030 inherit pub_methods_classAssetBase"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAssetBase.html#af221d4adee530465ded020e194496030">getAssetId</a> ()</td></tr>
<tr class="separator:af221d4adee530465ded020e194496030 inherit pub_methods_classAssetBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a00b3d3cf0e2bb08d4c268f34610bfaa6 inherit pub_methods_classAssetBase"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAssetBase.html#a00b3d3cf0e2bb08d4c268f34610bfaa6">refreshAsset</a> ()</td></tr>
<tr class="separator:a00b3d3cf0e2bb08d4c268f34610bfaa6 inherit pub_methods_classAssetBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classSimObject"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classSimObject')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classSimObject.html">SimObject</a></td></tr>
<tr class="memitem:a1c1f9babb145bfdf63e60223663dff3c inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1c1f9babb145bfdf63e60223663dff3c">call</a> (functionName,[args]*)</td></tr>
<tr class="separator:a1c1f9babb145bfdf63e60223663dff3c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b4f0f3ccdfa27b8008f8559a83539bc inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a3b4f0f3ccdfa27b8008f8559a83539bc">clone</a> ([bool copyDynamicFields?=false]?)</td></tr>
<tr class="separator:a3b4f0f3ccdfa27b8008f8559a83539bc inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a7a4721d0a51e952c211e9b0fea4d8090">delete</a> ()</td></tr>
<tr class="separator:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#accd2600060dbaee3a3b41aed4034c63c">dump</a> ()</td></tr>
<tr class="separator:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1810f5aba25efd242c24232c2c2bbd1a">dumpClassHierarchy</a> ()</td></tr>
<tr class="separator:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adeaebc2111072105cbb6961df917d223 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#adeaebc2111072105cbb6961df917d223">getClassName</a> ()</td></tr>
<tr class="separator:adeaebc2111072105cbb6961df917d223 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afbb3b5d0356df264b7343d135b697bcf inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#afbb3b5d0356df264b7343d135b697bcf">getClassNamespace</a> ()</td></tr>
<tr class="separator:afbb3b5d0356df264b7343d135b697bcf inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a771f0adf4c566c3ac2f7c5c32e75d43c inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a771f0adf4c566c3ac2f7c5c32e75d43c">getDynamicField</a> (index)</td></tr>
<tr class="separator:a771f0adf4c566c3ac2f7c5c32e75d43c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:affd866a31305bc1e70c572b2be76069b inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#affd866a31305bc1e70c572b2be76069b">getDynamicFieldCount</a> ()</td></tr>
<tr class="separator:affd866a31305bc1e70c572b2be76069b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af219f6b5498fbd8671e298303c28b1dc inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#af219f6b5498fbd8671e298303c28b1dc">getField</a> (int index)</td></tr>
<tr class="separator:af219f6b5498fbd8671e298303c28b1dc inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d14fc4334b31b14e243de86cc1609a4 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0d14fc4334b31b14e243de86cc1609a4">getFieldCount</a> ()</td></tr>
<tr class="separator:a0d14fc4334b31b14e243de86cc1609a4 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c87209e1a998d8b35e1cde74839bfcc inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a6c87209e1a998d8b35e1cde74839bfcc">getFieldType</a> (fieldName)</td></tr>
<tr class="separator:a6c87209e1a998d8b35e1cde74839bfcc inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf03af9303912906eada72ccf10115e8 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#adf03af9303912906eada72ccf10115e8">getFieldValue</a> (fieldName)</td></tr>
<tr class="separator:adf03af9303912906eada72ccf10115e8 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad35d7fe358fa34d2eba803c7506791f3 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ad35d7fe358fa34d2eba803c7506791f3">getGroup</a> ()</td></tr>
<tr class="separator:ad35d7fe358fa34d2eba803c7506791f3 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a67283be3f45257d1e0c474c563ebb6b6 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a67283be3f45257d1e0c474c563ebb6b6">getId</a> ()</td></tr>
<tr class="separator:a67283be3f45257d1e0c474c563ebb6b6 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a137797d39611f3f3108b30852d28622c inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a137797d39611f3f3108b30852d28622c">getInternalName</a> ()</td></tr>
<tr class="separator:a137797d39611f3f3108b30852d28622c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a510119ff902e4e96165a7475370be836 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a510119ff902e4e96165a7475370be836">getName</a> ()</td></tr>
<tr class="separator:a510119ff902e4e96165a7475370be836 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa71cf6ba84b0de85019204261a9136b7 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa71cf6ba84b0de85019204261a9136b7">getProgenitorFile</a> ()</td></tr>
<tr class="separator:aa71cf6ba84b0de85019204261a9136b7 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0f693104a44b07db870d4e54f2db4c08 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0f693104a44b07db870d4e54f2db4c08">getSuperClassNamespace</a> ()</td></tr>
<tr class="separator:a0f693104a44b07db870d4e54f2db4c08 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec389cbe6ac7aff8ce7196e7dbc007df inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aec389cbe6ac7aff8ce7196e7dbc007df">getType</a> ()</td></tr>
<tr class="separator:aec389cbe6ac7aff8ce7196e7dbc007df inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af4da33de69819e293d90cf52fcbda6da inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#af4da33de69819e293d90cf52fcbda6da">isChildOfGroup</a> ()</td></tr>
<tr class="separator:af4da33de69819e293d90cf52fcbda6da inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a35273f559aecabece437c22ee8aee443 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a35273f559aecabece437c22ee8aee443">isMemberOfClass</a> (string classname)</td></tr>
<tr class="separator:a35273f559aecabece437c22ee8aee443 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8a1d5ac5403526378c7abb0916c55c3c inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a8a1d5ac5403526378c7abb0916c55c3c">isMethod</a> (const char *methodName)</td></tr>
<tr class="separator:a8a1d5ac5403526378c7abb0916c55c3c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8ca0e6f21ff100da6bcd59f51d34fb8e inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a8ca0e6f21ff100da6bcd59f51d34fb8e">isMethod</a> (string method name)</td></tr>
<tr class="separator:a8ca0e6f21ff100da6bcd59f51d34fb8e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9fed7ee24702928365ad45e6eaba4d12 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a9fed7ee24702928365ad45e6eaba4d12">isTimerActive</a> ()</td></tr>
<tr class="separator:a9fed7ee24702928365ad45e6eaba4d12 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa92c3478d4ff5780f0f027598480d772 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa92c3478d4ff5780f0f027598480d772">save</a> (<a class="el" href="group__FileSystemFunctions.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>,[selectedOnly]?)</td></tr>
<tr class="separator:aa92c3478d4ff5780f0f027598480d772 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aabc265010a7a59dcec211ddd8f0ac5a7 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aabc265010a7a59dcec211ddd8f0ac5a7">schedule</a> (time, command,[arg]*)</td></tr>
<tr class="separator:aabc265010a7a59dcec211ddd8f0ac5a7 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3e15ecdee7ab3ece234913bc4e783c0 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa3e15ecdee7ab3ece234913bc4e783c0">setClassNamespace</a> ()</td></tr>
<tr class="separator:aa3e15ecdee7ab3ece234913bc4e783c0 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae099b2a1810ca2e23ac11d239ae0197e inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ae099b2a1810ca2e23ac11d239ae0197e">setFieldValue</a> (fieldName, value)</td></tr>
<tr class="separator:ae099b2a1810ca2e23ac11d239ae0197e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a5aaca360a719feabae0e4e57b921deae">setInternalName</a> (string InternalName)</td></tr>
<tr class="separator:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a4f673cd959711ae09927e7c44dae5fdb">setName</a> (newName)</td></tr>
<tr class="separator:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa8f68d1e6d8c6601c39b3f676f0e9c70">setProgenitorFile</a> (file)</td></tr>
<tr class="separator:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a9cbf471b97387d5bdefb88f92094ad54">setSuperClassNamespace</a> ()</td></tr>
<tr class="separator:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5447439ba5620b2ac00dc0ef97ef2142 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a5447439ba5620b2ac00dc0ef97ef2142">startTimer</a> (callbackFunction, float timePeriod,[repeat]?)</td></tr>
<tr class="separator:a5447439ba5620b2ac00dc0ef97ef2142 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa6f6bfef028c7b053444cbd48567d286">stopTimer</a> ()</td></tr>
<tr class="separator:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_static_methods_classSimObject"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classSimObject')"><img src="closed.png" alt="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="classSimObject.html">SimObject</a></td></tr>
<tr class="memitem:ac7926551c6df020f767d8d87f5a3d575 inherit pub_static_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">static S32 QSORT_CALLBACK&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ac7926551c6df020f767d8d87f5a3d575">compareFields</a> (const void *a, const void *b)</td></tr>
<tr class="separator:ac7926551c6df020f767d8d87f5a3d575 inherit pub_static_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a97ba2a47fd89944e231d5b648ba57e9d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int addDataKey </td>
          <td>(</td>
          <td class="paramtype">time&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">value&#160;</td>
          <td class="paramname">&#160;</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="a62c52869c292e382898baf8bf0f10751"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool addEmitter </td>
          <td>(</td>
          <td class="paramtype">emitterId&#160;</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="a34667db6397218cec6095b95566157c7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool 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="aadf1b5310270fdf2a86ce4397f3a34b3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string 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="a236782130d1270fc150f21a6fe12ed89"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int findEmitter </td>
          <td>(</td>
          <td class="paramtype">emitterName&#160;</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="ae447ba16e8e7120d61232985438c8945"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string getDataKey </td>
          <td>(</td>
          <td class="paramtype">keyIndex&#160;</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="a9d122dcf6b3f9182b56e04dc63c5bb39"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int 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="a83e0967a5f30ffb41c025a2b1975d79e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int getEmitter </td>
          <td>(</td>
          <td class="paramtype">emitterIndex&#160;</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="a3cb4eef072fe81e8d510b26375e6eda1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int 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="a86b28285f18abb693b75612d7c9850c4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float getFieldValue </td>
          <td>(</td>
          <td class="paramtype">time&#160;</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="a966b7c894d36d4f06c1ca1cc5b92c115"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string 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="a9a53c351d6e15571338f8f815ba4cfae"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float 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="afe4de1ef0f2ed8518705fd63eac66cbb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float 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="a228202a335fb156e2b29f4b9d178305e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float 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="abd8aea7c4b1e56289610de501589412f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float 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="ac4d15a794724d9eb9c23fa9909bdf1d4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float 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="ae5229ab25f74656324c83bc2003fb3ec"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float 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="ad13c2ee3067336b59a51741bcda0050f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int 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="aa3b76abbf116608d5cd2981856abf81f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string getSelectableFieldName </td>
          <td>(</td>
          <td class="paramtype">fieldIndex&#160;</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="a9ac6c66b7f08dec954784dbb85cfa27a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool 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="a50ad86e4769d41f235193b69e0588086"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float 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&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">toEmitterIndex&#160;</td>
          <td class="paramname">&#160;</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="a16c5643abb891c0e1181a07ea0de33a5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool removeDataKey </td>
          <td>(</td>
          <td class="paramtype">keyIndex&#160;</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="a1b164ba3e16400f89b44ce14fed9f81f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool removeEmitter </td>
          <td>(</td>
          <td class="paramtype">emitterId&#160;</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="ae2690a5bf3b2e6a5a33eb96424413e5c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool selectField </td>
          <td>(</td>
          <td class="paramtype">fieldName&#160;</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="ae84fc77a2783203e020cc5fa0363f817"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool setDataKeyValue </td>
          <td>(</td>
          <td class="paramtype">keyIndex&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">value&#160;</td>
          <td class="paramname">&#160;</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&#160;</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&#160;</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="a60a646933e416110d101fa03dfbc0610"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool setRepeatTime </td>
          <td>(</td>
          <td class="paramtype">repeatTime&#160;</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="aa1f46c6384a2d7630e9434fc477cdc13"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int setSingleDataKey </td>
          <td>(</td>
          <td class="paramtype">value&#160;</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="a3a20dde4fb2608332294d19794b2a579"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool setValueScale </td>
          <td>(</td>
          <td class="paramtype">valueScale&#160;</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 &#160;<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>