classRenderProxy.html 49 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494
  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: RenderProxy 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="classRenderProxy-members.html">List of all members</a> </div>
  46. <div class="headertitle"><div class="title">RenderProxy Class Reference</div></div>
  47. </div><!--header-->
  48. <div class="contents">
  49. <p><code>#include &lt;RenderProxy_ScriptBinding.h&gt;</code></p>
  50. <p>Inherits <a class="el" href="classSimObject.html">SimObject</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:a6626d48bdc5ee9aaa0fe5b3425624d1e" id="r_a6626d48bdc5ee9aaa0fe5b3425624d1e"><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="classRenderProxy.html#a6626d48bdc5ee9aaa0fe5b3425624d1e">getAnimation</a> ()</td></tr>
  55. <tr class="separator:a6626d48bdc5ee9aaa0fe5b3425624d1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  56. <tr class="memitem:a49dd522e1ce61a1a3adc66b38624f0c5" id="r_a49dd522e1ce61a1a3adc66b38624f0c5"><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="classRenderProxy.html#a49dd522e1ce61a1a3adc66b38624f0c5">getAnimationFrame</a> ()</td></tr>
  57. <tr class="separator:a49dd522e1ce61a1a3adc66b38624f0c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  58. <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="classRenderProxy.html#a9e2e68555b5699aa69c36d257d9f39b1">getAnimationTime</a> ()</td></tr>
  59. <tr class="separator:a9e2e68555b5699aa69c36d257d9f39b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  60. <tr class="memitem:a0819ba673a2065b6a8778fbc83c73c80" id="r_a0819ba673a2065b6a8778fbc83c73c80"><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="classRenderProxy.html#a0819ba673a2065b6a8778fbc83c73c80">getAnimationTimeScale</a> ()</td></tr>
  61. <tr class="separator:a0819ba673a2065b6a8778fbc83c73c80"><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="classRenderProxy.html#a832e57df908361dd86dc673520d7fb81">getImage</a> ()</td></tr>
  63. <tr class="separator:a832e57df908361dd86dc673520d7fb81"><td class="memSeparator" colspan="2">&#160;</td></tr>
  64. <tr class="memitem:a1c39af81a013da77799a4c30974fd618" id="r_a1c39af81a013da77799a4c30974fd618"><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="classRenderProxy.html#a1c39af81a013da77799a4c30974fd618">getImageFrame</a> ()</td></tr>
  65. <tr class="separator:a1c39af81a013da77799a4c30974fd618"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66. <tr class="memitem:ad3fb09be5ba6b8eba7110721e9bd57de" id="r_ad3fb09be5ba6b8eba7110721e9bd57de"><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="classRenderProxy.html#ad3fb09be5ba6b8eba7110721e9bd57de">getIsAnimationFinished</a> ()</td></tr>
  67. <tr class="separator:ad3fb09be5ba6b8eba7110721e9bd57de"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68. <tr class="memitem:a35da1b0e5bd87c33a1c90fa455c824bd" id="r_a35da1b0e5bd87c33a1c90fa455c824bd"><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="classRenderProxy.html#a35da1b0e5bd87c33a1c90fa455c824bd">isStaticFrameProvider</a> ()</td></tr>
  69. <tr class="separator:a35da1b0e5bd87c33a1c90fa455c824bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70. <tr class="memitem:a50a0a39c4b496964ae39dc1cf6bc0205" id="r_a50a0a39c4b496964ae39dc1cf6bc0205"><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="classRenderProxy.html#a50a0a39c4b496964ae39dc1cf6bc0205">pauseAnimation</a> (bool enable)</td></tr>
  71. <tr class="separator:a50a0a39c4b496964ae39dc1cf6bc0205"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72. <tr class="memitem:a2467cc682557a829ed9e9decc89a7c96" id="r_a2467cc682557a829ed9e9decc89a7c96"><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="classRenderProxy.html#a2467cc682557a829ed9e9decc89a7c96">playAnimation</a> (string animationAssetId)</td></tr>
  73. <tr class="separator:a2467cc682557a829ed9e9decc89a7c96"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <tr class="memitem:aab0b1a423b173bc7f83e19bb4a437d99" id="r_aab0b1a423b173bc7f83e19bb4a437d99"><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="classRenderProxy.html#aab0b1a423b173bc7f83e19bb4a437d99">setAnimationFrame</a> (int frame)</td></tr>
  75. <tr class="separator:aab0b1a423b173bc7f83e19bb4a437d99"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem:aea03a067699dfb3e1055c8b59a1a2090" id="r_aea03a067699dfb3e1055c8b59a1a2090"><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="classRenderProxy.html#aea03a067699dfb3e1055c8b59a1a2090">setAnimationTimeScale</a> (float timeScale)</td></tr>
  77. <tr class="separator:aea03a067699dfb3e1055c8b59a1a2090"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:a07a04cdb5656c28601fb16f2a704e23e" id="r_a07a04cdb5656c28601fb16f2a704e23e"><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="classRenderProxy.html#a07a04cdb5656c28601fb16f2a704e23e">setImage</a> (string imageAssetId, [int frame])</td></tr>
  79. <tr class="separator:a07a04cdb5656c28601fb16f2a704e23e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:ae7c385fd1ecd8a1b703512fa3f9261fe" id="r_ae7c385fd1ecd8a1b703512fa3f9261fe"><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="classRenderProxy.html#ae7c385fd1ecd8a1b703512fa3f9261fe">setImageFrame</a> (int frame)</td></tr>
  81. <tr class="separator:ae7c385fd1ecd8a1b703512fa3f9261fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:a84c1367b486680bcf22987540e217cfb" id="r_a84c1367b486680bcf22987540e217cfb"><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="classRenderProxy.html#a84c1367b486680bcf22987540e217cfb">stopAnimation</a> ()</td></tr>
  83. <tr class="separator:a84c1367b486680bcf22987540e217cfb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <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>
  85. <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>
  86. <tr class="separator:a2375929bea4901d98ae352231b0721ad inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <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>
  88. <tr class="separator:a22437f451ceb1429fa2a3be23d523954 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <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>
  90. <tr class="separator:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <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>
  92. <tr class="separator:a929e1325a515b279faca90a65028782e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <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>
  94. <tr class="separator:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <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>
  96. <tr class="separator:a78ee178b6a73658d65ca60da4d1e6683 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <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>
  98. <tr class="separator:ab8b0f8b874af628d7204d9cc2630ced7 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <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>
  100. <tr class="separator:a6e266d4432d70cad58461d96e1d2cbdf inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <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>
  102. <tr class="separator:a847e859bcc5b58df83fa7f331c167c32 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <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>
  104. <tr class="separator:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <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>
  106. <tr class="separator:a8f4e85d0903526235ed2ca86df69cdef inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <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>
  108. <tr class="separator:a9ce8801999cf2228ddde6d58ca3773d5 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <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>
  110. <tr class="separator:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <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>
  112. <tr class="separator:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <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>
  114. <tr class="separator:a66ac731a8dc088fe8c8ab17bf7c9eecd inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <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>
  116. <tr class="separator:a3e97a324df2af082cdb089491757ce11 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <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>
  118. <tr class="separator:abc2222a9649b5c033810e753b07f26a3 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <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>
  120. <tr class="separator:a1084f1964e446b3d279943cf6e575069 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <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>
  122. <tr class="separator:ab4e32fb984d9ce6584b0fa57c8772d3e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <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>
  124. <tr class="separator:a7543b8dc494ec0d9034cb73ae504f3ca inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <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>
  126. <tr class="separator:a0e143217119b68d557d17ac2f13b173e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <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>
  128. <tr class="separator:af2e74f6b683da8d2085f0991dab7948b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <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>
  130. <tr class="separator:ac636f89189406eef1b401292459b1a3b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <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>
  132. <tr class="separator:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <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>
  134. <tr class="separator:a88c8d99755a07ac4648360dd40ff67a5 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <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>
  136. <tr class="separator:a367706e675179342e6153c45f1ba06ae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <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>
  138. <tr class="separator:a0570b7f6eb94a0ed941fd75f6f01555b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <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>
  140. <tr class="separator:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <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>
  142. <tr class="separator:af9f341b474a28f4bcf79bc02439b7c18 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <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>
  144. <tr class="separator:a986f1b4a76969bac5dfd50b22af8dec6 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <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>
  146. <tr class="separator:ae329d6593bb3f9b8046e7cae693ccc09 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <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>
  148. <tr class="separator:a39653bc04e82875f2dc8d6dea25acdaa inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <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>
  150. <tr class="separator:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <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>
  152. <tr class="separator:a5807c03d2b725a54732d09b53d5da631 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. <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>
  154. <tr class="separator:a16d537cd7a1c438045bb756fe1e22d2d inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <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>
  156. <tr class="separator:a9f05bc4a94b98e2e3347fe34aeefe7c4 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. <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>
  158. <tr class="separator:a3f7f0520846a222310415ad7a8f8a4bf inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  159. <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>
  160. <tr class="separator:afa6eac5990b02024e77e3815161159df inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  161. <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>
  162. <tr class="separator:a07dd4cf0d113ff4a8943b900bda68a1c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  163. <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>
  164. <tr class="separator:a87be48ec4599c3d02a118cee89e47f55 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  165. <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>
  166. <tr class="separator:a1dcaa2910d6405134c74a71745d29154 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  167. <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>
  168. <tr class="separator:ab6e816c3694e8b6119bf9ac3f5556f32 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  169. <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>
  170. <tr class="separator:a216228c27df224ac5e8d3590494bfb3f inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  171. <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>
  172. <tr class="separator:ad517bd83c1c853985ab07cd22775c43d inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  173. </table>
  174. <h2 class="groupheader">Member Function Documentation</h2>
  175. <a id="a6626d48bdc5ee9aaa0fe5b3425624d1e" name="a6626d48bdc5ee9aaa0fe5b3425624d1e"></a>
  176. <h2 class="memtitle"><span class="permalink"><a href="#a6626d48bdc5ee9aaa0fe5b3425624d1e">&#9670;&#160;</a></span>getAnimation()</h2>
  177. <div class="memitem">
  178. <div class="memproto">
  179. <table class="memname">
  180. <tr>
  181. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getAnimation </td>
  182. <td>(</td>
  183. <td class="paramname"></td><td>)</td>
  184. <td></td>
  185. </tr>
  186. </table>
  187. </div><div class="memdoc">
  188. <p>Gets current animation asset Id. </p><dl class="section return"><dt>Returns</dt><dd>(string AnimationAssetId) The current animation asset Id. </dd></dl>
  189. </div>
  190. </div>
  191. <a id="a49dd522e1ce61a1a3adc66b38624f0c5" name="a49dd522e1ce61a1a3adc66b38624f0c5"></a>
  192. <h2 class="memtitle"><span class="permalink"><a href="#a49dd522e1ce61a1a3adc66b38624f0c5">&#9670;&#160;</a></span>getAnimationFrame()</h2>
  193. <div class="memitem">
  194. <div class="memproto">
  195. <table class="memname">
  196. <tr>
  197. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getAnimationFrame </td>
  198. <td>(</td>
  199. <td class="paramname"></td><td>)</td>
  200. <td></td>
  201. </tr>
  202. </table>
  203. </div><div class="memdoc">
  204. <p>Gets current animation frame. </p><dl class="section return"><dt>Returns</dt><dd>(int frame) The current animation frame </dd></dl>
  205. </div>
  206. </div>
  207. <a id="a9e2e68555b5699aa69c36d257d9f39b1" name="a9e2e68555b5699aa69c36d257d9f39b1"></a>
  208. <h2 class="memtitle"><span class="permalink"><a href="#a9e2e68555b5699aa69c36d257d9f39b1">&#9670;&#160;</a></span>getAnimationTime()</h2>
  209. <div class="memitem">
  210. <div class="memproto">
  211. <table class="memname">
  212. <tr>
  213. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> getAnimationTime </td>
  214. <td>(</td>
  215. <td class="paramname"></td><td>)</td>
  216. <td></td>
  217. </tr>
  218. </table>
  219. </div><div class="memdoc">
  220. <p>Gets current animation time. </p><dl class="section return"><dt>Returns</dt><dd>(float time) The current animation time </dd></dl>
  221. </div>
  222. </div>
  223. <a id="a0819ba673a2065b6a8778fbc83c73c80" name="a0819ba673a2065b6a8778fbc83c73c80"></a>
  224. <h2 class="memtitle"><span class="permalink"><a href="#a0819ba673a2065b6a8778fbc83c73c80">&#9670;&#160;</a></span>getAnimationTimeScale()</h2>
  225. <div class="memitem">
  226. <div class="memproto">
  227. <table class="memname">
  228. <tr>
  229. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> getAnimationTimeScale </td>
  230. <td>(</td>
  231. <td class="paramname"></td><td>)</td>
  232. <td></td>
  233. </tr>
  234. </table>
  235. </div><div class="memdoc">
  236. <p>Get the animation time scale for this render-proxy. </p><dl class="section return"><dt>Returns</dt><dd>(float) Returns the animation time scale for this render-proxy. </dd></dl>
  237. </div>
  238. </div>
  239. <a id="a832e57df908361dd86dc673520d7fb81" name="a832e57df908361dd86dc673520d7fb81"></a>
  240. <h2 class="memtitle"><span class="permalink"><a href="#a832e57df908361dd86dc673520d7fb81">&#9670;&#160;</a></span>getImage()</h2>
  241. <div class="memitem">
  242. <div class="memproto">
  243. <table class="memname">
  244. <tr>
  245. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getImage </td>
  246. <td>(</td>
  247. <td class="paramname"></td><td>)</td>
  248. <td></td>
  249. </tr>
  250. </table>
  251. </div><div class="memdoc">
  252. <p>Gets current image asset Id. </p><dl class="section return"><dt>Returns</dt><dd>(string imageAssetId) The image being displayed </dd></dl>
  253. </div>
  254. </div>
  255. <a id="a1c39af81a013da77799a4c30974fd618" name="a1c39af81a013da77799a4c30974fd618"></a>
  256. <h2 class="memtitle"><span class="permalink"><a href="#a1c39af81a013da77799a4c30974fd618">&#9670;&#160;</a></span>getImageFrame()</h2>
  257. <div class="memitem">
  258. <div class="memproto">
  259. <table class="memname">
  260. <tr>
  261. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getImageFrame </td>
  262. <td>(</td>
  263. <td class="paramname"></td><td>)</td>
  264. <td></td>
  265. </tr>
  266. </table>
  267. </div><div class="memdoc">
  268. <p>Gets current image Frame. </p><dl class="section return"><dt>Returns</dt><dd>(int frame) The frame currently being displayed </dd></dl>
  269. </div>
  270. </div>
  271. <a id="ad3fb09be5ba6b8eba7110721e9bd57de" name="ad3fb09be5ba6b8eba7110721e9bd57de"></a>
  272. <h2 class="memtitle"><span class="permalink"><a href="#ad3fb09be5ba6b8eba7110721e9bd57de">&#9670;&#160;</a></span>getIsAnimationFinished()</h2>
  273. <div class="memitem">
  274. <div class="memproto">
  275. <table class="memname">
  276. <tr>
  277. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> getIsAnimationFinished </td>
  278. <td>(</td>
  279. <td class="paramname"></td><td>)</td>
  280. <td></td>
  281. </tr>
  282. </table>
  283. </div><div class="memdoc">
  284. <p>Checks animation status. </p><dl class="section return"><dt>Returns</dt><dd>(bool finished) Whether or not the animation is finished </dd></dl>
  285. </div>
  286. </div>
  287. <a id="a35da1b0e5bd87c33a1c90fa455c824bd" name="a35da1b0e5bd87c33a1c90fa455c824bd"></a>
  288. <h2 class="memtitle"><span class="permalink"><a href="#a35da1b0e5bd87c33a1c90fa455c824bd">&#9670;&#160;</a></span>isStaticFrameProvider()</h2>
  289. <div class="memitem">
  290. <div class="memproto">
  291. <table class="memname">
  292. <tr>
  293. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> isStaticFrameProvider </td>
  294. <td>(</td>
  295. <td class="paramname"></td><td>)</td>
  296. <td></td>
  297. </tr>
  298. </table>
  299. </div><div class="memdoc">
  300. <p>Gets whether the render-proxy is in static or dynamic (animated)mode. </p><dl class="section return"><dt>Returns</dt><dd>Returns whether the render-proxy is in static or dynamic (animated)mode. </dd></dl>
  301. </div>
  302. </div>
  303. <a id="a50a0a39c4b496964ae39dc1cf6bc0205" name="a50a0a39c4b496964ae39dc1cf6bc0205"></a>
  304. <h2 class="memtitle"><span class="permalink"><a href="#a50a0a39c4b496964ae39dc1cf6bc0205">&#9670;&#160;</a></span>pauseAnimation()</h2>
  305. <div class="memitem">
  306. <div class="memproto">
  307. <table class="memname">
  308. <tr>
  309. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> pauseAnimation </td>
  310. <td>(</td>
  311. <td class="paramtype">bool&#160;</td>
  312. <td class="paramname"><em>enable</em></td><td>)</td>
  313. <td></td>
  314. </tr>
  315. </table>
  316. </div><div class="memdoc">
  317. <p>Pause the current animation </p><dl class="params"><dt>Parameters</dt><dd>
  318. <table class="params">
  319. <tr><td class="paramname">enable</td><td>If true, pause the animation. If false, continue animating </td></tr>
  320. </table>
  321. </dd>
  322. </dl>
  323. </div>
  324. </div>
  325. <a id="a2467cc682557a829ed9e9decc89a7c96" name="a2467cc682557a829ed9e9decc89a7c96"></a>
  326. <h2 class="memtitle"><span class="permalink"><a href="#a2467cc682557a829ed9e9decc89a7c96">&#9670;&#160;</a></span>playAnimation()</h2>
  327. <div class="memitem">
  328. <div class="memproto">
  329. <table class="memname">
  330. <tr>
  331. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> playAnimation </td>
  332. <td>(</td>
  333. <td class="paramtype">string&#160;</td>
  334. <td class="paramname"><em>animationAssetId</em></td><td>)</td>
  335. <td></td>
  336. </tr>
  337. </table>
  338. </div><div class="memdoc">
  339. <p>Plays an animation. </p><dl class="params"><dt>Parameters</dt><dd>
  340. <table class="params">
  341. <tr><td class="paramname">animationAssetId</td><td>The animation asset Id to play </td></tr>
  342. </table>
  343. </dd>
  344. </dl>
  345. <dl class="section return"><dt>Returns</dt><dd>Returns true on success. </dd></dl>
  346. </div>
  347. </div>
  348. <a id="aab0b1a423b173bc7f83e19bb4a437d99" name="aab0b1a423b173bc7f83e19bb4a437d99"></a>
  349. <h2 class="memtitle"><span class="permalink"><a href="#aab0b1a423b173bc7f83e19bb4a437d99">&#9670;&#160;</a></span>setAnimationFrame()</h2>
  350. <div class="memitem">
  351. <div class="memproto">
  352. <table class="memname">
  353. <tr>
  354. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> setAnimationFrame </td>
  355. <td>(</td>
  356. <td class="paramtype">int&#160;</td>
  357. <td class="paramname"><em>frame</em></td><td>)</td>
  358. <td></td>
  359. </tr>
  360. </table>
  361. </div><div class="memdoc">
  362. <p>Sets the current animation frame. </p><dl class="params"><dt>Parameters</dt><dd>
  363. <table class="params">
  364. <tr><td class="paramname">frame</td><td>Which frame of the animation to display </td></tr>
  365. </table>
  366. </dd>
  367. </dl>
  368. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  369. </div>
  370. </div>
  371. <a id="aea03a067699dfb3e1055c8b59a1a2090" name="aea03a067699dfb3e1055c8b59a1a2090"></a>
  372. <h2 class="memtitle"><span class="permalink"><a href="#aea03a067699dfb3e1055c8b59a1a2090">&#9670;&#160;</a></span>setAnimationTimeScale()</h2>
  373. <div class="memitem">
  374. <div class="memproto">
  375. <table class="memname">
  376. <tr>
  377. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> setAnimationTimeScale </td>
  378. <td>(</td>
  379. <td class="paramtype">float&#160;</td>
  380. <td class="paramname"><em>timeScale</em></td><td>)</td>
  381. <td></td>
  382. </tr>
  383. </table>
  384. </div><div class="memdoc">
  385. <p>Change the rate of animation. </p><dl class="params"><dt>Parameters</dt><dd>
  386. <table class="params">
  387. <tr><td class="paramname">timeScale</td><td>Value which will scale the frame animation speed. 1 by default. </td></tr>
  388. </table>
  389. </dd>
  390. </dl>
  391. </div>
  392. </div>
  393. <a id="a07a04cdb5656c28601fb16f2a704e23e" name="a07a04cdb5656c28601fb16f2a704e23e"></a>
  394. <h2 class="memtitle"><span class="permalink"><a href="#a07a04cdb5656c28601fb16f2a704e23e">&#9670;&#160;</a></span>setImage()</h2>
  395. <div class="memitem">
  396. <div class="memproto">
  397. <table class="memname">
  398. <tr>
  399. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> setImage </td>
  400. <td>(</td>
  401. <td class="paramtype">string&#160;</td>
  402. <td class="paramname"><em>imageAssetId</em></td><td>)</td>
  403. <td></td>
  404. </tr>
  405. </table>
  406. </div><div class="memdoc">
  407. <p>Sets imageAssetId/Frame. </p><dl class="params"><dt>Parameters</dt><dd>
  408. <table class="params">
  409. <tr><td class="paramname">imageAssetId</td><td>The image asset Id to display </td></tr>
  410. <tr><td class="paramname">frame</td><td>The frame of the image to display </td></tr>
  411. </table>
  412. </dd>
  413. </dl>
  414. <dl class="section return"><dt>Returns</dt><dd>Returns true on success. </dd></dl>
  415. </div>
  416. </div>
  417. <a id="ae7c385fd1ecd8a1b703512fa3f9261fe" name="ae7c385fd1ecd8a1b703512fa3f9261fe"></a>
  418. <h2 class="memtitle"><span class="permalink"><a href="#ae7c385fd1ecd8a1b703512fa3f9261fe">&#9670;&#160;</a></span>setImageFrame()</h2>
  419. <div class="memitem">
  420. <div class="memproto">
  421. <table class="memname">
  422. <tr>
  423. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> setImageFrame </td>
  424. <td>(</td>
  425. <td class="paramtype">int&#160;</td>
  426. <td class="paramname"><em>frame</em></td><td>)</td>
  427. <td></td>
  428. </tr>
  429. </table>
  430. </div><div class="memdoc">
  431. <p>Sets image frame. </p><dl class="params"><dt>Parameters</dt><dd>
  432. <table class="params">
  433. <tr><td class="paramname">frame</td><td>The frame to display </td></tr>
  434. </table>
  435. </dd>
  436. </dl>
  437. <dl class="section return"><dt>Returns</dt><dd>Returns true on success. </dd></dl>
  438. </div>
  439. </div>
  440. <a id="a84c1367b486680bcf22987540e217cfb" name="a84c1367b486680bcf22987540e217cfb"></a>
  441. <h2 class="memtitle"><span class="permalink"><a href="#a84c1367b486680bcf22987540e217cfb">&#9670;&#160;</a></span>stopAnimation()</h2>
  442. <div class="memitem">
  443. <div class="memproto">
  444. <table class="memname">
  445. <tr>
  446. <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> stopAnimation </td>
  447. <td>(</td>
  448. <td class="paramname"></td><td>)</td>
  449. <td></td>
  450. </tr>
  451. </table>
  452. </div><div class="memdoc">
  453. <p>Stop the current animation </p><dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  454. </div>
  455. </div>
  456. </div><!-- contents -->
  457. <!-- start footer part -->
  458. <hr class="footer"/><address class="footer"><small>
  459. 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
  460. </small></address>
  461. </body>
  462. </html>