Version 3.60.0 - Miku - in development
New Features - Sprite FX
- When defining the
renderTargets
in a WebGL Pipeline config, you can now set optionalwidth
andheight
properties, which will create a Render Target of that exact size, ignoring thescale
value (if also given). WebGLPipeline.isSpriteFX
is a new boolean property that defines if the pipeline is a Sprite FX Pipeline, or not. The default isfalse
.GameObjects.Components.FX
is a new component that provides access to FX specific properties and methods. The Image and Sprite Game Objects have this component by default.fxPadding
and its related methodsetFXPadding
allow you to set extra padding to be added to the texture the Game Object renders with. This is especially useful for Sprite FX shaders that modify the sprite beyond its bounds, such as glow or shadow effects.- The
WebGLPipeline.setShader
method has a new optional parameterbuffer
that allows you to set the vertex buffer to be bound before the shader is activated. - The
WebGLPipeline.setVertexBuffer
method has a new optional parameterbuffer
that allows you to set the vertex buffer to be bound if you don't want to bind the default one. - The
WebGLRenderer.createTextureFromSource
method has a new optional boolean parameterforceClamp
that will for the clamp wrapping mode even if the texture is a power-of-two. RenderTarget
will now automatically set the wrapping mode to clamp.WebGLPipeline.flipProjectionMatrix
is a new method that allows you to flip the y and bottom projection matrix values via a parameter.PipelineManager.renderTargets
is a new property that holds an array ofRenderTarget
objects that allSpriteFX
pipelines can share, to keep texture memory as low as possible.PipelineManager.maxDimension
is a new property that holds the largest possible target dimension.PipelineManager.frameInc
is a new property that holds the amount theRenderTarget
s will increase in size in each iteration. The default value is 32, meaning it will create targets of size 32, 64, 96, etc. You can control this via the pipeline config object.PipelineManager.targetIndex
is a new property that holds the internal target array offset index. Treat it as read-only.- The Pipeline Manager will now create a bunch of
RenderTarget
objects during itsboot
method. These are sized incrementally from 32px and up (use theframeInc
value to alter this). These targets are shared by all Sprite FX Pipelines. PipelineManager.getRenderTarget
is a new method that will return the aRenderTarget
that best fits the dimensions given. This is typically called by Sprite FX Pipelines, rather than directly.PipelineManager.getSwapRenderTarget
is a new method that will return a 'swap'RenderTarget
that matches the size of the main target. This is called by Sprite FX pipelines and not typically called directly.PipelineManager.getAltSwapRenderTarget
is a new method that will return a 'alternative swap'RenderTarget
that matches the size of the main target. This is called by Sprite FX pipelines and not typically called directly.
New Features - Compressed Texture Support
Phaser 3.60 contains support for Compressed Textures. It can parse both KTX and PVR containers and within those has support for the following formats: ETC, ETC1, ATC, ASTC, BPTC, RGTC, PVRTC, S3TC and S3TCSRB. Compressed Textures differ from normal textures in that their structure is optimized for fast GPU data reads and lower memory consumption. Popular tools that can create compressed textures include PVRTexTool, ASTC Encoder and Texture Packer.
Compressed Textures are loaded using the new this.load.texture
method, which takes a texture configuration object that maps the formats to the files. The browser will then download the first file in the object that it knows it can support. You can also provide Texture Atlas JSON data, or Multi Atlas JSON data, too, so you can use compressed texture atlases. Currently, Texture Packer is the best tool for creating these type of files.
Development of this feature was kindly sponsored by Club Penguin Rewritten (https://cprewritten.net).
TextureSoure.compressionAlgorithm
is now populated with the compression format used by the texture.Types.Textures.CompressedTextureData
is the new compressed texture configuration object type.TextureManager.addCompressedTexture
is a new method that will add a compressed texture, and optionally atlas data into the Texture Manager and return aTexture
object than any Sprite can use.Textures.Parsers.KTXParser
is a new parser for the KTX compression container format.Textures.Parsers.PVRParser
is a new parser for the PVR compression container format.- The
WebGLRenderer.compression
property now holds a more in-depth object containing supported compression formats. - The
WebGLRenderer.createTextureFromSource
method now accepts theCompressedTextureData
data objects and creates WebGL textures from them. WebGLRenderer.getCompressedTextures
is a new method that will populate theWebGLRenderer.compression
object and return its value. This is called automatically when the renderer boots.WebGLRenderer.getCompressedTextureName
is a new method that will return a compressed texture format GLenum based on the given format.
New Features - Multi Tint Pipeline
- If you have a customised Multi Tint Pipeline fragment shader that uses the
%forloop%
declaration, you should update it to follow the new format defined inMulti.frag
. This new shader uses a function calledgetSampler
instead. Please see the shader code and update your own shaders accordingly. You can also see the documentation for the MultiPipeline for details. - The
Multi.frag
shader now uses ahighp
precision instead ofmediump
. - The
WebGL.Utils.checkShaderMax
function will no longer use a massive if/else glsl shader check and will instead rely on the value given ingl.getParameter(gl.MAX_TEXTURE_IMAGE_UNITS)
. - The
WebGL.Utils.parseFragmentShaderMaxTextures
function no longer supports the%forloop%
declaration. - The internal WebGL Utils function
GenerateSrc
has been removed as it's no longer required internally.
New Features - Matter Physics v0.18
We have updated the version of Matter Physics to the latest v0.18 release. This is a big jump and brings with it quite a few internal changes to Matter. The following are the differences we have identified in this release:
- Up to ~40% performance improvement (on average measured over all examples, in Node on a Mac Air M1)
- Replaces
Matter.Grid
with a faster and more efficient broadphase inMatter.Detector
. - Reduced memory usage and garbage collection.
- Resolves issues in
Matter.SAT
related to collision reuse. - Removes performance issues from
Matter.Grid
. - Improved collision accuracy.
MatterPhysics.collision
is a new reference to theCollision
module, which now handles all Matter collision events.MatterPhysics.grid
has been removed as this is now handled by theCollision
module.MatterPhysics.sat
has been removed as this is now handled by theCollision
module.- The
Matter.Body.previousPositionImpulse
property has been removed as it's no longer used.
New Features
ScaleManager.getViewPort
is a new method that will return a Rectangle geometry object that matches the visible area of the screen (thanks @rexrainbow)- When starting a Scene and using an invalid key, Phaser will now raise a console warning informing you of this, instead of silently failing. Fix #5811 (thanks @ubershmekel)
GameObjects.Layer.addToDisplayList
andremoveFromDisplayList
are new methods that allows for you to now add a Layer as a child of another Layer. Fix #5799 (thanks @samme)GameObjects.Video.loadURL
has a new optional 4th parametercrossOrigin
. This allows you to specify a cross origin request type when loading the video cross-domain (thanks @rmartell)- You can now set
loader.imageLoadType: "HTMLImageElement"
in your Game Configuration and the Phaser Loader will use an Image Tag to load all images, rather than XHR and a Blob object which is the default. This is a global setting, so all file types that use images, such as Atlas or Spritesheet, will be changed via this flag (thanks @hanzooo) - You can now control the drawing offset of tiles in a Tileset using the new optional property
Tileset.tileOffset
(which is a Vector2). This property is set automatically when Tiled data is parsed and found to contain it. Fix #5633 (thanks @moJiXiang @kainage) - You can now set the alpha value of the Camera Flash effect before running it, where-as previously it was always 1 (thanks @kainage)
- The
Tilemap.createFromObjects
method has been overhauled to support typed tiles from the Tiled Map Editor (https://doc.mapeditor.org/en/stable/manual/custom-properties/#typed-tiles). It will now also examine the Tileset to inherit properties based on the tile gid. It will also now attempt to use the same texture and frame as Tiled when creating the object (thanks @lackhand) TweenManager.reset
is a new method that will take a tween, remove it from all internal arrays, then seek it back to its start and set it as being active.- The
Video
config will now detect forx-m4v
playback support for video formats and store it in theVideo.m4v
property. This is used automatically by theVideoFile
file loader. Fix #5719 (thanks @patrickkeenan) - The
KeyboardPlugin.removeKey
method has a new optional parameterremoveCapture
. This will remove any keyboard capture events for the given Key. Fix #5693 (thanks @cyantree) - The
KeyboardPlugin.removeAllKeys
method has a new optional parameterremoveCapture
. This will remove any keyboard capture events for all of the Keys owned by the plugin. WebGLShader.fragSrc
is a new property that holds the source of the fragment shader.WebGLShader.vertSrc
is a new property that holds the source of the vertex shader.WebGLShader#.createProgram
is a new method that will destroy and then re-create the shader program based on the given (or stored) vertex and fragment shader source.WebGLShader.setBoolean
is a new method that allows you to set a boolean uniform on a shader.WebGLPipeline.setBoolean
is a new method that allows you to set a boolean uniform on a shader.Phaser.Scenes.Systems.getStatus
is a new method that will return the current status of the Scene.Phaser.Scenes.ScenePlugin.getStatus
is a new method that will return the current status of the given Scene.Math.LinearXY
is a new function that will interpolate between 2 given Vector2s and return a new Vector2 as a result (thanks @GregDevProjects)Curves.Path.getCurveAt
is a new method that will return the curve that forms the path at the given location (thanks @natureofcode)- You can now use any
Shape
Game Object as a Geometry Mask. Fix #5900 (thanks @rexrainbow) Mesh.setTint
is a new method that will set the tint color across all vertices of a Mesh (thanks @rexrainbow)Mesh.tint
is a new setter that will set the tint color across all vertices of a Mesh (thanks @rexrainbow)Mesh.clearTint
is a new method that will clear the tint from all vertices of a Mesh (thanks @rexrainbow)- You can now use dot notation as the datakey when defining a Loader Pack File (thanks @rexrainbow)
Vector2.project
is a new method that will project the vector onto the given vector (thanks @samme)- Experimental feature: The
TilemapLayer
now has theMask
component - meaning you can apply a mask to tilemaps (thanks @samme) TilemapLayer.setTint
is a new method that allows you to set the tint color of all tiles in the given area, optionally based on the filtering search options. This is a WebGL only feature.RenderTexture.setIsSpriteTexture
is a new method that allows you to flag a Render Texture as being used as the source for Sprite Game Object textures. You can also toggle the new boolean propertyisSpriteTexture
as well. Doing this ensures that images drawn to the Render Texture are correctly inverted for rendering in WebGL. Not doing so can cause inverted frames. If you use this method, you must use it before drawing anything to the Render Texture. Fix #6057 #6017 (thanks @andymikulski @Grandnainconnu)UtilityPipeline.blitFrame
has a new optional boolean parameterflipY
which, if set, will invert the source Render Target while drawing it to the destination Render Target.
Geom Updates
The following are API-breaking, in that a new optional parameter has been inserted prior to the output parameter. If you use any of the following functions, please update your code:
- The
Geom.Intersects.GetLineToLine
method has a new optional parameterisRay
. Iftrue
it will treat the first line parameter as a ray, if false, as a line segment (the default). - The
Geom.Intersects.GetLineToPoints
method has a new optional parameterisRay
. Iftrue
it will treat the line parameter as a ray, if false, as a line segment (the default). - The
Geom.Intersects.GetLineToPolygon
method has a new optional parameterisRay
. Iftrue
it will treat the line parameter as a ray, if false, as a line segment (the default). Geom.Intersects.GetRaysFromPointToPolygon
uses the newisRay
parameter to enable this function to work fully again.
Loader Updates
MultiFile.pendingDestroy
is a new method that is called by the Loader Plugin and manages preparing the file for deletion. It also emits theFILE_COMPLETE
andFILE_KEY_COMPLETE
events, fixing a bug whereMultiFile
related files, such as an Atlas JSON or a Bitmap Font File, wouldn't emit thefilecomplete
events for the parent file, only for the sub-files. This means you can now listen for the file completion event formultiatlas
files, among others.MultiFile.destroy
is a new method that clears down all external references of the file, helping free-up resources.File.addToCache
no longer callsFile.pendingDestroy
, instead this is now handled by the Loader Plugin.- There is a new File constant
FILE_PENDING_DESTROY
which is used to ensure Files aren't flagged for destruction more than once. LoaderPlugin.localSchemes
is a new array of scheme strings that the Loader considers as being local files. This is populated by the newPhaser.Core.Config#loaderLocalScheme
game / scene config property. It defaults to[ 'file://', 'capacitor://' ]
but additional schemes can be defined or pushed onto this array. Based on #6010 (thanks @kglogocki)
Updates
- When you try to use a frame that is missing on the Texture, it will now give the key of the Texture in the console warning (thanks @samme)
- The
Display.Masks.BitmapMask
destroy
method will now remove the context-lost event handler. - The
hitArea
parameter of theGameObjects.Zone.setDropZone
method is now optional and if not given it will try to create a hit area based on the size of the Zone Game Object (thanks @rexrainbow) BitmapMask.scene
is a new property that allows the Bitmap Mask to reference the Scene it was created in.- The
DOMElement.preUpdate
method has been removed. If you overrode this method, please now seepreRender
instead. DOMElement.preRender
is a new method that will check parent visibility and improve its behavior, responding to the parent even if the Scene is paused or the element is inactive. Dom Elements are also no longer added to the Scene Update List. Fix #5816 (thanks @prakol16 @samme)- Phaser 3 is now built with webpack 5 and all related packages have been updated.
- Previously, an Array Matrix would enforce it had more than 2 rows. This restriction has been removed, allowing you to define and rotate single-row array matrices (thanks @andriibarvynko)
- The Gamepad objects now have full TypeScript definitions thanks to @sylvainpolletvillard
- Lots of configuration objects now have full TypeScript definitions thanks to @16patsle
Particle.fire
will now throw an error if the particle has no texture frame. This prevents an uncaught error later when the particle fails to render. Fix #5838 (thanks @samme @monteiz)ParticleEmitterManager.setEmitterFrames
will now print out console warnings if an invalid texture frame is given, or if no texture frames were set. Fix #5838 (thanks @samme @monteiz)SceneManager.stop
andsleep
will now ignore the call if the Scene has already been shut down, avoiding potential problems with duplicate event handles. Fix #5826 (thanks @samme)- Removed the
Tint
andFlip
components from theCamera
class. Neither were ever used internally, or during rendering, so it was just confusing having them in the API. - A new
console.error
will be printed if theFile
,MultiFile
,JSONFile
orXMLFile
fail to process or parse correctly, even if they manage to load. Fix #5862 #5851 (thanks @samme @ubershmekel) - The
ScriptFile
Loader File Type has a new optional parameter:type
. This is a string that controls the type attribute of the<script>
tag that is generated by the Loader. By default it is 'script', but you can change it to 'module' or any other valid type. - The JSON Hash and Array Texture Parsers will now throw a console.warn if the JSON is invalid and contains identically named frames.
Scene.pause
will now check to see if the Scene is in either a RUNNING or CREATING state and throw a warning if not. You cannot pause non-running Scenes.Mesh.addVertices
will now throw a console warning if invalid vertices data is given to the method (thanks @omniowl)Mesh.addVerticesFromObj
will now throw a console warning if invalid vertices data is given to the method (thanks @omniowl)TouchManager.onTouchOver
andonTouchOut
have been removed, along with all of their related event calls as they're not used by any browser any more.TouchManager.isTop
is a new property, copied from the MouseManager, that retains if the window the touch is interacting with is the top one, or not.- The
InputManager.onTouchMove
method will now check if the changed touch is over the canvas, or not, via the DOMelementFromPoint
function. This means if the touch leaves the canvas, it will now trigger theGAME_OUT
andGAME_OVER
events, where-as before this would only happen for a Mouse. If the touch isn't over the canvas, no Pointer touch move happens, just like with the mouse. Fix #5592 (thanks @rexrainbow) TileMap.createBlankDynamicLayer
has now been removed as it was deprecated in 3.50.TileMap.createDynamicLayer
has now been removed as it was deprecated in 3.50.TileMap.createStaticLayer
has now been removed as it was deprecated in 3.50.Animations.AnimationManager.createFromAseprite
has a new optional 3rd parametertarget
. This allows you to create the animations directly on a Sprite, instead of in the global Animation Manager (thanks Telemako)Animations.AnimationState.createFromAseprite
is a new method that allows you to create animations from exported Aseprite data directly on a Sprite, rather than always in the global Animation Manager (thanks Telemako)- The
path
package used by the TS Defs generator has been moved todevDependencies
(thanks @antkhnvsk) - The
GetValue
function has a new optional parameteraltSource
which allows you to provide an alternative object to source the value from. - The
Renderer.Snapshot.WebGL
function has had its first parameter changed from anHTMLCanvasElement
to aWebGLRenderingContext
. This is now passed in from thesnapshot
methods inside the WebGL Renderer. The change was made to allow it to work with WebGL2 custom contexts (thanks @andymikulski) - If you start a Scene that is already starting (START, LOADING, or CREATING) then the start operation is now ignored (thanks @samme)
- If you start a Scene that is Sleeping, it is shut down before starting again. This matches how Phaser currently handles paused scenes (thanks @samme)
- The right-click context menu used to be disabled on the document.body via the
disableContextMenu
function, but instead now uses the MouseManager / TouchManager targets, which if not specified defaults to the game canvas. Fix # (thanks @lukashass) - The Particle 'moveTo' calculations have been simplied and made more efficient (thanks @samme)
- The
Key.reset
method no longer resets theKey.enabled
orKey.preventDefault
booleans back totrue
again, but only resets the state of the Key. Fix #6098 (thanks @descodifica) - When setting the Input Debug Hit Area color it was previously fixed to the value given when created. The value is now taken from the object directly, meaning you can set
gameObject.hitAreaDebug.strokeColor
in real-time (thanks @spayton) - You can now have a particle frequency smaller than the delta step, which would previously lead to inconsistencies in emission rates (thanks @samme)
- The
Light
Game Object now has theOrigin
andTransform
components, along with 4 new properties:width
,height
,displayWidth
anddisplayHeight
. This allows you to add a Light to a Container, or enable it for physics. Fix #6126 (thanks @jcoppage) - The
Transform
Component has a new boolean read-only propertyhasTransformComponent
which is set totrue
by default. - The Arcade Physics
World.enableBody
method will now only create and add aBody
to an object if it has the Transform component, tested by checking thehasTransformComponent
property. Without the Transform component, creating a Body would error with NaN values, causing the rest of the bodies in the world to fail. ProcessQueue.isActive
is a new method that tests if the given object is in the active list, or not.ProcessQueue.isPending
is a new method that tests if the given object is in the pending insertion list, or not.ProcessQueue.isDestroying
is a new method that tests if the given object is pending destruction, or not.ProcessQueue.add
will no longer place the item into the pending list if it's already active or pending.ProcessQueue.remove
will check if the item is in the pending list, and simply remove it, rather than destroying it.Container.addHandler
will now callGameObject.addedToScene
.Container.removeHandler
will now callGameObject.removedFromScene
.
Bug Fixes
Animation.createFromAseprite
would calculate an incorrect frame duration if the frames didn't all have the same speed.- The URL scheme
capacitor://
has been added to the protocol check to prevent malformed double-urls in some environments (thanks @consolenaut) - Removed
Config.domBehindCanvas
property as it's never used internally. Fix #5749 (thanks @iamallenchang) dispatchTweenEvent
would overwrite one of the callback's parameters. This fix ensures thatTween.setCallback
now works consistently. Fix #5753 (thanks @andrei-pmbcn @samme)- The context restore event handler is now turned off when a Game Object is destroyed. This helps avoid memory leakage from Text and TileSprite Game Objects, especially if you consistently destroy and recreate your Game instance in a single-page app (thanks @rollinsafary-inomma @rexrainbow @samme)
- When the device does not support WebGL, creating a game with the renderer type set to
Phaser.WEBGL
will now fail with an error. Previously, it would fall back to Canvas. Now it will not fall back to Canvas. If you require that feature, use the AUTO render type. Fix #5583 (thanks @samme) - The
Tilemap.createFromObjects
method will now correctly place both tiles and other objects. Previously, it made the assumption that the origin was 0x1 for all objects, but Tiled only uses this for tiles and uses 0x0 for its other objects. It now handles both. Fix #5789 (thanks @samme) - The
CanvasRenderer.snapshotCanvas
method used an incorrect reference to the canvas, causing the operation to fail. It will now snapshot a canvas correctly. Fix #5792 #5448 (thanks @rollinsafary-inomma @samme @akeboshi1) - The
Tilemap.tileToWorldY
method incorrectly had the parametertileX
. It will worked, but didn't make sense. It is nowtileY
(thanks @mayacoda) - The
Tilemap.convertTilemapLayer
method would fail for isometric tilemaps by not setting the physic body alignment properly. It will now callgetBounds
correctly, allowing for use on non-orthagonal maps. Fix #5764 (thanks @mayacoda) - The
PluginManager.installScenePlugin
method will now check if the plugin is missing from the local keys array and add it back in, if it is (thanks @xiamidaxia) - The Spine Plugin would not work with multiple instances of the same game on a single page. It now stores its renderer reference outside of the plugin, enabling this. Fix #5765 (thanks @xiamidaxia)
- In Arcade Physics, Group vs. self collisions would cause double collision callbacks due to the use of the quad tree. For this specific conditions, the quad tree is now skipped. Fix #5758 (thanks @samme)
- During a call to
GameObject.Shapes.Rectangle.setSize
it will now correctly update the Rectangle object's display origin and default hitArea (thanks @rexrainbow) - The Arcade Physics Body will now recalculate its center after separation with a Tile in time for the values to be correct in the collision callbacks (thanks @samme)
- The
ParseTileLayers
function has been updated so that it no longer breaks when using a Tiled infinite map with empty chunks (thanks @jonnytest1) - The
PutTileAt
function will now set the Tile dimensions from the source Tileset, fixing size related issues when placing tiles manually. Fix #5644 (thanks @moJiXiang @stuffisthings) - The new
Tileset.tileOffset
property fixes an issue with drawing isometric tiles when an offset had been defined in the map data (thanks @moJiXiang) - Fixed issue in
Geom.Intersects.GetLineToLine
function that would fail with colinear lines (thanks @Skel0t) - The
CameraManager.destroy
function will now remove the Scale ManagerRESIZE
event listener created as part ofboot
, where-as before it didn't clean it up, leading to gc issues. Fix #5791 (thanks @liuhongxuan23) - With
roundPixels
set to true in the game or camera config, Sprites will no longer render at sub-pixel positions under CANVAS. Fix #5774 (thanks @samme) - The Camera will now emit
PRE_RENDER
andPOST_RENDER
events under the Canvas Renderer. Fix #5729 (thanks @ddanushkin) - The Multi Pipeline now uses
highp float
precision by default, instead ofmediump
. This fixes issues with strange blue 'spots' appearing under WebGL on some Android devices. Fix #5751 #5659 #5655 (thanks @actionmoon @DuncanPriebe @ddanushkin) - The
Tilemaps.Tile.getBounds
method would take acamera
parameter but then not pass it to the methods called internally, thus ignoring it. It now factors the camera into the returned Rectangle. Tilemap.createFromObjects
has had the rendering of Tiled object layers on isometric maps fixed. Objects contained in object layers generated by Tiled use orthogonal positioning even when the map is isometric and this update accounts for that (thanks @lfarroco)- Timers with very short delays (i.e. 1ms) would only run the callback at the speed of the frame update. It will now try and match the timer rate by iterating the calls per frame. Fix #5863 (thanks @rexrainbow)
- The
Text
,TileSprite
andRenderTexture
Game Objects would call the pre and post batch functions twice by mistake, potentially applying a post fx twice to them. ScaleManager.getParentBounds
will now also check to see if the canvas bounds have changed x or y position, and if so returntrue
, causing the Scale Manager to refresh all of its internal cached values. This fixes an issue where the canvas may have changed position on the page, but not its width or height, so a refresh wasn't triggered. Fix #5884 (thanks @jameswilddev)- The
SceneManager.bootScene
method will now always callLoaderPlugin.start
, even if there are no files in the queue. This means that the Loader will always dispatch itsSTART
andCOMPLETE
events, even if the queue is empty because the files are already cached. You can now rely on theSTART
andCOMPLETE
events to be fired, regardless, using them safely in your preload scene. Fix #5877 (thanks @sipals) - Calling
TimerEvent.reset
in the Timer callback would cause the timer to be added to the Clock's pending removal and insertion lists together, throwing an error. It will now not add to pending removal if the timer was reset. Fix #5887 (thanks @rexrainbow) - Calling
ParticleEmitter.setScale
would set thescaleY
property tonull
, causing calls tosetScaleY
to throw a runtime error.scaleY
is now a required property across both the Particle and Emitter classes and all of the conditional checks for it have been removed (thanks ojg15) - Calling
Tween.reset
when a tween was in a state ofPENDING_REMOVE
would cause it to fail to restart. It now restarts fully. Fix #4793 (thanks @spayton) - The default
Tween._pausedState
has changed fromINIT
toPENDING_ADD
. This fixes a bug where if you calledTween.play
immediately after creating it, it would force the tween to freeze. Fix #5454 (thanks @michal-bures) - If you start a
PathFollower
with ato
value it will now tween and complete at that value, rather than the end of the path as before (thanks @samme) Text
with RTL enabled wouldn't factor in the left / right padding correctly, causing the text to be cut off. It will now account for padding in the line width calculations. Fix #5830 (thanks @rexrainbow)- The
Path.fromJSON
function would use the wrong name for a Quadratic Bezier curve class, meaning it would be skipped in the exported JSON. It's now included correctly (thanks @natureofcode) - The
Input.Touch.TouchManager.stopListeners
forgot to remove thetouchcancel
handler. This is now removed correctly (thanks @teng-z) - The
BitmapMask
shader has been recoded so it now works correctly if you mask a Game Object that has alpha set on it, or in its texture. Previously it would alpha the Game Object against black (thanks stever1388) - When the Pointer moves out of the canvas and is released it would trigger
Uncaught TypeError: Cannot read properties of undefined (reading 'renderList')
if multiple children existed in the pointer-out array. Fix #5867 #5699 (thanks @rexrainbow @lyger) - If the Input Target in the game config was a string, it wouldn't be correctly parsed by the Touch Manager.
- The
InputPlugin.sortGameObjects
will now assign a value of 0 to any game object not in the render list, but still viable for input, such as an invisible object withalwaysEnabled
set to true. This fixes an issue where non-render list objects would be skipped. Fix #5507 (thanks @EmilSV) - The
GameObject.willRender
method will now factor in the parentdisplayList
, if it has one, to the end result. This fixes issues like that where an invisible Layer will still process input events. Fix #5883 (thanks @rexrainbow) InputPlugin.disable
will now also reset the drag state of the Game Object as well as remove it from all of the internal temporary arrays. This fixes issues where if you disabled a Game Object for input during an input event it would still remain in the temporary internal arrays. This method now also returns the Input Plugin, to matchenable
. Fix #5828 (thank @natureofcode @thewaver)- The
GetBounds
component has been removed from the Point Light Game Object. Fix #5934 (thanks @x-wk @samme) SceneManager.moveAbove
andmoveBelow
now take into account the modified indexes after the move (thanks @EmilSV)- When forcing a game to use
setTimeout
and then sending the game to sleep, it would accidentally restart by using Request Animation Frame instead (thanks @andymikulski) - Including a
render
object within the Game Config will no longer erase any top-level config render settings. Therender
object will now take priority over the game config, but both will be used (thanks @vzhou842) - Calling
Tween.stop(0)
would run for an additional delta before stopping, causing the Tween to not be truly 100% "reset". Fix #5986 (thanks @Mesonyx) - The
Utils.Array.SafeRange
function would exclude valid certain ranges. Fix #5979 (thanks @ksritharan) - The "Skip intersects check by argument" change in Arcade Physics has been reverted. Fix #5956 (thanks @samme)
- The
Container.pointToContainer
method would ignore the providedoutput
parameter, but now uses it (thanks @vforsh) - The
Polygon
Game Object would ignore itsclosePath
property when rendering in Canvas. Fix #5983 (thanks @optimumsuave) - IE9 Fix: Added 2 missing Typed Array polyfills (thanks @jcyuan)
- IE9 Fix: CanvasRenderer ignores frames with zero dimensions (thanks @jcyuan)
RenderTexture.batchTextureFrame
will now skip thedrawImage
call in canvas if the frame width or height are zero. Fix #5951 (thanks @Hoshinokoe)BlitterCanvasRenderer
will now skip thedrawImage
call in canvas if the frame width or height are zero.ParticleManagerCanvasRenderer
will now skip thedrawImage
call in canvas if the frame width or height are zero.CanvasSnapshot
will now skip thedrawImage
call in canvas if the frame width or height are zero.TextureManager.getBase64
will now skip thedrawImage
call in canvas if the frame width or height are zero.TilemapLayerCanvasRenderer
will now skip thedrawImage
call in canvas if the frame width or height are zero.- Audio will now unlock properly again on iOS14 and above in Safari. Fix #5696 (thanks @laineus)
- Drawing Game Objects to a Render Texture in WebGL would skip their blend modes. This is now applied correctly. Fix #5565 #5996 (thanks @sjb933 @danarcher)
- Loading a Script File Type will now default the 'type' property to 'script' when a type is not provided. Fix #5994 (thanks @samme @ItsGravix)
- Using
RenderTexture.fill
in CANVAS mode only would produce a nearly always black color due to float conversion (thanks @andymikulski) - If you Paused or Stopped a Scene that was in a preload state, it would still call 'create' after the Scene had shutdown (thanks @samme)
- BitmapText rendering wouldn't correctly apply per-character kerning offsets. These are now implemented during rendering (thanks @arbassic)
- Child Spine objects inside Containers wouldn't correctly inherit the parent Containers alpha. Fix #5853 (thanks @spayton)
- The DisplayList will now enter a while loop until all Game Objects are destroyed, rather than cache the list length. This prevents "cannot read property 'destroy' of undefined" errors in Scenes. Fix #5520 (thanks @schontz @astei)
- Particles can now be moved to 0x0.
moveToX
andmoveToY
now default to null instead of 0 (thanks @samme) - Layers will now destroy more carefully when children destroy themselves (thanks @rexrainbow)
- An error in the
GetBitmapTextSize
function caused kerning to not be applied correctly to Bitmap Text objects. This now works across WebGL and Canvas (thanks @arbassic @TJ09) WebGLSnapshot
andCanvasSnapshot
will now Math.floor the width/height values to ensure no sub-pixel dimensions, which corrupts the resulting texture. Fix #6099 (thanks @orjandh)ContainerCanvasRenderer
would pass in a 5thcontainer
parameter to the childrenderCanvas
call, which was breaking theGraphicsCanvasRenderer
and isn't needed by any Game Object, so has been removed. Fix #6093 (thanks @Antriel)- Fixed issue in
Utils.Objects.GetValue
where it would return an incorrect result if asource
andaltSource
were provided that didn't match in structure. Fix #5952 (thanks @rexrainbow) - Fixed issue in Game Config where having an empty object, such as
render: {}
would cause set properties to be overriden with the default value. Fix #6097 (thanks @michalfialadev) - The
SceneManager.moveAbove
andmoveBelow
methods didn't check the order of the Scenes being moved, so moved them even if one was already above / below the other. Both methods now check the indexes first. Fix #6040 (thanks @yuupsup) - Setting
scale.mode
in the Game Config would be ignored. It now accepts either this, orscaleMode
directly. Fix #5970 (thanks @samme) - The frame duration calculations in the
AnimationManager.createFromAseprite
method would be incorrect if they contained a mixture of long and very short duration frames (thanks @martincapello) - The
TilemapLayer.getTilesWithinShape
method would not return valid results when used with a Line geometry object. Fix #5640 (thanks @hrecker @samme) - Modified the way Phaser uses
require
statements in order to fix an issue in Google's closure-compiler when variables are re-assigned to new values (thanks @TJ09) - When creating a
MatterTileBody
from an isometric tile the tiles top value would be incorrect. ThegetTop
method has been fixed to address this (thanks @adamazmil) - Sprites created directly (not via the Game Object Factory) which are then added to a Container would fail to play their animations, because they were not added to the Scene Update List. Fix #5817 #5818 #6052 (thanks @prakol16 @adomas-sk)
- Game Objects that were created and destroyed (or moved to Containers) in the same frame were not correctly removed from the UpdateList. Fix #5803 (thanks @samme)
Container.removeHandler
now specifies the context forEvents.DESTROY
, fixing an issue where objects moved from one container, to another, then destroyed, would causesys
reference errors. Fix 5846 (thanks @sreadixl)Container.removeAll
(which is also called when a Container is destroyed) will now directly destroy the children, if the given parameter is set, rather than doing it after removing them via the event handler. This fixes an issue where nested Containers would add destroyed children back to the Scene as part of their shutdown process. Fix #6078 (thanks @BenoitFreslon)- The
DisplayList.addChildCallback
method will now check to see if the child has a parent container, and if it does, remove it from there before adding it to the Scene Display List. Fix #6091 (thanks @michalfialadev)
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:
@necrokot Golen @Pythux @samme @danfoster @eltociear @sylvainpolletvillard @hanzooo @etherealmachine @DeweyHur @twoco @austinlyon @Arcanorum OmniOwl @EsteFilipe @PhaserEditor2D @Fake @jonasrundberg @xmahle @arosemena @monteiz @VanaMartin