Merge branch 'develop'

Author: PhaserEditor2D

CHANGELOG.MD

@@ -1,5 +1,10 @@
 # Change Log
 
+## v3.36.0 - Nov 15, 2022
+
+* Animations Editor: allows compiling the animation constans.
+* The Keyboard Key section.
+
 ## v3.35.2 - Nov 10, 2022
 
 Update version.

animations-editor/compiler.rst

@@ -0,0 +1,28 @@
+.. include:: ../_header.rst
+
+Compiling animation key constants
+---------------------------------
+
+You can enable compiling a code file with constant definitions for the animation keys.
+
+For each animation, the compiler will generate a constant declaration. Like this:
+
+.. image:: ../images/animtions-editor-compiler-20221114.webp
+ :alt: Animations constants compiler.
+
+If you have a lot of animations in your game, we recommend using this feature. You can reference animations using constants (and auto-completion) instead of writing the key names "by hand".
+
+By default, the compiler is disabled. You can enable it in the **Compiler Settings** section. This section shows when no animation is selected:
+
+.. image:: ../images/animations-editor-compiler-settings-20221114.webp
+ :alt: Compiler settings.
+
+This a table with the parameters:
+
+* **Generate Code**: Enable the code generation.
+* **Output Language**: Choose between JavaScript and TypeScript.
+* **ES Module**: If selected, it generates an ES module file.
+* **Output Folder**: Choose the parent folder for the output file. If you are using a WebPack or similar bundler, you may want to generate the code in a sub-directory of the `src` folder.
+
+.. image:: ../images/animations-editor-select-output-folder-20221114.webp
+ :alt: Select the output folder.

animations-editor/index.rst

@@ -12,6 +12,7 @@ Animations Editor
     auto-build-animations
     edit-animations-properties
     adding-deleting-frames
+    compiler
 
 `Sprite animations <https://photonstorm.github.io/phaser3-docs/Phaser.Animations.Animation.html>`_ are the most frequent option to animate characters in Phaser_ games. The principle of this animation technique is the displaying of a sequence of images (frames), at a given "speed" or frame rate.
 

conf.py

@@ -56,9 +56,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = u'v3.35.2'
+version = u'v3.36.0'
 # The full version, including alpha/beta/rc tags.
-release = u'v3.35.2'
+release = u'v3.36.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.