Phaser Class: Stage

new Stage(game, width, height)

The Stage controls the canvas on which everything is displayed. It handles display within the browser, focus handling, game resizing, scaling and the pause, boot and orientation screens.

Parameters:

Name	Type	Description
`game`	Phaser.Game	Game reference to the currently running game.
`width`	number	Width of the canvas element.
`height`	number	Height of the canvas element.

Source:

core/Stage.js, line 17

Members

aspectRatio

Properties:

Name	Type	Description
`aspectRatio`	number	Aspect ratio.

Source:

core/Stage.js, line 62

backgroundColor

Properties:

Name	Type	Description
`paused`	number \| string	Gets and sets the background color of the stage. The color can be given as a number: 0xff0000 or a hex string: '#ff0000'

Source:

core/Stage.js, line 153

canvas

Properties:

Name	Type	Description
`canvas`	HTMLCanvasElement	Reference to the newly created <canvas> element.

Source:

core/Stage.js, line 39

checkOffsetInterval

Properties:

Name	Type	Description
`checkOffsetInterval`	number \| false	The time (in ms) between which the stage should check to see if it has moved.

Default Value:

2500

Source:

core/Stage.js, line 74

game

Properties:

Name	Type	Description
`game`	Phaser.Game	A reference to the currently running Game.

Source:

core/Stage.js, line 22

offset

Properties:

Name	Type	Description
`offset`	Phaser.Point	Get the offset values (for input and other things).

Source:

core/Stage.js, line 34

scale

Properties:

Name	Type	Description
`scale`	Phaser.StageScaleMode	The scale of the current running game.

Source:

core/Stage.js, line 57

scaleMode

Properties:

Name	Type	Description
`scaleMode`	number	The current scaleMode.

Source:

core/Stage.js, line 52

Methods

update()

Runs Stage processes that need periodic updates, such as the offset checks.

Source:

core/Stage.js, line 110

visibilityChange(event)

This method is called when the document visibility is changed.

Parameters:

Name	Type	Description
`event`	Event	Its type will be used to decide whether the game should be paused or not.

Source:

core/Stage.js, line 128