Reference to the Phaser.GameObjectFactory.
Anti-alias graphics. By default scaled images are smoothed in Canvas and WebGL, set anti-alias to false to disable this globally. Default: true
Reference to the assets cache.
A handy reference to world.camera.
A handy reference to renderer.view, the canvas that the game is being rendered in to.
Clear the Canvas each frame before rendering the display list.
You can set this to false to gain some performance if your game always contains a background that completely fills the display.
Default: true
The Phaser.Game configuration object.
A handy reference to renderer.context (only set for CANVAS games, not WebGL)
The Asset Generator.
The ID of the current/last logic update applied this render frame, starting from 0.
The first update is currentUpdateID === 0 and the last update is currentUpdateID === updatesThisFrame.
A set of useful debug utilities.
Contains device information and capabilities.
Should the game loop force a logic update, regardless of the delta timer? Set to true if you know you need this. You can toggle it on the fly.
If the game is struggling to maintain the desired FPS, this signal will be dispatched. The desired/chosen FPS should probably be closer to the {@link Phaser.Time#suggestedFps} value.
The current Game Height in pixels.
Do not modify this property directly: use {@link Phaser.ScaleManager#setGameSize} - eg. game.scale.setGameSize(width, height) - instead.
Default: 600
Phaser Game ID (for when Pixi supports multiple instances).
Reference to the input manager
Whether the game engine is booted, aka available.
Is game running or paused?
Reference to the assets loader.
If false Phaser will automatically render the display list every update. If true the render loop will be skipped.
You can toggle this value at run-time to gain exact control over when Phaser renders. This can be useful in certain types of game or application.
Please note that if you don't render the display list then none of the game object transforms will be updated, so use this value carefully.
Reference to the GameObject Creator.
Reference to the math helper.
Reference to the network class.
This event is fired when the game no longer has focus (typically on page hide).
Signal that fires when the boot phase/state has completed (and before the preloader starts)
This event is fired when the game has focus (typically on page show).
Signal that fires when a new progress is deemed necessary (No progress yet exists, progress is complete, or is incompatable) Progress is deemed incompatable if: * Progress state 'major' is more than one version behind activity 'major' version -> create new progress
Callback should initialize ProgressTracker and set progress.state as needed by the activity
This event is fired when the game pauses.
Signal that fires when the preload phase/state has completed (before the initial activity state/scene starts)
This event is fired when the game resumes from a paused state.
Signal that fires when the existing progress version is ONE 'major' version behind activity
Callback should:
The Games DOM parent.
The Particle Manager.
The paused state of the Game. A paused game doesn't update any of its subsystems. When a game is paused the onPause event is dispatched. When it is resumed the onResume event is dispatched. Gets and sets the paused state of the Game.
An internal property used by enableStep, but also useful to query from your own game objects.
Reference to the physics manager.
The Phaser.Physics.World configuration object.
Reference to the plugin manager.
The value of the preserveDrawingBuffer flag affects whether or not the contents of the stencil buffer is retained after rendering.
Automatically handles the core game loop via requestAnimationFrame or setTimeout
The Renderer this game will use. Either Phaser.AUTO, Phaser.CANVAS, Phaser.WEBGL, or Phaser.HEADLESS.
The Pixi Renderer.
The resolution of your game. This value is read only, but can be changed at start time it via a game configuration object. Default: 1
Instance of repeatable random data generator helper.
The game scale manager.
Reference to the sound manager.
Reference to the stage.
The StateManager.
When stepping is enabled this contains the current step cycle.
Enable core loop stepping with Game.enableStep().
Reference to the core game clock.
Use a transparent canvas background or not.
Reference to the tween manager.
Number of logic updates expected to occur this render frame; will be 1 unless there are catch-ups required (and allowed).
The current Game Width in pixels.
Do not modify this property directly: use {@link Phaser.ScaleManager#setGameSize} - eg. game.scale.setGameSize(width, height) - instead.
Default: 800
Reference to the world.
Returns object loaded from activity-config.json
Return the collection of assets used for the activity. Items in this collection before startUp will be preloaded.
Returns the signal used when an overlay button is pressed. These buttons are currently supported: ("backward"|"forward"|"home")
Returns the orientation the activity requested
Initialize engine sub modules and start the game.
Adds or removes this frameworks 'update' timer if needed. This timer is used for internal/framework updates and this function should only need to be called internally by the framework
Called when the Preloader is completed (before activity's initial state/scene). This checks for existing progress and compares its version to the current activity's version, then dispatches onNewProgress or onTransformProgress Progress is deemed incompatable if:
Nukes the entire game from orbit.
Calls destroy on Game.state, Game.sound, Game.scale, Game.stage, Game.input, Game.physics and Game.plugins.
Then sets all of those local handlers to null, destroys the renderer, removes the canvas from the DOM and resets the PIXI default renderer.
Disables core game loop stepping.
Enable core game loop stepping. When enabled you must call game.step() directly (perhaps via a DOM button?) Calling step will advance the game loop by one frame. This is extremely useful for hard to track down errors!
Called by the Stage visibility handler.
The DOM event that caused the game to pause, if any.
Called by the Stage visibility handler.
The DOM event that caused the game to pause, if any.
Called by the Stage visibility handler.
The DOM event that caused the game to pause, if any.
Called by the Stage visibility handler.
The DOM event that caused the game to pause, if any.
Parses a Game configuration object.
Resize the game to best match the requested params
Min width in pixels
Min height in pixels
Attemps to fill screen (while maintaining aspect)
Required orientation. Defaults to "any"
Ignore pixel density when calculating size. Defaults to true.
Checks if the device is capable of using the requested renderer and sets it up or an alternative if not.
Displays a Phaser version debug header in the console.
Start the boot and preload process. Once that is completed, start the activityStartState
When stepping is enabled you must call this function directly (perhaps via a DOM button?) to advance the game loop by one frame. This is extremely useful to hard to track down errors! Use the internal stepCount property to monitor progress.
The core game loop.
The current time as provided by RequestAnimationFrame.
Updates all logic subsystems in Phaser. Called automatically by Game.update.
The current timeStep value as determined by Game.update.
Runs the Render cycle.
It starts by calling State.preRender. In here you can do any last minute adjustments of display objects as required.
It then calls the renderer, which renders the entire display list, starting from the Stage object and working down.
It then calls plugin.render on any loaded plugins, in the order in which they were enabled.
After this State.render is called. Any rendering that happens here will take place on-top of the display list.
Finally plugin.postRender is called on any loaded plugins, in the order in which they were enabled.
This method is called automatically by Game.update, you don't need to call it directly.
Should you wish to have fine-grained control over when Phaser renders then use the Game.lockRender boolean.
Phaser will only render when this boolean is false.
Main Phaser game class