classAnimationAsset.html 51 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.9.8"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>TorqueScript Reference: AnimationAsset Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  13. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  14. </head>
  15. <body>
  16. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  17. <div id="titlearea">
  18. <table cellspacing="0" cellpadding="0">
  19. <tbody>
  20. <tr id="projectrow">
  21. <td id="projectalign">
  22. <div id="projectname">TorqueScript Reference
  23. </div>
  24. </td>
  25. </tr>
  26. </tbody>
  27. </table>
  28. </div>
  29. <!-- end header part -->
  30. <!-- Generated by Doxygen 1.9.8 -->
  31. <script type="text/javascript" src="menudata.js"></script>
  32. <script type="text/javascript" src="menu.js"></script>
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  35. $(function() {
  36. initMenu('',false,false,'search.php','Search');
  37. });
  38. /* @license-end */
  39. </script>
  40. <div id="main-nav"></div>
  41. </div><!-- top -->
  42. <div class="header">
  43. <div class="summary">
  44. <a href="#pub-methods">Public Member Functions</a> &#124;
  45. <a href="classAnimationAsset-members.html">List of all members</a> </div>
  46. <div class="headertitle"><div class="title">AnimationAsset Class Reference</div></div>
  47. </div><!--header-->
  48. <div class="contents">
  49. <p><code>#include &lt;AnimationAsset_ScriptBinding.h&gt;</code></p>
  50. <p>Inherits <a class="el" href="classAssetBase.html">AssetBase</a>.</p>
  51. <table class="memberdecls">
  52. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  53. Public Member Functions</h2></td></tr>
  54. <tr class="memitem:a64d0247d4c07f3f13ace70f49dfc5214" id="r_a64d0247d4c07f3f13ace70f49dfc5214"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimationAsset.html#a64d0247d4c07f3f13ace70f49dfc5214">getAnimationCycle</a> ()</td></tr>
  55. <tr class="separator:a64d0247d4c07f3f13ace70f49dfc5214"><td class="memSeparator" colspan="2">&#160;</td></tr>
  56. <tr class="memitem:a94a9eda011b0b242d990784bd2c757bb" id="r_a94a9eda011b0b242d990784bd2c757bb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimationAsset.html#a94a9eda011b0b242d990784bd2c757bb">getAnimationFrameCount</a> ([bool validatedFrames])</td></tr>
  57. <tr class="separator:a94a9eda011b0b242d990784bd2c757bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  58. <tr class="memitem:ad634774f5e87f1dd7a34dd5ef57427a7" id="r_ad634774f5e87f1dd7a34dd5ef57427a7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimationAsset.html#ad634774f5e87f1dd7a34dd5ef57427a7">getAnimationFrames</a> ([bool validatedFrames])</td></tr>
  59. <tr class="separator:ad634774f5e87f1dd7a34dd5ef57427a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  60. <tr class="memitem:a9e2e68555b5699aa69c36d257d9f39b1" id="r_a9e2e68555b5699aa69c36d257d9f39b1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimationAsset.html#a9e2e68555b5699aa69c36d257d9f39b1">getAnimationTime</a> ()</td></tr>
  61. <tr class="separator:a9e2e68555b5699aa69c36d257d9f39b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  62. <tr class="memitem:a832e57df908361dd86dc673520d7fb81" id="r_a832e57df908361dd86dc673520d7fb81"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimationAsset.html#a832e57df908361dd86dc673520d7fb81">getImage</a> ()</td></tr>
  63. <tr class="separator:a832e57df908361dd86dc673520d7fb81"><td class="memSeparator" colspan="2">&#160;</td></tr>
  64. <tr class="memitem:a30daddb98b4d963dd296f676f886cc4a" id="r_a30daddb98b4d963dd296f676f886cc4a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimationAsset.html#a30daddb98b4d963dd296f676f886cc4a">getNamedAnimationFrameCount</a> ([bool validatedFrames])</td></tr>
  65. <tr class="separator:a30daddb98b4d963dd296f676f886cc4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66. <tr class="memitem:a9cdd5e7eaee09e7028912b51a3784b6d" id="r_a9cdd5e7eaee09e7028912b51a3784b6d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimationAsset.html#a9cdd5e7eaee09e7028912b51a3784b6d">getNamedAnimationFrames</a> ([bool validatedFrames])</td></tr>
  67. <tr class="separator:a9cdd5e7eaee09e7028912b51a3784b6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68. <tr class="memitem:a8d052b930e4e4e18e8562fbc0a19da18" id="r_a8d052b930e4e4e18e8562fbc0a19da18"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimationAsset.html#a8d052b930e4e4e18e8562fbc0a19da18">getNamedCellsMode</a> ()</td></tr>
  69. <tr class="separator:a8d052b930e4e4e18e8562fbc0a19da18"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70. <tr class="memitem:a8dfd391c972d6d4c0caff2c2f7f76dad" id="r_a8dfd391c972d6d4c0caff2c2f7f76dad"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimationAsset.html#a8dfd391c972d6d4c0caff2c2f7f76dad">setAnimationCycle</a> (bool animationCycle)</td></tr>
  71. <tr class="separator:a8dfd391c972d6d4c0caff2c2f7f76dad"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72. <tr class="memitem:af05f5598f124126af7e0f0d53f409f36" id="r_af05f5598f124126af7e0f0d53f409f36"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimationAsset.html#af05f5598f124126af7e0f0d53f409f36">setAnimationFrames</a> (animationFrames)</td></tr>
  73. <tr class="separator:af05f5598f124126af7e0f0d53f409f36"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <tr class="memitem:ab362a4604a421df3d549b405248d348c" id="r_ab362a4604a421df3d549b405248d348c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimationAsset.html#ab362a4604a421df3d549b405248d348c">setAnimationTime</a> (float animationTime)</td></tr>
  75. <tr class="separator:ab362a4604a421df3d549b405248d348c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem:aa54343e5fc3a378b83e30eaf61c2eea0" id="r_aa54343e5fc3a378b83e30eaf61c2eea0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimationAsset.html#aa54343e5fc3a378b83e30eaf61c2eea0">setImage</a> (assetId)</td></tr>
  77. <tr class="separator:aa54343e5fc3a378b83e30eaf61c2eea0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:a12b1788eeacbaa0e7072181428c831b7" id="r_a12b1788eeacbaa0e7072181428c831b7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimationAsset.html#a12b1788eeacbaa0e7072181428c831b7">setNamedAnimationFrames</a> (animationFrames)</td></tr>
  79. <tr class="separator:a12b1788eeacbaa0e7072181428c831b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:a998f4a9b4aa5a8fe335f0af530454b0f" id="r_a998f4a9b4aa5a8fe335f0af530454b0f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimationAsset.html#a998f4a9b4aa5a8fe335f0af530454b0f">setNamedCellsMode</a> ()</td></tr>
  81. <tr class="separator:a998f4a9b4aa5a8fe335f0af530454b0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <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>
  83. <tr class="memitem:a927651202ec0b50abd34a632d7571992 inherit pub_methods_classAssetBase" id="r_a927651202ec0b50abd34a632d7571992"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAssetBase.html#a927651202ec0b50abd34a632d7571992">getAssetId</a> ()</td></tr>
  84. <tr class="separator:a927651202ec0b50abd34a632d7571992 inherit pub_methods_classAssetBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:a00b3d3cf0e2bb08d4c268f34610bfaa6 inherit pub_methods_classAssetBase" id="r_a00b3d3cf0e2bb08d4c268f34610bfaa6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAssetBase.html#a00b3d3cf0e2bb08d4c268f34610bfaa6">refreshAsset</a> ()</td></tr>
  86. <tr class="separator:a00b3d3cf0e2bb08d4c268f34610bfaa6 inherit pub_methods_classAssetBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <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>
  88. <tr class="memitem:a2375929bea4901d98ae352231b0721ad inherit pub_methods_classSimObject" id="r_a2375929bea4901d98ae352231b0721ad"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a2375929bea4901d98ae352231b0721ad">assignFieldsFrom</a> (<a class="el" href="classSimObject.html">SimObject</a>)</td></tr>
  89. <tr class="separator:a2375929bea4901d98ae352231b0721ad inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a22437f451ceb1429fa2a3be23d523954 inherit pub_methods_classSimObject" id="r_a22437f451ceb1429fa2a3be23d523954"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a22437f451ceb1429fa2a3be23d523954">clone</a> ([copyDynamicFields=false]?)</td></tr>
  91. <tr class="separator:a22437f451ceb1429fa2a3be23d523954 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject" id="r_a7a4721d0a51e952c211e9b0fea4d8090"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a7a4721d0a51e952c211e9b0fea4d8090">delete</a> ()</td></tr>
  93. <tr class="separator:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a929e1325a515b279faca90a65028782e inherit pub_methods_classSimObject" id="r_a929e1325a515b279faca90a65028782e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a929e1325a515b279faca90a65028782e">getId</a> ()</td></tr>
  95. <tr class="separator:a929e1325a515b279faca90a65028782e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject" id="r_a4f673cd959711ae09927e7c44dae5fdb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a4f673cd959711ae09927e7c44dae5fdb">setName</a> (newName)</td></tr>
  97. <tr class="separator:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:a78ee178b6a73658d65ca60da4d1e6683 inherit pub_methods_classSimObject" id="r_a78ee178b6a73658d65ca60da4d1e6683"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a78ee178b6a73658d65ca60da4d1e6683">getName</a> ()</td></tr>
  99. <tr class="separator:a78ee178b6a73658d65ca60da4d1e6683 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:ab8b0f8b874af628d7204d9cc2630ced7 inherit pub_methods_classSimObject" id="r_ab8b0f8b874af628d7204d9cc2630ced7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab8b0f8b874af628d7204d9cc2630ced7">getClassNamespace</a> ()</td></tr>
  101. <tr class="separator:ab8b0f8b874af628d7204d9cc2630ced7 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a6e266d4432d70cad58461d96e1d2cbdf inherit pub_methods_classSimObject" id="r_a6e266d4432d70cad58461d96e1d2cbdf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a6e266d4432d70cad58461d96e1d2cbdf">getSuperClassNamespace</a> ()</td></tr>
  103. <tr class="separator:a6e266d4432d70cad58461d96e1d2cbdf inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a847e859bcc5b58df83fa7f331c167c32 inherit pub_methods_classSimObject" id="r_a847e859bcc5b58df83fa7f331c167c32"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a847e859bcc5b58df83fa7f331c167c32">setClassNamespace</a> (nameSpace)</td></tr>
  105. <tr class="separator:a847e859bcc5b58df83fa7f331c167c32 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject" id="r_a9cbf471b97387d5bdefb88f92094ad54"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a9cbf471b97387d5bdefb88f92094ad54">setSuperClassNamespace</a> ()</td></tr>
  107. <tr class="separator:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:a8f4e85d0903526235ed2ca86df69cdef inherit pub_methods_classSimObject" id="r_a8f4e85d0903526235ed2ca86df69cdef"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a8f4e85d0903526235ed2ca86df69cdef">isMethod</a> (string methodName)</td></tr>
  109. <tr class="separator:a8f4e85d0903526235ed2ca86df69cdef inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:a9ce8801999cf2228ddde6d58ca3773d5 inherit pub_methods_classSimObject" id="r_a9ce8801999cf2228ddde6d58ca3773d5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a9ce8801999cf2228ddde6d58ca3773d5">call</a> (methodName, [args] *)</td></tr>
  111. <tr class="separator:a9ce8801999cf2228ddde6d58ca3773d5 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject" id="r_a1810f5aba25efd242c24232c2c2bbd1a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1810f5aba25efd242c24232c2c2bbd1a">dumpClassHierarchy</a> ()</td></tr>
  113. <tr class="separator:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject" id="r_accd2600060dbaee3a3b41aed4034c63c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#accd2600060dbaee3a3b41aed4034c63c">dump</a> ()</td></tr>
  115. <tr class="separator:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:a66ac731a8dc088fe8c8ab17bf7c9eecd inherit pub_methods_classSimObject" id="r_a66ac731a8dc088fe8c8ab17bf7c9eecd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a66ac731a8dc088fe8c8ab17bf7c9eecd">isMemberOfClass</a> (string classname)</td></tr>
  117. <tr class="separator:a66ac731a8dc088fe8c8ab17bf7c9eecd inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:a3e97a324df2af082cdb089491757ce11 inherit pub_methods_classSimObject" id="r_a3e97a324df2af082cdb089491757ce11"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a3e97a324df2af082cdb089491757ce11">getClassName</a> ()</td></tr>
  119. <tr class="separator:a3e97a324df2af082cdb089491757ce11 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:abc2222a9649b5c033810e753b07f26a3 inherit pub_methods_classSimObject" id="r_abc2222a9649b5c033810e753b07f26a3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#abc2222a9649b5c033810e753b07f26a3">getFieldValue</a> (fieldName)</td></tr>
  121. <tr class="separator:abc2222a9649b5c033810e753b07f26a3 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:a1084f1964e446b3d279943cf6e575069 inherit pub_methods_classSimObject" id="r_a1084f1964e446b3d279943cf6e575069"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1084f1964e446b3d279943cf6e575069">setFieldValue</a> (fieldName, value)</td></tr>
  123. <tr class="separator:a1084f1964e446b3d279943cf6e575069 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:ab4e32fb984d9ce6584b0fa57c8772d3e inherit pub_methods_classSimObject" id="r_ab4e32fb984d9ce6584b0fa57c8772d3e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab4e32fb984d9ce6584b0fa57c8772d3e">setEditFieldValue</a> (fieldName, value)</td></tr>
  125. <tr class="separator:ab4e32fb984d9ce6584b0fa57c8772d3e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:a7543b8dc494ec0d9034cb73ae504f3ca inherit pub_methods_classSimObject" id="r_a7543b8dc494ec0d9034cb73ae504f3ca"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a7543b8dc494ec0d9034cb73ae504f3ca">getDynamicFieldCount</a> ()</td></tr>
  127. <tr class="separator:a7543b8dc494ec0d9034cb73ae504f3ca inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:a0e143217119b68d557d17ac2f13b173e inherit pub_methods_classSimObject" id="r_a0e143217119b68d557d17ac2f13b173e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0e143217119b68d557d17ac2f13b173e">getDynamicField</a> (index)</td></tr>
  129. <tr class="separator:a0e143217119b68d557d17ac2f13b173e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:af2e74f6b683da8d2085f0991dab7948b inherit pub_methods_classSimObject" id="r_af2e74f6b683da8d2085f0991dab7948b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#af2e74f6b683da8d2085f0991dab7948b">getFieldCount</a> ()</td></tr>
  131. <tr class="separator:af2e74f6b683da8d2085f0991dab7948b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:ac636f89189406eef1b401292459b1a3b inherit pub_methods_classSimObject" id="r_ac636f89189406eef1b401292459b1a3b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ac636f89189406eef1b401292459b1a3b">getField</a> (int index)</td></tr>
  133. <tr class="separator:ac636f89189406eef1b401292459b1a3b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject" id="r_aa8f68d1e6d8c6601c39b3f676f0e9c70"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa8f68d1e6d8c6601c39b3f676f0e9c70">setProgenitorFile</a> (file)</td></tr>
  135. <tr class="separator:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:a88c8d99755a07ac4648360dd40ff67a5 inherit pub_methods_classSimObject" id="r_a88c8d99755a07ac4648360dd40ff67a5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a88c8d99755a07ac4648360dd40ff67a5">getProgenitorFile</a> ()</td></tr>
  137. <tr class="separator:a88c8d99755a07ac4648360dd40ff67a5 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:a367706e675179342e6153c45f1ba06ae inherit pub_methods_classSimObject" id="r_a367706e675179342e6153c45f1ba06ae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a367706e675179342e6153c45f1ba06ae">getType</a> ()</td></tr>
  139. <tr class="separator:a367706e675179342e6153c45f1ba06ae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:a0570b7f6eb94a0ed941fd75f6f01555b inherit pub_methods_classSimObject" id="r_a0570b7f6eb94a0ed941fd75f6f01555b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0570b7f6eb94a0ed941fd75f6f01555b">getFieldType</a> (fieldName)</td></tr>
  141. <tr class="separator:a0570b7f6eb94a0ed941fd75f6f01555b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <tr class="memitem:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject" id="r_a5aaca360a719feabae0e4e57b921deae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a5aaca360a719feabae0e4e57b921deae">setInternalName</a> (string InternalName)</td></tr>
  143. <tr class="separator:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:af9f341b474a28f4bcf79bc02439b7c18 inherit pub_methods_classSimObject" id="r_af9f341b474a28f4bcf79bc02439b7c18"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#af9f341b474a28f4bcf79bc02439b7c18">getInternalName</a> ()</td></tr>
  145. <tr class="separator:af9f341b474a28f4bcf79bc02439b7c18 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:a986f1b4a76969bac5dfd50b22af8dec6 inherit pub_methods_classSimObject" id="r_a986f1b4a76969bac5dfd50b22af8dec6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a986f1b4a76969bac5dfd50b22af8dec6">isChildOfGroup</a> (groupID)</td></tr>
  147. <tr class="separator:a986f1b4a76969bac5dfd50b22af8dec6 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <tr class="memitem:ae329d6593bb3f9b8046e7cae693ccc09 inherit pub_methods_classSimObject" id="r_ae329d6593bb3f9b8046e7cae693ccc09"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ae329d6593bb3f9b8046e7cae693ccc09">getGroup</a> ()</td></tr>
  149. <tr class="separator:ae329d6593bb3f9b8046e7cae693ccc09 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <tr class="memitem:a39653bc04e82875f2dc8d6dea25acdaa inherit pub_methods_classSimObject" id="r_a39653bc04e82875f2dc8d6dea25acdaa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a39653bc04e82875f2dc8d6dea25acdaa">startTimer</a> (callbackFunction, float timePeriod, [repeat]?)</td></tr>
  151. <tr class="separator:a39653bc04e82875f2dc8d6dea25acdaa inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject" id="r_aa6f6bfef028c7b053444cbd48567d286"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa6f6bfef028c7b053444cbd48567d286">stopTimer</a> ()</td></tr>
  153. <tr class="separator:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <tr class="memitem:a5807c03d2b725a54732d09b53d5da631 inherit pub_methods_classSimObject" id="r_a5807c03d2b725a54732d09b53d5da631"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a5807c03d2b725a54732d09b53d5da631">isTimerActive</a> ()</td></tr>
  155. <tr class="separator:a5807c03d2b725a54732d09b53d5da631 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. <tr class="memitem:a16d537cd7a1c438045bb756fe1e22d2d inherit pub_methods_classSimObject" id="r_a16d537cd7a1c438045bb756fe1e22d2d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a16d537cd7a1c438045bb756fe1e22d2d">schedule</a> (time, command, [arg] *)</td></tr>
  157. <tr class="separator:a16d537cd7a1c438045bb756fe1e22d2d inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <tr class="memitem:a9f05bc4a94b98e2e3347fe34aeefe7c4 inherit pub_methods_classSimObject" id="r_a9f05bc4a94b98e2e3347fe34aeefe7c4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a9f05bc4a94b98e2e3347fe34aeefe7c4">startListening</a> (<a class="el" href="classSimObject.html">SimObject</a>)</td></tr>
  159. <tr class="separator:a9f05bc4a94b98e2e3347fe34aeefe7c4 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  160. <tr class="memitem:a3f7f0520846a222310415ad7a8f8a4bf inherit pub_methods_classSimObject" id="r_a3f7f0520846a222310415ad7a8f8a4bf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a3f7f0520846a222310415ad7a8f8a4bf">stopListening</a> (<a class="el" href="classSimObject.html">SimObject</a>)</td></tr>
  161. <tr class="separator:a3f7f0520846a222310415ad7a8f8a4bf inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  162. <tr class="memitem:afa6eac5990b02024e77e3815161159df inherit pub_methods_classSimObject" id="r_afa6eac5990b02024e77e3815161159df"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#afa6eac5990b02024e77e3815161159df">addListener</a> (<a class="el" href="classSimObject.html">SimObject</a>)</td></tr>
  163. <tr class="separator:afa6eac5990b02024e77e3815161159df inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  164. <tr class="memitem:a07dd4cf0d113ff4a8943b900bda68a1c inherit pub_methods_classSimObject" id="r_a07dd4cf0d113ff4a8943b900bda68a1c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a07dd4cf0d113ff4a8943b900bda68a1c">removeListener</a> (<a class="el" href="classSimObject.html">SimObject</a>)</td></tr>
  165. <tr class="separator:a07dd4cf0d113ff4a8943b900bda68a1c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  166. <tr class="memitem:a87be48ec4599c3d02a118cee89e47f55 inherit pub_methods_classSimObject" id="r_a87be48ec4599c3d02a118cee89e47f55"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a87be48ec4599c3d02a118cee89e47f55">removeAllListeners</a> ()</td></tr>
  167. <tr class="separator:a87be48ec4599c3d02a118cee89e47f55 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  168. <tr class="memitem:a1dcaa2910d6405134c74a71745d29154 inherit pub_methods_classSimObject" id="r_a1dcaa2910d6405134c74a71745d29154"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1dcaa2910d6405134c74a71745d29154">postEvent</a> (<a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> eventName, <a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> data)</td></tr>
  169. <tr class="separator:a1dcaa2910d6405134c74a71745d29154 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  170. <tr class="memitem:ab6e816c3694e8b6119bf9ac3f5556f32 inherit pub_methods_classSimObject" id="r_ab6e816c3694e8b6119bf9ac3f5556f32"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab6e816c3694e8b6119bf9ac3f5556f32">save</a> (<a class="el" href="group__FileSystem.html#ga4ea5109dc203259fb3c01292345bc0ee">fileName</a>, [selectedOnly]?)</td></tr>
  171. <tr class="separator:ab6e816c3694e8b6119bf9ac3f5556f32 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  172. <tr class="memitem:a216228c27df224ac5e8d3590494bfb3f inherit pub_methods_classSimObject" id="r_a216228c27df224ac5e8d3590494bfb3f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a216228c27df224ac5e8d3590494bfb3f">addFieldFilter</a> (fieldName)</td></tr>
  173. <tr class="separator:a216228c27df224ac5e8d3590494bfb3f inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  174. <tr class="memitem:ad517bd83c1c853985ab07cd22775c43d inherit pub_methods_classSimObject" id="r_ad517bd83c1c853985ab07cd22775c43d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ad517bd83c1c853985ab07cd22775c43d">removeFieldFilter</a> (fieldName)</td></tr>
  175. <tr class="separator:ad517bd83c1c853985ab07cd22775c43d inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  176. </table>
  177. <h2 class="groupheader">Member Function Documentation</h2>
  178. <a id="a64d0247d4c07f3f13ace70f49dfc5214" name="a64d0247d4c07f3f13ace70f49dfc5214"></a>
  179. <h2 class="memtitle"><span class="permalink"><a href="#a64d0247d4c07f3f13ace70f49dfc5214">&#9670;&#160;</a></span>getAnimationCycle()</h2>
  180. <div class="memitem">
  181. <div class="memproto">
  182. <table class="memname">
  183. <tr>
  184. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> getAnimationCycle </td>
  185. <td>(</td>
  186. <td class="paramname"></td><td>)</td>
  187. <td></td>
  188. </tr>
  189. </table>
  190. </div><div class="memdoc">
  191. <p>Gets whether the animation cycles or not. </p><dl class="section return"><dt>Returns</dt><dd>Whether the animation cycles or not. </dd></dl>
  192. </div>
  193. </div>
  194. <a id="a94a9eda011b0b242d990784bd2c757bb" name="a94a9eda011b0b242d990784bd2c757bb"></a>
  195. <h2 class="memtitle"><span class="permalink"><a href="#a94a9eda011b0b242d990784bd2c757bb">&#9670;&#160;</a></span>getAnimationFrameCount()</h2>
  196. <div class="memitem">
  197. <div class="memproto">
  198. <table class="memname">
  199. <tr>
  200. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getAnimationFrameCount </td>
  201. <td>(</td>
  202. <td class="paramname"></td><td>)</td>
  203. <td></td>
  204. </tr>
  205. </table>
  206. </div><div class="memdoc">
  207. <p>Gets the count of frame that compose the animation or optionally only the ones validated against the image asset. </p><dl class="params"><dt>Parameters</dt><dd>
  208. <table class="params">
  209. <tr><td class="paramname">validatedFrames</td><td>- Whether to return only the validated frames or not. Optional: Default is false. </td></tr>
  210. </table>
  211. </dd>
  212. </dl>
  213. <dl class="section return"><dt>Returns</dt><dd>The image frames that compose the animation or optionally only the ones validated against the image asset. </dd></dl>
  214. </div>
  215. </div>
  216. <a id="ad634774f5e87f1dd7a34dd5ef57427a7" name="ad634774f5e87f1dd7a34dd5ef57427a7"></a>
  217. <h2 class="memtitle"><span class="permalink"><a href="#ad634774f5e87f1dd7a34dd5ef57427a7">&#9670;&#160;</a></span>getAnimationFrames()</h2>
  218. <div class="memitem">
  219. <div class="memproto">
  220. <table class="memname">
  221. <tr>
  222. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getAnimationFrames </td>
  223. <td>(</td>
  224. <td class="paramname"></td><td>)</td>
  225. <td></td>
  226. </tr>
  227. </table>
  228. </div><div class="memdoc">
  229. <p>Gets the frames that compose the animation or optionally only the ones validated against the image asset. </p><dl class="params"><dt>Parameters</dt><dd>
  230. <table class="params">
  231. <tr><td class="paramname">validatedFrames</td><td>- Whether to return only the validated frames or not. Optional: Default is false. </td></tr>
  232. </table>
  233. </dd>
  234. </dl>
  235. <dl class="section return"><dt>Returns</dt><dd>The image frames that compose the animation or optionally only the ones validated against the image asset. </dd></dl>
  236. </div>
  237. </div>
  238. <a id="a9e2e68555b5699aa69c36d257d9f39b1" name="a9e2e68555b5699aa69c36d257d9f39b1"></a>
  239. <h2 class="memtitle"><span class="permalink"><a href="#a9e2e68555b5699aa69c36d257d9f39b1">&#9670;&#160;</a></span>getAnimationTime()</h2>
  240. <div class="memitem">
  241. <div class="memproto">
  242. <table class="memname">
  243. <tr>
  244. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> getAnimationTime </td>
  245. <td>(</td>
  246. <td class="paramname"></td><td>)</td>
  247. <td></td>
  248. </tr>
  249. </table>
  250. </div><div class="memdoc">
  251. <p>Gets the total time to cycle through all animation frames. </p><dl class="section return"><dt>Returns</dt><dd>The total time to cycle through all animation frames. </dd></dl>
  252. </div>
  253. </div>
  254. <a id="a832e57df908361dd86dc673520d7fb81" name="a832e57df908361dd86dc673520d7fb81"></a>
  255. <h2 class="memtitle"><span class="permalink"><a href="#a832e57df908361dd86dc673520d7fb81">&#9670;&#160;</a></span>getImage()</h2>
  256. <div class="memitem">
  257. <div class="memproto">
  258. <table class="memname">
  259. <tr>
  260. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getImage </td>
  261. <td>(</td>
  262. <td class="paramname"></td><td>)</td>
  263. <td></td>
  264. </tr>
  265. </table>
  266. </div><div class="memdoc">
  267. <p>Gets the image asset Id. </p><dl class="section return"><dt>Returns</dt><dd>The image asset Id. </dd></dl>
  268. </div>
  269. </div>
  270. <a id="a30daddb98b4d963dd296f676f886cc4a" name="a30daddb98b4d963dd296f676f886cc4a"></a>
  271. <h2 class="memtitle"><span class="permalink"><a href="#a30daddb98b4d963dd296f676f886cc4a">&#9670;&#160;</a></span>getNamedAnimationFrameCount()</h2>
  272. <div class="memitem">
  273. <div class="memproto">
  274. <table class="memname">
  275. <tr>
  276. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getNamedAnimationFrameCount </td>
  277. <td>(</td>
  278. <td class="paramname"></td><td>)</td>
  279. <td></td>
  280. </tr>
  281. </table>
  282. </div><div class="memdoc">
  283. <p>Gets the count of named frames that compose the animation or optionally only the ones validated against the image asset. </p><dl class="params"><dt>Parameters</dt><dd>
  284. <table class="params">
  285. <tr><td class="paramname">validatedFrames</td><td>- Whether to return only the validated frames or not. Optional: Default is false. </td></tr>
  286. </table>
  287. </dd>
  288. </dl>
  289. <dl class="section return"><dt>Returns</dt><dd>The named image frames that compose the animation or optionally only the ones validated against the image asset. </dd></dl>
  290. </div>
  291. </div>
  292. <a id="a9cdd5e7eaee09e7028912b51a3784b6d" name="a9cdd5e7eaee09e7028912b51a3784b6d"></a>
  293. <h2 class="memtitle"><span class="permalink"><a href="#a9cdd5e7eaee09e7028912b51a3784b6d">&#9670;&#160;</a></span>getNamedAnimationFrames()</h2>
  294. <div class="memitem">
  295. <div class="memproto">
  296. <table class="memname">
  297. <tr>
  298. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getNamedAnimationFrames </td>
  299. <td>(</td>
  300. <td class="paramname"></td><td>)</td>
  301. <td></td>
  302. </tr>
  303. </table>
  304. </div><div class="memdoc">
  305. <p>Gets the named frames that compose the animation or optionally only the ones validated against the image asset. </p><dl class="params"><dt>Parameters</dt><dd>
  306. <table class="params">
  307. <tr><td class="paramname">validatedFrames</td><td>- Whether to return only the validated frames or not. Optional: Default is false. </td></tr>
  308. </table>
  309. </dd>
  310. </dl>
  311. <dl class="section return"><dt>Returns</dt><dd>The named image frames that compose the animation or optionally only the ones validated against the image asset. </dd></dl>
  312. </div>
  313. </div>
  314. <a id="a8d052b930e4e4e18e8562fbc0a19da18" name="a8d052b930e4e4e18e8562fbc0a19da18"></a>
  315. <h2 class="memtitle"><span class="permalink"><a href="#a8d052b930e4e4e18e8562fbc0a19da18">&#9670;&#160;</a></span>getNamedCellsMode()</h2>
  316. <div class="memitem">
  317. <div class="memproto">
  318. <table class="memname">
  319. <tr>
  320. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> getNamedCellsMode </td>
  321. <td>(</td>
  322. <td class="paramname"></td><td>)</td>
  323. <td></td>
  324. </tr>
  325. </table>
  326. </div><div class="memdoc">
  327. <p>Gets whether the animation is using names for its cells. </p><dl class="section return"><dt>Returns</dt><dd>True if the animation is using named cells. </dd></dl>
  328. </div>
  329. </div>
  330. <a id="a8dfd391c972d6d4c0caff2c2f7f76dad" name="a8dfd391c972d6d4c0caff2c2f7f76dad"></a>
  331. <h2 class="memtitle"><span class="permalink"><a href="#a8dfd391c972d6d4c0caff2c2f7f76dad">&#9670;&#160;</a></span>setAnimationCycle()</h2>
  332. <div class="memitem">
  333. <div class="memproto">
  334. <table class="memname">
  335. <tr>
  336. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> setAnimationCycle </td>
  337. <td>(</td>
  338. <td class="paramtype">bool&#160;</td>
  339. <td class="paramname"><em>animationCycle</em></td><td>)</td>
  340. <td></td>
  341. </tr>
  342. </table>
  343. </div><div class="memdoc">
  344. <p>Sets whether the animation cycles or not. </p><dl class="params"><dt>Parameters</dt><dd>
  345. <table class="params">
  346. <tr><td class="paramname">animationCycle</td><td>Whether the animation cycles or not. </td></tr>
  347. </table>
  348. </dd>
  349. </dl>
  350. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  351. </div>
  352. </div>
  353. <a id="af05f5598f124126af7e0f0d53f409f36" name="af05f5598f124126af7e0f0d53f409f36"></a>
  354. <h2 class="memtitle"><span class="permalink"><a href="#af05f5598f124126af7e0f0d53f409f36">&#9670;&#160;</a></span>setAnimationFrames()</h2>
  355. <div class="memitem">
  356. <div class="memproto">
  357. <table class="memname">
  358. <tr>
  359. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> setAnimationFrames </td>
  360. <td>(</td>
  361. <td class="paramtype">animationFrames&#160;</td>
  362. <td class="paramname"></td><td>)</td>
  363. <td></td>
  364. </tr>
  365. </table>
  366. </div><div class="memdoc">
  367. <p>Sets the image frames that compose the animation. </p><dl class="params"><dt>Parameters</dt><dd>
  368. <table class="params">
  369. <tr><td class="paramname">animationFrames</td><td>A set of image frames that compose the animation. </td></tr>
  370. </table>
  371. </dd>
  372. </dl>
  373. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  374. </div>
  375. </div>
  376. <a id="ab362a4604a421df3d549b405248d348c" name="ab362a4604a421df3d549b405248d348c"></a>
  377. <h2 class="memtitle"><span class="permalink"><a href="#ab362a4604a421df3d549b405248d348c">&#9670;&#160;</a></span>setAnimationTime()</h2>
  378. <div class="memitem">
  379. <div class="memproto">
  380. <table class="memname">
  381. <tr>
  382. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> setAnimationTime </td>
  383. <td>(</td>
  384. <td class="paramtype">float&#160;</td>
  385. <td class="paramname"><em>animationTime</em></td><td>)</td>
  386. <td></td>
  387. </tr>
  388. </table>
  389. </div><div class="memdoc">
  390. <p>Sets the total time to cycle through all animation frames. </p><dl class="params"><dt>Parameters</dt><dd>
  391. <table class="params">
  392. <tr><td class="paramname">animationTime</td><td>The total time to cycle through all animation frames. </td></tr>
  393. </table>
  394. </dd>
  395. </dl>
  396. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  397. </div>
  398. </div>
  399. <a id="aa54343e5fc3a378b83e30eaf61c2eea0" name="aa54343e5fc3a378b83e30eaf61c2eea0"></a>
  400. <h2 class="memtitle"><span class="permalink"><a href="#aa54343e5fc3a378b83e30eaf61c2eea0">&#9670;&#160;</a></span>setImage()</h2>
  401. <div class="memitem">
  402. <div class="memproto">
  403. <table class="memname">
  404. <tr>
  405. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> setImage </td>
  406. <td>(</td>
  407. <td class="paramtype">assetId&#160;</td>
  408. <td class="paramname"></td><td>)</td>
  409. <td></td>
  410. </tr>
  411. </table>
  412. </div><div class="memdoc">
  413. <p>Sets the image asset Id. </p><dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  414. </div>
  415. </div>
  416. <a id="a12b1788eeacbaa0e7072181428c831b7" name="a12b1788eeacbaa0e7072181428c831b7"></a>
  417. <h2 class="memtitle"><span class="permalink"><a href="#a12b1788eeacbaa0e7072181428c831b7">&#9670;&#160;</a></span>setNamedAnimationFrames()</h2>
  418. <div class="memitem">
  419. <div class="memproto">
  420. <table class="memname">
  421. <tr>
  422. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> setNamedAnimationFrames </td>
  423. <td>(</td>
  424. <td class="paramtype">animationFrames&#160;</td>
  425. <td class="paramname"></td><td>)</td>
  426. <td></td>
  427. </tr>
  428. </table>
  429. </div><div class="memdoc">
  430. <p>Sets the named image frames that compose the animation. </p><dl class="params"><dt>Parameters</dt><dd>
  431. <table class="params">
  432. <tr><td class="paramname">animationFrames</td><td>A set of named image frames that compose the animation. </td></tr>
  433. </table>
  434. </dd>
  435. </dl>
  436. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  437. </div>
  438. </div>
  439. <a id="a998f4a9b4aa5a8fe335f0af530454b0f" name="a998f4a9b4aa5a8fe335f0af530454b0f"></a>
  440. <h2 class="memtitle"><span class="permalink"><a href="#a998f4a9b4aa5a8fe335f0af530454b0f">&#9670;&#160;</a></span>setNamedCellsMode()</h2>
  441. <div class="memitem">
  442. <div class="memproto">
  443. <table class="memname">
  444. <tr>
  445. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> setNamedCellsMode </td>
  446. <td>(</td>
  447. <td class="paramname"></td><td>)</td>
  448. <td></td>
  449. </tr>
  450. </table>
  451. </div><div class="memdoc">
  452. <p>Sets whether the animation uses names for cells, instead of numerical index. </p><dl class="params"><dt>Parameters</dt><dd>
  453. <table class="params">
  454. <tr><td class="paramname">namedCellsMode</td><td>True if it should be using named cells. </td></tr>
  455. </table>
  456. </dd>
  457. </dl>
  458. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  459. </div>
  460. </div>
  461. </div><!-- contents -->
  462. <!-- start footer part -->
  463. <hr class="footer"/><address class="footer"><small>
  464. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
  465. </small></address>
  466. </body>
  467. </html>