animated_sprite.html 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320
  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  3. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  4. <!-- This file is generated by Nim. -->
  5. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  6. <head>
  7. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  8. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  9. <!-- Favicon -->
  10. <link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
  11. <link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
  12. <!-- Google fonts -->
  13. <link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
  14. <link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
  15. <!-- CSS -->
  16. <title>nodesnim/nodes2d/animated_sprite</title>
  17. <link rel="stylesheet" type="text/css" href="../../nimdoc.out.css">
  18. <script type="text/javascript" src="dochack.js"></script>
  19. <script type="text/javascript">
  20. function main() {
  21. var pragmaDots = document.getElementsByClassName("pragmadots");
  22. for (var i = 0; i < pragmaDots.length; i++) {
  23. pragmaDots[i].onclick = function(event) {
  24. // Hide tease
  25. event.target.parentNode.style.display = "none";
  26. // Show actual
  27. event.target.parentNode.nextElementSibling.style.display = "inline";
  28. }
  29. }
  30. const toggleSwitch = document.querySelector('.theme-switch input[type="checkbox"]');
  31. function switchTheme(e) {
  32. if (e.target.checked) {
  33. document.documentElement.setAttribute('data-theme', 'dark');
  34. localStorage.setItem('theme', 'dark');
  35. } else {
  36. document.documentElement.setAttribute('data-theme', 'light');
  37. localStorage.setItem('theme', 'light');
  38. }
  39. }
  40. toggleSwitch.addEventListener('change', switchTheme, false);
  41. if (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) {
  42. document.documentElement.setAttribute('data-theme', "dark");
  43. toggleSwitch.checked = true;
  44. } else if (window.matchMedia && window.matchMedia('(prefers-color-scheme: light)').matches) {
  45. document.documentElement.setAttribute('data-theme', "light");
  46. toggleSwitch.checked = false;
  47. } else {
  48. const currentTheme = localStorage.getItem('theme') ? localStorage.getItem('theme') : null;
  49. if (currentTheme) {
  50. document.documentElement.setAttribute('data-theme', currentTheme);
  51. if (currentTheme === 'dark') {
  52. toggleSwitch.checked = true;
  53. }
  54. }
  55. }
  56. }
  57. </script>
  58. </head>
  59. <body onload="main()">
  60. <div class="document" id="documentId">
  61. <div class="container">
  62. <h1 class="title">nodesnim/nodes2d/animated_sprite</h1>
  63. <div class="row">
  64. <div class="three columns">
  65. <div class="theme-switch-wrapper">
  66. <label class="theme-switch" for="checkbox">
  67. <input type="checkbox" id="checkbox" />
  68. <div class="slider round"></div>
  69. </label>
  70. &nbsp;&nbsp;&nbsp; <em>Dark Mode</em>
  71. </div>
  72. <div id="global-links">
  73. <ul class="simple">
  74. </ul>
  75. </div>
  76. <div id="searchInputDiv">
  77. Search: <input type="text" id="searchInput"
  78. onkeyup="search()" />
  79. </div>
  80. <div>
  81. Group by:
  82. <select onchange="groupBy(this.value)">
  83. <option value="section">Section</option>
  84. <option value="type">Type</option>
  85. </select>
  86. </div>
  87. <ul class="simple simple-toc" id="toc-list">
  88. <li>
  89. <a class="reference reference-toplevel" href="#6" id="56">Imports</a>
  90. <ul class="simple simple-toc-section">
  91. </ul>
  92. </li>
  93. <li>
  94. <a class="reference reference-toplevel" href="#7" id="57">Types</a>
  95. <ul class="simple simple-toc-section">
  96. <li><a class="reference" href="#AnimatedSpriteObj"
  97. title="AnimatedSpriteObj = object of Node2DObj
  98. reversed*, paused*: bool
  99. filter*: ColorRef
  100. animation*: string
  101. animations*: AnimationArray[GlTextureObj]"><wbr />Animated<wbr />Sprite<wbr />Obj<span class="attachedType"></span></a></li>
  102. <li><a class="reference" href="#AnimatedSpriteRef"
  103. title="AnimatedSpriteRef = ref AnimatedSpriteObj"><wbr />Animated<wbr />Sprite<wbr />Ref<span class="attachedType"></span></a></li>
  104. </ul>
  105. </li>
  106. <li>
  107. <a class="reference reference-toplevel" href="#12" id="62">Procs</a>
  108. <ul class="simple simple-toc-section">
  109. <li><a class="reference" href="#AnimatedSprite%2Cstring"
  110. title="AnimatedSprite(name: string = &quot;AnimatedSprite&quot;): AnimatedSpriteRef"><wbr />Animated<wbr />Sprite<span class="attachedType">AnimatedSpriteRef</span></a></li>
  111. </ul>
  112. </li>
  113. <li>
  114. <a class="reference reference-toplevel" href="#14" id="64">Methods</a>
  115. <ul class="simple simple-toc-section">
  116. <li><a class="reference" href="#draw.e%2CAnimatedSpriteRef%2CGLfloat%2CGLfloat"
  117. title="draw(self: AnimatedSpriteRef; w, h: GLfloat)"><wbr />draw<span class="attachedType">AnimatedSpriteRef</span></a></li>
  118. <li><a class="reference" href="#duplicate.e%2CAnimatedSpriteRef"
  119. title="duplicate(self: AnimatedSpriteRef): AnimatedSpriteRef"><wbr />duplicate<span class="attachedType">AnimatedSpriteRef</span></a></li>
  120. <li><a class="reference" href="#addAnimation.e%2CAnimatedSpriteRef%2Cstring%2Cfloat"
  121. title="addAnimation(self: AnimatedSpriteRef; name: string; speed: float = 2.0&apos;f32)"><wbr />add<wbr />Animation<span class="attachedType">AnimatedSpriteRef</span></a></li>
  122. <li><a class="reference" href="#addFrame.e%2CAnimatedSpriteRef%2Cstring%2CGlTextureObj"
  123. title="addFrame(self: AnimatedSpriteRef; name: string; frame: GlTextureObj)"><wbr />add<wbr />Frame<span class="attachedType">AnimatedSpriteRef</span></a></li>
  124. <li><a class="reference" href="#removeAnimation.e%2CAnimatedSpriteRef%2Cstring"
  125. title="removeAnimation(self: AnimatedSpriteRef; name: string)"><wbr />remove<wbr />Animation<span class="attachedType">AnimatedSpriteRef</span></a></li>
  126. <li><a class="reference" href="#pause.e%2CAnimatedSpriteRef"
  127. title="pause(self: AnimatedSpriteRef)"><wbr />pause<span class="attachedType">AnimatedSpriteRef</span></a></li>
  128. <li><a class="reference" href="#play.e%2CAnimatedSpriteRef%2Cstring%2Cbool"
  129. title="play(self: AnimatedSpriteRef; name: string = &quot;&quot;; backward: bool = false)"><wbr />play<span class="attachedType">AnimatedSpriteRef</span></a></li>
  130. <li><a class="reference" href="#resume.e%2CAnimatedSpriteRef"
  131. title="resume(self: AnimatedSpriteRef)"><wbr />resume<span class="attachedType">AnimatedSpriteRef</span></a></li>
  132. <li><a class="reference" href="#setSpeed.e%2CAnimatedSpriteRef%2Cstring%2Cfloat"
  133. title="setSpeed(self: AnimatedSpriteRef; name: string = &quot;&quot;; speed: float = 2.0&apos;f32)"><wbr />set<wbr />Speed<span class="attachedType">AnimatedSpriteRef</span></a></li>
  134. </ul>
  135. </li>
  136. </ul>
  137. </div>
  138. <div class="nine columns" id="content">
  139. <div id="tocRoot"></div>
  140. <p class="module-desc">It provides display animated sprites.</p>
  141. <div class="section" id="6">
  142. <h1><a class="toc-backref" href="#6">Imports</a></h1>
  143. <dl class="item">
  144. <a class="reference external" href="../thirdparty/opengl.html">../thirdparty/opengl</a>, <a class="reference external" href="../core/vector2.html">../core/vector2</a>, <a class="reference external" href="../core/rect2.html">../core/rect2</a>, <a class="reference external" href="../core/anchor.html">../core/anchor</a>, <a class="reference external" href="../core/input.html">../core/input</a>, <a class="reference external" href="../core/enums.html">../core/enums</a>, <a class="reference external" href="../core/image.html">../core/image</a>, <a class="reference external" href="../core/color.html">../core/color</a>, <a class="reference external" href="../core/animation.html">../core/animation</a>, <a class="reference external" href="../nodes/node.html">../nodes/node</a>, <a class="reference external" href="node2d.html">node2d</a>
  145. </dl></div>
  146. <div class="section" id="7">
  147. <h1><a class="toc-backref" href="#7">Types</a></h1>
  148. <dl class="item">
  149. <a id="AnimatedSpriteObj"></a>
  150. <dt><pre><a href="animated_sprite.html#AnimatedSpriteObj"><span class="Identifier">AnimatedSpriteObj</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="node2d.html#Node2DObj"><span class="Identifier">Node2DObj</span></a>
  151. <span class="Identifier">reversed</span><span class="Operator">*</span><span class="Other">,</span> <span class="Identifier">paused</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">bool</span>
  152. <span class="Identifier">filter</span><span class="Operator">*</span><span class="Other">:</span> <a href="../core/color.html#ColorRef"><span class="Identifier">ColorRef</span></a>
  153. <span class="Identifier">animation</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">string</span>
  154. <span class="Identifier">animations</span><span class="Operator">*</span><span class="Other">:</span> <a href="../core/animation.html#AnimationArray"><span class="Identifier">AnimationArray</span></a><span class="Other">[</span><a href="../core/image.html#GlTextureObj"><span class="Identifier">GlTextureObj</span></a><span class="Other">]</span>
  155. </pre></dt>
  156. <dd>
  157. </dd>
  158. <a id="AnimatedSpriteRef"></a>
  159. <dt><pre><a href="animated_sprite.html#AnimatedSpriteRef"><span class="Identifier">AnimatedSpriteRef</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <a href="animated_sprite.html#AnimatedSpriteObj"><span class="Identifier">AnimatedSpriteObj</span></a></pre></dt>
  160. <dd>
  161. </dd>
  162. </dl></div>
  163. <div class="section" id="12">
  164. <h1><a class="toc-backref" href="#12">Procs</a></h1>
  165. <dl class="item">
  166. <a id="AnimatedSprite,string"></a>
  167. <dt><pre><span class="Keyword">proc</span> <a href="#AnimatedSprite%2Cstring"><span class="Identifier">AnimatedSprite</span></a><span class="Other">(</span><span class="Identifier">name</span><span class="Other">:</span> <span class="Identifier">string</span> <span class="Other">=</span> <span class="StringLit">&quot;AnimatedSprite&quot;</span><span class="Other">)</span><span class="Other">:</span> <a href="animated_sprite.html#AnimatedSpriteRef"><span class="Identifier">AnimatedSpriteRef</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
  168. <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
  169. <dd>
  170. <p>Creates a new AnimatedSprite.</p>
  171. <p>Arguments:</p>
  172. <ul class="simple"><li><tt class="docutils literal"><span class="pre">name</span></tt> is a node name.</li>
  173. </ul>
  174. <p><strong class="examples_text">Examples:</strong></p>
  175. <pre class="listing"><span class="Keyword">var</span> <span class="Identifier">node</span> <span class="Other">=</span> <span class="Identifier">AnimatedSprite</span><span class="Other">(</span><span class="StringLit">&quot;AnimatedSprite&quot;</span><span class="Other">)</span></pre>
  176. </dd>
  177. </dl></div>
  178. <div class="section" id="14">
  179. <h1><a class="toc-backref" href="#14">Methods</a></h1>
  180. <dl class="item">
  181. <a id="draw.e,AnimatedSpriteRef,GLfloat,GLfloat"></a>
  182. <dt><pre><span class="Keyword">method</span> <a href="#draw.e%2CAnimatedSpriteRef%2CGLfloat%2CGLfloat"><span class="Identifier">draw</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="animated_sprite.html#AnimatedSpriteRef"><span class="Identifier">AnimatedSpriteRef</span></a><span class="Other">;</span> <span class="Identifier">w</span><span class="Other">,</span> <span class="Identifier">h</span><span class="Other">:</span> <a href="../thirdparty/opengl.html#GLfloat"><span class="Identifier">GLfloat</span></a><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">GLerror</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
  183. <dd>
  184. this method uses in the <tt class="docutils literal"><span class="pre">window.nim</span></tt>.
  185. </dd>
  186. <a id="duplicate.e,AnimatedSpriteRef"></a>
  187. <dt><pre><span class="Keyword">method</span> <a href="#duplicate.e%2CAnimatedSpriteRef"><span class="Identifier">duplicate</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="animated_sprite.html#AnimatedSpriteRef"><span class="Identifier">AnimatedSpriteRef</span></a><span class="Other">)</span><span class="Other">:</span> <a href="animated_sprite.html#AnimatedSpriteRef"><span class="Identifier">AnimatedSpriteRef</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">base</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
  188. <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
  189. <dd>
  190. Duplicates AnimatedSprite object and create a new AnimatedSprite.
  191. </dd>
  192. <a id="addAnimation.e,AnimatedSpriteRef,string,float"></a>
  193. <dt><pre><span class="Keyword">method</span> <a href="#addAnimation.e%2CAnimatedSpriteRef%2Cstring%2Cfloat"><span class="Identifier">addAnimation</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="animated_sprite.html#AnimatedSpriteRef"><span class="Identifier">AnimatedSpriteRef</span></a><span class="Other">;</span> <span class="Identifier">name</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">speed</span><span class="Other">:</span> <span class="Identifier">float</span> <span class="Other">=</span> <span class="FloatNumber">2.0'f32</span><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
  194. <span class="Identifier">base</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
  195. <dd>
  196. <p>Adds a new animation to the AnimatedSprite animations.</p>
  197. <p>Arguments:</p>
  198. <ul class="simple"><li><tt class="docutils literal"><span class="pre">name</span></tt> is an animation name.</li>
  199. <li><tt class="docutils literal"><span class="pre">speed</span></tt> is an animation speed.</li>
  200. </ul>
  201. </dd>
  202. <a id="addFrame.e,AnimatedSpriteRef,string,GlTextureObj"></a>
  203. <dt><pre><span class="Keyword">method</span> <a href="#addFrame.e%2CAnimatedSpriteRef%2Cstring%2CGlTextureObj"><span class="Identifier">addFrame</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="animated_sprite.html#AnimatedSpriteRef"><span class="Identifier">AnimatedSpriteRef</span></a><span class="Other">;</span> <span class="Identifier">name</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">frame</span><span class="Other">:</span> <a href="../core/image.html#GlTextureObj"><span class="Identifier">GlTextureObj</span></a><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">base</span><span class="Other">,</span>
  204. <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
  205. <dd>
  206. <p>Adds a new frame in the animation.</p>
  207. <p>Arguments:</p>
  208. <ul class="simple"><li><tt class="docutils literal"><span class="pre">name</span></tt> is an animation name.</li>
  209. </ul>
  210. </dd>
  211. <a id="removeAnimation.e,AnimatedSpriteRef,string"></a>
  212. <dt><pre><span class="Keyword">method</span> <a href="#removeAnimation.e%2CAnimatedSpriteRef%2Cstring"><span class="Identifier">removeAnimation</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="animated_sprite.html#AnimatedSpriteRef"><span class="Identifier">AnimatedSpriteRef</span></a><span class="Other">;</span> <span class="Identifier">name</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">base</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
  213. <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
  214. <dd>
  215. <p>Deletes animation from the AnimatedSprite animations. If <tt class="docutils literal"><span class="pre">name</span></tt> is a current animation name, then animation will not delete.</p>
  216. <p>Arguments:</p>
  217. <ul class="simple"><li><tt class="docutils literal"><span class="pre">name</span></tt> is an animation name.</li>
  218. </ul>
  219. </dd>
  220. <a id="pause.e,AnimatedSpriteRef"></a>
  221. <dt><pre><span class="Keyword">method</span> <a href="#pause.e%2CAnimatedSpriteRef"><span class="Identifier">pause</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="animated_sprite.html#AnimatedSpriteRef"><span class="Identifier">AnimatedSpriteRef</span></a><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">base</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
  222. <dd>
  223. Stops animation.
  224. </dd>
  225. <a id="play.e,AnimatedSpriteRef,string,bool"></a>
  226. <dt><pre><span class="Keyword">method</span> <a href="#play.e%2CAnimatedSpriteRef%2Cstring%2Cbool"><span class="Identifier">play</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="animated_sprite.html#AnimatedSpriteRef"><span class="Identifier">AnimatedSpriteRef</span></a><span class="Other">;</span> <span class="Identifier">name</span><span class="Other">:</span> <span class="Identifier">string</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">;</span> <span class="Identifier">backward</span><span class="Other">:</span> <span class="Identifier">bool</span> <span class="Other">=</span> <span class="Identifier">false</span><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">base</span><span class="Other">,</span>
  227. <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
  228. <dd>
  229. <p>Plays animation.</p>
  230. <p>Arguments:</p>
  231. <ul class="simple"><li><tt class="docutils literal"><span class="pre">name</span></tt> is an animation name. if it is &quot;&quot; than plays current animation.</li>
  232. <li>if <tt class="docutils literal"><span class="pre">backward</span></tt> is true then plays animation in reverse order.</li>
  233. </ul>
  234. </dd>
  235. <a id="resume.e,AnimatedSpriteRef"></a>
  236. <dt><pre><span class="Keyword">method</span> <a href="#resume.e%2CAnimatedSpriteRef"><span class="Identifier">resume</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="animated_sprite.html#AnimatedSpriteRef"><span class="Identifier">AnimatedSpriteRef</span></a><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">base</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
  237. <dd>
  238. Resumes animation.
  239. </dd>
  240. <a id="setSpeed.e,AnimatedSpriteRef,string,float"></a>
  241. <dt><pre><span class="Keyword">method</span> <a href="#setSpeed.e%2CAnimatedSpriteRef%2Cstring%2Cfloat"><span class="Identifier">setSpeed</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="animated_sprite.html#AnimatedSpriteRef"><span class="Identifier">AnimatedSpriteRef</span></a><span class="Other">;</span> <span class="Identifier">name</span><span class="Other">:</span> <span class="Identifier">string</span> <span class="Other">=</span> <span class="StringLit">&quot;&quot;</span><span class="Other">;</span> <span class="Identifier">speed</span><span class="Other">:</span> <span class="Identifier">float</span> <span class="Other">=</span> <span class="FloatNumber">2.0'f32</span><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">base</span><span class="Other">,</span>
  242. <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
  243. <dd>
  244. <p>Changes animation speed. If <tt class="docutils literal"><span class="pre">name</span></tt> is &quot;&quot; then changes the speed of the current animation.</p>
  245. <p>Arguments:</p>
  246. <ul class="simple"><li><tt class="docutils literal"><span class="pre">name</span></tt> is an animation name.</li>
  247. <li><tt class="docutils literal"><span class="pre">speed</span></tt> is a new speed.</li>
  248. </ul>
  249. </dd>
  250. </dl></div>
  251. </div>
  252. </div>
  253. <div class="row">
  254. <div class="twelve-columns footer">
  255. <span class="nim-sprite"></span>
  256. <br/>
  257. <small style="color: var(--hint);">Made with Nim. Generated: 2021-11-03 16:20:09 UTC</small>
  258. </div>
  259. </div>
  260. </div>
  261. </div>
  262. </body>
  263. </html>