Phaser 3.85.2 API Documentation

This is the complete API documentation for Phaser v3.85.2.

It gives you every single method, property, event, typedef, callback signature and more but without any context of their application.

For that, please use the API docs in conjunction with our Phaser Guide and example code.

Classes

• Phaser.Animations.Animation
• Phaser.Animations.AnimationFrame
• Phaser.Animations.AnimationManager
• Phaser.Animations.AnimationState
• Phaser.Cache.BaseCache
• Phaser.Cache.CacheManager
• Phaser.Cameras.Scene2D.BaseCamera
• Phaser.Cameras.Scene2D.Camera
• Phaser.Cameras.Scene2D.CameraManager
• Phaser.Cameras.Scene2D.Effects.Fade
• Phaser.Cameras.Scene2D.Effects.Flash
• Phaser.Cameras.Scene2D.Effects.Pan
• Phaser.Cameras.Scene2D.Effects.RotateTo
• Phaser.Cameras.Scene2D.Effects.Shake
• Phaser.Cameras.Scene2D.Effects.Zoom
• Phaser.Cameras.Controls.FixedKeyControl
• Phaser.Cameras.Controls.SmoothedKeyControl
• Phaser.Core.Config
• Phaser.Game
• Phaser.Core.TimeStep
• Phaser.Curves.CubicBezier
• Phaser.Curves.Curve
• Phaser.Curves.Ellipse
• Phaser.Curves.Line
• Phaser.Curves.MoveTo
• Phaser.Curves.Path
• Phaser.Curves.QuadraticBezier
• Phaser.Curves.Spline
• Phaser.Data.DataManager
• Phaser.Data.DataManagerPlugin
• Phaser.Display.Color
• Phaser.Display.ColorMatrix
• Phaser.Display.Masks.BitmapMask
• Phaser.Display.Masks.GeometryMask
• Phaser.Display.RGB
• Phaser.Display.BaseShader
• Phaser.DOM.RequestAnimationFrame
• Phaser.Events.EventEmitter
• Phaser.FX.Barrel
• Phaser.FX.Bloom
• Phaser.FX.Blur
• Phaser.FX.Bokeh
• Phaser.FX.Circle
• Phaser.FX.ColorMatrix
• Phaser.FX.Controller
• Phaser.FX.Displacement
• Phaser.FX.Glow
• Phaser.FX.Gradient
• Phaser.FX.Pixelate
• Phaser.FX.Shadow
• Phaser.FX.Shine
• Phaser.FX.Vignette
• Phaser.FX.Wipe
• Phaser.GameObjects.DynamicBitmapText
• Phaser.GameObjects.BitmapText
• Phaser.GameObjects.Blitter
• Phaser.GameObjects.Bob
• Phaser.GameObjects.Components.FX
• Phaser.GameObjects.Components.TransformMatrix
• Phaser.GameObjects.Container
• Phaser.GameObjects.DisplayList
• Phaser.GameObjects.DOMElement
• Phaser.GameObjects.Extern
• Phaser.GameObjects.GameObject
• Phaser.GameObjects.GameObjectCreator
• Phaser.GameObjects.GameObjectFactory
• Phaser.GameObjects.Graphics
• Phaser.GameObjects.Group
• Phaser.GameObjects.Image
• Phaser.GameObjects.Layer
• Phaser.GameObjects.Light
• Phaser.GameObjects.LightsManager
• Phaser.GameObjects.LightsPlugin
• Phaser.GameObjects.Mesh
• Phaser.GameObjects.NineSlice
• Phaser.GameObjects.Particles.EmitterColorOp
• Phaser.GameObjects.Particles.EmitterOp
• Phaser.GameObjects.Particles.GravityWell
• Phaser.GameObjects.Particles.Particle
• Phaser.GameObjects.Particles.ParticleBounds
• Phaser.GameObjects.Particles.ParticleEmitter
• Phaser.GameObjects.Particles.ParticleProcessor
• Phaser.GameObjects.Particles.Zones.DeathZone
• Phaser.GameObjects.Particles.Zones.EdgeZone
• Phaser.GameObjects.Particles.Zones.RandomZone
• Phaser.GameObjects.PathFollower
• Phaser.GameObjects.Plane
• Phaser.GameObjects.PointLight
• Phaser.GameObjects.RenderTexture
• Phaser.GameObjects.Rope
• Phaser.GameObjects.Shader
• Phaser.GameObjects.Arc
• Phaser.GameObjects.Curve
• Phaser.GameObjects.Ellipse
• Phaser.GameObjects.Grid
• Phaser.GameObjects.IsoBox
• Phaser.GameObjects.IsoTriangle
• Phaser.GameObjects.Line
• Phaser.GameObjects.Polygon
• Phaser.GameObjects.Rectangle
• Phaser.GameObjects.Shape
• Phaser.GameObjects.Star
• Phaser.GameObjects.Triangle
• Phaser.GameObjects.Sprite
• Phaser.GameObjects.Text
• Phaser.GameObjects.TextStyle
• Phaser.GameObjects.TileSprite
• Phaser.GameObjects.UpdateList
• Phaser.GameObjects.Video
• Phaser.GameObjects.Zone
• Phaser.Geom.Circle
• Phaser.Geom.Ellipse
• Phaser.Geom.Line
• Phaser.Geom.Mesh.Face
• Phaser.Geom.Mesh.Vertex
• Phaser.Geom.Point
• Phaser.Geom.Polygon
• Phaser.Geom.Rectangle
• Phaser.Geom.Triangle
• Phaser.Input.Gamepad.Axis
• Phaser.Input.Gamepad.Button
• Phaser.Input.Gamepad.Gamepad
• Phaser.Input.Gamepad.GamepadPlugin
• Phaser.Input.InputManager
• Phaser.Input.InputPlugin
• Phaser.Input.Keyboard.KeyCombo
• Phaser.Input.Keyboard.KeyboardManager
• Phaser.Input.Keyboard.KeyboardPlugin
• Phaser.Input.Keyboard.Key
• Phaser.Input.Mouse.MouseManager
• Phaser.Input.Pointer
• Phaser.Input.Touch.TouchManager
• Phaser.Loader.File
• Phaser.Loader.FileTypes.AnimationJSONFile
• Phaser.Loader.FileTypes.AsepriteFile
• Phaser.Loader.FileTypes.AtlasJSONFile
• Phaser.Loader.FileTypes.AtlasXMLFile
• Phaser.Loader.FileTypes.AudioFile
• Phaser.Loader.FileTypes.AudioSpriteFile
• Phaser.Loader.FileTypes.BinaryFile
• Phaser.Loader.FileTypes.BitmapFontFile
• Phaser.Loader.FileTypes.CompressedTextureFile
• Phaser.Loader.FileTypes.CSSFile
• Phaser.Loader.FileTypes.GLSLFile
• Phaser.Loader.FileTypes.HTML5AudioFile
• Phaser.Loader.FileTypes.HTMLFile
• Phaser.Loader.FileTypes.HTMLTextureFile
• Phaser.Loader.FileTypes.ImageFile
• Phaser.Loader.FileTypes.JSONFile
• Phaser.Loader.FileTypes.MultiAtlasFile
• Phaser.Loader.FileTypes.MultiScriptFile
• Phaser.Loader.FileTypes.OBJFile
• Phaser.Loader.FileTypes.PackFile
• Phaser.Loader.FileTypes.PluginFile
• Phaser.Loader.FileTypes.SceneFile
• Phaser.Loader.FileTypes.ScenePluginFile
• Phaser.Loader.FileTypes.ScriptFile
• Phaser.Loader.FileTypes.SpriteSheetFile
• Phaser.Loader.FileTypes.SVGFile
• Phaser.Loader.FileTypes.TextFile
• Phaser.Loader.FileTypes.TilemapCSVFile
• Phaser.Loader.FileTypes.TilemapImpactFile
• Phaser.Loader.FileTypes.TilemapJSONFile
• Phaser.Loader.FileTypes.UnityAtlasFile
• Phaser.Loader.FileTypes.VideoFile
• Phaser.Loader.FileTypes.XMLFile
• Phaser.Loader.LoaderPlugin
• Phaser.Loader.MultiFile
• Phaser.Math.Euler
• Phaser.Math.Matrix3
• Phaser.Math.Matrix4
• Phaser.Math.Quaternion
• Phaser.Math.RandomDataGenerator
• Phaser.Math.Vector2
• Phaser.Math.Vector3
• Phaser.Math.Vector4
• Phaser.Physics.Arcade.Image
• Phaser.Physics.Arcade.ArcadePhysics
• Phaser.Physics.Arcade.Sprite
• Phaser.Physics.Arcade.Body
• Phaser.Physics.Arcade.Collider
• Phaser.Physics.Arcade.Factory
• Phaser.Physics.Arcade.Group
• Phaser.Physics.Arcade.StaticBody
• Phaser.Physics.Arcade.StaticGroup
• Phaser.Physics.Arcade.World
• Phaser.Physics.Matter.BodyBounds
• Phaser.Physics.Matter.Factory
• Phaser.Physics.Matter.Image
• Phaser.Physics.Matter.MatterPhysics
• Phaser.Physics.Matter.Sprite
• Phaser.Physics.Matter.TileBody
• Phaser.Physics.Matter.PointerConstraint
• Phaser.Physics.Matter.World
• Phaser.Plugins.BasePlugin
• Phaser.Plugins.PluginManager
• Phaser.Plugins.ScenePlugin
• Phaser.Renderer.Canvas.CanvasRenderer
• Phaser.Renderer.WebGL.PipelineManager
• Phaser.Renderer.WebGL.Pipelines.BitmapMaskPipeline
• Phaser.Renderer.WebGL.Pipelines.FX.BarrelFXPipeline
• Phaser.Renderer.WebGL.Pipelines.FX.BloomFXPipeline
• Phaser.Renderer.WebGL.Pipelines.FX.BlurFXPipeline
• Phaser.Renderer.WebGL.Pipelines.FX.BokehFXPipeline
• Phaser.Renderer.WebGL.Pipelines.FX.CircleFXPipeline
• Phaser.Renderer.WebGL.Pipelines.FX.ColorMatrixFXPipeline
• Phaser.Renderer.WebGL.Pipelines.FX.DisplacementFXPipeline
• Phaser.Renderer.WebGL.Pipelines.FX.GlowFXPipeline
• Phaser.Renderer.WebGL.Pipelines.FX.GradientFXPipeline
• Phaser.Renderer.WebGL.Pipelines.FX.PixelateFXPipeline
• Phaser.Renderer.WebGL.Pipelines.FX.ShadowFXPipeline
• Phaser.Renderer.WebGL.Pipelines.FX.ShineFXPipeline
• Phaser.Renderer.WebGL.Pipelines.FX.VignetteFXPipeline
• Phaser.Renderer.WebGL.Pipelines.FX.WipeFXPipeline
• Phaser.Renderer.WebGL.Pipelines.FXPipeline
• Phaser.Renderer.WebGL.Pipelines.LightPipeline
• Phaser.Renderer.WebGL.Pipelines.MobilePipeline
• Phaser.Renderer.WebGL.Pipelines.MultiPipeline
• Phaser.Renderer.WebGL.Pipelines.PointLightPipeline
• Phaser.Renderer.WebGL.Pipelines.PostFXPipeline
• Phaser.Renderer.WebGL.Pipelines.PreFXPipeline
• Phaser.Renderer.WebGL.Pipelines.RopePipeline
• Phaser.Renderer.WebGL.Pipelines.SinglePipeline
• Phaser.Renderer.WebGL.Pipelines.UtilityPipeline
• Phaser.Renderer.WebGL.RenderTarget
• Phaser.Renderer.WebGL.WebGLPipeline
• Phaser.Renderer.WebGL.WebGLRenderer
• Phaser.Renderer.WebGL.WebGLShader
• Phaser.Renderer.WebGL.Wrappers.WebGLAttribLocationWrapper
• Phaser.Renderer.WebGL.Wrappers.WebGLBufferWrapper
• Phaser.Renderer.WebGL.Wrappers.WebGLFramebufferWrapper
• Phaser.Renderer.WebGL.Wrappers.WebGLProgramWrapper
• Phaser.Renderer.WebGL.Wrappers.WebGLTextureWrapper
• Phaser.Renderer.WebGL.Wrappers.WebGLUniformLocationWrapper
• Phaser.Scale.ScaleManager
• Phaser.Scene
• Phaser.Scenes.SceneManager
• Phaser.Scenes.ScenePlugin
• Phaser.Scenes.Systems
• Phaser.Sound.BaseSound
• Phaser.Sound.BaseSoundManager
• Phaser.Sound.HTML5AudioSound
• Phaser.Sound.HTML5AudioSoundManager
• Phaser.Sound.NoAudioSound
• Phaser.Sound.NoAudioSoundManager
• Phaser.Sound.WebAudioSound
• Phaser.Sound.WebAudioSoundManager
• Phaser.Structs.List
• Phaser.Structs.Map
• Phaser.Structs.ProcessQueue
• Phaser.Structs.RTree
• Phaser.Structs.Set
• Phaser.Structs.Size
• Phaser.Textures.CanvasTexture
• Phaser.Textures.DynamicTexture
• Phaser.Textures.Frame
• Phaser.Textures.Texture
• Phaser.Textures.TextureManager
• Phaser.Textures.TextureSource
• Phaser.Tilemaps.ImageCollection
• Phaser.Tilemaps.LayerData
• Phaser.Tilemaps.MapData
• Phaser.Tilemaps.ObjectLayer
• Phaser.Tilemaps.ObjectHelper
• Phaser.Tilemaps.Tile
• Phaser.Tilemaps.Tilemap
• Phaser.Tilemaps.TilemapLayer
• Phaser.Tilemaps.Tileset
• Phaser.Time.Clock
• Phaser.Time.Timeline
• Phaser.Time.TimerEvent
• Phaser.Tweens.BaseTween
• Phaser.Tweens.BaseTweenData
• Phaser.Tweens.Tween
• Phaser.Tweens.TweenChain
• Phaser.Tweens.TweenData
• Phaser.Tweens.TweenFrameData
• Phaser.Tweens.TweenManager
• Class
• Phaser.FacebookInstantGamesPlugin
• Phaser.FacebookInstantGamesLeaderboard

Constants

• Phaser
• Phaser.BlendModes
• Phaser.Core
• Phaser.Display
• Phaser.FX
• Phaser.GameObjects
• Phaser.Input
• Phaser.Math
• Phaser.Renderer
• Phaser.Scale
• Phaser.Structs
• Phaser.Textures
• Phaser.Tilemaps
• Phaser.Tweens

Events

• Phaser.Animations.Events
• Phaser.Cache.Events
• Phaser.Cameras.Scene2D.Events
• Phaser.Core.Events
• Phaser.Data.Events
• Phaser.GameObjects.Events
• Phaser.GameObjects.Particles.Events
• Phaser.Input.Events
• Phaser.Input.Gamepad.Events
• Phaser.Input.Keyboard.Events
• Phaser.Loader.Events
• Phaser.Physics.Arcade.Events
• Phaser.Physics.Matter.Events
• Phaser.Renderer.Events
• Phaser.Renderer.WebGL.Pipelines.Events
• Phaser.Scale.Events
• Phaser.Scenes.Events
• Phaser.Sound.Events
• Phaser.Structs.Events
• Phaser.Textures.Events
• Phaser.Time.Events
• Phaser.Tweens.Events

Game Object Classes

• Phaser.GameObjects.Arc
• Phaser.GameObjects.BitmapText
• Phaser.GameObjects.Blitter
• Phaser.GameObjects.Bob
• Phaser.GameObjects.Components
• Phaser.GameObjects.Container
• Phaser.GameObjects.Curve
• Phaser.GameObjects.DisplayList
• Phaser.GameObjects.DOMElement
• Phaser.GameObjects.DynamicBitmapText
• Phaser.GameObjects.Ellipse
• Phaser.GameObjects.Events
• Phaser.GameObjects.Extern
• Phaser.GameObjects.GameObject
• Phaser.GameObjects.GameObjectCreator
• Phaser.GameObjects.GameObjectFactory
• Phaser.GameObjects.Graphics
• Phaser.GameObjects.Grid
• Phaser.GameObjects.Group
• Phaser.GameObjects.Image
• Phaser.GameObjects.IsoBox
• Phaser.GameObjects.IsoTriangle
• Phaser.GameObjects.Layer
• Phaser.GameObjects.Light
• Phaser.GameObjects.LightsManager
• Phaser.GameObjects.LightsPlugin
• Phaser.GameObjects.Line
• Phaser.GameObjects.Mesh
• Phaser.GameObjects.NineSlice
• Phaser.GameObjects.Particles
• Phaser.GameObjects.PathFollower
• Phaser.GameObjects.Plane
• Phaser.GameObjects.PointLight
• Phaser.GameObjects.Polygon
• Phaser.GameObjects.Rectangle
• Phaser.GameObjects.RenderTexture
• Phaser.GameObjects.RetroFont
• Phaser.GameObjects.Rope
• Phaser.GameObjects.Shader
• Phaser.GameObjects.Shape
• Phaser.GameObjects.Sprite
• Phaser.GameObjects.Star
• Phaser.GameObjects.Text
• Phaser.GameObjects.TextStyle
• Phaser.GameObjects.TileSprite
• Phaser.GameObjects.Triangle
• Phaser.GameObjects.UpdateList
• Phaser.GameObjects.Video
• Phaser.GameObjects.Zone

Game Object Functions

• Phaser.GameObjects.BuildGameObject
• Phaser.GameObjects.BuildGameObjectAnimation
• Phaser.GameObjects.GetCalcMatrix
• Phaser.GameObjects.GetTextSize
• Phaser.GameObjects.MeasureText

Arcade Physics

• Phaser.Physics.Arcade.ArcadePhysics
• Phaser.Physics.Arcade.Body
• Phaser.Physics.Arcade.Collider
• Phaser.Physics.Arcade.Components
• Phaser.Physics.Arcade.DYNAMIC_BODY
• Phaser.Physics.Arcade.Events
• Phaser.Physics.Arcade.FACING_DOWN
• Phaser.Physics.Arcade.FACING_LEFT
• Phaser.Physics.Arcade.FACING_NONE
• Phaser.Physics.Arcade.FACING_RIGHT
• Phaser.Physics.Arcade.FACING_UP
• Phaser.Physics.Arcade.Factory
• Phaser.Physics.Arcade.GetCollidesWith
• Phaser.Physics.Arcade.GetOverlapX
• Phaser.Physics.Arcade.GetOverlapY
• Phaser.Physics.Arcade.Group
• Phaser.Physics.Arcade.GROUP
• Phaser.Physics.Arcade.Image
• Phaser.Physics.Arcade.ProcessX
• Phaser.Physics.Arcade.ProcessY
• Phaser.Physics.Arcade.SeparateX
• Phaser.Physics.Arcade.SeparateY
• Phaser.Physics.Arcade.SetCollisionObject
• Phaser.Physics.Arcade.Sprite
• Phaser.Physics.Arcade.STATIC_BODY
• Phaser.Physics.Arcade.StaticBody
• Phaser.Physics.Arcade.StaticGroup
• Phaser.Physics.Arcade.Tilemap
• Phaser.Physics.Arcade.TILEMAPLAYER
• Phaser.Physics.Arcade.World

Matter Physics

• Phaser.Physics.Matter.BodyBounds
• Phaser.Physics.Matter.Components
• Phaser.Physics.Matter.Events
• Phaser.Physics.Matter.Factory
• Phaser.Physics.Matter.Image
• Phaser.Physics.Matter.Matter
• Phaser.Physics.Matter.MatterGameObject
• Phaser.Physics.Matter.MatterPhysics
• Phaser.Physics.Matter.PhysicsEditorParser
• Phaser.Physics.Matter.PhysicsJSONParser
• Phaser.Physics.Matter.PointerConstraint
• Phaser.Physics.Matter.Sprite
• Phaser.Physics.Matter.TileBody
• Phaser.Physics.Matter.World

Typedefs

• Phaser
• Phaser.Device
• Phaser.Physics.Matter.Events
• Phaser.Scale
• Phaser.Tilemaps
• Phaser.Tweens
• Phaser.Types.Actions
• Phaser.Types.Animations
• Phaser.Types.Cameras.Controls
• Phaser.Types.Cameras.Scene2D
• Phaser.Types.Core
• Phaser.Types.Create
• Phaser.Types.Curves
• Phaser.Types.Display
• Phaser.Types.GameObjects
• Phaser.Types.GameObjects.BitmapText
• Phaser.Types.GameObjects.Container
• Phaser.Types.GameObjects.Graphics
• Phaser.Types.GameObjects.Group
• Phaser.Types.GameObjects.Mesh
• Phaser.Types.GameObjects.NineSlice
• Phaser.Types.GameObjects.Particles
• Phaser.Types.GameObjects.PathFollower
• Phaser.Types.GameObjects.Plane
• Phaser.Types.GameObjects.RenderTexture
• Phaser.Types.GameObjects.Rope
• Phaser.Types.GameObjects.Shader
• Phaser.Types.GameObjects.Sprite
• Phaser.Types.GameObjects.Text
• Phaser.Types.GameObjects.TileSprite
• Phaser.Types.GameObjects.Video
• Phaser.Types.GameObjects.Zone
• Phaser.Types.Geom.Mesh
• Phaser.Types.Input
• Phaser.Types.Input.Gamepad
• Phaser.Types.Input.Keyboard
• Phaser.Types.Loader
• Phaser.Types.Loader.FileTypes
• Phaser.Types.Math
• Phaser.Types.Physics.Arcade
• Phaser.Types.Physics.Matter
• Phaser.Types.Plugins
• Phaser.Types.Renderer.Snapshot
• Phaser.Types.Renderer.WebGL
• Phaser.Types.Scenes
• Phaser.Types.Sound
• Phaser.Types.Textures
• Phaser.Types.Tilemaps
• Phaser.Types.Time
• Phaser.Types.Tweens