Phaser v3.88

[photonstorm]

New Features

• Transform.getWorldPoint is a new method that will return the World point as a Vector2 of a Game Object, factoring in parents if applicable (thanks @samme)
• Utils.Array.GetFirst can now search from the end of the array when setting startIndex to -1.
• DynamicTexture and by extension RenderTexture now have a new boolean property forceEven in their constructor, setSize and resize methods. This will force the given width and height values to be rounded up to the nearest even value. This significantly improves the rendering quality of the render texture in most circumstances, so the flag is true by default. This is a potentially breaking change, so if you know you need an odd sized texture, please set the value to false. Fix Size of renderTexture and the rendering quality #6988 (thanks @rexrainbow)

Updates

• Tween.isNumberTween is a new boolean property that tells if the Tween is a NumberTween, or not.
• The TransformMatrix.setTransform method has been updated so that it uses the old way of passing in matrix values for Canvas 2D. This fixes the error "Failed to execute 'setTransform' on 'CanvasRenderingContext2D': 6 arguments required, but only 1 present." in old legacy browsers such as Chromium Embedded Framework. Fix Failed to execute 'setTransform' on 'CanvasRenderingContext2D': 6 arguments required, but only 1 present. #6965 (thanks @rafa-fie)
• Handlers for both mousedown and mouseup have been added for unlocking Web Audio. Both events occur before a click event, allowing for earlier audio unlocking on devices that use a mouse (thanks @pavle-goloskokovic)
• In both the Canvas and WebGL Renderer the background color, as set in the game config, is applied directly to the canvas immediately upon creation, rather than at the first render step. This may avoid some 'flashes' of color in certain circumstances (thanks @pavle-goloskokovic)
• The Texture Manager will now fail gracefully when a texture isn't created as a result of calling the addBase64 method. Rather than the error "TypeError: null is not an object (evaluating 'texture.source')" is will not return early (thanks @samme)
• Both TweenBuilder and NumberTweenBuilder have been updated to use GetFastValue for most properties instead of GetValue.
• The Transform.getWorldTransformMatrix method will now destroy the parent matrix at the end, if it was created within the method.
• The Arcade Physics Body.setGameObject and StaticBody.setGameObject methods have been updated to do the following: Return if no valid Game Object is passed. Disable and null the body of the existing Game Object if the Body has one. Set the body property, even if it doesn't exist (converts non-physics objects into physics objects). Calls setSize to update the body dimensions to make the new Game Object and finally sets enable based on the given parameter, which is now correctly referenced. The StaticBody version also has a new parameter, enable which matches that of the Dynamic Body and defaults to true (the original state). Fix Exception in Arcade Static Body.setGameObject method, null pointer #6969 (thanks @yongzheng7)
• The Arcade Physics ArcadeColliderType has been updated to include Physics.Arcade.StaticBody. Fix The type of Arcade Static Body is missing #6967 (thanks @yongzheng7)
• Phaser.Types.GameObjects.Text.TextStyle now includes letterSpacing: a positive or negative amount to add to the spacing between characters. Fix Text gameobjects: Word wrap doesn't take into account letter spacing #7002 (thanks @Stever1388)
• Tilemaps.Parsers.Tiled.ParseTilesets, Tilemaps.Parsers.Tiled.BuildTilesetIndex and Tilemaps.ImageCollection.addImage have been updated to include width and height of each individual image. Fix Improve support for TiledImageCollection - as it currently assumes all tilesets will be the maximum size of the image in the collection #6990 (thanks @stickleprojects)
• Tilemaps.Components.RenderDebug and Tilemaps.Parsers.Tiled.BuildTilesetIndex have been updated to include width and height offsets in Image Collections.
• Added a warning to Tilemaps.Components.GetTilesWithinShape when attempting to use this method with non orthogonal tilemaps.
• Changed the Cameras.Scene2D.Camera.preRender method from protected to public. Fix Camera.preRender should be public instead of protected? #7020 (thanks @zoubingwu)

Bug Fixes

• TweenData.update will now check if the Tween is a Number Tween and apply the final start/end value to the result on completion, instead of the eased value as calculated by the change made in v3.87.
• BaseTweenData.duration can now never be zero or less than zero, which would trigger NaN errors. It's now clamped to a minimum of 0.01ms. Fix Tweens: Duration of 0 Makes Values NaN (Alpha) #6955 (thanks @kainage)
• Fixed the properties in the FontFileConfig (thanks @samme)
• Matter.World.update could hang and crash the browser if a large delta value was given to it, such as returning to a long-dormant tab. The Matter Runner config values are now properly passed through, preventing this from happening. Fix Tab stalls when using matterjs and moving away from the tab for a while, probably Engine.update related #6977 (thanks @ubershmekel @samme)
• Phaser.Physics.Matter.Components.Transform#scale correctly scales the physics body with the GameObject. Fix Using the .scale setter on a Matter gameobject doesn't update the matter body size #7001 (thanks @Stever1388)
• Phaser.Textures.Frame.setCropUVs updated crop calculation to include the spriteSourceSize. Fix Wrong math in the crop component for trimmed frames #6996 (thanks @CrispMind)
• Phaser.Tilemaps.Parsers.Tiled.ParseJSONTiled updated hexagonal tilemaps to correctly calculate the widthInPixels and heightInPixels based on the hexagonal overlapping tiles. Fix Calculation for widthInPixels and heightInPixels in MapData class does not consider orientation="hexagonal" #6992 (thanks @ptantiku)
• Phaser.Display.Color.Interpolate.RGBWithRGB now correctly returns a Phaser.Types.Display.ColorObject that includes r, g, b, a and color values. Fix Interpolate.ColorWithColor always returns a ColorObject with an undefined color value #6979 (thanks @XWILKINX)
• Fixed incorrect Arcade Physics circle separation logic for circle to circle, and circle to rectangle collisions. The logic was incorrectly moving only one body, even if both could be moved. Fix Arcade Body circle separations are incorrect #6963 (thanks @samme)
• Phaser.Plugins.PluginManager automatically boots plugins when the game config render type is set to Phaser.HEADLESS. Fix NodeJS: scene started before plugins loaded #6893 (thanks @hubertgrzeskowiak)
• Tweens created with persist set to true and given a completeDelay value are no longer destroyed and can be replayed. Fix Tweens with persist:true and a completeDelay are destroyed on completion and cannot be replayed #7008 (thanks @Stever1388)
• The Tweens.TweenChain onStart event is now dispatched properly. Fix TweenChain onStart doesn't get called #7007 (thanks @Stever1388)
• GameObjects.Particles.Zones.DeathZone now uses world position coordinates instead of local position coordinates following the particle emitter position. Fix Particle DeathZones don't work #7006 (thanks @Stever1388)
• Merged pull request Prevent hanging timer events with repeat #7009 from @samme that prevents hanging timer events with repeats and negative delays. Fix A TimerEvent with a delay of 0 and repeat of -1 causes an infinite loop #7004 (thanks @Stever1388)
• When adding a new Tween, passing an event listener callback outside the Phaser.Types.Tweens.TweenBuilderConfig object is now correctly executed without errors. Fix Calling killTweensOf or killAll inside a tween on complete callback throws Uncaught TypeError: cannot read properties of null #7003 (thanks @Stever1388)
• A GameObjects.Text created with wordwrap and with letterSpacing applied now takes into account the provided letterSpacing value to correctly wrap lines. Fix Text gameobjects: Word wrap doesn't take into account letter spacing #7002 (thanks @Stever1388)
• Creating new GameObjects.DOMElement sets the GameObject's displayWidth and displayHeight using its scaleX and scaleY values instead of the DOM elements getBoundingClientRect() values. Fix [dom] error Arcade.Body size when Scale use ScaleModes.FIT #6871 (thanks @HawkenKing)
• Setting scale mode to Phaser.Scale.FIT and autoCenter to Phaser.Scale.CENTER_BOTH correctly centres canvas on iOS devices. Fix iOS displays autoCenter: Phaser.Scale.CENTER_BOTH in a way not consistent with results on android and on pc #6862 (thanks @HawkenKing)
• On hex maps, creating a blank layer with the Tilemaps.Tilemap.createBlankLayer method now correctly sets the hexSideLength as loaded from the hex tilemap. Fix putTileAt into createBlankLayer on hex map from Tiled renders wrong #6074 (thanks @wwoods)
• The Input.InputPlugin.processDragUpEvent now correctly returns x and y coordinates in world space.
• Animations.AnimationState.play method now prioritises the frameRate property when it is set in the PlayAnimationConfig object over animation data loaded from an external file.
• Fixed an issue where sounds / music would stop playing in iOS 17.5.1+ or iOS18+ after losing/gaining focus in Safari. The Web Audio Sound Manager will now listen for the 'visible' event and suspend and resume the context as a result. Fix Phaser sounds/music stop playing in the new iOS 17.5.1 after losing/gaining focus in safari #6829 (thanks @JanAmbrozic @condeagustin)
• The Layer Game Object method setToTop would throw an exception: getDisplayList is not a function. This method has now been added to the Game Object. Fix Layers's setToTop() method throws an exception: this.getDisplayList is not a function #7014 (thanks @leha-games @rexrainbow)
• Fixed an issue where the Particle EmitterOp defaultEmit() always returned undefined, causing particle problems if you gave only an onUpdate callback. Also if you configured an EmitterOp with onEmit or onUpdate, the op's current value would be incorrect (an object) until the first emit. Fix Phaser 3.87 doc issue deriving on unexpected visual @ emitters under CANVAS rendering #7016 (thanks @urueda @samme)

Examples, Documentation, Beta Testing and TypeScript

Thanks to the following for helping with the Phaser Examples, Beta Testing, Docs, and TypeScript definitions, either by reporting errors, fixing them, or helping author the docs:

@samme
@justin-calleja

---

This discussion was created from the release Phaser v3.88.