Phaser Class: Game

new Game(width, height, renderer, parent, state, transparent, antialias, physicsConfig)

Game constructor

Instantiate a new <code>Phaser.Game</code> object.

Parameters:

Name	Type	Argument	Default	Description
`width`	number \| string	<optional>	800	The width of your game in game pixels. If given as a string the value must be between 0 and 100 and will be used as the percentage width of the parent container, or the browser window if no parent is given.
`height`	number \| string	<optional>	600	The height of your game in game pixels. If given as a string the value must be between 0 and 100 and will be used as the percentage height of the parent container, or the browser window if no parent is given.
`renderer`	number	<optional>	Phaser.AUTO	Which renderer to use: Phaser.AUTO will auto-detect, Phaser.WEBGL, Phaser.CANVAS or Phaser.HEADLESS (no rendering at all).
`parent`	string \| HTMLElement	<optional>	''	The DOM element into which this games canvas will be injected. Either a DOM ID (string) or the element itself.
`state`	object	<optional>	null	The default state object. A object consisting of Phaser.State functions (preload, create, update, render) or null.
`transparent`	boolean	<optional>	false	Use a transparent canvas background or not.
`antialias`	boolean	<optional>	true	Draw all image textures anti-aliased or not. The default is for smooth textures, but disable if your game features pixel art.
`physicsConfig`	object	<optional>	null	A physics configuration object to pass to the Physics world on creation.

Source:

core/Game.js, line 26

Members

add

Properties:

Name	Type	Description
`add`	Phaser.GameObjectFactory	Reference to the Phaser.GameObjectFactory.

Source:

core/Game.js, line 114

antialias

Properties:

Name	Type	Description
`antialias`	boolean	Anti-alias graphics. By default scaled images are smoothed in Canvas and WebGL, set anti-alias to false to disable this globally.

Default Value:

true

Source:

core/Game.js, line 71

cache

Properties:

Name	Type	Description
`cache`	Phaser.Cache	Reference to the assets cache.

Source:

core/Game.js, line 124

camera

Properties:

Name	Type	Description
`camera`	Phaser.Camera	A handy reference to world.camera.

Source:

core/Game.js, line 194

canvas

Properties:

Name	Type	Description
`canvas`	HTMLCanvasElement	A handy reference to renderer.view, the canvas that the game is being rendered in to.

Source:

core/Game.js, line 199

config

Properties:

Name	Type	Description
`config`	object	The Phaser.Game configuration object.

Source:

core/Game.js, line 36

context

Properties:

Name	Type	Description
`context`	CanvasRenderingContext2D	A handy reference to renderer.context (only set for CANVAS games, not WebGL)

Source:

core/Game.js, line 204

debug

Properties:

Name	Type	Description
`debug`	Phaser.Utils.Debug	A set of useful debug utilitie.

Source:

core/Game.js, line 209

device

Properties:

Name	Type	Description
`device`	Phaser.Device	Contains device information and capabilities.

Source:

core/Game.js, line 189

height

Properties:

Name	Type	Description
`height`	number	The calculated game height in pixels.

Default Value:

Source:

core/Game.js, line 59

id

Properties:

Name	Type	Description
`id`	number	Phaser Game ID (for when Pixi supports multiple instances).

Source:

core/Game.js, line 31

input

Properties:

Name	Type	Description
`input`	Phaser.Input	Reference to the input manager

Source:

core/Game.js, line 129

isBooted

Properties:

Name	Type	Description
`isBooted`	boolean	Whether the game engine is booted, aka available.

Default Value:

false

Source:

core/Game.js, line 98

isRunning

Properties:

Name	Type	Description
`id`	boolean	Is game running or paused?

Default Value:

false

Source:

core/Game.js, line 104

load

Properties:

Name	Type	Description
`load`	Phaser.Loader	Reference to the assets loader.

Source:

core/Game.js, line 134

make

Properties:

Name	Type	Description
`make`	Phaser.GameObjectCreator	Reference to the GameObject Creator.

Source:

core/Game.js, line 119

math

Properties:

Name	Type	Description
`math`	Phaser.Math	Reference to the math helper.

Source:

core/Game.js, line 139

net

Properties:

Name	Type	Description
`net`	Phaser.Net	Reference to the network class.

Source:

core/Game.js, line 144

onBlur

Properties:

Name	Type	Description
`onBlur`	Phaser.Signal	This event is fired when the game no longer has focus (typically on page hide).

Source:

core/Game.js, line 250

onFocus

Properties:

Name	Type	Description
`onFocus`	Phaser.Signal	This event is fired when the game has focus (typically on page show).

Source:

core/Game.js, line 255

onPause

Properties:

Name	Type	Description
`onPause`	Phaser.Signal	This event is fired when the game pauses.

Source:

core/Game.js, line 240

onResume

Properties:

Name	Type	Description
`onResume`	Phaser.Signal	This event is fired when the game resumes from a paused state.

Source:

core/Game.js, line 245

parent

Properties:

Name	Type	Description
`parent`	string \| HTMLElement	The Games DOM parent.

Source:

core/Game.js, line 47

particles

Properties:

Name	Type	Description
`particles`	Phaser.Particles	The Particle Manager.

Source:

core/Game.js, line 214

paused

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.

Properties:

Name	Type	Description
`paused`	boolean	Gets and sets the paused state of the Game.

Source:

core/Game.js, line 867

<readonly> pendingStep

Properties:

Name	Type	Description
`pendingStep`	boolean	An internal property used by enableStep, but also useful to query from your own game objects.

Default Value:

false

Source:

core/Game.js, line 228

physics

Properties:

Name	Type	Description
`physics`	Phaser.Physics	Reference to the physics manager.

Source:

core/Game.js, line 179

physicsConfig

Properties:

Name	Type	Description
`physicsConfig`	object	The Phaser.Physics.World configuration object.

Source:

core/Game.js, line 41

preserveDrawingBuffer

Properties:

Name	Type	Description
`preserveDrawingBuffer`	boolean	The value of the preserveDrawingBuffer flag affects whether or not the contents of the stencil buffer is retained after rendering.

Default Value:

false

Source:

core/Game.js, line 77

raf

Properties:

Name	Type	Description
`raf`	Phaser.RequestAnimationFrame	Automatically handles the core game loop via requestAnimationFrame or setTimeout

Source:

core/Game.js, line 109

renderer

Properties:

Name	Type	Description
`renderer`	PIXI.CanvasRenderer \| PIXI.WebGLRenderer	The Pixi Renderer.

Source:

core/Game.js, line 82

renderType

Properties:

Name	Type	Description
`renderType`	number	The Renderer this game will use. Either Phaser.AUTO, Phaser.CANVAS or Phaser.WEBGL.

Source:

core/Game.js, line 87

rnd

Properties:

Name	Type	Description
`rnd`	Phaser.RandomDataGenerator	Instance of repeatable random data generator helper.

Source:

core/Game.js, line 184

scale

Properties:

Name	Type	Description
`scale`	Phaser.ScaleManager	The game scale manager.

Source:

core/Game.js, line 149

sound

Properties:

Name	Type	Description
`sound`	Phaser.SoundManager	Reference to the sound manager.

Source:

core/Game.js, line 154

stage

Properties:

Name	Type	Description
`stage`	Phaser.Stage	Reference to the stage.

Source:

core/Game.js, line 159

state

Properties:

Name	Type	Description
`state`	Phaser.StateManager	The StateManager.

Source:

core/Game.js, line 92

<readonly> stepCount

Properties:

Name	Type	Description
`stepCount`	number	When stepping is enabled this contains the current step cycle.

Default Value:

Source:

core/Game.js, line 235

<readonly> stepping

Properties:

Name	Type	Description
`stepping`	boolean	Enable core loop stepping with Game.enableStep().

Default Value:

false

Source:

core/Game.js, line 221

time

Properties:

Name	Type	Description
`time`	Phaser.Time	Reference to the core game clock.

Source:

core/Game.js, line 164

transparent

Properties:

Name	Type	Description
`transparent`	boolean	Use a transparent canvas background or not.

Default Value:

false

Source:

core/Game.js, line 65

tweens

Properties:

Name	Type	Description
`tweens`	Phaser.TweenManager	Reference to the tween manager.

Source:

core/Game.js, line 169

width

Properties:

Name	Type	Description
`width`	number	The calculated game width in pixels.

Default Value:

Source:

core/Game.js, line 53

world

Properties:

Name	Type	Description
`world`	Phaser.World	Reference to the world.

Source:

core/Game.js, line 174

Methods

<protected> boot()

Initialize engine sub modules and start the game.

Source:

core/Game.js, line 417

destroy()

Nukes the entire game from orbit.

Source:

core/Game.js, line 755

disableStep()

Disables core game loop stepping.

Source:

core/Game.js, line 730

enableStep()

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!

Source:

core/Game.js, line 716

<protected> focusGain(event)

Called by the Stage visibility handler.

Parameters:

Name	Type	Description
`event`	object	The DOM event that caused the game to pause, if any.

Source:

core/Game.js, line 845

<protected> focusLoss(event)

Called by the Stage visibility handler.

Parameters:

Name	Type	Description
`event`	object	The DOM event that caused the game to pause, if any.

Source:

core/Game.js, line 827

<protected> gamePaused(event)

Called by the Stage visibility handler.

Parameters:

Name	Type	Description
`event`	object	The DOM event that caused the game to pause, if any.

Source:

core/Game.js, line 786

<protected> gameResumed(event)

Called by the Stage visibility handler.

Parameters:

Name	Type	Description
`event`	object	The DOM event that caused the game to pause, if any.

Source:

core/Game.js, line 806

<protected> parseConfig()

Parses a Game configuration object.

Source:

core/Game.js, line 342

<protected> setUpRenderer()

Checks if the device is capable of using the requested renderer and sets it up or an alternative if not.

Source:

core/Game.js, line 565

<protected> showDebugHeader()

Displays a Phaser version debug header in the console.

Source:

core/Game.js, line 503

step()

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.

Source:

core/Game.js, line 742

<protected> update(time)

The core game loop.

Parameters:

Name	Type	Description
`time`	number	The current time as provided by RequestAnimationFrame.

Source:

core/Game.js, line 646