edit-animations-properties.html 8.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154
  1. <!DOCTYPE html>
  2. <html class="writer-html5" lang="en" >
  3. <head>
  4. <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  6. <title>Editing the properties of the animations &mdash; Phaser Editor 2D Help</title>
  7. <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  8. <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  9. <link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
  10. <link rel="shortcut icon" href="../_static/icon.png"/>
  11. <!--[if lt IE 9]>
  12. <script src="../_static/js/html5shiv.min.js"></script>
  13. <![endif]-->
  14. <script src="../_static/jquery.js?v=5d32c60e"></script>
  15. <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
  16. <script src="../_static/documentation_options.js?v=a1f35292"></script>
  17. <script src="../_static/doctools.js?v=888ff710"></script>
  18. <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
  19. <script src="../_static/js/theme.js"></script>
  20. <link rel="index" title="Index" href="../genindex.html" />
  21. <link rel="search" title="Search" href="../search.html" />
  22. <link rel="next" title="Adding and deleting frames" href="adding-deleting-frames.html" />
  23. <link rel="prev" title="Automatic creation of the animations" href="auto-build-animations.html" />
  24. </head>
  25. <body class="wy-body-for-nav">
  26. <div class="wy-grid-for-nav">
  27. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  28. <div class="wy-side-scroll">
  29. <div class="wy-side-nav-search" style="background: #343131" >
  30. <a href="../index.html" class="icon icon-home">
  31. Phaser Editor 2D
  32. <img src="../_static/logo.png" class="logo" alt="Logo"/>
  33. </a>
  34. <div class="version">
  35. v3.67.0
  36. </div>
  37. <div role="search">
  38. <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
  39. <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
  40. <input type="hidden" name="check_keywords" value="yes" />
  41. <input type="hidden" name="area" value="default" />
  42. </form>
  43. </div>
  44. </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
  45. <ul class="current">
  46. <li class="toctree-l1"><a class="reference internal" href="../intro/index.html">Introduction</a></li>
  47. <li class="toctree-l1"><a class="reference internal" href="../first-steps/index.html">First steps</a></li>
  48. <li class="toctree-l1"><a class="reference internal" href="../workbench/index.html">Workbench</a></li>
  49. <li class="toctree-l1"><a class="reference internal" href="../asset-pack-editor/index.html">Asset Pack Editor</a></li>
  50. <li class="toctree-l1"><a class="reference internal" href="../scene-editor/index.html">Scene Editor</a></li>
  51. <li class="toctree-l1"><a class="reference internal" href="../code-editor/index.html">Code Editor</a></li>
  52. <li class="toctree-l1 current"><a class="reference internal" href="index.html">Animations Editor</a><ul class="current">
  53. <li class="toctree-l2"><a class="reference internal" href="new-file-wizard.html">Create a new Animations file</a></li>
  54. <li class="toctree-l2"><a class="reference internal" href="add-animation.html">Adding animations to the file</a></li>
  55. <li class="toctree-l2"><a class="reference internal" href="auto-build-animations.html">Automatic creation of the animations</a></li>
  56. <li class="toctree-l2 current"><a class="current reference internal" href="#">Editing the properties of the animations</a></li>
  57. <li class="toctree-l2"><a class="reference internal" href="adding-deleting-frames.html">Adding and deleting frames</a></li>
  58. <li class="toctree-l2"><a class="reference internal" href="compiler.html">Compiling animation key constants</a></li>
  59. </ul>
  60. </li>
  61. <li class="toctree-l1"><a class="reference internal" href="../atlas-editor/index.html">Atlas Editor</a></li>
  62. <li class="toctree-l1"><a class="reference internal" href="../misc/index.html">Miscellaneous</a></li>
  63. <li class="toctree-l1"><a class="reference internal" href="../pricing/index.html">License and pricing</a></li>
  64. </ul>
  65. </div>
  66. </div>
  67. </nav>
  68. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" style="background: #343131" >
  69. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  70. <a href="../index.html">Phaser Editor 2D</a>
  71. </nav>
  72. <div class="wy-nav-content">
  73. <div class="rst-content">
  74. <div role="navigation" aria-label="Page navigation">
  75. <ul class="wy-breadcrumbs">
  76. <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
  77. <li class="breadcrumb-item"><a href="index.html">Animations Editor</a></li>
  78. <li class="breadcrumb-item active">Editing the properties of the animations</li>
  79. <li class="wy-breadcrumbs-aside">
  80. </li>
  81. </ul>
  82. <hr/>
  83. </div>
  84. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  85. <div itemprop="articleBody">
  86. <section id="editing-the-properties-of-the-animations">
  87. <h1>Editing the properties of the animations<a class="headerlink" href="#editing-the-properties-of-the-animations" title="Link to this heading"></a></h1>
  88. <p>These are the properties of an animation:</p>
  89. <p><strong>Key</strong>: The identifier of the animations. Used to play the animation in a sprite: <code class="docutils literal notranslate"><span class="pre">sprite.play(&quot;walk&quot;)</span></code>.</p>
  90. <p><strong>Frame Rate</strong>: The frame rate of playback in frames per second (default 24).</p>
  91. <p><strong>Delay</strong>: Delay before starting playback. Value given in milliseconds.</p>
  92. <p><strong>Repeat</strong>: Number of times to repeat the animation (-1 for infinity).</p>
  93. <p><strong>Repeat Delay</strong>: Delay before the animation repeats. Value given in milliseconds.</p>
  94. <p><strong>Yoyo</strong>: Should the animation yoyo? (reverse back down to the start) before repeating?</p>
  95. <p><strong>Show On Start</strong>: Should sprite.visible = true when the animation starts to play?</p>
  96. <p><strong>Hide On Complete</strong>: Should <code class="docutils literal notranslate"><span class="pre">sprite.visible</span> <span class="pre">=</span> <span class="pre">false</span></code> when the animation finishes.</p>
  97. <p><strong>Skip Missed Frames</strong>: Skip frames if the time lags, or always advanced anyway?</p>
  98. <p>By default, the editor shows all the animations and in the <a class="reference external" href="../workbench/inspector-view.html">Inspector view</a> shows the properties of all of them. However, you can click on an animation in the editor, to edit the properties of that single animation. Or select a couple of animations in the <a class="reference external" href="../workbench/outline-view.html">Outline view</a>.</p>
  99. <img alt="Edit the animations." src="../_images/animations-edit.webp" />
  100. </section>
  101. </div>
  102. </div>
  103. <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
  104. <a href="auto-build-animations.html" class="btn btn-neutral float-left" title="Automatic creation of the animations" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
  105. <a href="adding-deleting-frames.html" class="btn btn-neutral float-right" title="Adding and deleting frames" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
  106. </div>
  107. <hr/>
  108. <div role="contentinfo">
  109. <p>&#169; Copyright 2016-2024, Arian Fornaris.</p>
  110. </div>
  111. Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
  112. <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
  113. provided by <a href="https://readthedocs.org">Read the Docs</a>.
  114. </footer>
  115. </div>
  116. </div>
  117. </section>
  118. </div>
  119. <script>
  120. jQuery(function () {
  121. SphinxRtdTheme.Navigation.enable(true);
  122. });
  123. </script>
  124. <!-- Theme Analytics -->
  125. <script async src="https://www.googletagmanager.com/gtag/js?id=UA-67206336-2"></script>
  126. <script>
  127. window.dataLayer = window.dataLayer || [];
  128. function gtag(){dataLayer.push(arguments);}
  129. gtag('js', new Date());
  130. gtag('config', 'UA-67206336-2', {
  131. 'anonymize_ip': false,
  132. });
  133. </script>
  134. </body>
  135. </html>