Home Explore Help
Sign In
TorqueEngine
/
Torque2D
mirror of https://github.com/TorqueGameEngines/Torque2D.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: 6bcbc35cd1
Branches Tags
Torque2D
/
TorqueScriptDocs
/
html
/
classRenderProxy.html

classRenderProxy.html 38 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    6. 

  6. <meta name="generator" content="Doxygen 1.8.10"/>
    7. 

  7. <title>TorqueScript Reference: RenderProxy Class Reference</title>
    8. 

  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    9. 

  9. <script type="text/javascript" src="jquery.js"></script>
    10. 

  10. <script type="text/javascript" src="dynsections.js"></script>
    11. 

  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
    12. 

  12. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
    13. 

  13. </head>
    14. 

  14. <body>
    15. 

  15. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    16. 

  16. <div id="titlearea">
    17. 

  17. <table cellspacing="0" cellpadding="0">
    18. 

  18.  <tbody>
    19. 

  19.  <tr style="height: 56px;">
    20. 

  20.   <td id="projectalign" style="padding-left: 0.5em;">
    21. 

  21.    <div id="projectname">TorqueScript Reference
    22. 

  22.    </div>
    23. 

  23.   </td>
    24. 

  24.  </tr>
    25. 

  25.  </tbody>
    26. 

  26. </table>
    27. 

  27. </div>
    28. 

  28. <!-- end header part -->
    29. 

  29. <!-- Generated by Doxygen 1.8.10 -->
    30. 

  30.   <div id="navrow1" class="tabs">
    31. 

  31.     <ul class="tablist">
    32. 

  32.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
    33. 

  33.       <li><a href="modules.html"><span>Modules</span></a></li>
    34. 

  34.       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
    35. 

  35.     </ul>
    36. 

  36.   </div>
    37. 

  37.   <div id="navrow2" class="tabs2">
    38. 

  38.     <ul class="tablist">
    39. 

  39.       <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
    40. 

  40.       <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
    41. 

  41.       <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
    42. 

  42.       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    43. 

  43.     </ul>
    44. 

  44.   </div>
    45. 

  45. </div><!-- top -->
    46. 

  46. <div class="header">
    47. 

  47.   <div class="summary">
    48. 

  48. <a href="#pub-methods">Public Member Functions</a> &#124;
    49. 

  49. <a href="classRenderProxy-members.html">List of all members</a>  </div>
    50. 

  50.   <div class="headertitle">
    51. 

  51. <div class="title">RenderProxy Class Reference</div>  </div>
    52. 

  52. </div><!--header-->
    53. 

  53. <div class="contents">
    54. 

  54. 

  55. <p>Inherits <a class="el" href="classSimObject.html">SimObject</a>.</p>
    56. 

  56. <table class="memberdecls">
    57. 

  57. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
    58. 

  58. Public Member Functions</h2></td></tr>
    59. 

  59. <tr class="memitem: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>
    60. 

  60. <tr class="separator:a6626d48bdc5ee9aaa0fe5b3425624d1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
    61. 

  61. <tr class="memitem: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>
    62. 

  62. <tr class="separator:a49dd522e1ce61a1a3adc66b38624f0c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
    63. 

  63. <tr class="memitem: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>
    64. 

  64. <tr class="separator:a9e2e68555b5699aa69c36d257d9f39b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
    65. 

  65. <tr class="memitem: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>
    66. 

  66. <tr class="separator:a0819ba673a2065b6a8778fbc83c73c80"><td class="memSeparator" colspan="2">&#160;</td></tr>
    67. 

  67. <tr class="memitem: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>
    68. 

  68. <tr class="separator:a832e57df908361dd86dc673520d7fb81"><td class="memSeparator" colspan="2">&#160;</td></tr>
    69. 

  69. <tr class="memitem: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>
    70. 

  70. <tr class="separator:a1c39af81a013da77799a4c30974fd618"><td class="memSeparator" colspan="2">&#160;</td></tr>
    71. 

  71. <tr class="memitem: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>
    72. 

  72. <tr class="separator:ad3fb09be5ba6b8eba7110721e9bd57de"><td class="memSeparator" colspan="2">&#160;</td></tr>
    73. 

  73. <tr class="memitem: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>
    74. 

  74. <tr class="separator:a35da1b0e5bd87c33a1c90fa455c824bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
    75. 

  75. <tr class="memitem:a50a0a39c4b496964ae39dc1cf6bc0205"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRenderProxy.html#a50a0a39c4b496964ae39dc1cf6bc0205">pauseAnimation</a> (bool enable)</td></tr>
    76. 

  76. <tr class="separator:a50a0a39c4b496964ae39dc1cf6bc0205"><td class="memSeparator" colspan="2">&#160;</td></tr>
    77. 

  77. <tr class="memitem: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>
    78. 

  78. <tr class="separator:a2467cc682557a829ed9e9decc89a7c96"><td class="memSeparator" colspan="2">&#160;</td></tr>
    79. 

  79. <tr class="memitem:aab0b1a423b173bc7f83e19bb4a437d99"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRenderProxy.html#aab0b1a423b173bc7f83e19bb4a437d99">setAnimationFrame</a> (int frame)</td></tr>
    80. 

  80. <tr class="separator:aab0b1a423b173bc7f83e19bb4a437d99"><td class="memSeparator" colspan="2">&#160;</td></tr>
    81. 

  81. <tr class="memitem:aea03a067699dfb3e1055c8b59a1a2090"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRenderProxy.html#aea03a067699dfb3e1055c8b59a1a2090">setAnimationTimeScale</a> (float timeScale)</td></tr>
    82. 

  82. <tr class="separator:aea03a067699dfb3e1055c8b59a1a2090"><td class="memSeparator" colspan="2">&#160;</td></tr>
    83. 

  83. <tr class="memitem: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>
    84. 

  84. <tr class="separator:a07a04cdb5656c28601fb16f2a704e23e"><td class="memSeparator" colspan="2">&#160;</td></tr>
    85. 

  85. <tr class="memitem: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>
    86. 

  86. <tr class="separator:ae7c385fd1ecd8a1b703512fa3f9261fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
    87. 

  87. <tr class="memitem:a84c1367b486680bcf22987540e217cfb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRenderProxy.html#a84c1367b486680bcf22987540e217cfb">stopAnimation</a> ()</td></tr>
    88. 

  88. <tr class="separator:a84c1367b486680bcf22987540e217cfb"><td class="memSeparator" colspan="2">&#160;</td></tr>
    89. 

  89. <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>
    90. 

  90. <tr class="memitem:a22437f451ceb1429fa2a3be23d523954 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a22437f451ceb1429fa2a3be23d523954">clone</a> ([copyDynamicFields=false]?)</td></tr>
    91. 

  91. <tr class="separator:a22437f451ceb1429fa2a3be23d523954 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
    92. 

  92. <tr class="memitem:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a7a4721d0a51e952c211e9b0fea4d8090">delete</a> ()</td></tr>
    93. 

  93. <tr class="separator:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
    94. 

  94. <tr class="memitem:a929e1325a515b279faca90a65028782e inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a929e1325a515b279faca90a65028782e">getId</a> ()</td></tr>
    95. 

  95. <tr class="separator:a929e1325a515b279faca90a65028782e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
    96. 

  96. <tr class="memitem:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a4f673cd959711ae09927e7c44dae5fdb">setName</a> (newName)</td></tr>
    97. 

  97. <tr class="separator:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
    98. 

  98. <tr class="memitem:a78ee178b6a73658d65ca60da4d1e6683 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a78ee178b6a73658d65ca60da4d1e6683">getName</a> ()</td></tr>
    99. 

  99. <tr class="separator:a78ee178b6a73658d65ca60da4d1e6683 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
    100. 

  100. <tr class="memitem:ab8b0f8b874af628d7204d9cc2630ced7 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab8b0f8b874af628d7204d9cc2630ced7">getClassNamespace</a> ()</td></tr>
    101. 

  101. <tr class="separator:ab8b0f8b874af628d7204d9cc2630ced7 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
    102. 

  102. <tr class="memitem:a6e266d4432d70cad58461d96e1d2cbdf inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a6e266d4432d70cad58461d96e1d2cbdf">getSuperClassNamespace</a> ()</td></tr>
    103. 

  103. <tr class="separator:a6e266d4432d70cad58461d96e1d2cbdf inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
    104. 

  104. <tr class="memitem:a847e859bcc5b58df83fa7f331c167c32 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a847e859bcc5b58df83fa7f331c167c32">setClassNamespace</a> (nameSpace)</td></tr>
    105. 

  105. <tr class="separator:a847e859bcc5b58df83fa7f331c167c32 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
    106. 

  106. <tr class="memitem:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a9cbf471b97387d5bdefb88f92094ad54">setSuperClassNamespace</a> ()</td></tr>
    107. 

  107. <tr class="separator:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
    108. 

  108. <tr class="memitem:a8f4e85d0903526235ed2ca86df69cdef inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a8f4e85d0903526235ed2ca86df69cdef">isMethod</a> (string methodName)</td></tr>
    109. 

  109. <tr class="separator:a8f4e85d0903526235ed2ca86df69cdef inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
    110. 

  110. <tr class="memitem:abd9730d5538d1713b82fe92bca7b5cba inherit pub_methods_classSimObject"><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#abd9730d5538d1713b82fe92bca7b5cba">call</a> (methodName, [args]*)</td></tr>
    111. 

  111. <tr class="separator:abd9730d5538d1713b82fe92bca7b5cba inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
    112. 

  112. <tr class="memitem:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1810f5aba25efd242c24232c2c2bbd1a">dumpClassHierarchy</a> ()</td></tr>
    113. 

  113. <tr class="separator:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
    114. 

  114. <tr class="memitem:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#accd2600060dbaee3a3b41aed4034c63c">dump</a> ()</td></tr>
    115. 

  115. <tr class="separator:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
    116. 

  116. <tr class="memitem:a66ac731a8dc088fe8c8ab17bf7c9eecd inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a66ac731a8dc088fe8c8ab17bf7c9eecd">isMemberOfClass</a> (string classname)</td></tr>
    117. 

  117. <tr class="separator:a66ac731a8dc088fe8c8ab17bf7c9eecd inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
    118. 

  118. <tr class="memitem:a3e97a324df2af082cdb089491757ce11 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a3e97a324df2af082cdb089491757ce11">getClassName</a> ()</td></tr>
    119. 

  119. <tr class="separator:a3e97a324df2af082cdb089491757ce11 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
    120. 

  120. <tr class="memitem:abc2222a9649b5c033810e753b07f26a3 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#abc2222a9649b5c033810e753b07f26a3">getFieldValue</a> (fieldName)</td></tr>
    121. 

  121. <tr class="separator:abc2222a9649b5c033810e753b07f26a3 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
    122. 

  122. <tr class="memitem:a1084f1964e446b3d279943cf6e575069 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1084f1964e446b3d279943cf6e575069">setFieldValue</a> (fieldName, value)</td></tr>
    123. 

  123. <tr class="separator:a1084f1964e446b3d279943cf6e575069 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
    124. 

  124. <tr class="memitem:a7543b8dc494ec0d9034cb73ae504f3ca inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a7543b8dc494ec0d9034cb73ae504f3ca">getDynamicFieldCount</a> ()</td></tr>
    125. 

  125. <tr class="separator:a7543b8dc494ec0d9034cb73ae504f3ca inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
    126. 

  126. <tr class="memitem:a0e143217119b68d557d17ac2f13b173e inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0e143217119b68d557d17ac2f13b173e">getDynamicField</a> (index)</td></tr>
    127. 

  127. <tr class="separator:a0e143217119b68d557d17ac2f13b173e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
    128. 

  128. <tr class="memitem:af2e74f6b683da8d2085f0991dab7948b inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#af2e74f6b683da8d2085f0991dab7948b">getFieldCount</a> ()</td></tr>
    129. 

  129. <tr class="separator:af2e74f6b683da8d2085f0991dab7948b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
    130. 

  130. <tr class="memitem:ac636f89189406eef1b401292459b1a3b inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ac636f89189406eef1b401292459b1a3b">getField</a> (int index)</td></tr>
    131. 

  131. <tr class="separator:ac636f89189406eef1b401292459b1a3b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
    132. 

  132. <tr class="memitem:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa8f68d1e6d8c6601c39b3f676f0e9c70">setProgenitorFile</a> (file)</td></tr>
    133. 

  133. <tr class="separator:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
    134. 

  134. <tr class="memitem:a88c8d99755a07ac4648360dd40ff67a5 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a88c8d99755a07ac4648360dd40ff67a5">getProgenitorFile</a> ()</td></tr>
    135. 

  135. <tr class="separator:a88c8d99755a07ac4648360dd40ff67a5 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
    136. 

  136. <tr class="memitem:a367706e675179342e6153c45f1ba06ae inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a367706e675179342e6153c45f1ba06ae">getType</a> ()</td></tr>
    137. 

  137. <tr class="separator:a367706e675179342e6153c45f1ba06ae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
    138. 

  138. <tr class="memitem:a0570b7f6eb94a0ed941fd75f6f01555b inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0570b7f6eb94a0ed941fd75f6f01555b">getFieldType</a> (fieldName)</td></tr>
    139. 

  139. <tr class="separator:a0570b7f6eb94a0ed941fd75f6f01555b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
    140. 

  140. <tr class="memitem:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a5aaca360a719feabae0e4e57b921deae">setInternalName</a> (string InternalName)</td></tr>
    141. 

  141. <tr class="separator:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
    142. 

  142. <tr class="memitem:af9f341b474a28f4bcf79bc02439b7c18 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#af9f341b474a28f4bcf79bc02439b7c18">getInternalName</a> ()</td></tr>
    143. 

  143. <tr class="separator:af9f341b474a28f4bcf79bc02439b7c18 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
    144. 

  144. <tr class="memitem:a986f1b4a76969bac5dfd50b22af8dec6 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a986f1b4a76969bac5dfd50b22af8dec6">isChildOfGroup</a> (groupID)</td></tr>
    145. 

  145. <tr class="separator:a986f1b4a76969bac5dfd50b22af8dec6 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
    146. 

  146. <tr class="memitem:ae329d6593bb3f9b8046e7cae693ccc09 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ae329d6593bb3f9b8046e7cae693ccc09">getGroup</a> ()</td></tr>
    147. 

  147. <tr class="separator:ae329d6593bb3f9b8046e7cae693ccc09 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
    148. 

  148. <tr class="memitem:a39653bc04e82875f2dc8d6dea25acdaa inherit pub_methods_classSimObject"><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>
    149. 

  149. <tr class="separator:a39653bc04e82875f2dc8d6dea25acdaa inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
    150. 

  150. <tr class="memitem:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa6f6bfef028c7b053444cbd48567d286">stopTimer</a> ()</td></tr>
    151. 

  151. <tr class="separator:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
    152. 

  152. <tr class="memitem:a5807c03d2b725a54732d09b53d5da631 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a5807c03d2b725a54732d09b53d5da631">isTimerActive</a> ()</td></tr>
    153. 

  153. <tr class="separator:a5807c03d2b725a54732d09b53d5da631 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
    154. 

  154. <tr class="memitem:ab5179f3203c92793cb8f4e6066b55e39 inherit pub_methods_classSimObject"><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#ab5179f3203c92793cb8f4e6066b55e39">schedule</a> (time, command, [arg]*)</td></tr>
    155. 

  155. <tr class="separator:ab5179f3203c92793cb8f4e6066b55e39 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
    156. 

  156. <tr class="memitem:ab6e816c3694e8b6119bf9ac3f5556f32 inherit pub_methods_classSimObject"><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>
    157. 

  157. <tr class="separator:ab6e816c3694e8b6119bf9ac3f5556f32 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
    158. 

  158. <tr class="memitem:a216228c27df224ac5e8d3590494bfb3f inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a216228c27df224ac5e8d3590494bfb3f">addFieldFilter</a> (fieldName)</td></tr>
    159. 

  159. <tr class="separator:a216228c27df224ac5e8d3590494bfb3f inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
    160. 

  160. <tr class="memitem:ad517bd83c1c853985ab07cd22775c43d inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ad517bd83c1c853985ab07cd22775c43d">removeFieldFilter</a> (fieldName)</td></tr>
    161. 

  161. <tr class="separator:ad517bd83c1c853985ab07cd22775c43d inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
    162. 

  162. </table>
    163. 

  163. <h2 class="groupheader">Member Function Documentation</h2>
    164. 

  164. <a class="anchor" id="a6626d48bdc5ee9aaa0fe5b3425624d1e"></a>
    165. 

  165. <div class="memitem">
    166. 

  166. <div class="memproto">
    167. 

  167.       <table class="memname">
    168. 

  168.         <tr>
    169. 

  169.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getAnimation </td>
    170. 

  170.           <td>(</td>
    171. 

  171.           <td class="paramname"></td><td>)</td>
    172. 

  172.           <td></td>
    173. 

  173.         </tr>
    174. 

  174.       </table>
    175. 

  175. </div><div class="memdoc">
    176. 

  176. <p>Gets current animation asset Id. </p><dl class="section return"><dt>Returns</dt><dd>(string AnimationAssetId) The current animation asset Id. </dd></dl>
    177. 

  177. 

  178. </div>
    179. 

  179. </div>
    180. 

  180. <a class="anchor" id="a49dd522e1ce61a1a3adc66b38624f0c5"></a>
    181. 

  181. <div class="memitem">
    182. 

  182. <div class="memproto">
    183. 

  183.       <table class="memname">
    184. 

  184.         <tr>
    185. 

  185.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getAnimationFrame </td>
    186. 

  186.           <td>(</td>
    187. 

  187.           <td class="paramname"></td><td>)</td>
    188. 

  188.           <td></td>
    189. 

  189.         </tr>
    190. 

  190.       </table>
    191. 

  191. </div><div class="memdoc">
    192. 

  192. <p>Gets current animation frame. </p><dl class="section return"><dt>Returns</dt><dd>(int frame) The current animation frame </dd></dl>
    193. 

  193. 

  194. </div>
    195. 

  195. </div>
    196. 

  196. <a class="anchor" id="a9e2e68555b5699aa69c36d257d9f39b1"></a>
    197. 

  197. <div class="memitem">
    198. 

  198. <div class="memproto">
    199. 

  199.       <table class="memname">
    200. 

  200.         <tr>
    201. 

  201.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> getAnimationTime </td>
    202. 

  202.           <td>(</td>
    203. 

  203.           <td class="paramname"></td><td>)</td>
    204. 

  204.           <td></td>
    205. 

  205.         </tr>
    206. 

  206.       </table>
    207. 

  207. </div><div class="memdoc">
    208. 

  208. <p>Gets current animation time. </p><dl class="section return"><dt>Returns</dt><dd>(float time) The current animation time </dd></dl>
    209. 

  209. 

  210. </div>
    211. 

  211. </div>
    212. 

  212. <a class="anchor" id="a0819ba673a2065b6a8778fbc83c73c80"></a>
    213. 

  213. <div class="memitem">
    214. 

  214. <div class="memproto">
    215. 

  215.       <table class="memname">
    216. 

  216.         <tr>
    217. 

  217.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> getAnimationTimeScale </td>
    218. 

  218.           <td>(</td>
    219. 

  219.           <td class="paramname"></td><td>)</td>
    220. 

  220.           <td></td>
    221. 

  221.         </tr>
    222. 

  222.       </table>
    223. 

  223. </div><div class="memdoc">
    224. 

  224. <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>
    225. 

  225. 

  226. </div>
    227. 

  227. </div>
    228. 

  228. <a class="anchor" id="a832e57df908361dd86dc673520d7fb81"></a>
    229. 

  229. <div class="memitem">
    230. 

  230. <div class="memproto">
    231. 

  231.       <table class="memname">
    232. 

  232.         <tr>
    233. 

  233.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getImage </td>
    234. 

  234.           <td>(</td>
    235. 

  235.           <td class="paramname"></td><td>)</td>
    236. 

  236.           <td></td>
    237. 

  237.         </tr>
    238. 

  238.       </table>
    239. 

  239. </div><div class="memdoc">
    240. 

  240. <p>Gets current image asset Id. </p><dl class="section return"><dt>Returns</dt><dd>(string imageAssetId) The image being displayed </dd></dl>
    241. 

  241. 

  242. </div>
    243. 

  243. </div>
    244. 

  244. <a class="anchor" id="a1c39af81a013da77799a4c30974fd618"></a>
    245. 

  245. <div class="memitem">
    246. 

  246. <div class="memproto">
    247. 

  247.       <table class="memname">
    248. 

  248.         <tr>
    249. 

  249.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getImageFrame </td>
    250. 

  250.           <td>(</td>
    251. 

  251.           <td class="paramname"></td><td>)</td>
    252. 

  252.           <td></td>
    253. 

  253.         </tr>
    254. 

  254.       </table>
    255. 

  255. </div><div class="memdoc">
    256. 

  256. <p>Gets current image Frame. </p><dl class="section return"><dt>Returns</dt><dd>(int frame) The frame currently being displayed </dd></dl>
    257. 

  257. 

  258. </div>
    259. 

  259. </div>
    260. 

  260. <a class="anchor" id="ad3fb09be5ba6b8eba7110721e9bd57de"></a>
    261. 

  261. <div class="memitem">
    262. 

  262. <div class="memproto">
    263. 

  263.       <table class="memname">
    264. 

  264.         <tr>
    265. 

  265.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> getIsAnimationFinished </td>
    266. 

  266.           <td>(</td>
    267. 

  267.           <td class="paramname"></td><td>)</td>
    268. 

  268.           <td></td>
    269. 

  269.         </tr>
    270. 

  270.       </table>
    271. 

  271. </div><div class="memdoc">
    272. 

  272. <p>Checks animation status. </p><dl class="section return"><dt>Returns</dt><dd>(bool finished) Whether or not the animation is finished </dd></dl>
    273. 

  273. 

  274. </div>
    275. 

  275. </div>
    276. 

  276. <a class="anchor" id="a35da1b0e5bd87c33a1c90fa455c824bd"></a>
    277. 

  277. <div class="memitem">
    278. 

  278. <div class="memproto">
    279. 

  279.       <table class="memname">
    280. 

  280.         <tr>
    281. 

  281.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> isStaticFrameProvider </td>
    282. 

  282.           <td>(</td>
    283. 

  283.           <td class="paramname"></td><td>)</td>
    284. 

  284.           <td></td>
    285. 

  285.         </tr>
    286. 

  286.       </table>
    287. 

  287. </div><div class="memdoc">
    288. 

  288. <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>
    289. 

  289. 

  290. </div>
    291. 

  291. </div>
    292. 

  292. <a class="anchor" id="a50a0a39c4b496964ae39dc1cf6bc0205"></a>
    293. 

  293. <div class="memitem">
    294. 

  294. <div class="memproto">
    295. 

  295.       <table class="memname">
    296. 

  296.         <tr>
    297. 

  297.           <td class="memname">void pauseAnimation </td>
    298. 

  298.           <td>(</td>
    299. 

  299.           <td class="paramtype">bool&#160;</td>
    300. 

  300.           <td class="paramname"><em>enable</em></td><td>)</td>
    301. 

  301.           <td></td>
    302. 

  302.         </tr>
    303. 

  303.       </table>
    304. 

  304. </div><div class="memdoc">
    305. 

  305. <p>Pause the current animation </p><dl class="params"><dt>Parameters</dt><dd>
    306. 

  306.   <table class="params">
    307. 

  307.     <tr><td class="paramname">enable</td><td>If true, pause the animation. If false, continue animating </td></tr>
    308. 

  308.   </table>
    309. 

  309.   </dd>
    310. 

  310. </dl>
    311. 

  311. 

  312. </div>
    313. 

  313. </div>
    314. 

  314. <a class="anchor" id="a2467cc682557a829ed9e9decc89a7c96"></a>
    315. 

  315. <div class="memitem">
    316. 

  316. <div class="memproto">
    317. 

  317.       <table class="memname">
    318. 

  318.         <tr>
    319. 

  319.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> playAnimation </td>
    320. 

  320.           <td>(</td>
    321. 

  321.           <td class="paramtype">string&#160;</td>
    322. 

  322.           <td class="paramname"><em>animationAssetId</em></td><td>)</td>
    323. 

  323.           <td></td>
    324. 

  324.         </tr>
    325. 

  325.       </table>
    326. 

  326. </div><div class="memdoc">
    327. 

  327. <p>Plays an animation. </p><dl class="params"><dt>Parameters</dt><dd>
    328. 

  328.   <table class="params">
    329. 

  329.     <tr><td class="paramname">animationAssetId</td><td>The animation asset Id to play </td></tr>
    330. 

  330.   </table>
    331. 

  331.   </dd>
    332. 

  332. </dl>
    333. 

  333. <dl class="section return"><dt>Returns</dt><dd>Returns true on success. </dd></dl>
    334. 

  334. 

  335. </div>
    336. 

  336. </div>
    337. 

  337. <a class="anchor" id="aab0b1a423b173bc7f83e19bb4a437d99"></a>
    338. 

  338. <div class="memitem">
    339. 

  339. <div class="memproto">
    340. 

  340.       <table class="memname">
    341. 

  341.         <tr>
    342. 

  342.           <td class="memname">void setAnimationFrame </td>
    343. 

  343.           <td>(</td>
    344. 

  344.           <td class="paramtype">int&#160;</td>
    345. 

  345.           <td class="paramname"><em>frame</em></td><td>)</td>
    346. 

  346.           <td></td>
    347. 

  347.         </tr>
    348. 

  348.       </table>
    349. 

  349. </div><div class="memdoc">
    350. 

  350. <p>Sets the current animation frame. </p><dl class="params"><dt>Parameters</dt><dd>
    351. 

  351.   <table class="params">
    352. 

  352.     <tr><td class="paramname">frame</td><td>Which frame of the animation to display </td></tr>
    353. 

  353.   </table>
    354. 

  354.   </dd>
    355. 

  355. </dl>
    356. 

  356. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
    357. 

  357. 

  358. </div>
    359. 

  359. </div>
    360. 

  360. <a class="anchor" id="aea03a067699dfb3e1055c8b59a1a2090"></a>
    361. 

  361. <div class="memitem">
    362. 

  362. <div class="memproto">
    363. 

  363.       <table class="memname">
    364. 

  364.         <tr>
    365. 

  365.           <td class="memname">void setAnimationTimeScale </td>
    366. 

  366.           <td>(</td>
    367. 

  367.           <td class="paramtype">float&#160;</td>
    368. 

  368.           <td class="paramname"><em>timeScale</em></td><td>)</td>
    369. 

  369.           <td></td>
    370. 

  370.         </tr>
    371. 

  371.       </table>
    372. 

  372. </div><div class="memdoc">
    373. 

  373. <p>Change the rate of animation. </p><dl class="params"><dt>Parameters</dt><dd>
    374. 

  374.   <table class="params">
    375. 

  375.     <tr><td class="paramname">timeScale</td><td>Value which will scale the frame animation speed. 1 by default. </td></tr>
    376. 

  376.   </table>
    377. 

  377.   </dd>
    378. 

  378. </dl>
    379. 

  379. 

  380. </div>
    381. 

  381. </div>
    382. 

  382. <a class="anchor" id="a07a04cdb5656c28601fb16f2a704e23e"></a>
    383. 

  383. <div class="memitem">
    384. 

  384. <div class="memproto">
    385. 

  385.       <table class="memname">
    386. 

  386.         <tr>
    387. 

  387.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> setImage </td>
    388. 

  388.           <td>(</td>
    389. 

  389.           <td class="paramtype">string&#160;</td>
    390. 

  390.           <td class="paramname"><em>imageAssetId</em></td><td>)</td>
    391. 

  391.           <td></td>
    392. 

  392.         </tr>
    393. 

  393.       </table>
    394. 

  394. </div><div class="memdoc">
    395. 

  395. <p>Sets imageAssetId/Frame. </p><dl class="params"><dt>Parameters</dt><dd>
    396. 

  396.   <table class="params">
    397. 

  397.     <tr><td class="paramname">imageAssetId</td><td>The image asset Id to display </td></tr>
    398. 

  398.     <tr><td class="paramname">frame</td><td>The frame of the image to display </td></tr>
    399. 

  399.   </table>
    400. 

  400.   </dd>
    401. 

  401. </dl>
    402. 

  402. <dl class="section return"><dt>Returns</dt><dd>Returns true on success. </dd></dl>
    403. 

  403. 

  404. </div>
    405. 

  405. </div>
    406. 

  406. <a class="anchor" id="ae7c385fd1ecd8a1b703512fa3f9261fe"></a>
    407. 

  407. <div class="memitem">
    408. 

  408. <div class="memproto">
    409. 

  409.       <table class="memname">
    410. 

  410.         <tr>
    411. 

  411.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> setImageFrame </td>
    412. 

  412.           <td>(</td>
    413. 

  413.           <td class="paramtype">int&#160;</td>
    414. 

  414.           <td class="paramname"><em>frame</em></td><td>)</td>
    415. 

  415.           <td></td>
    416. 

  416.         </tr>
    417. 

  417.       </table>
    418. 

  418. </div><div class="memdoc">
    419. 

  419. <p>Sets image frame. </p><dl class="params"><dt>Parameters</dt><dd>
    420. 

  420.   <table class="params">
    421. 

  421.     <tr><td class="paramname">frame</td><td>The frame to display </td></tr>
    422. 

  422.   </table>
    423. 

  423.   </dd>
    424. 

  424. </dl>
    425. 

  425. <dl class="section return"><dt>Returns</dt><dd>Returns true on success. </dd></dl>
    426. 

  426. 

  427. </div>
    428. 

  428. </div>
    429. 

  429. <a class="anchor" id="a84c1367b486680bcf22987540e217cfb"></a>
    430. 

  430. <div class="memitem">
    431. 

  431. <div class="memproto">
    432. 

  432.       <table class="memname">
    433. 

  433.         <tr>
    434. 

  434.           <td class="memname">void stopAnimation </td>
    435. 

  435.           <td>(</td>
    436. 

  436.           <td class="paramname"></td><td>)</td>
    437. 

  437.           <td></td>
    438. 

  438.         </tr>
    439. 

  439.       </table>
    440. 

  440. </div><div class="memdoc">
    441. 

  441. <p>Stop the current animation </p><dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
    442. 

  442. 

  443. </div>
    444. 

  444. </div>
    445. 

  445. </div><!-- contents -->
    446. 

  446. <!-- start footer part -->
    447. 

  447. <hr class="footer"/><address class="footer"><small>
    448. 

  448. Generated by &#160;<a href="http://www.doxygen.org/index.html">
    449. 

  449. <img class="footer" src="doxygen.png" alt="doxygen"/>
    450. 

  450. </a> 1.8.10
    451. 

  451. </small></address>
    452. 

  452. </body>
    453. 

  453. </html>
    454.