classAnimationAsset.html 50 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <title>AnimationAsset Class Reference</title>
  6. <link href="torquedoc.css" rel="stylesheet" type="text/css"/>
  7. </head>
  8. <body>
  9. <table width="100%" class="header">
  10. <tr>
  11. </tr>
  12. <tr><td class="headermenu">
  13. <center>
  14. <a class="qindex" href="index.html">Main</a> &nbsp;
  15. <a class="qindex" target="_blank" href="https://github.com/GarageGames/Torque2D">GitHub</a>
  16. </center>
  17. </td></tr>
  18. </table>
  19. <br>
  20. <!-- END HEADER -->
  21. <!-- Generated by Doxygen 1.8.3.1 -->
  22. </div><!-- top -->
  23. <div class="header">
  24. <div class="summary">
  25. <a href="classAnimationAsset-members.html">List of all members</a> &#124;
  26. <a href="#pub-methods">Public Member Functions</a> &#124;
  27. <a href="#pub-attribs">Public Attributes</a> </div>
  28. <div class="headertitle">
  29. <div class="title">AnimationAsset Class Reference</div> </div>
  30. </div><!--header-->
  31. <div class="contents">
  32. <p>Inherits <a class="el" href="classAssetBase.html">AssetBase</a>.</p>
  33. <table class="memberdecls">
  34. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  35. Public Member Functions</h2></td></tr>
  36. <tr class="memitem:a09b701a3254b5ded3a4b72b29aa31ee0"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimationAsset.html#a09b701a3254b5ded3a4b72b29aa31ee0">getAnimationCycle</a> ()</td></tr>
  37. <tr class="separator:a09b701a3254b5ded3a4b72b29aa31ee0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  38. <tr class="memitem:aae4ae24e6db7d567ac6b00570e58638c"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimationAsset.html#aae4ae24e6db7d567ac6b00570e58638c">getAnimationFrameCount</a> ([bool validatedFrames])</td></tr>
  39. <tr class="separator:aae4ae24e6db7d567ac6b00570e58638c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  40. <tr class="memitem:a93a878ff6017a63a13282dcab9366992"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimationAsset.html#a93a878ff6017a63a13282dcab9366992">getAnimationFrames</a> ([bool validatedFrames])</td></tr>
  41. <tr class="separator:a93a878ff6017a63a13282dcab9366992"><td class="memSeparator" colspan="2">&#160;</td></tr>
  42. <tr class="memitem:a77baadd7769b4d0ac3cad0213488bdea"><td class="memItemLeft" align="right" valign="top">virtual float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimationAsset.html#a77baadd7769b4d0ac3cad0213488bdea">getAnimationTime</a> ()</td></tr>
  43. <tr class="separator:a77baadd7769b4d0ac3cad0213488bdea"><td class="memSeparator" colspan="2">&#160;</td></tr>
  44. <tr class="memitem:aafc4bb978a6d000d8494bb610c0af499"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimationAsset.html#aafc4bb978a6d000d8494bb610c0af499">getImage</a> ()</td></tr>
  45. <tr class="separator:aafc4bb978a6d000d8494bb610c0af499"><td class="memSeparator" colspan="2">&#160;</td></tr>
  46. <tr class="memitem:a0e0679df0eeae9236d0880edd85519a4"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimationAsset.html#a0e0679df0eeae9236d0880edd85519a4">setAnimationCycle</a> (bool animationCycle)</td></tr>
  47. <tr class="separator:a0e0679df0eeae9236d0880edd85519a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  48. <tr class="memitem:ad1c620c225f5c7b63f904e517ef0a263"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimationAsset.html#ad1c620c225f5c7b63f904e517ef0a263">setAnimationFrames</a> (animationFrames)</td></tr>
  49. <tr class="separator:ad1c620c225f5c7b63f904e517ef0a263"><td class="memSeparator" colspan="2">&#160;</td></tr>
  50. <tr class="memitem:afb9f289b850b53af7c86d86ee7054a28"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimationAsset.html#afb9f289b850b53af7c86d86ee7054a28">setAnimationTime</a> (float animationTime)</td></tr>
  51. <tr class="separator:afb9f289b850b53af7c86d86ee7054a28"><td class="memSeparator" colspan="2">&#160;</td></tr>
  52. <tr class="memitem:ae166795d89cbd6d05e7f76b0bb5bfc09"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimationAsset.html#ae166795d89cbd6d05e7f76b0bb5bfc09">setImage</a> (assetId)</td></tr>
  53. <tr class="separator:ae166795d89cbd6d05e7f76b0bb5bfc09"><td class="memSeparator" colspan="2">&#160;</td></tr>
  54. <tr class="inherit_header pub_methods_classAssetBase"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classAssetBase')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classAssetBase.html">AssetBase</a></td></tr>
  55. <tr class="memitem:a230e1f128bddb72dcf289217e1c96639 inherit pub_methods_classAssetBase"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAssetBase.html#a230e1f128bddb72dcf289217e1c96639">getAssetId</a> ()</td></tr>
  56. <tr class="separator:a230e1f128bddb72dcf289217e1c96639 inherit pub_methods_classAssetBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  57. <tr class="memitem:a36787c73dae5dbd4bece558a4e967ca4 inherit pub_methods_classAssetBase"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAssetBase.html#a36787c73dae5dbd4bece558a4e967ca4">refreshAsset</a> ()</td></tr>
  58. <tr class="separator:a36787c73dae5dbd4bece558a4e967ca4 inherit pub_methods_classAssetBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  59. <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>
  60. <tr class="memitem:aa19815069e82c393e2c10885eabf8016 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa19815069e82c393e2c10885eabf8016">addFieldFilter</a> (fieldName)</td></tr>
  61. <tr class="separator:aa19815069e82c393e2c10885eabf8016 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  62. <tr class="memitem:a804a3fb06b864699c7bc2601e685756d inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a804a3fb06b864699c7bc2601e685756d">call</a> (%args)</td></tr>
  63. <tr class="separator:a804a3fb06b864699c7bc2601e685756d inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  64. <tr class="memitem:abce68a893b7efa10c06ea780ddda7f06 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#abce68a893b7efa10c06ea780ddda7f06">clone</a> ([bool copyDynamicFields?=false])</td></tr>
  65. <tr class="separator:abce68a893b7efa10c06ea780ddda7f06 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66. <tr class="memitem:a0407d340f60883977e60e7414f804be8 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0407d340f60883977e60e7414f804be8">delete</a> ()</td></tr>
  67. <tr class="separator:a0407d340f60883977e60e7414f804be8 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68. <tr class="memitem:a6a5e4ea85ff866ed5340d20993541c50 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a6a5e4ea85ff866ed5340d20993541c50">dump</a> ()</td></tr>
  69. <tr class="separator:a6a5e4ea85ff866ed5340d20993541c50 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70. <tr class="memitem:a7b595302fce08857b11a01bbb1083a7e inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a7b595302fce08857b11a01bbb1083a7e">dumpClassHierarchy</a> ()</td></tr>
  71. <tr class="separator:a7b595302fce08857b11a01bbb1083a7e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72. <tr class="memitem:a8e927f41d38b279dc8684f7ced03c0fb inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a8e927f41d38b279dc8684f7ced03c0fb">getClassName</a> ()</td></tr>
  73. <tr class="separator:a8e927f41d38b279dc8684f7ced03c0fb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <tr class="memitem:a90cc89c3cebc772fdadfd9ac87ecd24e inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a90cc89c3cebc772fdadfd9ac87ecd24e">getClassNamespace</a> ()</td></tr>
  75. <tr class="separator:a90cc89c3cebc772fdadfd9ac87ecd24e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem:a09ab8f9a6a8e3ee0cfc3c78ebb54f113 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a09ab8f9a6a8e3ee0cfc3c78ebb54f113">getDynamicField</a> (index)</td></tr>
  77. <tr class="separator:a09ab8f9a6a8e3ee0cfc3c78ebb54f113 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:a2d78d37eac1f119baf560cd273c03538 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a2d78d37eac1f119baf560cd273c03538">getDynamicFieldCount</a> ()</td></tr>
  79. <tr class="separator:a2d78d37eac1f119baf560cd273c03538 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:a55ace9339e968c26428e0082bd190693 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a55ace9339e968c26428e0082bd190693">getField</a> (int index)</td></tr>
  81. <tr class="separator:a55ace9339e968c26428e0082bd190693 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:abef30dc0fc312dd3334e2a4a8491da37 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#abef30dc0fc312dd3334e2a4a8491da37">getFieldCount</a> ()</td></tr>
  83. <tr class="separator:abef30dc0fc312dd3334e2a4a8491da37 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:a6e9001db89eb8822430f0d02c6108b43 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a6e9001db89eb8822430f0d02c6108b43">getFieldType</a> (fieldName)</td></tr>
  85. <tr class="separator:a6e9001db89eb8822430f0d02c6108b43 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:addb1c5fbb1495cf580318456b639548d inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#addb1c5fbb1495cf580318456b639548d">getFieldValue</a> (fieldName)</td></tr>
  87. <tr class="separator:addb1c5fbb1495cf580318456b639548d inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:a1a4f6c730ac5325e79cc4554e43db26e inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1a4f6c730ac5325e79cc4554e43db26e">getGroup</a> ()</td></tr>
  89. <tr class="separator:a1a4f6c730ac5325e79cc4554e43db26e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a230cd7c02705a8d3eea78cacb320591f inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a230cd7c02705a8d3eea78cacb320591f">getId</a> ()</td></tr>
  91. <tr class="separator:a230cd7c02705a8d3eea78cacb320591f inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:a9b026d477bdd586a8ad5ee0e7a6fb7fe inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a9b026d477bdd586a8ad5ee0e7a6fb7fe">getInternalName</a> ()</td></tr>
  93. <tr class="separator:a9b026d477bdd586a8ad5ee0e7a6fb7fe inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a84e32f38cdb775bfe739867d55737b4d inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a84e32f38cdb775bfe739867d55737b4d">getName</a> ()</td></tr>
  95. <tr class="separator:a84e32f38cdb775bfe739867d55737b4d inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:a1058915844541a6bebebc75415bbe7e0 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1058915844541a6bebebc75415bbe7e0">getProgenitorFile</a> ()</td></tr>
  97. <tr class="separator:a1058915844541a6bebebc75415bbe7e0 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:a4b464b66407955fa435f66dc684971c8 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a4b464b66407955fa435f66dc684971c8">getSuperClassNamespace</a> ()</td></tr>
  99. <tr class="separator:a4b464b66407955fa435f66dc684971c8 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:a320f74b22aa85775725f8569154d667e inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a320f74b22aa85775725f8569154d667e">getType</a> ()</td></tr>
  101. <tr class="separator:a320f74b22aa85775725f8569154d667e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:a1260a9ecd13cdbea359d9fe7c045794e inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1260a9ecd13cdbea359d9fe7c045794e">isChildOfGroup</a> ()</td></tr>
  103. <tr class="separator:a1260a9ecd13cdbea359d9fe7c045794e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a86048647be436a21246de6a92f807ea4 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a86048647be436a21246de6a92f807ea4">isMemberOfClass</a> (string classname)</td></tr>
  105. <tr class="separator:a86048647be436a21246de6a92f807ea4 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:a89bdccd1d3b307d9caf08496003a63cb inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a89bdccd1d3b307d9caf08496003a63cb">isMethod</a> (string method name)</td></tr>
  107. <tr class="separator:a89bdccd1d3b307d9caf08496003a63cb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:a4d77984a510b832f0f2a87d132192af1 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a4d77984a510b832f0f2a87d132192af1">isTimerActive</a> ()</td></tr>
  109. <tr class="separator:a4d77984a510b832f0f2a87d132192af1 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:a5a3e025c27ebe1d34a8485ee53199dcb inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a5a3e025c27ebe1d34a8485ee53199dcb">removeFieldFilter</a> (fieldName)</td></tr>
  111. <tr class="separator:a5a3e025c27ebe1d34a8485ee53199dcb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:aac4f9db0033e9192254a8308f6101909 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aac4f9db0033e9192254a8308f6101909">save</a> (fileName,[selectedOnly])</td></tr>
  113. <tr class="separator:aac4f9db0033e9192254a8308f6101909 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:a38c14c64f403c3df7749ca315c325386 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a38c14c64f403c3df7749ca315c325386">schedule</a> (time, command,&lt; arg1...argN &gt;)</td></tr>
  115. <tr class="separator:a38c14c64f403c3df7749ca315c325386 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:ac70958a4cae93deda0d031947d187892 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ac70958a4cae93deda0d031947d187892">setClassNamespace</a> ()</td></tr>
  117. <tr class="separator:ac70958a4cae93deda0d031947d187892 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:a29f97240eeaf780e9c02bee7aa6e7b25 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a29f97240eeaf780e9c02bee7aa6e7b25">setFieldValue</a> (fieldName, value)</td></tr>
  119. <tr class="separator:a29f97240eeaf780e9c02bee7aa6e7b25 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:acf355cf2001b85ffcf07958400c97605 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#acf355cf2001b85ffcf07958400c97605">setInternalName</a> ()</td></tr>
  121. <tr class="separator:acf355cf2001b85ffcf07958400c97605 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:a1e799de6b4329f9ce9b94a176ad1cfbb inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1e799de6b4329f9ce9b94a176ad1cfbb">setName</a> (newName)</td></tr>
  123. <tr class="separator:a1e799de6b4329f9ce9b94a176ad1cfbb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:ad2b00ab622649aa8b1b2b5600ea4abb1 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ad2b00ab622649aa8b1b2b5600ea4abb1">setProgenitorFile</a> (file)</td></tr>
  125. <tr class="separator:ad2b00ab622649aa8b1b2b5600ea4abb1 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:a94f53f0f93ced24b597de83aa122e824 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a94f53f0f93ced24b597de83aa122e824">setSuperClassNamespace</a> ()</td></tr>
  127. <tr class="separator:a94f53f0f93ced24b597de83aa122e824 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:ab928f21c5a7e13a0c2cdbcf479c9e07d inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab928f21c5a7e13a0c2cdbcf479c9e07d">startTimer</a> (callbackFunction, float timePeriod,[repeat])</td></tr>
  129. <tr class="separator:ab928f21c5a7e13a0c2cdbcf479c9e07d inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:acd9c4032150dd0566eca593062588e9f inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#acd9c4032150dd0566eca593062588e9f">stopTimer</a> ()</td></tr>
  131. <tr class="separator:acd9c4032150dd0566eca593062588e9f inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. </table><table class="memberdecls">
  133. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  134. Public Attributes</h2></td></tr>
  135. <tr class="memitem:a91f4c0729a592f49dd5bd6d6f47c3d99"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimationAsset.html#a91f4c0729a592f49dd5bd6d6f47c3d99">AnimationCycle</a></td></tr>
  136. <tr class="separator:a91f4c0729a592f49dd5bd6d6f47c3d99"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:a362f9ab78796da1423cc199d68c6438c"><td class="memItemLeft" align="right" valign="top">intList&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimationAsset.html#a362f9ab78796da1423cc199d68c6438c">AnimationFrames</a></td></tr>
  138. <tr class="separator:a362f9ab78796da1423cc199d68c6438c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:a5395141842490e2791a685b51d2e53bb"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimationAsset.html#a5395141842490e2791a685b51d2e53bb">AnimationTime</a></td></tr>
  140. <tr class="separator:a5395141842490e2791a685b51d2e53bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:a6a62b63d29151983e36fc12e8b11830a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimationAsset.html#a6a62b63d29151983e36fc12e8b11830a">AssetAutoUnload</a></td></tr>
  142. <tr class="separator:a6a62b63d29151983e36fc12e8b11830a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:afb8c6d89b6fa8f9d468234d62a9336f2"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimationAsset.html#afb8c6d89b6fa8f9d468234d62a9336f2">AssetCategory</a></td></tr>
  144. <tr class="separator:afb8c6d89b6fa8f9d468234d62a9336f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <tr class="memitem:a6b92b2fd9a0306c52ca5f877cc90e0fd"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimationAsset.html#a6b92b2fd9a0306c52ca5f877cc90e0fd">AssetDescription</a></td></tr>
  146. <tr class="separator:a6b92b2fd9a0306c52ca5f877cc90e0fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:a8863ac9437db1bc5c3dd05e15cb2449d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimationAsset.html#a8863ac9437db1bc5c3dd05e15cb2449d">AssetInternal</a></td></tr>
  148. <tr class="separator:a8863ac9437db1bc5c3dd05e15cb2449d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:aca0f29e9fed0393045de34431605efa4"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimationAsset.html#aca0f29e9fed0393045de34431605efa4">AssetName</a></td></tr>
  150. <tr class="separator:aca0f29e9fed0393045de34431605efa4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <tr class="memitem:a8f1a307cd1c6ca17c953d09f92421493"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimationAsset.html#a8f1a307cd1c6ca17c953d09f92421493">AssetPrivate</a></td></tr>
  152. <tr class="separator:a8f1a307cd1c6ca17c953d09f92421493"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. <tr class="memitem:af82eeeb46db2fe6edd295b32106c7983"><td class="memItemLeft" align="right" valign="top">imageAssetPtr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimationAsset.html#af82eeeb46db2fe6edd295b32106c7983">Image</a></td></tr>
  154. <tr class="separator:af82eeeb46db2fe6edd295b32106c7983"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:a8ecf2bb0834c3497e8989141d7e69cea"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimationAsset.html#a8ecf2bb0834c3497e8989141d7e69cea">RandomStart</a></td></tr>
  156. <tr class="separator:a8ecf2bb0834c3497e8989141d7e69cea"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. <tr><td colspan="2"><div class="groupHeader">SimBase</div></td></tr>
  158. <tr class="memitem:a4e97619dc246bf9c6a42bba94f892230"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimationAsset.html#a4e97619dc246bf9c6a42bba94f892230">canSaveDynamicFields</a></td></tr>
  159. <tr class="separator:a4e97619dc246bf9c6a42bba94f892230"><td class="memSeparator" colspan="2">&#160;</td></tr>
  160. <tr class="memitem:acb3c7f993e7058658f54e5486e2084b9"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimationAsset.html#acb3c7f993e7058658f54e5486e2084b9">internalName</a></td></tr>
  161. <tr class="separator:acb3c7f993e7058658f54e5486e2084b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  162. <tr class="memitem:ab5730497da94d1245cd785b56317aa91"><td class="memItemLeft" align="right" valign="top">SimObjectPtr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimationAsset.html#ab5730497da94d1245cd785b56317aa91">parentGroup</a></td></tr>
  163. <tr class="separator:ab5730497da94d1245cd785b56317aa91"><td class="memSeparator" colspan="2">&#160;</td></tr>
  164. <tr><td colspan="2"><div class="groupHeader">Namespace Linking</div></td></tr>
  165. <tr class="memitem:a2332454c3e868bc60476630d10a70320"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimationAsset.html#a2332454c3e868bc60476630d10a70320">superclass</a></td></tr>
  166. <tr class="separator:a2332454c3e868bc60476630d10a70320"><td class="memSeparator" colspan="2">&#160;</td></tr>
  167. <tr class="memitem:a8c91f64cb7bbeb2242c48fbffb9105ba"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimationAsset.html#a8c91f64cb7bbeb2242c48fbffb9105ba">class</a></td></tr>
  168. <tr class="separator:a8c91f64cb7bbeb2242c48fbffb9105ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
  169. <tr class="inherit_header pub_attribs_classAssetBase"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classAssetBase')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="classAssetBase.html">AssetBase</a></td></tr>
  170. <tr class="memitem:a8f82e59d767f679c3ed297cd6dfc5ac5 inherit pub_attribs_classAssetBase"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAssetBase.html#a8f82e59d767f679c3ed297cd6dfc5ac5">AssetAutoUnload</a></td></tr>
  171. <tr class="separator:a8f82e59d767f679c3ed297cd6dfc5ac5 inherit pub_attribs_classAssetBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  172. <tr class="memitem:af920abeb8831199fae1a83fd7f3afd37 inherit pub_attribs_classAssetBase"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAssetBase.html#af920abeb8831199fae1a83fd7f3afd37">AssetCategory</a></td></tr>
  173. <tr class="separator:af920abeb8831199fae1a83fd7f3afd37 inherit pub_attribs_classAssetBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  174. <tr class="memitem:a1d249aa215d4579fe732e32cccdb4021 inherit pub_attribs_classAssetBase"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAssetBase.html#a1d249aa215d4579fe732e32cccdb4021">AssetDescription</a></td></tr>
  175. <tr class="separator:a1d249aa215d4579fe732e32cccdb4021 inherit pub_attribs_classAssetBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  176. <tr class="memitem:a3ad3cfe6f29b55a29666156ca2babfdf inherit pub_attribs_classAssetBase"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAssetBase.html#a3ad3cfe6f29b55a29666156ca2babfdf">AssetInternal</a></td></tr>
  177. <tr class="separator:a3ad3cfe6f29b55a29666156ca2babfdf inherit pub_attribs_classAssetBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  178. <tr class="memitem:ae78c28bf7522713e543e9aeaa93b0213 inherit pub_attribs_classAssetBase"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAssetBase.html#ae78c28bf7522713e543e9aeaa93b0213">AssetName</a></td></tr>
  179. <tr class="separator:ae78c28bf7522713e543e9aeaa93b0213 inherit pub_attribs_classAssetBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  180. <tr class="memitem:a2d3b820d2f0fdb4a2ab4962b70b61a50 inherit pub_attribs_classAssetBase"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAssetBase.html#a2d3b820d2f0fdb4a2ab4962b70b61a50">AssetPrivate</a></td></tr>
  181. <tr class="separator:a2d3b820d2f0fdb4a2ab4962b70b61a50 inherit pub_attribs_classAssetBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  182. <tr class="memitem:a3223587548dcc79cfd0ccafcee216a21 inherit pub_attribs_classAssetBase"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAssetBase.html#a3223587548dcc79cfd0ccafcee216a21">canSaveDynamicFields</a></td></tr>
  183. <tr class="separator:a3223587548dcc79cfd0ccafcee216a21 inherit pub_attribs_classAssetBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  184. <tr class="memitem:ab4986ad5bfc7c2236235a478a55bf8f5 inherit pub_attribs_classAssetBase"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAssetBase.html#ab4986ad5bfc7c2236235a478a55bf8f5">internalName</a></td></tr>
  185. <tr class="separator:ab4986ad5bfc7c2236235a478a55bf8f5 inherit pub_attribs_classAssetBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  186. <tr class="memitem:a160519731297cea7ca3fcc22b5147a8d inherit pub_attribs_classAssetBase"><td class="memItemLeft" align="right" valign="top">SimObjectPtr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAssetBase.html#a160519731297cea7ca3fcc22b5147a8d">parentGroup</a></td></tr>
  187. <tr class="separator:a160519731297cea7ca3fcc22b5147a8d inherit pub_attribs_classAssetBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  188. <tr class="memitem:aaf0e7dda4de67ea30415ff0b37e3baa6 inherit pub_attribs_classAssetBase"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAssetBase.html#aaf0e7dda4de67ea30415ff0b37e3baa6">superclass</a></td></tr>
  189. <tr class="separator:aaf0e7dda4de67ea30415ff0b37e3baa6 inherit pub_attribs_classAssetBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  190. <tr class="memitem:a9346a452032f9019bf35c51df0dd7854 inherit pub_attribs_classAssetBase"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAssetBase.html#a9346a452032f9019bf35c51df0dd7854">class</a></td></tr>
  191. <tr class="separator:a9346a452032f9019bf35c51df0dd7854 inherit pub_attribs_classAssetBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  192. <tr class="inherit_header pub_attribs_classSimObject"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classSimObject')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="classSimObject.html">SimObject</a></td></tr>
  193. <tr class="memitem:ab49fae316a2d0c12834f50c3d77202e6 inherit pub_attribs_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab49fae316a2d0c12834f50c3d77202e6">canSaveDynamicFields</a></td></tr>
  194. <tr class="separator:ab49fae316a2d0c12834f50c3d77202e6 inherit pub_attribs_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  195. <tr class="memitem:ad03202387165717f164f996a5b22c9bb inherit pub_attribs_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ad03202387165717f164f996a5b22c9bb">internalName</a></td></tr>
  196. <tr class="separator:ad03202387165717f164f996a5b22c9bb inherit pub_attribs_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  197. <tr class="memitem:a0f783d7e37cad2b0a9d6f7b0d1672a28 inherit pub_attribs_classSimObject"><td class="memItemLeft" align="right" valign="top">SimObjectPtr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0f783d7e37cad2b0a9d6f7b0d1672a28">parentGroup</a></td></tr>
  198. <tr class="separator:a0f783d7e37cad2b0a9d6f7b0d1672a28 inherit pub_attribs_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  199. <tr class="memitem:aa0d134072878053537fefb1768b63d3f inherit pub_attribs_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa0d134072878053537fefb1768b63d3f">superclass</a></td></tr>
  200. <tr class="separator:aa0d134072878053537fefb1768b63d3f inherit pub_attribs_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  201. <tr class="memitem:ab83c7a59a66018d9b5eec3c8dcd3397d inherit pub_attribs_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ab83c7a59a66018d9b5eec3c8dcd3397d">class</a></td></tr>
  202. <tr class="separator:ab83c7a59a66018d9b5eec3c8dcd3397d inherit pub_attribs_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  203. </table>
  204. <h2 class="groupheader">Member Function Documentation</h2>
  205. <a class="anchor" id="a09b701a3254b5ded3a4b72b29aa31ee0"></a>
  206. <div class="memitem">
  207. <div class="memproto">
  208. <table class="mlabels">
  209. <tr>
  210. <td class="mlabels-left">
  211. <table class="memname">
  212. <tr>
  213. <td class="memname">virtual bool AnimationAsset::getAnimationCycle </td>
  214. <td>(</td>
  215. <td class="paramname"></td><td>)</td>
  216. <td></td>
  217. </tr>
  218. </table>
  219. </td>
  220. <td class="mlabels-right">
  221. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  222. </tr>
  223. </table>
  224. </div><div class="memdoc">
  225. <p>Gets whether the animation cycles or not. </p>
  226. <dl class="section return"><dt>Returns</dt><dd>Whether the animation cycles or not. </dd></dl>
  227. </div>
  228. </div>
  229. <a class="anchor" id="aae4ae24e6db7d567ac6b00570e58638c"></a>
  230. <div class="memitem">
  231. <div class="memproto">
  232. <table class="mlabels">
  233. <tr>
  234. <td class="mlabels-left">
  235. <table class="memname">
  236. <tr>
  237. <td class="memname">virtual int AnimationAsset::getAnimationFrameCount </td>
  238. <td>(</td>
  239. <td class="paramname"></td><td>)</td>
  240. <td></td>
  241. </tr>
  242. </table>
  243. </td>
  244. <td class="mlabels-right">
  245. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  246. </tr>
  247. </table>
  248. </div><div class="memdoc">
  249. <p>Gets the count of frame that compose the animation or optionally only the ones validated against the image asset. </p>
  250. <dl class="params"><dt>Parameters</dt><dd>
  251. <table class="params">
  252. <tr><td class="paramname">validatedFrames</td><td>- Whether to return only the validated frames or not. Optional: Default is false. </td></tr>
  253. </table>
  254. </dd>
  255. </dl>
  256. <dl class="section return"><dt>Returns</dt><dd>The image frames that compose the animation or optionally only the ones validated against the image asset. </dd></dl>
  257. </div>
  258. </div>
  259. <a class="anchor" id="a93a878ff6017a63a13282dcab9366992"></a>
  260. <div class="memitem">
  261. <div class="memproto">
  262. <table class="mlabels">
  263. <tr>
  264. <td class="mlabels-left">
  265. <table class="memname">
  266. <tr>
  267. <td class="memname">virtual string AnimationAsset::getAnimationFrames </td>
  268. <td>(</td>
  269. <td class="paramname"></td><td>)</td>
  270. <td></td>
  271. </tr>
  272. </table>
  273. </td>
  274. <td class="mlabels-right">
  275. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  276. </tr>
  277. </table>
  278. </div><div class="memdoc">
  279. <p>Gets the frames that compose the animation or optionally only the ones validated against the image asset. </p>
  280. <dl class="params"><dt>Parameters</dt><dd>
  281. <table class="params">
  282. <tr><td class="paramname">validatedFrames</td><td>- Whether to return only the validated frames or not. Optional: Default is false. </td></tr>
  283. </table>
  284. </dd>
  285. </dl>
  286. <dl class="section return"><dt>Returns</dt><dd>The image frames that compose the animation or optionally only the ones validated against the image asset. </dd></dl>
  287. </div>
  288. </div>
  289. <a class="anchor" id="a77baadd7769b4d0ac3cad0213488bdea"></a>
  290. <div class="memitem">
  291. <div class="memproto">
  292. <table class="mlabels">
  293. <tr>
  294. <td class="mlabels-left">
  295. <table class="memname">
  296. <tr>
  297. <td class="memname">virtual float AnimationAsset::getAnimationTime </td>
  298. <td>(</td>
  299. <td class="paramname"></td><td>)</td>
  300. <td></td>
  301. </tr>
  302. </table>
  303. </td>
  304. <td class="mlabels-right">
  305. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  306. </tr>
  307. </table>
  308. </div><div class="memdoc">
  309. <p>Gets the total time to cycle through all animation frames. </p>
  310. <dl class="section return"><dt>Returns</dt><dd>The total time to cycle through all animation frames. </dd></dl>
  311. </div>
  312. </div>
  313. <a class="anchor" id="aafc4bb978a6d000d8494bb610c0af499"></a>
  314. <div class="memitem">
  315. <div class="memproto">
  316. <table class="mlabels">
  317. <tr>
  318. <td class="mlabels-left">
  319. <table class="memname">
  320. <tr>
  321. <td class="memname">virtual string AnimationAsset::getImage </td>
  322. <td>(</td>
  323. <td class="paramname"></td><td>)</td>
  324. <td></td>
  325. </tr>
  326. </table>
  327. </td>
  328. <td class="mlabels-right">
  329. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  330. </tr>
  331. </table>
  332. </div><div class="memdoc">
  333. <p>Gets the image asset Id. </p>
  334. <dl class="section return"><dt>Returns</dt><dd>The image asset Id. </dd></dl>
  335. </div>
  336. </div>
  337. <a class="anchor" id="a0e0679df0eeae9236d0880edd85519a4"></a>
  338. <div class="memitem">
  339. <div class="memproto">
  340. <table class="mlabels">
  341. <tr>
  342. <td class="mlabels-left">
  343. <table class="memname">
  344. <tr>
  345. <td class="memname">virtual void AnimationAsset::setAnimationCycle </td>
  346. <td>(</td>
  347. <td class="paramtype">bool&#160;</td>
  348. <td class="paramname"><em>animationCycle</em></td><td>)</td>
  349. <td></td>
  350. </tr>
  351. </table>
  352. </td>
  353. <td class="mlabels-right">
  354. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  355. </tr>
  356. </table>
  357. </div><div class="memdoc">
  358. <p>Sets whether the animation cycles or not. </p>
  359. <dl class="params"><dt>Parameters</dt><dd>
  360. <table class="params">
  361. <tr><td class="paramname">animationCycle</td><td>Whether the animation cycles or not. </td></tr>
  362. </table>
  363. </dd>
  364. </dl>
  365. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  366. </div>
  367. </div>
  368. <a class="anchor" id="ad1c620c225f5c7b63f904e517ef0a263"></a>
  369. <div class="memitem">
  370. <div class="memproto">
  371. <table class="mlabels">
  372. <tr>
  373. <td class="mlabels-left">
  374. <table class="memname">
  375. <tr>
  376. <td class="memname">virtual void AnimationAsset::setAnimationFrames </td>
  377. <td>(</td>
  378. <td class="paramtype">animationFrames&#160;</td>
  379. <td class="paramname"></td><td>)</td>
  380. <td></td>
  381. </tr>
  382. </table>
  383. </td>
  384. <td class="mlabels-right">
  385. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  386. </tr>
  387. </table>
  388. </div><div class="memdoc">
  389. <p>Sets the image frames that compose the animation. </p>
  390. <dl class="params"><dt>Parameters</dt><dd>
  391. <table class="params">
  392. <tr><td class="paramname">animationFrames</td><td>A set of image frames that compose the animation. </td></tr>
  393. </table>
  394. </dd>
  395. </dl>
  396. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  397. </div>
  398. </div>
  399. <a class="anchor" id="afb9f289b850b53af7c86d86ee7054a28"></a>
  400. <div class="memitem">
  401. <div class="memproto">
  402. <table class="mlabels">
  403. <tr>
  404. <td class="mlabels-left">
  405. <table class="memname">
  406. <tr>
  407. <td class="memname">virtual void AnimationAsset::setAnimationTime </td>
  408. <td>(</td>
  409. <td class="paramtype">float&#160;</td>
  410. <td class="paramname"><em>animationTime</em></td><td>)</td>
  411. <td></td>
  412. </tr>
  413. </table>
  414. </td>
  415. <td class="mlabels-right">
  416. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  417. </tr>
  418. </table>
  419. </div><div class="memdoc">
  420. <p>Sets the total time to cycle through all animation frames. </p>
  421. <dl class="params"><dt>Parameters</dt><dd>
  422. <table class="params">
  423. <tr><td class="paramname">animationTime</td><td>The total time to cycle through all animation frames. </td></tr>
  424. </table>
  425. </dd>
  426. </dl>
  427. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  428. </div>
  429. </div>
  430. <a class="anchor" id="ae166795d89cbd6d05e7f76b0bb5bfc09"></a>
  431. <div class="memitem">
  432. <div class="memproto">
  433. <table class="mlabels">
  434. <tr>
  435. <td class="mlabels-left">
  436. <table class="memname">
  437. <tr>
  438. <td class="memname">virtual void AnimationAsset::setImage </td>
  439. <td>(</td>
  440. <td class="paramtype">assetId&#160;</td>
  441. <td class="paramname"></td><td>)</td>
  442. <td></td>
  443. </tr>
  444. </table>
  445. </td>
  446. <td class="mlabels-right">
  447. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  448. </tr>
  449. </table>
  450. </div><div class="memdoc">
  451. <p>Sets the image asset Id. </p>
  452. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  453. </div>
  454. </div>
  455. <h2 class="groupheader">Member Data Documentation</h2>
  456. <a class="anchor" id="a91f4c0729a592f49dd5bd6d6f47c3d99"></a>
  457. <div class="memitem">
  458. <div class="memproto">
  459. <table class="memname">
  460. <tr>
  461. <td class="memname">bool AnimationAsset::AnimationCycle</td>
  462. </tr>
  463. </table>
  464. </div><div class="memdoc">
  465. </div>
  466. </div>
  467. <a class="anchor" id="a362f9ab78796da1423cc199d68c6438c"></a>
  468. <div class="memitem">
  469. <div class="memproto">
  470. <table class="memname">
  471. <tr>
  472. <td class="memname">intList AnimationAsset::AnimationFrames</td>
  473. </tr>
  474. </table>
  475. </div><div class="memdoc">
  476. </div>
  477. </div>
  478. <a class="anchor" id="a5395141842490e2791a685b51d2e53bb"></a>
  479. <div class="memitem">
  480. <div class="memproto">
  481. <table class="memname">
  482. <tr>
  483. <td class="memname">float AnimationAsset::AnimationTime</td>
  484. </tr>
  485. </table>
  486. </div><div class="memdoc">
  487. </div>
  488. </div>
  489. <a class="anchor" id="a6a62b63d29151983e36fc12e8b11830a"></a>
  490. <div class="memitem">
  491. <div class="memproto">
  492. <table class="memname">
  493. <tr>
  494. <td class="memname">bool AnimationAsset::AssetAutoUnload</td>
  495. </tr>
  496. </table>
  497. </div><div class="memdoc">
  498. <p>Whether the asset is automatically unloaded when an asset is released and has no other acquisitions or not. </p>
  499. </div>
  500. </div>
  501. <a class="anchor" id="afb8c6d89b6fa8f9d468234d62a9336f2"></a>
  502. <div class="memitem">
  503. <div class="memproto">
  504. <table class="memname">
  505. <tr>
  506. <td class="memname">string AnimationAsset::AssetCategory</td>
  507. </tr>
  508. </table>
  509. </div><div class="memdoc">
  510. <p>An arbitrary category that can be used to categorized assets. </p>
  511. </div>
  512. </div>
  513. <a class="anchor" id="a6b92b2fd9a0306c52ca5f877cc90e0fd"></a>
  514. <div class="memitem">
  515. <div class="memproto">
  516. <table class="memname">
  517. <tr>
  518. <td class="memname">string AnimationAsset::AssetDescription</td>
  519. </tr>
  520. </table>
  521. </div><div class="memdoc">
  522. <p>The simple description of the asset contents. </p>
  523. </div>
  524. </div>
  525. <a class="anchor" id="a8863ac9437db1bc5c3dd05e15cb2449d"></a>
  526. <div class="memitem">
  527. <div class="memproto">
  528. <table class="memname">
  529. <tr>
  530. <td class="memname">bool AnimationAsset::AssetInternal</td>
  531. </tr>
  532. </table>
  533. </div><div class="memdoc">
  534. <p>Whether the asset is used internally only or not. </p>
  535. </div>
  536. </div>
  537. <a class="anchor" id="aca0f29e9fed0393045de34431605efa4"></a>
  538. <div class="memitem">
  539. <div class="memproto">
  540. <table class="memname">
  541. <tr>
  542. <td class="memname">string AnimationAsset::AssetName</td>
  543. </tr>
  544. </table>
  545. </div><div class="memdoc">
  546. <p>The name of the asset. The is not a unique identification like an asset Id. </p>
  547. </div>
  548. </div>
  549. <a class="anchor" id="a8f1a307cd1c6ca17c953d09f92421493"></a>
  550. <div class="memitem">
  551. <div class="memproto">
  552. <table class="memname">
  553. <tr>
  554. <td class="memname">bool AnimationAsset::AssetPrivate</td>
  555. </tr>
  556. </table>
  557. </div><div class="memdoc">
  558. <p>Whether the asset is private or not. </p>
  559. </div>
  560. </div>
  561. <a class="anchor" id="a4e97619dc246bf9c6a42bba94f892230"></a>
  562. <div class="memitem">
  563. <div class="memproto">
  564. <table class="memname">
  565. <tr>
  566. <td class="memname">bool AnimationAsset::canSaveDynamicFields</td>
  567. </tr>
  568. </table>
  569. </div><div class="memdoc">
  570. </div>
  571. </div>
  572. <a class="anchor" id="a8c91f64cb7bbeb2242c48fbffb9105ba"></a>
  573. <div class="memitem">
  574. <div class="memproto">
  575. <table class="memname">
  576. <tr>
  577. <td class="memname">string AnimationAsset::class</td>
  578. </tr>
  579. </table>
  580. </div><div class="memdoc">
  581. <p>Script SuperClass of object. </p>
  582. </div>
  583. </div>
  584. <a class="anchor" id="af82eeeb46db2fe6edd295b32106c7983"></a>
  585. <div class="memitem">
  586. <div class="memproto">
  587. <table class="memname">
  588. <tr>
  589. <td class="memname">imageAssetPtr AnimationAsset::Image</td>
  590. </tr>
  591. </table>
  592. </div><div class="memdoc">
  593. </div>
  594. </div>
  595. <a class="anchor" id="acb3c7f993e7058658f54e5486e2084b9"></a>
  596. <div class="memitem">
  597. <div class="memproto">
  598. <table class="memname">
  599. <tr>
  600. <td class="memname">string AnimationAsset::internalName</td>
  601. </tr>
  602. </table>
  603. </div><div class="memdoc">
  604. </div>
  605. </div>
  606. <a class="anchor" id="ab5730497da94d1245cd785b56317aa91"></a>
  607. <div class="memitem">
  608. <div class="memproto">
  609. <table class="memname">
  610. <tr>
  611. <td class="memname">SimObjectPtr AnimationAsset::parentGroup</td>
  612. </tr>
  613. </table>
  614. </div><div class="memdoc">
  615. <p>Group hierarchy parent of the object. </p>
  616. </div>
  617. </div>
  618. <a class="anchor" id="a8ecf2bb0834c3497e8989141d7e69cea"></a>
  619. <div class="memitem">
  620. <div class="memproto">
  621. <table class="memname">
  622. <tr>
  623. <td class="memname">bool AnimationAsset::RandomStart</td>
  624. </tr>
  625. </table>
  626. </div><div class="memdoc">
  627. </div>
  628. </div>
  629. <a class="anchor" id="a2332454c3e868bc60476630d10a70320"></a>
  630. <div class="memitem">
  631. <div class="memproto">
  632. <table class="memname">
  633. <tr>
  634. <td class="memname">string AnimationAsset::superclass</td>
  635. </tr>
  636. </table>
  637. </div><div class="memdoc">
  638. <p>Script Class of object. </p>
  639. </div>
  640. </div>
  641. </div><!-- contents -->
  642. <!-- START FOOTER -->
  643. <br>
  644. <br>
  645. <center>
  646. <div style="color: #777777;">
  647. Copyright &copy; 2013 <a style="color: #777777;" target="_blank" href="http://www.garagegames.com">GarageGames, LLC</a>. All Rights Reserved.
  648. </div>
  649. </center>
  650. </body>
  651. </html>