Phaser 3 Change Log

Version 3.4.0 - Miyako - 12th April 2018

New Features

A beta release of the new Container Game Object arrives in this version. We've flagged it as beta because there are known issues in using Containers in Scenes that have multiple cameras or irregular camera viewports. However, in all other instances we've tested they are operating normally, so we felt it would be best to release them into this build to give developers a chance to get used to them. Using a Container will issue a single console warning as a reminder. We will remove this once they leave beta in a future release. In the meantime they are fully documented and you can find numerous examples in the Phaser 3 Examples repo too.

• A new property was added to Matter.World, correction which is used in the Engine.update call and allows you to adjust the time being passed to the simulation. The default value is 1 to remain consistent with previous releases.
• Matter Physics now has a new config property getDelta which allows you to specify your own function to calculate the delta value given to the Matter Engine when it updates.
• Matter Physics has two new methods: set60Hz and set30Hz which will set an Engine update rate of 60Hz and 30Hz respectively. 60Hz being the default.
• Matter Physics has a new config and run-time property autoUpdate, which defaults to true. When enabled the Matter Engine will update in sync with the game step (set by Request Animation Frame). The delta value given to Matter is now controlled by the getDelta function.
• Matter Physics has a new method step which manually advances the physics simulation by one iteration, using whatever delta and correction values you pass in to it. When used in combination with autoUpdate=false you can now explicitly control the update frequency of the physics simulation and unbind it from the game step.
• Matter Physics has two new debug properties: debugShowJoint and debugJointColor. If defined they will display joints in Matter bodies during the postUpdate debug phase (only if debug is enabled) (thanks @OmarShehata)
• Group.destroy has a new optional argument destroyChildren which will automatically call destroy on all children of a Group if set to true (the default is false, hence it doesn't change the public API). Fix #3246 (thanks @DouglasLapsley)
• WebAudioSound.setMute is a chainable way to mute a single Sound instance.
• WebAudioSound.setVolume is a chainable way to set the volume of a single Sound instance.
• WebAudioSound.setSeek is a chainable way to set seek to a point of a single Sound instance.
• WebAudioSound.setLoop is a chainable way to set the loop state of a single Sound instance.
• HTML5AudioSound.setMute is a chainable way to mute a single Sound instance.
• HTML5AudioSound.setVolume is a chainable way to set the volume of a single Sound instance.
• HTML5AudioSound.setSeek is a chainable way to set seek to a point of a single Sound instance.
• HTML5AudioSound.setLoop is a chainable way to set the loop state of a single Sound instance.
• BitmapText has a new property letterSpacing which accepts a positive or negative number to add / reduce spacing between characters (thanks @wtravO)
• You can now pass a Sprite Sheet or Canvas as the Texture key to Tilemap.addTileset and it will work in WebGL, where-as before it would display a corrupted tilemap. Fix #3407 (thanks @Zykino)
• Graphics.slice allows you to easily draw a Pacman, or slice of pie shape to a Graphics object.
• List.addCallback is a new optional callback that is invoked every time a new child is added to the List. You can use this to have a callback fire when children are added to the Display List.
• List.removeCallback is a new optional callback that is invoked every time a new child is removed from the List. You can use this to have a callback fire when children are removed from the Display List.
• ScenePlugin.restart allows you to restart the current Scene. It's the same result as calling ScenePlugin.start without any arguments, but is more clear.
• Utils.Array.Add allows you to add one or more items safely to an array, with optional limits and callbacks.
• Utils.Array.AddAt allows you to add one or more items safely to an array at a specified position, with optional limits and callbacks.
• Utils.Array.BringToTop allows you to bring an array element to the top of the array.
• Utils.Array.CountAllMatching will scan an array and count all elements with properties matching the given value.
• Utils.Array.Each will pass each element of an array to a given callback, with optional arguments.
• Utils.Array.EachInRange will pass each element of an array in a given range to a callback, with optional arguments.
• Utils.Array.GetAll will return all elements from an array, with optional property and value comparisons.
• Utils.Array.GetFirst will return the first element in an array, with optional property and value comparisons.
• Utils.Array.GetRandomElement has been renamed to GetRandom and will return a random element from an array.
• Utils.Array.MoveDown will move the given array element down one position in the array.
• Utils.Array.MoveTo will move the given array element to the given position in the array.
• Utils.Array.MoveUp will move the given array element up one position in the array.
• Utils.Array.Remove will remove the given element or array of elements from the array, with an optional callback.
• Utils.Array.RemoveAt will remove the element from the given position in the array, with an optional callback.
• Utils.Array.RemoveBetween will remove the elements between the given range in the array, with an optional callback.
• Utils.Array.Replace will replace an existing element in an array with a new one.
• Utils.Array.SendToBack allows you to send an array element to the bottom of the array.
• Utils.Array.SetAll will set a property on all elements of an array to the given value, with optional range limits.
• Utils.Array.Swap will swap the position of two elements in an array.
• TransformMatrix.destroy is a new method that will clear out the array and object used by a Matrix internally.
• BaseSound, and by extension WebAudioSound and HTMLAudioSound, will now emit a destroy event when they are destroyed (thanks @rexrainbow)
• A new property was added to the Scene config: mapAdd which is used to extend the default injection map of a scene instead of overwriting it (thanks @sebashwa)
• GetBounds getTopLeft, getTopRight, getBottomLeft and getBottomRight all have a new optional argument includeParent which will factor in all ancestor transforms to the returned point.

Bug Fixes

• In the WebGL Render Texture the tint of the texture was always set to 0xffffff and therefore the alpha values were ignored. The tint is now calculated using the alpha value. Fix #3385 (thanks @ger1995)
• The RenderTexture now uses the ComputedSize component instead of Size (which requires a frame), allowing calls to getBounds to work. Fix #3451 (thanks @kuoruan)
• PathFollower.start has been renamed to startFollow, but PathFollower.setPath was still using PathFollower.start (thanks @samid737)
• BaseSoundManager.rate and BaseSoundManager.detune would incorrectly called setRate on its sounds, instead of calculateRate.
• The Gamepad Axis getValue method now correctly applies the threshold and zeroes out the returned value.
• The HueToComponent module was not correctly exporting itself. Fix #3482 (thanks @jdotrjs)
• Matter.World was using setZ instead of setDepth for the Debug Graphics Layer, causing it to appear behind objects in some display lists.
• Game.destroy now checks to see if the renderer exists before calling destroy on it. Fix #3498 (thanks @Huararanga)
• Keyboard.JustDown and Keyboard.JustUp were being reset too early, causing them to fail when called in update loops. Fix #3490 (thanks @belen-albeza)
• RenderTexture.destroy no longer throws an error when called. Fix #3475 (thanks @kuoruan)
• The WebGL TileSprite batch now modulates the tilePosition to avoid large values being passed into the UV data, fixing corruption when scrolling TileSprites over a long period of time. Fix #3402 (thanks @vinerz @FrancescoNegri)
• LineCurve.getResolution was missing the divisions argument and always returning 1, which made it fail when used as part of a Path. It now defaults to return 1 unless specified otherwise (thanks _ok)
• A Game Object enabled for drag would no longer fire over and out events after being dragged, now it does (thanks @jmcriat)
• Line.getPointA and Line.getPointB incorrectly set the values into the Vector2 (thanks @Tomas2h)
• DynamicTilemapLayer now uses the ComputedSize component, which stops it breaking if you call setDisplaySize (thanks Babsobar)
• StaticTilemapLayer now uses the ComputedSize component, which stops it breaking if you call setDisplaySize (thanks Babsobar)
• CanvasPool.first always returned null, and now returns the first available Canvas. Fix #3520 (thanks @mchiasson)
• When starting a new Scene with an optional data argument it wouldn't get passed through if the Scene was not yet available (i.e. the game had not fully booted). The data is now passed to the Scene init and create methods and stored in the Scene Settings data property. Fix #3363 (thanks @pixelhijack)
• Tween.restart handles removed tweens properly and reads them back into the active queue for the TweenManager (thanks @wtravO)
• Tween.resume will now call Tween.play on a tween that was paused due to its config object, not as a result of having its paused method called. Fix #3452 (thanks @jazen)
• LoaderPlugin.isReady referenced a constant that no longer exists. Fix #3503 (thanks @Twilrom)
• Tween Timeline.destroy was trying to call destroy on Tweens instead of stop (thanks @Antriel)
• Calling setOffset on a Static Arcade Physics Body would break because the method was missing. It has been added and now functions as expected. Fix #3465 (thanks @josephjaniga and @DouglasLapsley)
• Calling Impact.World.remove(body) during a Body.updateCallback would cause the internal loop to crash when trying to access a now missing body. Two extra checks are in place to avoid this (thanks @iamDecode)
• If setInteractive is called on a Game Object that fails to set a hit area, it will no longer try to assign dropZone to an undefined input property.
• The Matter SetBody Component will no longer try to call setOrigin unless the Game Object has the origin component (which not all do, like Graphics and Container)
• Matter Image and Matter Sprite didn't define a destroy method, causing an error when trying to destroy the parent Game Object. Fix #3516 (thanks @RollinSafary)

Updates

• The RTree library (rbush) used by Phaser 3 suffered from violating CSP policies by dynamically creating Functions at run-time in an eval-like manner. These are now defined via generators. Fix #3441 (thanks @jamierocks @Colbydude @jdotrjs)
• BaseSound has had its rate and detune properties removed as they are always set in the overriding class.
• BaseSound setRate and setDetune from the 3.3.0 release have moved to the WebAudioSound and HTML5AudioSound classes respectively, as they each handle the values differently.
• The file InteractiveObject.js has been renamed to CreateInteractiveObject.js to more accurately reflect what it does and to avoid type errors in the docs.
• Renamed the Camera Controls module exports for Fixed to FixedKeyControl and Smoothed to SmoothedKeyControl to match the class names. Fix #3463 (thanks @seivan)
• The ComputedSize Component now has setSize and setDisplaySize methods. This component is used for Game Objects that have a non-texture based size.
• The GamepadManager now extends EventEmitter directly, just like the KeyboardManager does.
• The Gamepad Axis threshold has been increased from 0.05 to 0.1.
• Utils.Array.FindClosestInSorted has a new optional argument key which will allow you to scan a top-level property of any object in the given sorted array and get the closest match to it.
• Vector2.setTo is a method alias for Vector2.set allowing it to be used inter-changeably with Geom.Point.
• List.add can now take an array or a single child. If an array is given it's passed over to List.addMultiple.
• List.add has a new optional argument skipCallback.
• List.addAt has a new optional argument skipCallback.
• List.addMultiple has a new optional argument skipCallback.
• List.remove has a new optional argument skipCallback.
• List.removeAt has a new optional argument skipCallback.
• List.removeBetween has a new optional argument skipCallback.
• List.removeAll has a new optional argument skipCallback.
• When using the extend property of a Scene config object it will now block overwriting the Scene sys property.
• When using the extend property of a Scene config object, if you define a property called data that has an object set, it will populate the Scenes Data Manager with those values.
• SceneManager._processing has been renamed to isProcessing which is now a boolean, not an integer. It's also now public and read-only.
• SceneManager.isBooted is a new boolean read-only property that lets you know if the Scene Manager has performed its initial boot sequence.
• TransformMatrix has the following new getter and setters: a, b, c, d, tx and ty. It also has the following new getters: scaleX, scaleY and rotation.
• List.getByKey has been removed. Use List.getFirst instead which offers the exact same functionality.
• List.sortIndexHandler has been removed because it's no longer required.
• List.sort no longer takes an array as its argument, instead it only sorts the List contents by the defined property.
• List.addMultiple has been removed. Used List.add instead which offers the exact same functionality.
• List is now internally using all of the new Utils.Array functions.
• Rectangle.Union will now cache all vars internally so you can use one of the input rectangles as the output rectangle without corrupting it.
• When shutting down a Matter World it will now call MatterEvents.off, clearing all events, and also removeAllListeners for any local events.
• Removed InputPlugin.sortInteractiveObjects because the method isn't used anywhere internally.

Animation System Updates

We have refactored the Animation API to make it more consistent with the rest of Phaser 3 and to fix some issues. All of the following changes apply to the Animation Component:

• Animation durations, delays and repeatDelays are all now specified in milliseconds, not seconds like before. This makes them consistent with Tweens, Sounds and other parts of v3. You can still use the frameRate property to set the speed of an animation in frames per second.
• All of the Animation callbacks have been removed, including onStart, onRepeat, onUpdate and onComplete and the corresponding params arrays like onStartParams and the property callbackScope. The reason for this is that they were all set on a global level, meaning that if you had 100 Sprites sharing the same animation, it was impossible to set the callbacks to fire for just one of those Sprites, but instead they would fire for all 100 and it was up to you to figure out which Sprite you wanted to update. Instead of callbacks animations now dispatch events on the Game Objects in which they are running. This means you can now do sprite.on('animationstart') and it will be invoked at the same point the old onStart callback would have been. The new events are: animationstart, animtionrepeat, animationupdate and animationcomplete. They're all dispatched from the Game Object that has the animation playing, not from the animation itself. This allows you far more control over what happens in the callbacks and we believe generally makes them more useful.
• The AnimationFrame.onUpdate callback has been removed. You can now use the animationupdate event dispatched from the Game Object itself and check the 2nd argument, which is the animation frame.
• Animation.stopAfterDelay is a new method that will stop a Sprites animation after the given time in ms.
• Animation.stopOnRepeat is a new method that will stop a Sprites animation when it goes to repeat.
• Animation.stopOnFrame is a new method that will stop a Sprites animation when it sets the given frame.
• Animation.stop no longer has the dispatchCallbacks argument, because it dispatches an event which you can choose to ignore.
• delay method has been removed.
• setDelay allows you to define the delay before playback begins.
• getDelay returns the animation playback delay value.
• delayedPlay now returns the parent Game Object instead of the component.
• load now returns the parent Game Object instead of the component.
• pause now returns the parent Game Object instead of the component.
• resume now returns the parent Game Object instead of the component.
• isPaused returns a boolean indicating the paused state of the animation.
• paused method has been removed.
• play now returns the parent Game Object instead of the component.
• progress method has been removed.
• getProgress returns the animation progress value.
• setProgress lets you jump the animation to a specific progress point.
• repeat method has been removed.
• getRepeat returns the animation repeat value.
• setRepeat sets the number of times the current animation will repeat.
• repeatDelay method has been removed.
• getRepeatDelay returns the animation repeat delay value.
• setRepeatDelay sets the delay time between each repeat.
• restart now returns the parent Game Object instead of the component.
• stop now returns the parent Game Object instead of the component.
• timeScale method has been removed.
• getTimeScale returns the animation time scale value.
• setTimeScale sets the time scale value.
• totalFrames method has been removed.
• getTotalFrames returns the total number of frames in the animation.
• totalProgres method has been removed as it did nothing and was mis-spelt.
• yoyo method has been removed.
• getYoyo returns if the animation will yoyo or not.
• setYoyo sets if the animation will yoyo or not.
• updateFrame will now call setSizeToFrame on the Game Object, which will adjust the Game Objects width and height properties to match the frame size. Fix #3473 (thanks @wtravO @jp-gc)
• updateFrame now supports animation frames with custom pivot points and injects these into the Game Object origin.
• destroy now removes events, references to the Animation Manager and parent Game Object, clears the current animation and frame and empties internal arrays.
• Changing the yoyo property on an Animation Component would have no effect as it only ever checked the global property, it now checks the local one properly allowing you to specify a yoyo on a per Game Object basis.
• Animation.destroy now properly clears the global animation object.
• Animation.getFrameByProgress will return the Animation Frame that is closest to the given progress value. For example, in a 5 frame animation calling this method with a value of 0.5 would return the middle frame.

Examples, Documentation and TypeScript

My thanks to the following for helping with the Phaser 3 Examples, Docs and TypeScript definitions, either by reporting errors, fixing them or helping author the docs:

@gabegordon @melissaelopez @samid737 @nbs @tgrajewski @pagesrichie @hexus @mbrickn @erd0s @icbat @Matthew-Herman @ampled @mkimmet @PaNaVTEC